Skip to content
GitHub

Objects

Amount

Fields

NameDescription
value
UInt64!
assetCode
String!

ISO 4217 currency code, e.g. USD

assetScale
UInt8!

Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit

Asset

Implements

Fields

NameDescription
id
ID!

Asset id

code
String!

ISO 4217 currency code, e.g. USD

scale
UInt8!

Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit

liquidity
UInt64

Available liquidity

withdrawalThreshold
UInt64

Minimum amount of liquidity that can be withdrawn from the asset

liquidityThreshold
UInt64

Account Servicing Entity will be notified via a webhook event if liquidity falls below this value

receivingFee
Fee

The receiving fee structure for the asset

sendingFee
Fee

The sending fee structure for the asset

fees
FeesConnection

Fetch a page of asset fees

Arguments

NameDescription
after
String

Paginating forwards: the cursor before the the requested page.

before
String

Paginating backwards: the cursor after the the requested page.

first
Int

Paginating forwards: The first n elements from the page.

last
Int

Paginating backwards: The last n elements from the page.

sortOrder
SortOrder

Ascending or descending order of creation.

createdAt
String!

Date-time of creation

AssetEdge

Fields

NameDescription
node
Asset!
cursor
String!

AssetMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
asset
Asset

AssetsConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[AssetEdge!]!

CreateOrUpdatePeerByUrlMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
peer
Peer

CreatePeerMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
peer
Peer

CreateReceiverResponse

Fields

NameDescription
code
String!
success
Boolean!
message
String
receiver
Receiver

CreateWalletAddressKeyMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
walletAddressKey
WalletAddressKey

CreateWalletAddressMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
walletAddress
WalletAddress

DeleteAssetMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!

DeletePeerMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!

Fee

Implements

Fields

NameDescription
id
ID!

Fee id

assetId
ID!

Asset id associated with the fee

type
FeeType!

Type of fee (sending or receiving)

fixed
UInt64!

Fixed fee

basisPoints
Int!

Basis points fee. 1 basis point = 0.01%, 100 basis points = 1%, 10000 basis points = 100%

createdAt
String!

Date-time of creation

FeeEdge

Fields

NameDescription
node
Fee!
cursor
String!

FeesConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[FeeEdge!]!

Http

Fields

NameDescription
outgoing
HttpOutgoing!

Outgoing connection details

HttpOutgoing

Fields

NameDescription
authToken
String!

Auth token to present at the peering Rafiki instance

endpoint
String!

Peer's connection endpoint

IncomingPayment

Implements

Fields

NameDescription
id
ID!

Incoming Payment id

walletAddressId
ID!

Id of the wallet address under which this incoming payment was created.

client
String

Information about the wallet address of the Open Payments client that created the incoming payment.

liquidity
UInt64

Available liquidity

state
IncomingPaymentState!

Incoming payment state

expiresAt
String!

Date-time of expiry. After this time, the incoming payment will not accept further payments made to it.

incomingAmount
Amount

The maximum amount that should be paid into the wallet address under this incoming payment.

receivedAmount
Amount!

The total amount that has been paid into the wallet address under this incoming payment.

metadata
JSONObject

Additional metadata associated with the incoming payment.

createdAt
String!

Date-time of creation

IncomingPaymentConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[IncomingPaymentEdge!]!

IncomingPaymentEdge

Fields

NameDescription
node
IncomingPayment!
cursor
String!

IncomingPaymentResponse

Fields

NameDescription
code
String!
success
Boolean!
message
String
payment
IncomingPayment

Jwk

Fields

NameDescription
kid
String!

Key id

x
String!

Base64 url-encoded public key.

alg
Alg!

Cryptographic algorithm family used with the key. The only allowed value is EdDSA.

kty
Kty!

Key type. The only allowed value is OKP.

crv
Crv!

Curve that the key pair is derived from. The only allowed value is Ed25519.

LiquidityMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
error
LiquidityError

OutgoingPayment

Implements

Fields

