Objects

AccountingTransfer

Implements

Model

Fields

Name	Description
id `ID!`	Unique identifier for the accounting transfer.
debitAccountId `ID!`	Unique identifier for the debit account.
creditAccountId `ID!`	Unique identifier for the credit account.
amount `UInt64!`	Amount sent (fixed send).
transferType `TransferType!`	Type of the accounting transfer.
ledger `UInt8!`	Identifier that partitions the sets of accounts that can transact with each other.
createdAt `String!`	The date and time that the accounting transfer was created.
state `TransferState!`	The state of the accounting transfer.
expiresAt `String`	The date and time that the accounting transfer will expire.

AccountingTransferConnection

Fields

Name	Description
debits `[AccountingTransfer!]!`
credits `[AccountingTransfer!]!`

AdditionalProperty

Fields

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.

Amount

Fields

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.

ApproveIncomingPaymentResponse

Fields

Name	Description
payment `IncomingPayment`	The incoming payment that was approved.

Asset

Implements

Model

Fields

Name Description

id
ID!

Unique identifier of the asset.

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.

liquidity
UInt64

Available liquidity

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.

receivingFee
Fee

The receiving fee structure for the asset.

sendingFee
Fee

The sending fee structure for the asset.

fees
FeesConnection

Fetches a paginated list of fees associated with this asset.

Arguments

Name	Description
after `String`	Forward pagination: Cursor (fee ID) to start retrieving fees after this point.
before `String`	Backward pagination: Cursor (fee ID) to start retrieving fees before this point.
first `Int`	Forward pagination: Limit the result to the first n fees after the `after` cursor.
last `Int`	Backward pagination: Limit the result to the last n fees before the `before` cursor.
sortOrder `SortOrder`	Specify the sort order of fees based on their creation data, either ascending or descending.

createdAt
String!

The date and time when the asset was created.

tenantId
ID!

AssetEdge

Fields

Name	Description
node `Asset!`	An asset node in the list.
cursor `String!`	A cursor for paginating through the assets.

AssetMutationResponse

Fields

Name	Description
asset `Asset`	The asset affected by the mutation.

AssetsConnection

Fields

Name	Description
pageInfo `PageInfo!`	Information to aid in pagination.
edges `[AssetEdge!]!`	A list of edges representing assets and cursors for pagination.

CancelIncomingPaymentResponse

Fields

Name	Description
payment `IncomingPayment`	The incoming payment that was canceled.

CreateOrUpdatePeerByUrlMutationResponse

Fields

Name	Description
peer `Peer`	The peer created or updated based on a URL.

CreatePeerMutationResponse

Fields

Name	Description
peer `Peer`	The peer created by the mutation.

CreateReceiverResponse

Fields

Name	Description
receiver `Receiver`	The receiver object returned in the response.

CreateTenantSettingsMutationResponse

Fields

Name	Description
settings `[TenantSetting!]!`	New tenant settings.

CreateWalletAddressKeyMutationResponse

Fields

Name	Description
walletAddressKey `WalletAddressKey`	The wallet address key that was created.

CreateWalletAddressMutationResponse

Fields

Name	Description
walletAddress `WalletAddress`	The newly created wallet address.

DeleteAssetMutationResponse

Fields

Name	Description
asset `Asset`	The asset that was deleted.

DeletePeerMutationResponse

Fields

Name	Description
success `Boolean!`	Indicates whether the peer deletion was successful.

DeleteTenantMutationResponse

Fields

Name	Description
success `Boolean!`

Fee

Implements

Model

Fields

Name	Description
id `ID!`	Unique identifier of the fee.
assetId `ID!`	Unique identifier of the asset associated with the fee.
type `FeeType!`	Type of fee, either sending or receiving.
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%.
createdAt `String!`	The date and time that this fee was created.

FeeEdge

Fields

Name	Description
node `Fee!`	A fee node in the list.
cursor `String!`	A cursor for paginating through the fees.

FeesConnection

Fields

Name	Description
pageInfo `PageInfo!`	Pagination information for fees.
edges `[FeeEdge!]!`	A list of fee edges, containing fee nodes and cursors for pagination.

Http

Fields

Name	Description
outgoing `HttpOutgoing!`	Details of the outgoing connection for peering.

HttpOutgoing

Fields

Name	Description
authToken `String!`	Authorization token to be presented to the peer's Rafiki instance.
endpoint `String!`	Connection endpoint of the peer.

IncomingPayment

Implements

Fields

