Objects
Amount
Fields
Name | Description |
---|---|
valueUInt64!
|
|
assetCodeString!
|
ISO 4217 currency code, e.g. |
assetScaleUInt8!
|
Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit |
Asset
Implements
Fields
Name | Description |
---|---|
idID!
|
Asset id |
codeString!
|
ISO 4217 currency code, e.g. |
scaleUInt8!
|
Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit |
liquidityUInt64
|
Available liquidity |
withdrawalThresholdUInt64
|
Minimum amount of liquidity that can be withdrawn from the asset |
liquidityThresholdUInt64
|
Account Servicing Entity will be notified via a webhook event if liquidity falls below this value |
receivingFeeFee
|
The receiving fee structure for the asset |
sendingFeeFee
|
The sending fee structure for the asset |
createdAtString!
|
Date-time of creation |
AssetEdge
Fields
Name | Description |
---|---|
nodeAsset!
|
|
cursorString!
|
AssetMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
assetAsset
|
AssetsConnection
Fields
Name | Description |
---|---|
pageInfoPageInfo!
|
|
edges[AssetEdge!]!
|
CreateOrUpdatePeerByUrlMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
peerPeer
|
CreatePaymentPointerKeyMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
paymentPointerKeyPaymentPointerKey
|
CreatePaymentPointerMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
paymentPointerPaymentPointer
|
CreatePeerMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
peerPeer
|
CreateReceiverResponse
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString
|
|
receiverReceiver
|
DeletePeerMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
Fee
Implements
Fields
Name | Description |
---|---|
idID!
|
Fee id |
assetIdID!
|
Asset id associated with the fee |
typeFeeType!
|
Type of fee (sending or receiving) |
fixedUInt64!
|
Fixed fee |
basisPointsInt!
|
Basis points fee. 1 basis point = 0.01%, 100 basis points = 1%, 10000 basis points = 100% |
createdAtString!
|
Date-time of creation |
Http
Fields
Name | Description |
---|---|
outgoingHttpOutgoing!
|
Outgoing connection details |
HttpOutgoing
Fields
Name | Description |
---|---|
authTokenString!
|
Auth token to present at the peering Rafiki instance |
endpointString!
|
Peer's connection endpoint |
IncomingPayment
Implements
Fields
Name | Description |
---|---|
idID!
|
Incoming Payment id |
paymentPointerIdID!
|
Id of the payment pointer under which this incoming payment was created |
stateIncomingPaymentState!
|
Incoming payment state |
expiresAtString!
|
Date-time of expiry. After this time, the incoming payment will not accept further payments made to it. |
incomingAmountAmount
|
The maximum amount that should be paid into the payment pointer under this incoming payment. |
receivedAmountAmount!
|
The total amount that has been paid into the payment pointer under this incoming payment. |
metadataJSONObject
|
Additional metadata associated with the incoming payment. |
createdAtString!
|
Date-time of creation |
IncomingPaymentConnection
Fields
Name | Description |
---|---|
pageInfoPageInfo!
|
|
edges[IncomingPaymentEdge!]!
|
IncomingPaymentEdge
Fields
Name | Description |
---|---|
nodeIncomingPayment!
|
|
cursorString!
|
IncomingPaymentResponse
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString
|
|
paymentIncomingPayment
|
Jwk
Fields
Name | Description |
---|---|
kidString!
|
Key id |
xString!
|
Base64 url-encoded public key. |
algAlg!
|
Cryptographic algorithm family used with the key. The only allowed value is |
ktyKty!
|
Key type. The only allowed value is |
crvCrv!
|
Curve that the key pair is derived from. The only allowed value is |
LiquidityMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
errorLiquidityError
|
OutgoingPayment
Implements
Fields
Name | Description |
---|---|
idID!
|
Outgoing payment id |
paymentPointerIdID!
|
Id of the payment pointer under which this outgoing payment was created |
stateOutgoingPaymentState!
|
Outgoing payment state |
errorString
|
|
stateAttemptsInt!
|
|
debitAmountAmount!
|
Amount to send (fixed send) |
receiveAmountAmount!
|
Amount to receive (fixed receive) |
receiverString!
|
Payment pointer URL of the receiver |
metadataJSONObject
|
Additional metadata associated with the outgoing payment. |
quoteQuote
|
Quote for this outgoing payment |
sentAmountAmount!
|
Amount already sent |
createdAtString!
|
Date-time of creation |
OutgoingPaymentConnection
Fields
Name | Description |
---|---|
pageInfoPageInfo!
|
|
edges[OutgoingPaymentEdge!]!
|
OutgoingPaymentEdge
Fields
Name | Description |
---|---|
nodeOutgoingPayment!
|
|
cursorString!
|
OutgoingPaymentResponse
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString
|
|
paymentOutgoingPayment
|
PageInfo
Fields
Name | Description |
---|---|
endCursorString
|
Paginating forwards: the cursor to continue. |
hasNextPageBoolean!
|
Paginating forwards: Are there more pages? |
hasPreviousPageBoolean!
|
Paginating backwards: Are there more pages? |
startCursorString
|
Paginating backwards: the cursor to continue. |
Payment
Implements
Fields
Name | Description |
---|---|
idID!
|
Payment id |
typePaymentType!
|
Type of payment |
paymentPointerIdID!
|
Id of the payment pointer under which this payment was created |
stateString!
|
Either the IncomingPaymentState or OutgoingPaymentState according to type |
metadataJSONObject
|
Additional metadata associated with the payment. |
createdAtString!
|
Date-time of creation |
PaymentConnection
Fields
Name | Description |
---|---|
pageInfoPageInfo!
|
|
edges[PaymentEdge!]!
|
PaymentEdge
Fields
Name | Description |
---|---|
nodePayment!
|
|
cursorString!
|
PaymentPointer
Implements
Fields
Name | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
idID!
|
Payment pointer id |
||||||||||
assetAsset!
|
Asset of the payment pointer |
||||||||||
urlString!
|
Payment Pointer URL |
||||||||||
publicNameString
|
Public name associated with the payment pointer |
||||||||||
incomingPaymentsIncomingPaymentConnection
|
List of incoming payments received by this payment pointer Arguments
|
||||||||||
quotesQuoteConnection
|
List of quotes created at this payment pointer Arguments
|
||||||||||
outgoingPaymentsOutgoingPaymentConnection
|
List of outgoing payments sent from this payment pointer Arguments
|
||||||||||
createdAtString!
|
Date-time of creation |
||||||||||
statusPaymentPointerStatus!
|
Status of the payment pointer |
PaymentPointerEdge
Fields
Name | Description |
---|---|
nodePaymentPointer!
|
|
cursorString!
|
PaymentPointerKey
Implements
Fields
Name | Description |
---|---|
idID!
|
Internal id of key |
paymentPointerIdID!
|
Id of the payment pointer to which this key belongs to |
jwkJwk!
|
Public key |
revokedBoolean!
|
Indicator whether the key has been revoked |
createdAtString!
|
Date-time of creation |
PaymentPointersConnection
Fields
Name | Description |
---|---|
pageInfoPageInfo!
|
|
edges[PaymentPointerEdge!]!
|
PaymentPointerWithdrawal
Fields
Name | Description |
---|---|
idID!
|
Withdrawal Id |
amountUInt64!
|
Amount to withdraw |
paymentPointerPaymentPointer!
|
Payment pointer details |
PaymentPointerWithdrawalMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
errorLiquidityError
|
|
withdrawalPaymentPointerWithdrawal
|
Peer
Implements
Fields
Name | Description |
---|---|
idID!
|
Peer id |
maxPacketAmountUInt64
|
Maximum packet amount that the peer accepts |
httpHttp!
|
Peering connection details |
assetAsset!
|
Asset of peering relationship |
staticIlpAddressString!
|
Peer's ILP address |
nameString
|
Peer's public name |
liquidityThresholdUInt64
|
Account Servicing Entity will be notified via a webhook event if peer liquidity falls below this value |
liquidityUInt64
|
Available liquidity |
createdAtString!
|
Date-time of creation |
PeerEdge
Fields
Name | Description |
---|---|
nodePeer!
|
|
cursorString!
|
PeersConnection
Fields
Name | Description |
---|---|
pageInfoPageInfo!
|
|
edges[PeerEdge!]!
|
Quote
Fields
Name | Description |
---|---|
idID!
|
Quote id |
paymentPointerIdID!
|
Id of the payment pointer under which this quote was created |
receiverString!
|
Payment pointer URL of the receiver |
debitAmountAmount!
|
Amount to send (fixed send) |
receiveAmountAmount!
|
Amount to receive (fixed receive) |
maxPacketAmountUInt64!
|
Maximum value per packet allowed on the possible routes |
minExchangeRateFloat!
|
Aggregate exchange rate the payment is guaranteed to meet |
lowEstimatedExchangeRateFloat!
|
Lower bound of probed exchange rate |
highEstimatedExchangeRateFloat!
|
Upper bound of probed exchange rate |
createdAtString!
|
Date-time of creation |
expiresAtString!
|
Date-time of expiration |
QuoteConnection
Fields
Name | Description |
---|---|
pageInfoPageInfo!
|
|
edges[QuoteEdge!]!
|
QuoteEdge
Fields
Name | Description |
---|---|
nodeQuote!
|
|
cursorString!
|
QuoteResponse
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString
|
|
quoteQuote
|
Receiver
Fields
Name | Description |
---|---|
idString!
|
Incoming payment URL |
paymentPointerUrlString!
|
Payment pointer URL under which the incoming payment was created |
completedBoolean!
|
Describes whether the incoming payment has completed receiving funds. |
incomingAmountAmount
|
The maximum amount that should be paid into the payment pointer under this incoming payment. |
receivedAmountAmount!
|
The total amount that has been paid into the payment pointer under this incoming payment. |
expiresAtString
|
Date-time of expiry. After this time, the incoming payment will accept further payments made to it. |
metadataJSONObject
|
Additional metadata associated with the incoming payment. |
createdAtString!
|
Date-time of creation |
updatedAtString!
|
Date-time of last update |
RevokePaymentPointerKeyMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
paymentPointerKeyPaymentPointerKey
|
SetFeeResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
feeFee
|
TransferMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
TriggerPaymentPointerEventsMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
countInt
|
Number of events triggered |
UpdatePaymentPointerMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
paymentPointerPaymentPointer
|
UpdatePeerMutationResponse
Implements
Fields
Name | Description |
---|---|
codeString!
|
|
successBoolean!
|
|
messageString!
|
|
peerPeer
|
WebhookEvent
Implements
Fields
Name | Description |
---|---|
idID!
|
Event id |
typeString!
|
Type of event |
dataJSONObject!
|
Stringified JSON data |
createdAtString!
|
Date-time of creation |
WebhookEventsConnection
Fields
Name | Description |
---|---|
pageInfoPageInfo!
|
|
edges[WebhookEventsEdge!]!
|
WebhookEventsEdge
Fields
Name | Description |
---|---|
nodeWebhookEvent!
|
|
cursorString!
|