NameDescription
id
ID!

Outgoing payment id

walletAddressId
ID!

Id of the wallet address under which this outgoing payment was created

client
String

Information about the wallet address of the Open Payments client that created the outgoing payment.

liquidity
UInt64

Available liquidity

state
OutgoingPaymentState!

Outgoing payment state

error
String
stateAttempts
Int!
debitAmount
Amount!

Amount to send (fixed send)

receiveAmount
Amount!

Amount to receive (fixed receive)

receiver
String!

Wallet address URL of the receiver

metadata
JSONObject

Additional metadata associated with the outgoing payment.

quote
Quote

Quote for this outgoing payment

sentAmount
Amount!

Amount already sent

createdAt
String!

Date-time of creation

OutgoingPaymentConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[OutgoingPaymentEdge!]!

OutgoingPaymentEdge

Fields

NameDescription
node
OutgoingPayment!
cursor
String!

OutgoingPaymentResponse

Fields

NameDescription
code
String!
success
Boolean!
message
String
payment
OutgoingPayment

PageInfo

Fields

NameDescription
endCursor
String

Paginating forwards: the cursor to continue.

hasNextPage
Boolean!

Paginating forwards: Are there more pages?

hasPreviousPage
Boolean!

Paginating backwards: Are there more pages?

startCursor
String

Paginating backwards: the cursor to continue.

Payment

Implements

Fields

NameDescription
id
ID!

Payment id

type
PaymentType!

Type of payment

walletAddressId
ID!

Id of the wallet address under which this payment was created

client
String

Information about the wallet address of the Open Payments client that created the payment.

state
String!

Either the IncomingPaymentState or OutgoingPaymentState according to type

liquidity
UInt64

Available liquidity

metadata
JSONObject

Additional metadata associated with the payment.

createdAt
String!

Date-time of creation

PaymentConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[PaymentEdge!]!

PaymentEdge

Fields

NameDescription
node
Payment!
cursor
String!

Peer

Implements

Fields

NameDescription
id
ID!

Peer id

maxPacketAmount
UInt64

Maximum packet amount that the peer accepts

http
Http!

Peering connection details

asset
Asset!

Asset of peering relationship

staticIlpAddress
String!

Peer's ILP address

name
String

Peer's public name

liquidityThreshold
UInt64

Account Servicing Entity will be notified via a webhook event if peer liquidity falls below this value

liquidity
UInt64

Available liquidity

createdAt
String!

Date-time of creation

PeerEdge

Fields

NameDescription
node
Peer!
cursor
String!

PeersConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[PeerEdge!]!

Quote

Fields

NameDescription
id
ID!

Quote id

walletAddressId
ID!

Id of the wallet address under which this quote was created

receiver
String!

Wallet address URL of the receiver

debitAmount
Amount!

Amount to send (fixed send)

receiveAmount
Amount!

Amount to receive (fixed receive)

maxPacketAmount
UInt64!

Maximum value per packet allowed on the possible routes

minExchangeRate
Float!

Aggregate exchange rate the payment is guaranteed to meet

lowEstimatedExchangeRate
Float!

Lower bound of probed exchange rate

highEstimatedExchangeRate
Float!

Upper bound of probed exchange rate

createdAt
String!

Date-time of creation

expiresAt
String!

Date-time of expiration

QuoteConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[QuoteEdge!]!

QuoteEdge

Fields

NameDescription
node
Quote!
cursor
String!

QuoteResponse

Fields

NameDescription
code
String!
success
Boolean!
message
String
quote
Quote

Receiver

Fields

NameDescription
id
String!

Incoming payment URL

walletAddressUrl
String!

Wallet address URL under which the incoming payment was created

completed
Boolean!

Describes whether the incoming payment has completed receiving funds.

incomingAmount
Amount

The maximum amount that should be paid into the wallet address under this incoming payment.

receivedAmount
Amount!

The total amount that has been paid into the wallet address under this incoming payment.

expiresAt
String