Name	Description
id `ID!`	Unique identifier of the incoming payment.
walletAddressId `ID!`	Unique identifier of the wallet address under which the incoming payment was created.
client `String`	Information about the wallet address of the Open Payments client that created the incoming payment.
liquidity `UInt64`	Current amount of liquidity available for this incoming payment.
state `IncomingPaymentState!`	State of the incoming payment.
expiresAt `String!`	Date and time that the incoming payment will expire. 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 wallet address under this incoming payment.
receivedAmount `Amount!`	The total amount that has been paid into the wallet address under this incoming payment.
metadata `JSONObject`	Additional metadata associated with the incoming payment.
createdAt `String!`	The date and time that the incoming payment was created.
tenantId `String`	The tenant UUID associated with the incoming payment. If not provided, it will be obtained from the signature.

IncomingPaymentConnection

Fields

Name	Description
pageInfo `PageInfo!`	Pagination information for the incoming payments.
edges `[IncomingPaymentEdge!]!`	A list of incoming payment edges, containing incoming payment nodes and cursors for pagination.

IncomingPaymentEdge

Fields

Name	Description
node `IncomingPayment!`	An incoming payment node in the list.
cursor `String!`	A cursor for paginating through the incoming payments.

IncomingPaymentResponse

Fields

Name	Description
payment `IncomingPayment`	The incoming payment object returned in the response.

Jwk

Fields

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

LiquidityMutationResponse

Fields

Name	Description
success `Boolean!`	Indicates whether the liquidity operation was successful.

OutgoingPayment

Implements

Fields

Name	Description
id `ID!`	Unique identifier of the outgoing payment.
walletAddressId `ID!`	Unique identifier of the wallet address under which the outgoing payment was created.
client `String`	Information about the wallet address of the Open Payments client that created the outgoing payment.
liquidity `UInt64`	Current amount of liquidity available for this outgoing payment.
state `OutgoingPaymentState!`	State of the outgoing payment.
error `String`	Any error encountered during the payment process.
stateAttempts `Int!`	Number of attempts made to send an outgoing payment.
debitAmount `Amount!`	Amount to send (fixed send).
receiveAmount `Amount!`	Amount to receive (fixed receive).
receiver `String!`	Wallet address URL of the receiver.
metadata `JSONObject`	Additional metadata associated with the outgoing payment.
quote `Quote`	Corresponding quote for the outgoing payment.
sentAmount `Amount!`	Amount already sent.
createdAt `String!`	The date and time that the outgoing payment was created.
grantId `String`	Unique identifier of the grant under which the outgoing payment was created.
tenantId `String`	Tenant ID of the outgoing payment.

OutgoingPaymentConnection

Fields

Name	Description
pageInfo `PageInfo!`	Pagination information for the outgoing payments.
edges `[OutgoingPaymentEdge!]!`	A list of outgoing payment edges, containing outgoing payment nodes and cursors for pagination.

OutgoingPaymentEdge

Fields

Name	Description
node `OutgoingPayment!`	An outgoing payment node in the list.
cursor `String!`	A cursor for paginating through the outgoing payments.

OutgoingPaymentResponse

Fields

Name	Description
payment `OutgoingPayment`	The outgoing payment object returned in the response.

PageInfo

Fields

Name	Description
endCursor `String`	The cursor used to fetch the next page when paginating forwards.
hasNextPage `Boolean!`	Indicates if there are more pages when paginating forwards.
hasPreviousPage `Boolean!`	Indicates if there are more pages when paginating backwards.
startCursor `String`	The cursor used to fetch the next page when paginating backwards.

Payment

Implements

Fields

Name	Description
id `ID!`	Unique identifier of the payment.
type `PaymentType!`	Type of payment, either incoming or outgoing.
walletAddressId `ID!`	Unique identifier of the wallet address under which the payment was created.
client `String`	Information about the wallet address of the Open Payments client that created the payment.
state `String!`	State of the payment, either `IncomingPaymentState` or `OutgoingPaymentState` according to payment type
liquidity `UInt64`	Current amount of liquidity available for this payment.
metadata `JSONObject`	Additional metadata associated with the payment.
createdAt `String!`	The date and time that the payment was created.

PaymentConnection

Fields

Name	Description
pageInfo `PageInfo!`	Pagination information for the payments.
edges `[PaymentEdge!]!`	A list of payment edges, containing payment nodes and cursors for pagination.

PaymentEdge

Fields

Name	Description
node `Payment!`	A payment node in the list.
cursor `String!`	A cursor for paginating through the payments.

Peer

Implements

Model

Fields

