Input objects

AdditionalPropertyInput

Arguments

Name	Description
key String!	Key for the additional property.
value String!	Value for the additional property.
visibleInOpenPayments Boolean!	Indicates whether the property is visible in Open Payments wallet address requests.

AmountInput

Arguments

Name	Description
value UInt64!	Numerical value.
assetCode String!	Should be an ISO 4217 currency code whenever possible, e.g. USD. For more information, refer to assets.
assetScale UInt8!	Difference in order of magnitude between the standard unit of an asset and its corresponding fractional unit.

ApproveIncomingPaymentInput

Arguments

Name	Description
id ID!	Unique identifier of the incoming payment to be approved. Note: incoming payment must be PENDING.

CancelIncomingPaymentInput

Arguments

Name	Description
id ID!	Unique identifier of the incoming payment to be canceled. Note: incoming payment must be PENDING.

CancelOutgoingPaymentInput

Arguments

Name	Description
id ID!	Unique identifier of the outgoing payment to cancel.
reason String	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.

CreateAssetInput

Arguments

Name	Description
code String!	Should be an ISO 4217 currency code whenever possible, e.g. USD. For more information, refer to assets.
scale UInt8!	Difference in order of magnitude between the standard unit of an asset and its corresponding fractional unit.
withdrawalThreshold UInt64	Minimum amount of liquidity that can be withdrawn from the asset.
liquidityThreshold UInt64	A webhook event will notify the Account Servicing Entity if liquidity falls below this value.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.
tenantId ID	Unique identifier of the tenant associated with the asset. This cannot be changed. Optional, if not provided, the tenantId will be obtained from the signature.

CreateAssetLiquidityWithdrawalInput

Arguments

Name	Description
assetId String!	Unique identifier of the asset to create the withdrawal for.
amount UInt64!	Amount of liquidity to withdraw.
id String!	Unique identifier of the withdrawal.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.
timeoutSeconds UInt64!	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!	Unique identifier of the wallet address under which the incoming payment will be created.
expiresAt String	Date and time that the incoming payment will expire.
metadata JSONObject	Additional metadata associated with the incoming payment.
incomingAmount AmountInput	Maximum amount to be received for this incoming payment.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

CreateIncomingPaymentWithdrawalInput

Arguments

Name	Description
incomingPaymentId String!	Unique identifier of the incoming payment to withdraw liquidity from.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.
timeoutSeconds UInt64!	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!	Unique identifier of the asset associated with the peering relationship.
peerUrl String!	Peer's URL address, where auto-peering requests are accepted.
name String	Internal name for the peer, used to override auto-peering default names.
liquidityThreshold UInt64	A webhook event will notify the Account Servicing Entity if peer liquidity falls below this value.
liquidityToDeposit UInt64	Amount of liquidity to deposit for the peer.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

CreateOutgoingPaymentFromIncomingPaymentInput

Arguments

Name	Description
walletAddressId String!	Unique identifier 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. For more information, refer to idempotency.

CreateOutgoingPaymentInput

Arguments

Name	Description
walletAddressId String!	Unique identifier of the wallet address under which the outgoing payment will be created.
quoteId String!	Unique identifier 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. For more information, refer to idempotency.

CreateOutgoingPaymentWithdrawalInput

Arguments

Name	Description
outgoingPaymentId String!	Unique identifier of the outgoing payment to withdraw liquidity from.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.
timeoutSeconds UInt64!	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!	Unique identifier of the asset associated with the peering relationship.
staticIlpAddress String!	ILP address of the peer.
name String	Internal name of the peer.
liquidityThreshold UInt64	A webhook event will notify the Account Servicing Entity if peer liquidity falls below this value.
initialLiquidity UInt64	Initial amount of liquidity to deposit for the peer.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

CreatePeerLiquidityWithdrawalInput

Arguments

Name	Description
peerId String!	Unique identifier of the peer to create the withdrawal for.
amount UInt64!	Amount of liquidity to withdraw.
id String!	Unique identifier of the withdrawal.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.
timeoutSeconds UInt64!	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!	Unique identifier 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. For more information, refer to idempotency.

CreateReceiverInput

Arguments

Name	Description
walletAddressUrl String!	Receiving wallet address URL.
expiresAt String	Date and time that the incoming payment expires for the receiver.
incomingAmount AmountInput	Maximum amount to be received for this incoming payment.
metadata JSONObject	Additional metadata associated with the incoming payment.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

CreateTenantInput

Arguments

Name	Description
id ID	Unique identifier of the tenant. Must be compliant with uuid v4. Will be generated automatically if not provided.
email String	Contact email of the tenant owner.
apiSecret String!	Secret used to secure requests made for this tenant.
idpConsentUrl String	URL of the tenant's identity provider's consent screen.
idpSecret String	Secret used to secure requests from the tenant's identity provider.
publicName String	Public name for the tenant.
settings [TenantSettingInput!]	Initial settings for tenant.

CreateTenantSettingsInput

Arguments

Name	Description
settings [TenantSettingInput!]!	List of a settings for a tenant.

CreateWalletAddressInput

Arguments

Name	Description
tenantId ID	Unique identifier of the tenant associated with the wallet address. This cannot be changed. Optional, if not provided, the tenantId will be obtained from the signature.
assetId String!	Unique identifier of the asset associated with the wallet address. This cannot be changed.
address String!	Wallet address. This cannot be changed.
publicName String	Public name associated with the wallet address. This is visible to anyone with the wallet address URL.
idempotencyKey String	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.

