Input objects
AddAssetLiquidityInput
Arguments
Name | Description |
---|---|
assetIdString!
|
The id of the asset to add liquidity. |
amountUInt64!
|
Amount of liquidity to add. |
idString!
|
The id of the transfer. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
AddPeerLiquidityInput
Arguments
Name | Description |
---|---|
peerIdString!
|
The id of the peer to add liquidity. |
amountUInt64!
|
Amount of liquidity to add. |
idString!
|
The id of the transfer. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
AmountInput
Arguments
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 |
CreateAssetInput
Arguments
Name | Description |
---|---|
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 |
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 |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreateAssetLiquidityWithdrawalInput
Arguments
Name | Description |
---|---|
assetIdString!
|
The id of the asset to create the withdrawal for. |
amountUInt64!
|
Amount of withdrawal. |
idString!
|
The id of the withdrawal. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreateIncomingPaymentInput
Arguments
Name | Description |
---|---|
paymentPointerIdString!
|
Id of the payment pointer under which the incoming payment will be created |
expiresAtString
|
Expiration date-time |
metadataJSONObject
|
Additional metadata associated with the incoming payment. |
incomingAmountAmountInput
|
Maximum amount to be received |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreateOrUpdatePeerByUrlInput
Arguments
Name | Description |
---|---|
maxPacketAmountUInt64
|
Maximum packet amount that the peer accepts |
assetIdString!
|
Asset id of peering relationship |
peerUrlString!
|
Peer's URL address at which the peer accepts auto-peering requests |
nameString
|
Peer's internal name for overriding auto-peer's default naming |
liquidityThresholdUInt64
|
Account Servicing Entity will be notified via a webhook event if peer liquidity falls below this value |
addedLiquidityUInt64
|
Initial amount of liquidity to add for peer |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreateOutgoingPaymentInput
Arguments
Name | Description |
---|---|
paymentPointerIdString!
|
Id of the payment pointer under which the outgoing payment will be created |
quoteIdString!
|
Id of the corresponding quote for that outgoing payment |
metadataJSONObject
|
Additional metadata associated with the outgoing payment. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreatePaymentPointerInput
Arguments
Name | Description |
---|---|
assetIdString!
|
Asset of the payment pointer |
urlString!
|
Payment Pointer URL |
publicNameString
|
Public name associated with the payment pointer |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreatePaymentPointerKeyInput
Arguments
Name | Description |
---|---|
paymentPointerIdString!
|
|
jwkJwkInput!
|
Public key |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreatePaymentPointerWithdrawalInput
Arguments
Name | Description |
---|---|
paymentPointerIdString!
|
The id of the Open Payments payment pointer to create the withdrawal for. |
idString!
|
The id of the withdrawal. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreatePeerInput
Arguments
Name | Description |
---|---|
maxPacketAmountUInt64
|
Maximum packet amount that the peer accepts |
httpHttpInput!
|
Peering connection details |
assetIdString!
|
Asset id of peering relationship |
staticIlpAddressString!
|
Peer's ILP address |
nameString
|
Peer's internal name |
liquidityThresholdUInt64
|
Account Servicing Entity will be notified via a webhook event if peer liquidity falls below this value |
initialLiquidityUInt64
|
Initial amount of liquidity to add for peer |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreatePeerLiquidityWithdrawalInput
Arguments
Name | Description |
---|---|
peerIdString!
|
The id of the peer to create the withdrawal for. |
amountUInt64!
|
Amount of withdrawal. |
idString!
|
The id of the withdrawal. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreateQuoteInput
Arguments
Name | Description |
---|---|
paymentPointerIdString!
|
Id of the payment pointer under which the quote will be created |
debitAmountAmountInput
|
Amount to send (fixed send) |
receiveAmountAmountInput
|
Amount to receive (fixed receive) |
receiverString!
|
Payment pointer URL of the receiver |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
CreateReceiverInput
Arguments
Name | Description |
---|---|
paymentPointerUrlString!
|
Receiving payment pointer URL |
expiresAtString
|
Expiration date-time |
incomingAmountAmountInput
|
Maximum amount to be received |
metadataJSONObject
|
Additional metadata associated with the incoming payment. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
DeletePeerInput
Arguments
Name | Description |
---|---|
idID!
|
|
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
DepositEventLiquidityInput
Arguments
Name | Description |
---|---|
eventIdString!
|
The id of the event to deposit into. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
FeeDetails
Arguments
Name | Description |
---|---|
fixedUInt64!
|
A flat fee |
basisPointsInt!
|
Basis points fee. Should be between 0 and 10000 (inclusive). 1 basis point = 0.01%, 100 basis points = 1%, 10000 basis points = 100% |
FilterString
Arguments
Name | Description |
---|---|
in[String!]!
|
HttpIncomingInput
Arguments
Name | Description |
---|---|
authTokens[String!]!
|
Array of auth tokens accepted by this Rafiki instance |
HttpInput
Arguments
Name | Description |
---|---|
incomingHttpIncomingInput
|
Incoming connection details |
outgoingHttpOutgoingInput!
|
Outgoing connection details |
HttpOutgoingInput
Arguments
Name | Description |
---|---|
authTokenString!
|
Auth token to present at the peering Rafiki instance |
endpointString!
|
Peer's connection endpoint |
JwkInput
Arguments
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 |
PaymentFilter
Arguments
Name | Description |
---|---|
typeFilterString
|
|
paymentPointerIdFilterString
|
PostLiquidityWithdrawalInput
Arguments
Name | Description |
---|---|
withdrawalIdString!
|
The id of the liquidity withdrawal to post. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
RevokePaymentPointerKeyInput
Arguments
Name | Description |
---|---|
idString!
|
Internal id of key |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
SetFeeInput
Arguments
Name | Description |
---|---|
assetIdID!
|
Asset id to add the fee to |
typeFeeType!
|
Type of fee (sending or receiving) |
feeFeeDetails!
|
Fee values |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
TriggerPaymentPointerEventsInput
Arguments
Name | Description |
---|---|
limitInt!
|
Maximum number of events being triggered (n). |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
UpdateAssetInput
Arguments
Name | Description |
---|---|
idString!
|
Asset id |
withdrawalThresholdUInt64
|
New 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 new value |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
UpdatePaymentPointerInput
Arguments
Name | Description |
---|---|
idID!
|
ID of payment pointer to update |
publicNameString
|
New public name for payment pointer |
statusPaymentPointerStatus
|
New status to set the payment pointer to |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
UpdatePeerInput
Arguments
Name | Description |
---|---|
idString!
|
Peer id |
maxPacketAmountUInt64
|
New maximum packet amount that the peer accepts |
httpHttpInput
|
New peering connection details |
staticIlpAddressString
|
Peer's new ILP address |
nameString
|
Peer's new public name |
liquidityThresholdUInt64
|
Account Servicing Entity will be notified via a webhook event if peer liquidity falls below this new value |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
VoidLiquidityWithdrawalInput
Arguments
Name | Description |
---|---|
withdrawalIdString!
|
The id of the liquidity withdrawal to void. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |
WebhookEventFilter
Arguments
Name | Description |
---|---|
typeFilterString
|
WithdrawEventLiquidityInput
Arguments
Name | Description |
---|---|
eventIdString!
|
The id of the event to withdraw from. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. See idempotence |