| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| grants | -GrantsConnection! | -- -Fetch a page of grants. - - | -|
| 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. - - | -|
| filter | -GrantFilter | -- -Filter grants based on specific criteria. - - | -|
| grant | -Grant! | -- -Fetch a grant - - | -|
| id | -ID! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| revokeGrant | -RevokeGrantMutationResponse! | -- -Revoke Grant - - | -|
| input | -RevokeGrantInput! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Access id - - | -|
| identifier | -String | -- -Payment pointer of a sub-resource (incoming payment, outgoing payment, or quote) - - | -|
| type | -String! | -- -Access type (incoming payment, outgoing payment, or quote) - - | -|
| actions | -[String]! | -- -Access action (create, read, list or complete) - - | -|
| limits | -LimitData | -- -Payment limits - - | -|
| createdAt | -String! | -- -Date-time of creation - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Grant id - - | -|
| client | -String! | -- -Payment pointer of the grantee's account - - | -|
| access | -[Access!]! | -- -Access details - - | -|
| state | -GrantState! | -- -State of the grant - - | -|
| finalizationReason | -GrantFinalization | -- -Reason a grant was finalized - - | -|
| createdAt | -String! | -- -Date-time of creation - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| node | -Grant! | -- | |
| cursor | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| pageInfo | -PageInfo! | -- | |
| edges | -[GrantEdge!]! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| receiver | -String | -- -Payment pointer URL of the receiver - - | -|
| debitAmount | -PaymentAmount | -- -Amount to debit - - | -|
| receiveAmount | -PaymentAmount | -- -Amount to receive - - | -|
| interval | -String | -- -Interval between payments - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| 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. - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| value | -UInt64! | -- | |
| assetCode | -String! | -- -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), e.g. `USD` - - | -|
| assetScale | -UInt8! | -- -Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| Field | -Type | -Description | -|
|---|---|---|---|
| in | -[GrantState!] | -- | |
| notIn | -[GrantState!] | -- | |
| Field | -Type | -Description | -|
|---|---|---|---|
| in | -[String!] | -- | |
| Field | -Type | -Description | -|
|---|---|---|---|
| identifier | -FilterString | -- | |
| state | -FilterGrantState | -- | |
| Field | -Type | -Description | -|
|---|---|---|---|
| grantId | -String! | -- | |
| Value | -Description | - - -
|---|---|
| ISSUED | -- -grant was issued - - | -
| REVOKED | -- -grant was revoked - - | -
| REJECTED | -- -grant was rejected - - | -
| Value | -Description | - - -
|---|---|
| PROCESSING | -- -grant request is determining what state to enter next - - | -
| PENDING | -- -grant request is awaiting interaction - - | -
| APPROVED | -- -grant was approved - - | -
| FINALIZED | -- -grant was finalized and no more access tokens or interactions can be made on it - - | -
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- | |
| createdAt | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| asset | -Asset | -- -Fetch an asset - - | -|
| id | -String! | -- | |
| assets | -AssetsConnection! | -- -Fetch a page of assets. - - | -|
| 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. - - | -|
| peer | -Peer | -- -Fetch a peer - - | -|
| id | -String! | -- | |
| peers | -PeersConnection! | -- -Fetch a page of peers. - - | -|
| 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. - - | -|
| paymentPointer | -PaymentPointer | -- -Fetch a payment pointer - - | -|
| id | -String! | -- | |
| paymentPointers | -PaymentPointersConnection! | -- -Fetch a page of payment pointers. - - | -|
| 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. - - | -|
| quote | -Quote | -- -Fetch an Open Payments quote - - | -|
| id | -String! | -- | |
| outgoingPayment | -OutgoingPayment | -- -Fetch an Open Payments outgoing payment - - | -|
| id | -String! | -- | |
| incomingPayment | -IncomingPayment | -- -Fetch an Open Payments incoming payment - - | -|
| id | -String! | -- | |
| webhookEvents | -WebhookEventsConnection! | -- -Fetch a page of webhook events - - | -|
| 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. - - | -|
| filter | -WebhookEventFilter | -- -Filter webhook events based on specific criteria. - - | -|
| payments | -PaymentConnection! | -- -Fetch a page of combined payments - - | -|
| 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. - - | -|
| filter | -PaymentFilter | -- -Filter payment events based on specific criteria. - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| createAsset | -AssetMutationResponse! | -- -Create an asset - - | -|
| input | -CreateAssetInput! | -- | |
| updateAsset | -AssetMutationResponse! | -- -Update an asset - - | -|
| input | -UpdateAssetInput! | -- | |
| addAssetLiquidity | -LiquidityMutationResponse | -- -Add asset liquidity - - | -|
| input | -AddAssetLiquidityInput! | -- | |
| createAssetLiquidityWithdrawal | -LiquidityMutationResponse | -- -Withdraw asset liquidity - - | -|
| input | -CreateAssetLiquidityWithdrawalInput! | -- | |
| createPeer | -CreatePeerMutationResponse! | -- -Create a peer - - | -|
| input | -CreatePeerInput! | -- | |
| updatePeer | -UpdatePeerMutationResponse! | -- -Update a peer - - | -|
| input | -UpdatePeerInput! | -- | |
| deletePeer | -DeletePeerMutationResponse! | -- -Delete a peer - - | -|
| input | -DeletePeerInput! | -- | |
| addPeerLiquidity | -LiquidityMutationResponse | -- -Add peer liquidity - - | -|
| input | -AddPeerLiquidityInput! | -- | |
| createPeerLiquidityWithdrawal | -LiquidityMutationResponse | -- -Withdraw peer liquidity - - | -|
| input | -CreatePeerLiquidityWithdrawalInput! | -- | |
| postLiquidityWithdrawal | -LiquidityMutationResponse | -- -Post liquidity withdrawal. Withdrawals are two-phase commits and are committed via this mutation. - - | -|
| input | -PostLiquidityWithdrawalInput! | -- | |
| voidLiquidityWithdrawal | -LiquidityMutationResponse | -- -Void liquidity withdrawal. Withdrawals are two-phase commits and are rolled back via this mutation. - - | -|
| input | -VoidLiquidityWithdrawalInput! | -- | |
| createPaymentPointer | -CreatePaymentPointerMutationResponse! | -- -Create a payment pointer - - | -|
| input | -CreatePaymentPointerInput! | -- | |
| updatePaymentPointer | -UpdatePaymentPointerMutationResponse! | -- -Update a payment pointer - - | -|
| input | -UpdatePaymentPointerInput! | -- | |
| createPaymentPointerKey | -CreatePaymentPointerKeyMutationResponse | -- -Add a public key to a payment pointer that is used to verify Open Payments requests. - - | -|
| input | -CreatePaymentPointerKeyInput! | -- | |
| revokePaymentPointerKey | -RevokePaymentPointerKeyMutationResponse | -- -Revoke a public key associated with a payment pointer. Open Payment requests using this key for request signatures will be denied going forward. - - | -|
| input | -RevokePaymentPointerKeyInput! | -- | |
| createIncomingPayment | -IncomingPaymentResponse! | -- -Create an internal Open Payments Incoming Payment. The receiver has a payment pointer on this Rafiki instance. - - | -|
| input | -CreateIncomingPaymentInput! | -- | |
| createReceiver | -CreateReceiverResponse! | -- -Create an internal or external Open Payments Incoming Payment. The receiver has a payment pointer on either this or another Open Payments resource server. - - | -|
| input | -CreateReceiverInput! | -- | |
| createQuote | -QuoteResponse! | -- -Create an Open Payments Quote - - | -|
| input | -CreateQuoteInput! | -- | |
| createOutgoingPayment | -OutgoingPaymentResponse! | -- -Create an Open Payments Outgoing Payment - - | -|
| input | -CreateOutgoingPaymentInput! | -- | |
| depositEventLiquidity | -LiquidityMutationResponse | -- -Deposit webhook event liquidity - - | -|
| input | -DepositEventLiquidityInput! | -- | |
| withdrawEventLiquidity | -LiquidityMutationResponse | -- -Withdraw webhook event liquidity - - | -|
| input | -WithdrawEventLiquidityInput! | -- | |
| createPaymentPointerWithdrawal | -PaymentPointerWithdrawalMutationResponse | -- -Withdraw liquidity from a payment pointer received via Web Monetization. - - | -|
| input | -CreatePaymentPointerWithdrawalInput! | -- | |
| triggerPaymentPointerEvents | -TriggerPaymentPointerEventsMutationResponse! | -- -If automatic withdrawal of funds received via Web Monetization by the payment pointer are disabled, this mutation can be used to trigger up to n withdrawal events. - - | -|
| input | -TriggerPaymentPointerEventsInput! | -- | |
| setFee | -SetFeeResponse! | -- -Set the fee on an asset - - | -|
| input | -SetFeeInput! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| value | -UInt64! | -- | |
| assetCode | -String! | -- -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), e.g. `USD` - - | -|
| assetScale | -UInt8! | -- -Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Asset id - - | -|
| code | -String! | -- -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), 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 - - | -|
| createdAt | -String! | -- -Date-time of creation - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| node | -Asset! | -- | |
| cursor | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| asset | -Asset | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| pageInfo | -PageInfo! | -- | |
| edges | -[AssetEdge!]! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| paymentPointerKey | -PaymentPointerKey | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| paymentPointer | -PaymentPointer | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| peer | -Peer | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String | -- | |
| receiver | -Receiver | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| 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 - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| outgoing | -HttpOutgoing! | -- -Outgoing connection details - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| authToken | -String! | -- -Auth token to present at the peering Rafiki instance - - | -|
| endpoint | -String! | -- -Peer's connection endpoint - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Incoming Payment id - - | -|
| paymentPointerId | -ID! | -- -Id of the payment pointer under which this incoming payment was created - - | -|
| 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 payment pointer under this incoming payment. - - | -|
| receivedAmount | -Amount! | -- -The total amount that has been paid into the payment pointer under this incoming payment. - - | -|
| metadata | -JSONObject | -- -Additional metadata associated with the incoming payment. - - | -|
| createdAt | -String! | -- -Date-time of creation - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| pageInfo | -PageInfo! | -- | |
| edges | -[IncomingPaymentEdge!]! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| node | -IncomingPayment! | -- | |
| cursor | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String | -- | |
| payment | -IncomingPayment | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| 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`. - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| error | -LiquidityError | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Outgoing payment id - - | -|
| paymentPointerId | -ID! | -- -Id of the payment pointer under which this outgoing payment was created - - | -|
| 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! | -- -Payment pointer 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 - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| pageInfo | -PageInfo! | -- | |
| edges | -[OutgoingPaymentEdge!]! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| node | -OutgoingPayment! | -- | |
| cursor | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String | -- | |
| payment | -OutgoingPayment | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| 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. - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Payment id - - | -|
| type | -PaymentType! | -- -Type of payment - - | -|
| paymentPointerId | -ID! | -- -Id of the payment pointer under which this payment was created - - | -|
| state | -String! | -- -Either the IncomingPaymentState or OutgoingPaymentState according to type - - | -|
| metadata | -JSONObject | -- -Additional metadata associated with the payment. - - | -|
| createdAt | -String! | -- -Date-time of creation - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| pageInfo | -PageInfo! | -- | |
| edges | -[PaymentEdge!]! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| node | -Payment! | -- | |
| cursor | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Payment pointer id - - | -|
| asset | -Asset! | -- -Asset of the payment pointer - - | -|
| url | -String! | -- -Payment Pointer URL - - | -|
| publicName | -String | -- -Public name associated with the payment pointer - - | -|
| incomingPayments | -IncomingPaymentConnection | -- -List of incoming payments received by this payment pointer - - | -|
| 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. - - | -|
| quotes | -QuoteConnection | -- -List of quotes created at this payment pointer - - | -|
| 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. - - | -|
| outgoingPayments | -OutgoingPaymentConnection | -- -List of outgoing payments sent from this payment pointer - - | -|
| 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. - - | -|
| createdAt | -String! | -- -Date-time of creation - - | -|
| status | -PaymentPointerStatus! | -- -Status of the payment pointer - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| node | -PaymentPointer! | -- | |
| cursor | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Internal id of key - - | -|
| paymentPointerId | -ID! | -- -Id of the payment pointer 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 - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Withdrawal Id - - | -|
| amount | -UInt64! | -- -Amount to withdraw - - | -|
| paymentPointer | -PaymentPointer! | -- -Payment pointer details - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| error | -LiquidityError | -- | |
| withdrawal | -PaymentPointerWithdrawal | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| pageInfo | -PageInfo! | -- | |
| edges | -[PaymentPointerEdge!]! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| 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 - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| node | -Peer! | -- | |
| cursor | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| pageInfo | -PageInfo! | -- | |
| edges | -[PeerEdge!]! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Quote id - - | -|
| paymentPointerId | -ID! | -- -Id of the payment pointer under which this quote was created - - | -|
| receiver | -String! | -- -Payment pointer 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 - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| pageInfo | -PageInfo! | -- | |
| edges | -[QuoteEdge!]! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| node | -Quote! | -- | |
| cursor | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String | -- | |
| quote | -Quote | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -String! | -- -Incoming payment URL - - | -|
| paymentPointerUrl | -String! | -- -Payment pointer 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 payment pointer under this incoming payment. - - | -|
| receivedAmount | -Amount! | -- -The total amount that has been paid into the payment pointer 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 - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| paymentPointerKey | -PaymentPointerKey | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| fee | -Fee | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| count | -Int | -- -Number of events triggered - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| paymentPointer | -PaymentPointer | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |
| peer | -Peer | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- -Event id - - | -|
| type | -String! | -- -Type of event - - | -|
| data | -JSONObject! | -- -Stringified JSON data - - | -|
| createdAt | -String! | -- -Date-time of creation - - | -|
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| pageInfo | -PageInfo! | -- | |
| edges | -[WebhookEventsEdge!]! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| node | -WebhookEvent! | -- | |
| cursor | -String! | -- | |
| Field | -Type | -Description | -|
|---|---|---|---|
| assetId | -String! | -- -The id of the asset to add liquidity. - - | -|
| amount | -UInt64! | -- -Amount of liquidity to add. - - | -|
| id | -String! | -- -The id of the transfer. - - | -|
| idempotencyKey | -String! | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| peerId | -String! | -- -The id of the peer to add liquidity. - - | -|
| amount | -UInt64! | -- -Amount of liquidity to add. - - | -|
| id | -String! | -- -The id of the transfer. - - | -|
| idempotencyKey | -String! | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| value | -UInt64! | -- | |
| assetCode | -String! | -- -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), e.g. `USD` - - | -|
| assetScale | -UInt8! | -- -Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| code | -String! | -- -[ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217), e.g. `USD` - - | -|
| scale | -UInt8! | -- -Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit - - | -|
| 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 - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| assetId | -String! | -- -The id of the asset to create the withdrawal for. - - | -|
| amount | -UInt64! | -- -Amount of withdrawal. - - | -|
| id | -String! | -- -The id of the withdrawal. - - | -|
| idempotencyKey | -String! | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| paymentPointerId | -String! | -- -Id of the payment pointer under which the incoming payment will be created - - | -|
| expiresAt | -String | -- -Expiration date-time - - | -|
| metadata | -JSONObject | -- -Additional metadata associated with the incoming payment. - - | -|
| incomingAmount | -AmountInput | -- -Maximum amount to be received - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| paymentPointerId | -String! | -- -Id of the payment pointer under which the outgoing payment will be created - - | -|
| quoteId | -String! | -- -Id of the corresponding quote for that outgoing payment - - | -|
| metadata | -JSONObject | -- -Additional metadata associated with the outgoing payment. - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| assetId | -String! | -- -Asset of the payment pointer - - | -|
| url | -String! | -- -Payment Pointer URL - - | -|
| publicName | -String | -- -Public name associated with the payment pointer - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| paymentPointerId | -String! | -- | |
| jwk | -JwkInput! | -- -Public key - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| paymentPointerId | -String! | -- -The id of the Open Payments payment pointer to create the withdrawal for. - - | -|
| id | -String! | -- -The id of the withdrawal. - - | -|
| idempotencyKey | -String! | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| maxPacketAmount | -UInt64 | -- -Maximum packet amount that the peer accepts - - | -|
| http | -HttpInput! | -- -Peering connection details - - | -|
| assetId | -String! | -- -Asset id of peering relationship - - | -|
| staticIlpAddress | -String! | -- -Peer's ILP address - - | -|
| name | -String | -- -Peer's internal name - - | -|
| liquidityThreshold | -UInt64 | -- -Account Servicing Entity will be notified via a webhook event if peer liquidity falls below this value - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| peerId | -String! | -- -The id of the peer to create the withdrawal for. - - | -|
| amount | -UInt64! | -- -Amount of withdrawal. - - | -|
| id | -String! | -- -The id of the withdrawal. - - | -|
| idempotencyKey | -String! | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| paymentPointerId | -String! | -- -Id of the payment pointer under which the quote will be created - - | -|
| debitAmount | -AmountInput | -- -Amount to send (fixed send) - - | -|
| receiveAmount | -AmountInput | -- -Amount to receive (fixed receive) - - | -|
| receiver | -String! | -- -Payment pointer URL of the receiver - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| paymentPointerUrl | -String! | -- -Receiving payment pointer URL - - | -|
| expiresAt | -String | -- -Expiration date-time - - | -|
| incomingAmount | -AmountInput | -- -Maximum amount to be received - - | -|
| metadata | -JSONObject | -- -Additional metadata associated with the incoming payment. - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| id | -ID! | -- | |
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| eventId | -String! | -- -The id of the event to deposit into. - - | -|
| idempotencyKey | -String! | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| fixed | -UInt64! | -- -A flat fee - - | -|
| basisPoints | -Int! | -- -Basis points fee. Should be between 0 and 10000 (inclusive). 1 basis point = 0.01%, 100 basis points = 1%, 10000 basis points = 100% - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| in | -[String!]! | -- | |
| Field | -Type | -Description | -|
|---|---|---|---|
| authTokens | -[String!]! | -- -Array of auth tokens accepted by this Rafiki instance - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| incoming | -HttpIncomingInput | -- -Incoming connection details - - | -|
| outgoing | -HttpOutgoingInput! | -- -Outgoing connection details - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| authToken | -String! | -- -Auth token to present at the peering Rafiki instance - - | -|
| endpoint | -String! | -- -Peer's connection endpoint - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| 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`. - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| type | -FilterString | -- | |
| paymentPointerId | -FilterString | -- | |
| Field | -Type | -Description | -|
|---|---|---|---|
| withdrawalId | -String! | -- -The id of the liquidity withdrawal to post. - - | -|
| idempotencyKey | -String! | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| id | -String! | -- -Internal id of key - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| assetId | -ID! | -- -Asset id to add the fee to - - | -|
| type | -FeeType! | -- -Type of fee (sending or receiving) - - | -|
| fee | -FeeDetails! | -- -Fee values - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| limit | -Int! | -- -Maximum number of events being triggered (n). - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| id | -String! | -- -Asset id - - | -|
| withdrawalThreshold | -UInt64 | -- -New 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 new value - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| id | -ID! | -- -ID of payment pointer to update - - | -|
| publicName | -String | -- -New public name for payment pointer - - | -|
| status | -PaymentPointerStatus | -- -New status to set the payment pointer to - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| id | -String! | -- -Peer id - - | -|
| maxPacketAmount | -UInt64 | -- -New maximum packet amount that the peer accepts - - | -|
| http | -HttpInput | -- -New peering connection details - - | -|
| staticIlpAddress | -String | -- -Peer's new ILP address - - | -|
| name | -String | -- -Peer's new public name - - | -|
| liquidityThreshold | -UInt64 | -- -Account Servicing Entity will be notified via a webhook event if peer liquidity falls below this new value - - | -|
| idempotencyKey | -String | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| withdrawalId | -String! | -- -The id of the liquidity withdrawal to void. - - | -|
| idempotencyKey | -String! | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Field | -Type | -Description | -|
|---|---|---|---|
| type | -FilterString | -- | |
| Field | -Type | -Description | -|
|---|---|---|---|
| eventId | -String! | -- -The id of the event to withdraw from. - - | -|
| idempotencyKey | -String! | -- -Unique key to ensure duplicate or retried requests are processed only once. See [idempotence](https://en.wikipedia.org/wiki/Idempotence) - - | -|
| Value | -Description | - - -
|---|---|
| EdDSA | -- |
| Value | -Description | - - -
|---|---|
| Ed25519 | -- |
| Value | -Description | - - -
|---|---|
| SENDING | -- -Sender pays the fees - - | -
| RECEIVING | -- -Receiver pays the fees - - | -
| Value | -Description | - - -
|---|---|
| PENDING | -- -The payment has a state of PENDING when it is initially created. - - | -
| PROCESSING | -- -As soon as payment has started (funds have cleared into the account) the state moves to PROCESSING - - | -
| COMPLETED | -- -The payment is either auto-completed once the received amount equals the expected `incomingAmount`, or it is completed manually via an API call. - - | -
| EXPIRED | -- -If the payment expires before it is completed then the state will move to EXPIRED and no further payments will be accepted. - - | -
| Value | -Description | - - -
|---|---|
| OKP | -- |
| Value | -Description | - - -
|---|---|
| AlreadyPosted | -- |
| AlreadyVoided | -- |
| AmountZero | -- |
| InsufficientBalance | -- |
| InvalidId | -- |
| TransferExists | -- |
| UnknownAsset | -- |
| UnknownIncomingPayment | -- |
| UnknownPayment | -- |
| UnknownPaymentPointer | -- |
| UnknownPeer | -- |
| UnknownTransfer | -- |
| Value | -Description | - - -
|---|---|
| FUNDING | -- -Will transition to SENDING once payment funds are reserved - - | -
| SENDING | -- -Paying, will transition to COMPLETED on success - - | -
| COMPLETED | -- -Successful completion - - | -
| FAILED | -- -Payment failed - - | -
| Value | -Description | - - -
|---|---|
| INACTIVE | -- -Status after deactivating - - | -
| ACTIVE | -- -Default status - - | -
| Value | -Description | - - -
|---|---|
| INCOMING | -- |
| OUTGOING | -- |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- | |
| paymentPointerId | -ID! | -- | |
| metadata | -JSONObject | -- | |
| createdAt | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| id | -ID! | -- | |
| createdAt | -String! | -- | |
| Field | -Argument | -Type | -Description | -
|---|---|---|---|
| code | -String! | -- | |
| success | -Boolean! | -- | |
| message | -String! | -- | |