CreateWalletAddressKeyInput

Arguments

Name	Description
walletAddressId String!	Unique identifier of the wallet address to associate with the key.
jwk JwkInput!	Public key in JSON Web Key (JWK) format.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

CreateWalletAddressWithdrawalInput

Arguments

Name	Description
walletAddressId String!	Unique identifier of the Open Payments wallet address to create the withdrawal for.
id String!	Unique identifier of the withdrawal.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.
timeoutSeconds UInt64!	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.

DeleteAssetInput

Arguments

Name	Description
id ID!	Unique identifier of the asset to delete.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

DeletePeerInput

Arguments

Name	Description
id ID!	Unique identifier of the peer to be deleted.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

DepositAssetLiquidityInput

Arguments

Name	Description
assetId String!	Unique identifier of the asset to deposit liquidity into.
amount UInt64!	Amount of liquidity to deposit.
id String!	Unique identifier of the liquidity transfer.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

DepositEventLiquidityInput

Arguments

Name	Description
eventId String!	Unique identifier of the event to deposit liquidity into.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

DepositOutgoingPaymentLiquidityInput

Arguments

Name	Description
outgoingPaymentId String!	Unique identifier of the outgoing payment to deposit liquidity into.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

DepositPeerLiquidityInput

Arguments

Name	Description
peerId String!	Unique identifier of the peer to deposit liquidity into.
amount UInt64!	Amount of liquidity to deposit.
id String!	Unique identifier of the liquidity transfer.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

FeeDetails

Arguments

Name	Description
fixed UInt64!	Amount of the flat, fixed fee to charge.
basisPoints Int!	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%.

FilterString

Arguments

Name	Description
in [String!]!	Array of strings to filter by.

HttpIncomingInput

Arguments

Name	Description
authTokens [String!]!	Array of authorization 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!	Authorization token to present at the peer's Rafiki instance.
endpoint String!	Connection endpoint of the peer.

JwkInput

Arguments

Name	Description
kid String!	Unique identifier for the key.
x String!	Base64 url-encoded public key.
alg Alg!	Cryptographic algorithm used with the key. The only allowed value is EdDSA.
kty Kty!	Key type. The only allowed value is OKP.
crv Crv!	Cryptographic curve that the key pair is derived from. The only allowed value is Ed25519.

OutgoingPaymentFilter

Arguments

Name	Description
receiver FilterString	Filter for outgoing payments based on the receiver's details.
walletAddressId FilterString	Filter for outgoing payments based on the wallet address ID.
state FilterString	Filter for outgoing payments based on their state.

PaymentFilter

Arguments

Name	Description
type FilterString	Filter for payments based on their type.
walletAddressId FilterString	Filter for payments based on the wallet address ID.

PostLiquidityWithdrawalInput

Arguments

Name	Description
withdrawalId String!	Unique identifier of the liquidity withdrawal to post.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

RevokeWalletAddressKeyInput

Arguments

Name	Description
id String!	Internal unique identifier of the key to revoke.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

SetFeeInput

Arguments

Name	Description
assetId ID!	Unique identifier of the asset id to add the fees to.
type FeeType!	Type of fee, either sending or receiving.
fee FeeDetails!	Fee values
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

TenantSettingInput

Arguments

Name	Description
key String!	Key for this setting.
value String!	Value of a setting for this key.

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. For more information, refer to idempotency.

UpdateAssetInput

Arguments

Name	Description
id String!	Unique identifier of the asset to update.
withdrawalThreshold UInt64	New minimum amount of liquidity that can be withdrawn from the asset.
liquidityThreshold UInt64	A webhook event will notify the Account Servicing Entity if liquidity falls below this new value.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

UpdateIncomingPaymentInput

Arguments

Name	Description
id ID!	Unique identifier of the incoming payment to update.
metadata JSONObject!	The new metadata object to save for the incoming payment. It will overwrite any existing metadata.

UpdatePeerInput

Arguments

Name	Description
id String!	Unique identifier of the peer to update.
maxPacketAmount UInt64	New maximum packet amount that the peer accepts.
http HttpInput	New peering connection details.
staticIlpAddress String	New ILP address for the peer.
name String	New public name for the peer.
liquidityThreshold UInt64	A webhook event will notify the Account Servicing Entity if peer liquidity falls below this new value.
idempotencyKey String	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

UpdateTenantInput

Arguments

Name	Description
id ID!	Unique identifier of the tenant.
email String	Contact email of the tenant owner.
apiSecret String	Secret used to secure requests made for this tenant.
idpConsentUrl String	URL of the tenant's identity provider's consent screen.
idpSecret String	Secret used to secure requests from the tenant's identity provider.
publicName String	Public name for the tenant.

UpdateWalletAddressInput

Arguments

Name	Description
id ID!	Unique identifier of the wallet address to update. This cannot be changed.
publicName String	New public name for the wallet address. This is visible to anyone with the wallet address URL.
status WalletAddressStatus	New status to set the wallet address to, either active or inactive.
idempotencyKey String	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.

VoidLiquidityWithdrawalInput

Arguments

Name	Description
withdrawalId String!	Unique identifier of the liquidity withdrawal to void.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.

WebhookEventFilter

Arguments

Name	Description
type FilterString	Filter for webhook events based on their type.

WithdrawEventLiquidityInput

Arguments

Name	Description
eventId String!	Unique identifier of the event to withdraw liquidity from.
idempotencyKey String!	Unique key to ensure duplicate or retried requests are processed only once. For more information, refer to idempotency.