Name	Description
id `ID!`	Unique identifier of the peer.
maxPacketAmount `UInt64`	Maximum packet amount that the peer accepts.
http `Http!`	Peering connection details.
asset `Asset!`	Asset of peering relationship.
staticIlpAddress `String!`	ILP address of the peer.
name `String`	Public name for the peer.
liquidityThreshold `UInt64`	A webhook event will notify the Account Servicing Entity if liquidity falls below this value.
liquidity `UInt64`	Current amount of peer liquidity available.
createdAt `String!`	The date and time when the peer was created.
tenantId `ID!`	Unique identifier of the tenant associated with the peer.

PeerEdge

Fields

Name	Description
node `Peer!`	A peer node in the list.
cursor `String!`	A cursor for paginating through the peers.

PeersConnection

Fields

Name	Description
pageInfo `PageInfo!`	Information to aid in pagination.
edges `[PeerEdge!]!`	A list of edges representing peers and cursors for pagination.

Quote

Fields

Name	Description
id `ID!`	Unique identifier of the quote.
tenantId `ID!`	Unique identifier of the tenant under which the quote was created.
walletAddressId `ID!`	Unique identifier of the wallet address under which the quote was created.
receiver `String!`	Wallet address URL of the receiver.
debitAmount `Amount!`	Amount to send (fixed send).
receiveAmount `Amount!`	Amount to receive (fixed receive).
createdAt `String!`	The date and time that the quote was created.
expiresAt `String!`	The date and time that the quote will expire.
estimatedExchangeRate `Float`	Estimated exchange rate for this quote.

QuoteConnection

Fields

Name	Description
pageInfo `PageInfo!`	Pagination information for quotes.
edges `[QuoteEdge!]!`	A list of quote edges, containing quote nodes and cursors for pagination.

QuoteEdge

Fields

Name	Description
node `Quote!`	A quote node in the list.
cursor `String!`	A cursor for paginating through the quotes.

QuoteResponse

Fields

Name	Description
quote `Quote`	The quote object returned in the response.

Receiver

Fields

Name	Description
id `String!`	Unique identifier of the receiver (incoming payment URL).
walletAddressUrl `String!`	Wallet address URL under which the incoming payment was created.
completed `Boolean!`	Indicates whether the incoming payment has completed receiving funds.
incomingAmount `Amount`	The maximum amount that should be paid into the wallet address under this incoming payment.
receivedAmount `Amount!`	The total amount that has been paid into the wallet address under this incoming payment.
expiresAt `String`	Date and time that the incoming payment will expire. After this time, the incoming payment will not accept further payments made to it.
metadata `JSONObject`	Additional metadata associated with the incoming payment.
createdAt `String!`	The date and time that the incoming payment was created.
updatedAt `String!`	The date and time that the incoming payment was last updated.

RevokeWalletAddressKeyMutationResponse

Fields

Name	Description
walletAddressKey `WalletAddressKey`	The wallet address key that was revoked.

SetFeeResponse

Fields

Name	Description
fee `Fee`	The fee that was set.

Tenant

Implements

Model

Fields

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.
createdAt `String!`	The date and time that this tenant was created.
deletedAt `String`	The date and time that this tenant was deleted.
settings `[TenantSetting!]!`	List of settings for the tenant.

TenantEdge

Fields

Name	Description
node `Tenant!`	A tenant node in the list.
cursor `String!`	A cursor for paginating through the tenants.

TenantMutationResponse

Fields

Name	Description
tenant `Tenant!`

TenantsConnection

Fields

Name	Description
pageInfo `PageInfo!`	Information to aid in pagination.
edges `[TenantEdge!]!`	A list of edges representing tenants and cursors for pagination.

TenantSetting

Fields

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

TriggerWalletAddressEventsMutationResponse

Fields

Name	Description
count `Int`	The number of events that were triggered.

UpdatePeerMutationResponse

Fields

Name	Description
peer `Peer`	The peer that was updated.

UpdateWalletAddressMutationResponse

Fields

Name	Description
walletAddress `WalletAddress`	The updated wallet address.

WalletAddress

Implements

Model

Fields

Name Description

id
ID!

Unique identifier of the wallet address.

asset
Asset!

Asset of the wallet address.

liquidity
UInt64

Current amount of liquidity available for this wallet address.

address
String!

Wallet Address.

publicName
String

Public name associated with the wallet address. This is visible to anyone with the wallet address URL.

incomingPayments
IncomingPaymentConnection

List of incoming payments received by this wallet address

Arguments

Name	Description
after `String`	Forward pagination: Cursor (incoming payment ID) to start retrieving incoming payments after this point.
before `String`	Backward pagination: Cursor (incoming payment ID) to start retrieving incoming payments before this point.
first `Int`	Forward pagination: Limit the result to the first n incoming payments after the `after` cursor.
last `Int`	Backward pagination: Limit the result to the last n incoming payments before the `before` cursor.
sortOrder `SortOrder`	Specify the sort order of incoming payments based on their creation date, either ascending or descending.

