Input objects
Arguments
Name | Description |
---|---|
keyString!
|
Key for the additional property. |
valueString!
|
Value for the additional property. |
visibleInOpenPaymentsBoolean!
|
Indicates whether the property is visible in Open Payments wallet address requests. |
Arguments
Name | Description |
---|---|
valueUInt64!
|
Numerical value. |
assetCodeString!
|
Should be an ISO 4217 currency code whenever possible, e.g. |
assetScaleUInt8!
|
Difference in order of magnitude between the standard unit of an asset and its corresponding fractional unit. |
Arguments
Name | Description |
---|---|
idID!
|
Unique identifier of the incoming payment to be approved. Note: incoming payment must be PENDING. |
Arguments
Name | Description |
---|---|
idID!
|
Unique identifier of the incoming payment to be canceled. Note: incoming payment must be PENDING. |
Arguments
Name | Description |
---|---|
idID!
|
Unique identifier of the outgoing payment to cancel. |
reasonString
|
Reason why this outgoing payment has been canceled. This value will be publicly visible in the metadata field if this outgoing payment is requested through Open Payments. |
Arguments
Name | Description |
---|---|
codeString!
|
Should be an ISO 4217 currency code whenever possible, e.g. |
scaleUInt8!
|
Difference in order of magnitude between the standard unit of an asset and its corresponding fractional unit. |
withdrawalThresholdUInt64
|
Minimum amount of liquidity that can be withdrawn from the asset. |
liquidityThresholdUInt64
|
A webhook event will notify the Account Servicing Entity if liquidity falls below this value. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
assetIdString!
|
Unique identifier of the asset to create the withdrawal for. |
amountUInt64!
|
Amount of liquidity to withdraw. |
idString!
|
Unique identifier of the withdrawal. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
timeoutSecondsUInt64!
|
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. |
Arguments
Name | Description |
---|---|
walletAddressIdString!
|
Unique identifier of the wallet address under which the incoming payment will be created. |
expiresAtString
|
Date and time that the incoming payment will expire. |
metadataJSONObject
|
Additional metadata associated with the incoming payment. |
incomingAmountAmountInput
|
Maximum amount to be received for this incoming payment. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
incomingPaymentIdString!
|
Unique identifier of the incoming payment to withdraw liquidity from. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
timeoutSecondsUInt64!
|
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. |
Arguments
Name | Description |
---|---|
maxPacketAmountUInt64
|
Maximum packet amount that the peer accepts. |
assetIdString!
|
Unique identifier of the asset associated with the peering relationship. |
peerUrlString!
|
Peer's URL address, where auto-peering requests are accepted. |
nameString
|
Internal name for the peer, used to override auto-peering default names. |
liquidityThresholdUInt64
|
A webhook event will notify the Account Servicing Entity if peer liquidity falls below this value. |
liquidityToDepositUInt64
|
Amount of liquidity to deposit for the peer. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
CreateOutgoingPaymentFromIncomingPaymentInput
Section titled “CreateOutgoingPaymentFromIncomingPaymentInput”Arguments
Name | Description |
---|---|
walletAddressIdString!
|
Unique identifier of the wallet address under which the outgoing payment will be created. |
incomingPaymentString!
|
Incoming payment URL to create the outgoing payment from. |
debitAmountAmountInput!
|
Amount to send (fixed send). |
metadataJSONObject
|
Additional metadata associated with the outgoing payment. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
walletAddressIdString!
|
Unique identifier of the wallet address under which the outgoing payment will be created. |
quoteIdString!
|
Unique identifier 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. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
outgoingPaymentIdString!
|
Unique identifier of the outgoing payment to withdraw liquidity from. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
timeoutSecondsUInt64!
|
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. |
Arguments
Name | Description |
---|---|
maxPacketAmountUInt64
|
Maximum packet amount that the peer accepts. |
httpHttpInput!
|
Peering connection details. |
assetIdString!
|
Unique identifier of the asset associated with the peering relationship. |
staticIlpAddressString!
|
ILP address of the peer. |
nameString
|
Internal name of the peer. |
liquidityThresholdUInt64
|
A webhook event will notify the Account Servicing Entity if peer liquidity falls below this value. |
initialLiquidityUInt64
|
Initial amount of liquidity to deposit for the peer. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
peerIdString!
|
Unique identifier of the peer to create the withdrawal for. |
amountUInt64!
|
Amount of liquidity to withdraw. |
idString!
|
Unique identifier of the withdrawal. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
timeoutSecondsUInt64!
|
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. |
Arguments
Name | Description |
---|---|
walletAddressIdString!
|
Unique identifier of the wallet address under which the quote will be created. |
debitAmountAmountInput
|
Amount to send (fixed send). |
receiveAmountAmountInput
|
Amount to receive (fixed receive). |
receiverString!
|
Wallet address URL of the receiver. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
walletAddressUrlString!
|
Receiving wallet address URL. |
expiresAtString
|
Date and time that the incoming payment expires for the receiver. |
incomingAmountAmountInput
|
Maximum amount to be received for this incoming payment. |
metadataJSONObject
|
Additional metadata associated with the incoming payment. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
assetIdString!
|
Unique identifier of the asset associated with the wallet address. This cannot be changed. |
urlString!
|
Wallet address URL. This cannot be changed. |
publicNameString
|
Public name associated with the wallet address. This is visible to anyone with the wallet address URL. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
additionalProperties[AdditionalPropertyInput!]
|
Additional properties associated with the wallet address. |
Arguments
Name | Description |
---|---|
walletAddressIdString!
|
Unique identifier of the wallet address to associate with the key. |
jwkJwkInput!
|
Public key in JSON Web Key (JWK) format. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
walletAddressIdString!
|
Unique identifier of the Open Payments wallet address to create the withdrawal for. |
idString!
|
Unique identifier of the withdrawal. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
timeoutSecondsUInt64!
|
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. |
Arguments
Name | Description |
---|---|
idID!
|
Unique identifier of the asset to delete. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
idID!
|
Unique identifier of the peer to be deleted. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
assetIdString!
|
Unique identifier of the asset to deposit liquidity into. |
amountUInt64!
|
Amount of liquidity to deposit. |
idString!
|
Unique identifier of the liquidity transfer. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
eventIdString!
|
Unique identifier of the event to deposit liquidity into. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
outgoingPaymentIdString!
|
Unique identifier of the outgoing payment to deposit liquidity into. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
peerIdString!
|
Unique identifier of the peer to deposit liquidity into. |
amountUInt64!
|
Amount of liquidity to deposit. |
idString!
|
Unique identifier of the liquidity transfer. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
fixedUInt64!
|
Amount of the flat, fixed fee to charge. |
basisPointsInt!
|
Basis points fee is a variable fee charged based on the total amount. Should be between 0 and 10000 (inclusive). 1 basis point = 0.01%, 100 basis points = 1%, 10000 basis points = 100%. |
Arguments
Name | Description |
---|---|
in[String!]!
|
Array of strings to filter by. |
Arguments
Name | Description |
---|---|
authTokens[String!]!
|
Array of authorization tokens accepted by this Rafiki instance. |
Arguments
Name | Description |
---|---|
incomingHttpIncomingInput
|
Incoming connection details. |
outgoingHttpOutgoingInput!
|
Outgoing connection details. |
Arguments
Name | Description |
---|---|
authTokenString!
|
Authorization token to present at the peer's Rafiki instance. |
endpointString!
|
Connection endpoint of the peer. |
Arguments
Name | Description |
---|---|
kidString!
|
Unique identifier for the key. |
xString!
|
Base64 url-encoded public key. |
algAlg!
|
Cryptographic algorithm used with the key. The only allowed value is |
ktyKty!
|
Key type. The only allowed value is |
crvCrv!
|
Cryptographic curve that the key pair is derived from. The only allowed value is |
Arguments
Name | Description |
---|---|
receiverFilterString
|
Filter for outgoing payments based on the receiver's details. |
walletAddressIdFilterString
|
Filter for outgoing payments based on the wallet address ID. |
stateFilterString
|
Filter for outgoing payments based on their state. |
Arguments
Name | Description |
---|---|
typeFilterString
|
Filter for payments based on their type. |
walletAddressIdFilterString
|
Filter for payments based on the wallet address ID. |
Arguments
Name | Description |
---|---|
withdrawalIdString!
|
Unique identifier of the liquidity withdrawal to post. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
idString!
|
Internal unique identifier of the key to revoke. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
assetIdID!
|
Unique identifier of the asset id to add the fees to. |
typeFeeType!
|
Type of fee, either sending or receiving. |
feeFeeDetails!
|
Fee values |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
limitInt!
|
Maximum number of events being triggered (n). |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
idString!
|
Unique identifier of the asset to update. |
withdrawalThresholdUInt64
|
New minimum amount of liquidity that can be withdrawn from the asset. |
liquidityThresholdUInt64
|
A webhook event will notify the Account Servicing Entity if liquidity falls below this new value. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
idID!
|
Unique identifier of the incoming payment to update. |
metadataJSONObject!
|
The new metadata object to save for the incoming payment. It will overwrite any existing metadata. |
Arguments
Name | Description |
---|---|
idString!
|
Unique identifier of the peer to update. |
maxPacketAmountUInt64
|
New maximum packet amount that the peer accepts. |
httpHttpInput
|
New peering connection details. |
staticIlpAddressString
|
New ILP address for the peer. |
nameString
|
New public name for the peer. |
liquidityThresholdUInt64
|
A webhook event will notify the Account Servicing Entity if peer liquidity falls below this new value. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
idID!
|
Unique identifier of the wallet address to update. This cannot be changed. |
publicNameString
|
New public name for the wallet address. This is visible to anyone with the wallet address URL. |
statusWalletAddressStatus
|
New status to set the wallet address to, either active or inactive. |
idempotencyKeyString
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
additionalProperties[AdditionalPropertyInput!]
|
Additional properties associated with this wallet address. |
Arguments
Name | Description |
---|---|
withdrawalIdString!
|
Unique identifier of the liquidity withdrawal to void. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |
Arguments
Name | Description |
---|---|
typeFilterString
|
Filter for webhook events based on their type. |
Arguments
Name | Description |
---|---|
eventIdString!
|
Unique identifier of the event to withdraw liquidity from. |
idempotencyKeyString!
|
Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency. |