Queries

accountingTransfers

Type: AccountingTransferConnection!

Fetch a paginated list of accounting transfers for a given account.

Arguments

Name	Description
id String!	Unique identifier of the account.
limit Int	Limit the number of results returned. If no limit is provided, the default limit is 20.

asset

Type: Asset

Fetch an asset by its ID.

Arguments

Name	Description
id String!	Unique identifier of the asset.

assetByCodeAndScale

Type: Asset

Get an asset based on its currency code and scale if it exists.

Arguments

Name	Description
code String!	ISO 4217 currency code.
scale UInt8!	Difference in order of magnitude between the standard unit of an asset and its corresponding fractional unit.

assets

Type: AssetsConnection!

Fetch a paginated list of assets.

Arguments

Name	Description
after String	Forward pagination: Cursor (asset ID) to start retrieving assets after this point.
before String	Backward pagination: Cursor (asset ID) to start retrieving assets before this point.
first Int	Forward pagination: Limit the result to the first n assets after the after cursor.
last Int	Backward pagination: Limit the result to the last n assets before the before cursor.
sortOrder SortOrder	Specify the sort order of assets based on their creation data, either ascending or descending.
tenantId String	Unique identifier of the tenant associated with the wallet address. Optional, if not provided, the tenantId will be obtained from the signature.

incomingPayment

Type: IncomingPayment

Fetch an Open Payments incoming payment by its ID.

Arguments

Name	Description
id String!	Unique identifier of the incoming payment.

outgoingPayment

Type: OutgoingPayment

Fetch an Open Payments outgoing payment by its ID.

Arguments

Name	Description
id String!	Unique identifier of the outgoing payment.

outgoingPayments

Type: OutgoingPaymentConnection!

Fetch a paginated list of outgoing payments by receiver.

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.
filter OutgoingPaymentFilter	Filter outgoing payments based on specific criteria such as receiver, wallet address ID, or state.
tenantId String	Unique identifier of the tenant associated with the wallet address. Optional, if not provided, the tenantId will be obtained from the signature.

payments

Type: PaymentConnection!

Fetch a paginated list of combined payments, including incoming and outgoing payments.

Arguments

Name	Description
after String	Forward pagination: Cursor (payment ID) to start retrieving payments after this point.
before String	Backward pagination: Cursor (payment ID) to start retrieving payments before this point.
first Int	Forward pagination: Limit the result to the first n payments after the after cursor.
last Int	Backward pagination: Limit the result to the last n payments before the before cursor.
sortOrder SortOrder	Specify the sort order of payments based on their creation date, either ascending or descending.
filter PaymentFilter	Filter payment events based on specific criteria such as payment type or wallet address ID.
tenantId String	Unique identifier of the tenant associated with the wallet address. Optional, if not provided, the tenantId will be obtained from the signature.

peer

Type: Peer

Fetch a peer by its ID.

Arguments

Name	Description
id String!	Unique identifier of the peer.

peerByAddressAndAsset

Type: Peer

Get a peer based on its ILP address and asset ID if it exists.

Arguments

Name	Description
staticIlpAddress String!	ILP address of the peer.
assetId String!	Asset ID of peering relationship.

peers

Type: PeersConnection!

Fetch a paginated list of peers.

Arguments

Name	Description
after String	Forward pagination: Cursor (peer ID) to start retrieving peers after this point.
before String	Backward pagination: Cursor (peer ID) to start retrieving peers before this point.
first Int	Forward pagination: Limit the result to the first n peers after the after cursor.
last Int	Backward pagination: Limit the result to the last n peers before the before cursor.
sortOrder SortOrder	Specify the sort order of peers based on their creation date, either ascending or descending.
tenantId ID	Unique identifier of the tenant associated with the peer.

quote

Type: Quote

Fetch an Open Payments quote by its ID.

Arguments

Name	Description
id String!	Unique identifier of the quote.

receiver

Type: Receiver

Retrieve an Open Payments incoming payment by receiver ID. The receiver’s wallet address can be hosted on this server or a remote Open Payments resource server.

Arguments

Name	Description
id String!	Unique identifier of the receiver (incoming payment URL).

tenant

Type: Tenant!

Retrieve a tenant of the instance.

Arguments

Name	Description
id String!	Unique identifier of the tenant.

tenants

Type: TenantsConnection!

As an operator, fetch a paginated list of tenants on the instance.

Arguments

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

walletAddress

Type: WalletAddress

Fetch a wallet address by its ID.

Arguments

Name	Description
id String!	Unique identifier of the wallet address.

walletAddressByUrl

Type: WalletAddress

Get a wallet address by its url if it exists

Arguments

Name	Description
url String!	Wallet Address URL.

walletAddresses

Type: WalletAddressesConnection!

Fetch a paginated list of wallet addresses.

Arguments

Name	Description
after String	Forward pagination: Cursor (wallet address ID) to start retrieving wallet addresses after this point.
before String	Backward pagination: Cursor (wallet address ID) to start retrieving wallet addresses before this point.
first Int	Forward pagination: Limit the result to the first n wallet addresses after the after cursor.
last Int	Backward pagination: Limit the result to the last n wallet addresses before the before cursor.
sortOrder SortOrder	Specify the sort order of wallet addresses based on their creation date, either ascending or descending.
tenantId String	Unique identifier of the tenant associated with the wallet address. Optional, if not provided, the tenantId will be obtained from the signature.

webhookEvents

Type: WebhookEventsConnection!

Fetch a paginated list of webhook events.

Arguments

Name	Description
after String	Forward pagination: Cursor (webhook event ID) to start retrieving webhook events after this point.
before String	Backward pagination: Cursor (webhook event ID) to start retrieving webhook events before this point.
first Int	Forward pagination: Limit the result to the first n webhook events after the after cursor.
last Int	Backward pagination: Limit the result to the last n webhook events before the before cursor.
sortOrder SortOrder	Specify the sort order of webhook events based on their creation date, either ascending or descending.
filter WebhookEventFilter	Filter webhook events based on specific criteria.
tenantId String	Unique identifier of the tenant associated with the wallet address. Optional, if not provided, the tenantId will be obtained from the signature.

whoami

Type: WhoamiResponse!

Determine if the requester has operator permissions