quotes
QuoteConnection

List of quotes created at this wallet address

Arguments

Name	Description
after `String`	Forward pagination: Cursor (quote ID) to start retrieving quotes after this point.
before `String`	Backward pagination: Cursor (quote ID) to start retrieving quotes before this point.
first `Int`	Forward pagination: Limit the result to the first n quotes after the `after` cursor.
last `Int`	Backward pagination: Limit the result to the last n quotes before the `before` cursor.
sortOrder `SortOrder`	Specify the sort order of quotes based on their creation data, either ascending or descending.

outgoingPayments
OutgoingPaymentConnection

List of outgoing payments sent from this wallet address

Arguments

Name	Description
after `String`	Forward pagination: Cursor (outgoing payment ID) to start retrieving outgoing payments after this point.
before `String`	Backward pagination: Cursor (outgoing payment ID) to start retrieving outgoing payments before this point.
first `Int`	Forward pagination: Limit the result to the first n outgoing payments after the `after` cursor.
last `Int`	Backward pagination: Limit the result to the last n outgoing payments before the `before` cursor.
sortOrder `SortOrder`	Specify the sort order of outgoing payments based on their creation date, either ascending or descending.

createdAt
String!

The date and time when the wallet address was created.

status
WalletAddressStatus!

The current status of the wallet, either active or inactive.

walletAddressKeys
WalletAddressKeyConnection

List of keys associated with this wallet address

Arguments

Name	Description
after `String`	Forward pagination: Cursor (wallet address key ID) to start retrieving keys after this point.
before `String`	Backward pagination: Cursor (wallet address key ID) to start retrieving keys before this point.
first `Int`	Forward pagination: Limit the result to the first n keys after the `after` cursor.
last `Int`	Backward pagination: Limit the result to the last n keys before the `before` cursor.
sortOrder `SortOrder`	Specify the sort order of keys based on their creation data, either ascending or descending.

additionalProperties
[AdditionalProperty]

Additional properties associated with the wallet address.

tenantId
String

Tenant ID of the wallet address.

WalletAddressEdge

Fields

Name	Description
node `WalletAddress!`	A wallet address node in the list.
cursor `String!`	A cursor for paginating through the wallet addresses.

WalletAddressesConnection

Fields

Name	Description
pageInfo `PageInfo!`	Pagination information for the wallet addresses.
edges `[WalletAddressEdge!]!`	A list of wallet address edges, containing wallet address nodes and cursors for pagination.

WalletAddressKey

Implements

Model

Fields

Name	Description
id `ID!`	Unique internal identifier for the wallet address key.
walletAddressId `ID!`	Unique identifier of the wallet address to associate with the key.
jwk `Jwk!`	The public key object in JSON Web Key (JWK) format.
revoked `Boolean!`	Indicator of whether the key has been revoked.
createdAt `String!`	The date and time that this wallet address key was created.

WalletAddressKeyConnection

Fields

Name	Description
pageInfo `PageInfo!`	Pagination information for wallet address keys.
edges `[WalletAddressKeyEdge!]!`	A list of wallet address key edges, containing wallet address key nodes and cursors for pagination.

WalletAddressKeyEdge

Fields

Name	Description
node `WalletAddressKey!`	A wallet address key node in the list.
cursor `String!`	A cursor for paginating through the wallet address keys.

WalletAddressWithdrawal

Fields

Name	Description
id `ID!`	Unique identifier for the withdrawal.
amount `UInt64!`	Amount to be withdrawn.
walletAddress `WalletAddress!`	Details about the wallet address from which the withdrawal is made.

WalletAddressWithdrawalMutationResponse

Fields

Name	Description
withdrawal `WalletAddressWithdrawal`	The wallet address withdrawal that was processed.

WebhookEvent

Implements

Model

Fields

Name	Description
id `ID!`	Unique identifier of the webhook event.
tenantId `ID!`	Tenant of the webhook event.
type `String!`	Type of webhook event.
data `JSONObject!`	Stringified JSON data for the webhook event.
createdAt `String!`	The date and time when the webhook event was created.

WebhookEventsConnection

Fields

Name	Description
pageInfo `PageInfo!`	Pagination information for webhook events.
edges `[WebhookEventsEdge!]!`	A list of webhook event edges, containing event nodes and cursors for pagination.

WebhookEventsEdge

Fields

Name	Description
node `WebhookEvent!`	A webhook event node in the list.
cursor `String!`	A cursor for paginating through the webhook events.

WhoamiResponse

Fields

Name	Description
id `String!`
isOperator `Boolean!`