Date-time of expiry. After this time, the incoming payment will accept further payments made to it.

metadata
JSONObject

Additional metadata associated with the incoming payment.

createdAt
String!

Date-time of creation

updatedAt
String!

Date-time of last update

RevokeWalletAddressKeyMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
walletAddressKey
WalletAddressKey

SetFeeResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
fee
Fee

TransferMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!

TriggerWalletAddressEventsMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
count
Int

Number of events triggered

UpdatePeerMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
peer
Peer

UpdateWalletAddressMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
walletAddress
WalletAddress

WalletAddress

Implements

Fields

NameDescription
id
ID!

Wallet address id

asset
Asset!

Asset of the wallet address

liquidity
UInt64

Available liquidity

url
String!

Wallet Address URL

publicName
String

Public name associated with the wallet address

incomingPayments
IncomingPaymentConnection

List of incoming payments received by this wallet address

Arguments

NameDescription
after
String

Paginating forwards: the cursor before the the requested page.

before
String

Paginating backwards: the cursor after the the requested page.

first
Int

Paginating forwards: The first n elements from the page.

last
Int

Paginating backwards: The last n elements from the page.

sortOrder
SortOrder

Ascending or descending order of creation.

quotes
QuoteConnection

List of quotes created at this wallet address

Arguments

NameDescription
after
String

Paginating forwards: the cursor before the the requested page.

before
String

Paginating backwards: the cursor after the the requested page.

first
Int

Paginating forwards: The first n elements from the page.

last
Int

Paginating backwards: The last n elements from the page.

sortOrder
SortOrder

Ascending or descending order of creation.

outgoingPayments
OutgoingPaymentConnection

List of outgoing payments sent from this wallet address

Arguments

NameDescription
after
String

Paginating forwards: the cursor before the the requested page.

before
String

Paginating backwards: the cursor after the the requested page.

first
Int

Paginating forwards: The first n elements from the page.

last
Int

Paginating backwards: The last n elements from the page.

sortOrder
SortOrder

Ascending or descending order of creation.

createdAt
String!

Date-time of creation

status
WalletAddressStatus!

Status of the wallet address

walletAddressKeys
WalletAddressKeyConnection

Arguments

NameDescription
after
String

Paginating forwards: the cursor before the the requested page.

before
String

Paginating backwards: the cursor after the the requested page.

first
Int

Paginating forwards: The first n elements from the page.

last
Int

Paginating backwards: The last n elements from the page.

sortOrder
SortOrder

Ascending or descending order of creation.

WalletAddressEdge

Fields

NameDescription
node
WalletAddress!
cursor
String!

WalletAddressesConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[WalletAddressEdge!]!

WalletAddressKey

Implements

Fields

NameDescription
id
ID!

Internal id of key

walletAddressId
ID!

Id of the wallet address to which this key belongs to

jwk
Jwk!

Public key

revoked
Boolean!

Indicator whether the key has been revoked

createdAt
String!

Date-time of creation

WalletAddressKeyConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[WalletAddressKeyEdge!]!

WalletAddressKeyEdge

Fields

NameDescription
node
WalletAddressKey!
cursor
String!

WalletAddressWithdrawal

Fields

NameDescription
id
ID!

Withdrawal Id

amount
UInt64!

Amount to withdraw

walletAddress
WalletAddress!

Wallet address details

WalletAddressWithdrawalMutationResponse

Implements

Fields

NameDescription
code
String!
success
Boolean!
message
String!
error
LiquidityError
withdrawal
WalletAddressWithdrawal

WebhookEvent

Implements

Fields

NameDescription
id
ID!

Event id

type
String!

Type of event

data
JSONObject!

Stringified JSON data

createdAt
String!

Date-time of creation

WebhookEventsConnection

Fields

NameDescription
pageInfo
PageInfo!
edges
[WebhookEventsEdge!]!

WebhookEventsEdge

Fields

NameDescription
node
WebhookEvent!
cursor
String!