Input objects

AmountInput

Arguments

Name	Description
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

CancelOutgoingPaymentInput

Arguments

Name	Description
id ID!	Outgoing payment id
reason String	Reason why this Outgoing Payment has been cancelled. This value will be publicly visible in the metadata field if this outgoing payment is requested through Open Payments.

CreateAssetInput

Arguments

Name	Description
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
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

CreateAssetLiquidityWithdrawalInput

Arguments

Name	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
timeoutSeconds UInt64!	This is the interval in seconds after a pending transfer's created at which it may be posted or voided. Zero denotes a no timeout single-phase posted transfer.

CreateIncomingPaymentInput

Arguments

Name	Description
walletAddressId String!	Id of the wallet address 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

CreateIncomingPaymentWithdrawalInput

Arguments

Name	Description
incomingPaymentId String!	The id of the incoming payment to withdraw from.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. See idempotence
timeoutSeconds UInt64!	This is the interval in seconds after a pending transfer's created at which it may be posted or voided. Zero denotes a no timeout single-phase posted transfer.

CreateOrUpdatePeerByUrlInput

Arguments

Name	Description
maxPacketAmount UInt64	Maximum packet amount that the peer accepts
assetId String!	Asset id of peering relationship
peerUrl String!	Peer's URL address at which the peer accepts auto-peering requests
name String	Peer's internal name for overriding auto-peer's default naming
liquidityThreshold UInt64	Account Servicing Entity will be notified via a webhook event if peer liquidity falls below this value
liquidityToDeposit UInt64	Amount of liquidity to deposit for peer
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

CreateOutgoingPaymentFromIncomingPaymentInput

Arguments

Name	Description
walletAddressId String!	Id of the wallet address under which the outgoing payment will be created
incomingPayment String!	Incoming payment url to create the outgoing payment from
debitAmount AmountInput!	Amount to send (fixed send)
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

CreateOutgoingPaymentInput

Arguments

Name	Description
walletAddressId String!	Id of the wallet address 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

CreateOutgoingPaymentWithdrawalInput

Arguments

Name	Description
outgoingPaymentId String!	The id of the outgoing payment to withdraw from.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. See idempotence
timeoutSeconds UInt64!	This is the interval in seconds after a pending transfer's created at which it may be posted or voided. Zero denotes a no timeout single-phase posted transfer.

CreatePeerInput

Arguments

Name	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
initialLiquidity UInt64	Initial amount of liquidity to deposit for peer
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

CreatePeerLiquidityWithdrawalInput

Arguments

Name	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
timeoutSeconds UInt64!	This is the interval in seconds after a pending transfer's created at which it may be posted or voided. Zero denotes a no timeout single-phase posted transfer.

CreateQuoteInput

Arguments

Name	Description
walletAddressId String!	Id of the wallet address under which the quote will be created
debitAmount AmountInput	Amount to send (fixed send)
receiveAmount AmountInput	Amount to receive (fixed receive)
receiver String!	Wallet address URL of the receiver
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

CreateReceiverInput

Arguments

Name	Description
walletAddressUrl String!	Receiving wallet address 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

CreateWalletAddressInput

Arguments

Name	Description
assetId String!	Asset of the wallet address
url String!	Wallet Address URL
publicName String	Public name associated with the wallet address
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

CreateWalletAddressKeyInput

Arguments

Name	Description
walletAddressId String!
jwk JwkInput!	Public key
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

CreateWalletAddressWithdrawalInput

Arguments

Name	Description
walletAddressId String!	The id of the Open Payments wallet address 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
timeoutSeconds UInt64!	This is the interval in seconds after a pending transfer's created at which it may be posted or voided. Zero denotes a no timeout single-phase posted transfer.

DeletePeerInput

Arguments

Name	Description
id ID!
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

DepositAssetLiquidityInput

Arguments

Name	Description
assetId String!	The id of the asset to deposit liquidity.
amount UInt64!	Amount of liquidity to deposit.
id String!	The id of the transfer.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

DepositEventLiquidityInput

Arguments

Name	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

DepositOutgoingPaymentLiquidityInput

Arguments

Name	Description
outgoingPaymentId String!	The id of the outgoing payment to deposit into.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

DepositPeerLiquidityInput

Arguments

Name	Description
peerId String!	The id of the peer to deposit liquidity.
amount UInt64!	Amount of liquidity to deposit.
id String!	The id of the transfer.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

FeeDetails

Arguments

Name	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%

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
incoming HttpIncomingInput	Incoming connection details
outgoing HttpOutgoingInput!	Outgoing connection details

HttpOutgoingInput

Arguments

Name	Description
authToken String!	Auth token to present at the peering Rafiki instance
endpoint String!	Peer's connection endpoint

JwkInput

Arguments

Name	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.

PaymentFilter

Arguments

Name	Description
type FilterString
walletAddressId FilterString

PostLiquidityWithdrawalInput

Arguments

Name	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

RevokeWalletAddressKeyInput

Arguments

Name	Description
id String!	Internal id of key
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

SetFeeInput

Arguments

Name	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

TriggerWalletAddressEventsInput

Arguments

Name	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

UpdateAssetInput

Arguments

Name	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

UpdatePeerInput

Arguments

Name	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

UpdateWalletAddressInput

Arguments

Name	Description
id ID!	ID of wallet address to update
publicName String	New public name for wallet address
status WalletAddressStatus	New status to set the wallet address to
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. See idempotence

VoidLiquidityWithdrawalInput

Arguments

Name	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

WebhookEventFilter

Arguments

Name	Description
type FilterString

WithdrawEventLiquidityInput

Arguments

Name	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