Backend Admin API

The Backend Admin API provides you with comprehensive capabilities to manage your Rafiki instance. Core functionality includes managing peering relationships, assets, wallet addresses and their public keys, as well as liquidity management through deposits and withdrawals. Another important aspect of the Backend Admin API is to manage Open Payments resources like payments and quotes.

API Endpoints
# Staging:
https://staging.example.com/graphql

Queries

accountingTransfers

Description

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

Response

Returns an AccountingTransferConnection!

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.

Example

Query
query AccountingTransfers(
  $id: String!,
  $limit: Int
) {
  accountingTransfers(
    id: $id,
    limit: $limit
  ) {
    debits {
      id
      debitAccountId
      creditAccountId
      amount
      transferType
      ledger
      createdAt
      state
      expiresAt
    }
    credits {
      id
      debitAccountId
      creditAccountId
      amount
      transferType
      ledger
      createdAt
      state
      expiresAt
    }
  }
}
Variables
{"id": "xyz789", "limit": 987}
Response
{
  "data": {
    "accountingTransfers": {
      "debits": [AccountingTransfer],
      "credits": [AccountingTransfer]
    }
  }
}
Queries

asset

Description

Fetch an asset by its ID.

Response

Returns an Asset

Arguments
Name Description
id - String! Unique identifier of the asset.

Example

Query
query Asset($id: String!) {
  asset(id: $id) {
    id
    code
    scale
    liquidity
    withdrawalThreshold
    liquidityThreshold
    receivingFee {
      id
      assetId
      type
      fixed
      basisPoints
      createdAt
    }
    sendingFee {
      id
      assetId
      type
      fixed
      basisPoints
      createdAt
    }
    fees {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...FeeEdgeFragment
      }
    }
    createdAt
    tenantId
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "asset": {
      "id": "4",
      "code": "xyz789",
      "scale": UInt8,
      "liquidity": UInt64,
      "withdrawalThreshold": UInt64,
      "liquidityThreshold": UInt64,
      "receivingFee": Fee,
      "sendingFee": Fee,
      "fees": FeesConnection,
      "createdAt": "abc123",
      "tenantId": 4
    }
  }
}
Queries

assetByCodeAndScale

Description

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

Response

Returns an Asset

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.

Example

Query
query AssetByCodeAndScale(
  $code: String!,
  $scale: UInt8!
) {
  assetByCodeAndScale(
    code: $code,
    scale: $scale
  ) {
    id
    code
    scale
    liquidity
    withdrawalThreshold
    liquidityThreshold
    receivingFee {
      id
      assetId
      type
      fixed
      basisPoints
      createdAt
    }
    sendingFee {
      id
      assetId
      type
      fixed
      basisPoints
      createdAt
    }
    fees {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...FeeEdgeFragment
      }
    }
    createdAt
    tenantId
  }
}
Variables
{
  "code": "abc123",
  "scale": UInt8
}
Response
{
  "data": {
    "assetByCodeAndScale": {
      "id": 4,
      "code": "xyz789",
      "scale": UInt8,
      "liquidity": UInt64,
      "withdrawalThreshold": UInt64,
      "liquidityThreshold": UInt64,
      "receivingFee": Fee,
      "sendingFee": Fee,
      "fees": FeesConnection,
      "createdAt": "abc123",
      "tenantId": 4
    }
  }
}
Queries

assets

Description

Fetch a paginated list of assets.

Response

Returns an AssetsConnection!

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.

Example

Query
query Assets(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $sortOrder: SortOrder,
  $tenantId: String
) {
  assets(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    sortOrder: $sortOrder,
    tenantId: $tenantId
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    edges {
      node {
        ...AssetFragment
      }
      cursor
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987,
  "sortOrder": "ASC",
  "tenantId": "xyz789"
}
Response
{
  "data": {
    "assets": {
      "pageInfo": PageInfo,
      "edges": [AssetEdge]
    }
  }
}
Queries

incomingPayment

Description

Fetch an Open Payments incoming payment by its ID.

Response

Returns an IncomingPayment

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

Example

Query
query IncomingPayment($id: String!) {
  incomingPayment(id: $id) {
    id
    walletAddressId
    client
    liquidity
    state
    expiresAt
    incomingAmount {
      value
      assetCode
      assetScale
    }
    receivedAmount {
      value
      assetCode
      assetScale
    }
    metadata
    createdAt
    tenantId
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "incomingPayment": {
      "id": 4,
      "walletAddressId": 4,
      "client": "xyz789",
      "liquidity": UInt64,
      "state": "PENDING",
      "expiresAt": "abc123",
      "incomingAmount": Amount,
      "receivedAmount": Amount,
      "metadata": {},
      "createdAt": "xyz789",
      "tenantId": "abc123"
    }
  }
}
Queries

outgoingPayment

Description

Fetch an Open Payments outgoing payment by its ID.

Response

Returns an OutgoingPayment

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

Example

Query
query OutgoingPayment($id: String!) {
  outgoingPayment(id: $id) {
    id
    walletAddressId
    client
    liquidity
    state
    error
    stateAttempts
    debitAmount {
      value
      assetCode
      assetScale
    }
    receiveAmount {
      value
      assetCode
      assetScale
    }
    receiver
    metadata
    quote {
      id
      tenantId
      walletAddressId
      receiver
      debitAmount {
        ...AmountFragment
      }
      receiveAmount {
        ...AmountFragment
      }
      createdAt
      expiresAt
      estimatedExchangeRate
    }
    sentAmount {
      value
      assetCode
      assetScale
    }
    createdAt
    grantId
    tenantId
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "outgoingPayment": {
      "id": 4,
      "walletAddressId": "4",
      "client": "abc123",
      "liquidity": UInt64,
      "state": "FUNDING",
      "error": "xyz789",
      "stateAttempts": 123,
      "debitAmount": Amount,
      "receiveAmount": Amount,
      "receiver": "abc123",
      "metadata": {},
      "quote": Quote,
      "sentAmount": Amount,
      "createdAt": "abc123",
      "grantId": "abc123",
      "tenantId": "xyz789"
    }
  }
}
Queries

outgoingPayments

Description

Fetch a paginated list of outgoing payments by receiver.

Response

Returns an OutgoingPaymentConnection!

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.

Example

Query
query OutgoingPayments(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $sortOrder: SortOrder,
  $filter: OutgoingPaymentFilter,
  $tenantId: String
) {
  outgoingPayments(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    sortOrder: $sortOrder,
    filter: $filter,
    tenantId: $tenantId
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    edges {
      node {
        ...OutgoingPaymentFragment
      }
      cursor
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123,
  "sortOrder": "ASC",
  "filter": OutgoingPaymentFilter,
  "tenantId": "abc123"
}
Response
{
  "data": {
    "outgoingPayments": {
      "pageInfo": PageInfo,
      "edges": [OutgoingPaymentEdge]
    }
  }
}
Queries

payments

Description

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

Response

Returns a PaymentConnection!

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.

Example

Query
query Payments(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $sortOrder: SortOrder,
  $filter: PaymentFilter,
  $tenantId: String
) {
  payments(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    sortOrder: $sortOrder,
    filter: $filter,
    tenantId: $tenantId
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    edges {
      node {
        ...PaymentFragment
      }
      cursor
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123,
  "sortOrder": "ASC",
  "filter": PaymentFilter,
  "tenantId": "abc123"
}
Response
{
  "data": {
    "payments": {
      "pageInfo": PageInfo,
      "edges": [PaymentEdge]
    }
  }
}
Queries

peer

Description

Fetch a peer by its ID.

Response

Returns a Peer

Arguments
Name Description
id - String! Unique identifier of the peer.

Example

Query
query Peer($id: String!) {
  peer(id: $id) {
    id
    maxPacketAmount
    http {
      outgoing {
        ...HttpOutgoingFragment
      }
    }
    asset {
      id
      code
      scale
      liquidity
      withdrawalThreshold
      liquidityThreshold
      receivingFee {
        ...FeeFragment
      }
      sendingFee {
        ...FeeFragment
      }
      fees {
        ...FeesConnectionFragment
      }
      createdAt
      tenantId
    }
    staticIlpAddress
    name
    liquidityThreshold
    liquidity
    createdAt
    tenantId
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "peer": {
      "id": "4",
      "maxPacketAmount": UInt64,
      "http": Http,
      "asset": Asset,
      "staticIlpAddress": "abc123",
      "name": "xyz789",
      "liquidityThreshold": UInt64,
      "liquidity": UInt64,
      "createdAt": "abc123",
      "tenantId": 4
    }
  }
}
Queries

peerByAddressAndAsset

Description

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

Response

Returns a Peer

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

Example

Query
query PeerByAddressAndAsset(
  $staticIlpAddress: String!,
  $assetId: String!
) {
  peerByAddressAndAsset(
    staticIlpAddress: $staticIlpAddress,
    assetId: $assetId
  ) {
    id
    maxPacketAmount
    http {
      outgoing {
        ...HttpOutgoingFragment
      }
    }
    asset {
      id
      code
      scale
      liquidity
      withdrawalThreshold
      liquidityThreshold
      receivingFee {
        ...FeeFragment
      }
      sendingFee {
        ...FeeFragment
      }
      fees {
        ...FeesConnectionFragment
      }
      createdAt
      tenantId
    }
    staticIlpAddress
    name
    liquidityThreshold
    liquidity
    createdAt
    tenantId
  }
}
Variables
{
  "staticIlpAddress": "abc123",
  "assetId": "abc123"
}
Response
{
  "data": {
    "peerByAddressAndAsset": {
      "id": "4",
      "maxPacketAmount": UInt64,
      "http": Http,
      "asset": Asset,
      "staticIlpAddress": "xyz789",
      "name": "abc123",
      "liquidityThreshold": UInt64,
      "liquidity": UInt64,
      "createdAt": "xyz789",
      "tenantId": 4
    }
  }
}
Queries

peers

Description

Fetch a paginated list of peers.

Response

Returns a PeersConnection!

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.

Example

Query
query Peers(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $sortOrder: SortOrder,
  $tenantId: ID
) {
  peers(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    sortOrder: $sortOrder,
    tenantId: $tenantId
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    edges {
      node {
        ...PeerFragment
      }
      cursor
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123,
  "sortOrder": "ASC",
  "tenantId": "4"
}
Response
{
  "data": {
    "peers": {
      "pageInfo": PageInfo,
      "edges": [PeerEdge]
    }
  }
}
Queries

quote

Description

Fetch an Open Payments quote by its ID.

Response

Returns a Quote

Arguments
Name Description
id - String! Unique identifier of the quote.

Example

Query
query Quote($id: String!) {
  quote(id: $id) {
    id
    tenantId
    walletAddressId
    receiver
    debitAmount {
      value
      assetCode
      assetScale
    }
    receiveAmount {
      value
      assetCode
      assetScale
    }
    createdAt
    expiresAt
    estimatedExchangeRate
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "quote": {
      "id": 4,
      "tenantId": 4,
      "walletAddressId": 4,
      "receiver": "xyz789",
      "debitAmount": Amount,
      "receiveAmount": Amount,
      "createdAt": "abc123",
      "expiresAt": "xyz789",
      "estimatedExchangeRate": 123.45
    }
  }
}
Queries

receiver

Description

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.

Response

Returns a Receiver

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

Example

Query
query Receiver($id: String!) {
  receiver(id: $id) {
    id
    walletAddressUrl
    completed
    incomingAmount {
      value
      assetCode
      assetScale
    }
    receivedAmount {
      value
      assetCode
      assetScale
    }
    expiresAt
    metadata
    createdAt
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "receiver": {
      "id": "xyz789",
      "walletAddressUrl": "abc123",
      "completed": false,
      "incomingAmount": Amount,
      "receivedAmount": Amount,
      "expiresAt": "xyz789",
      "metadata": {},
      "createdAt": "xyz789"
    }
  }
}
Queries

tenant

Description

Retrieve a tenant of the instance.

Response

Returns a Tenant!

Arguments
Name Description
id - String! Unique identifier of the tenant.

Example

Query
query Tenant($id: String!) {
  tenant(id: $id) {
    id
    email
    apiSecret
    idpConsentUrl
    idpSecret
    publicName
    createdAt
    deletedAt
    settings {
      key
      value
    }
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "tenant": {
      "id": 4,
      "email": "abc123",
      "apiSecret": "abc123",
      "idpConsentUrl": "abc123",
      "idpSecret": "abc123",
      "publicName": "abc123",
      "createdAt": "xyz789",
      "deletedAt": "abc123",
      "settings": [TenantSetting]
    }
  }
}
Queries

tenants

Description

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

Response

Returns a TenantsConnection!

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.

Example

Query
query Tenants(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $sortOrder: SortOrder
) {
  tenants(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    sortOrder: $sortOrder
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    edges {
      node {
        ...TenantFragment
      }
      cursor
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 123,
  "sortOrder": "ASC"
}
Response
{
  "data": {
    "tenants": {
      "pageInfo": PageInfo,
      "edges": [TenantEdge]
    }
  }
}
Queries

walletAddress

Description

Fetch a wallet address by its ID.

Response

Returns a WalletAddress

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

Example

Query
query WalletAddress($id: String!) {
  walletAddress(id: $id) {
    id
    asset {
      id
      code
      scale
      liquidity
      withdrawalThreshold
      liquidityThreshold
      receivingFee {
        ...FeeFragment
      }
      sendingFee {
        ...FeeFragment
      }
      fees {
        ...FeesConnectionFragment
      }
      createdAt
      tenantId
    }
    liquidity
    address
    publicName
    incomingPayments {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...IncomingPaymentEdgeFragment
      }
    }
    quotes {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...QuoteEdgeFragment
      }
    }
    outgoingPayments {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...OutgoingPaymentEdgeFragment
      }
    }
    createdAt
    status
    walletAddressKeys {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...WalletAddressKeyEdgeFragment
      }
    }
    additionalProperties {
      key
      value
      visibleInOpenPayments
    }
    tenantId
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "walletAddress": {
      "id": "4",
      "asset": Asset,
      "liquidity": UInt64,
      "address": "abc123",
      "publicName": "abc123",
      "incomingPayments": IncomingPaymentConnection,
      "quotes": QuoteConnection,
      "outgoingPayments": OutgoingPaymentConnection,
      "createdAt": "xyz789",
      "status": "INACTIVE",
      "walletAddressKeys": WalletAddressKeyConnection,
      "additionalProperties": [AdditionalProperty],
      "tenantId": "xyz789"
    }
  }
}
Queries

walletAddressByUrl

Description

Get a wallet address by its url if it exists

Response

Returns a WalletAddress

Arguments
Name Description
url - String! Wallet Address URL.

Example

Query
query WalletAddressByUrl($url: String!) {
  walletAddressByUrl(url: $url) {
    id
    asset {
      id
      code
      scale
      liquidity
      withdrawalThreshold
      liquidityThreshold
      receivingFee {
        ...FeeFragment
      }
      sendingFee {
        ...FeeFragment
      }
      fees {
        ...FeesConnectionFragment
      }
      createdAt
      tenantId
    }
    liquidity
    address
    publicName
    incomingPayments {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...IncomingPaymentEdgeFragment
      }
    }
    quotes {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...QuoteEdgeFragment
      }
    }
    outgoingPayments {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...OutgoingPaymentEdgeFragment
      }
    }
    createdAt
    status
    walletAddressKeys {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...WalletAddressKeyEdgeFragment
      }
    }
    additionalProperties {
      key
      value
      visibleInOpenPayments
    }
    tenantId
  }
}
Variables
{"url": "abc123"}
Response
{
  "data": {
    "walletAddressByUrl": {
      "id": "4",
      "asset": Asset,
      "liquidity": UInt64,
      "address": "xyz789",
      "publicName": "abc123",
      "incomingPayments": IncomingPaymentConnection,
      "quotes": QuoteConnection,
      "outgoingPayments": OutgoingPaymentConnection,
      "createdAt": "abc123",
      "status": "INACTIVE",
      "walletAddressKeys": WalletAddressKeyConnection,
      "additionalProperties": [AdditionalProperty],
      "tenantId": "xyz789"
    }
  }
}
Queries

walletAddresses

Description

Fetch a paginated list of wallet addresses.

Response

Returns a WalletAddressesConnection!

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.

Example

Query
query WalletAddresses(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $sortOrder: SortOrder,
  $tenantId: String
) {
  walletAddresses(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    sortOrder: $sortOrder,
    tenantId: $tenantId
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    edges {
      node {
        ...WalletAddressFragment
      }
      cursor
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 123,
  "sortOrder": "ASC",
  "tenantId": "xyz789"
}
Response
{
  "data": {
    "walletAddresses": {
      "pageInfo": PageInfo,
      "edges": [WalletAddressEdge]
    }
  }
}
Queries

webhookEvents

Description

Fetch a paginated list of webhook events.

Response

Returns a WebhookEventsConnection!

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.

Example

Query
query WebhookEvents(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $sortOrder: SortOrder,
  $filter: WebhookEventFilter,
  $tenantId: String
) {
  webhookEvents(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    sortOrder: $sortOrder,
    filter: $filter,
    tenantId: $tenantId
  ) {
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    edges {
      node {
        ...WebhookEventFragment
      }
      cursor
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987,
  "sortOrder": "ASC",
  "filter": WebhookEventFilter,
  "tenantId": "abc123"
}
Response
{
  "data": {
    "webhookEvents": {
      "pageInfo": PageInfo,
      "edges": [WebhookEventsEdge]
    }
  }
}
Queries

whoami

Description

Determine if the requester has operator permissions

Response

Returns a WhoamiResponse!

Example

Query
query Whoami {
  whoami {
    id
    isOperator
  }
}
Response
{
  "data": {
    "whoami": {
      "id": "abc123",
      "isOperator": true
    }
  }
}

Mutations

approveIncomingPayment

Description

Approves the incoming payment if the incoming payment is in the PENDING state

Response

Returns an ApproveIncomingPaymentResponse!

Arguments
Name Description
input - ApproveIncomingPaymentInput!

Example

Query
mutation ApproveIncomingPayment($input: ApproveIncomingPaymentInput!) {
  approveIncomingPayment(input: $input) {
    payment {
      id
      walletAddressId
      client
      liquidity
      state
      expiresAt
      incomingAmount {
        ...AmountFragment
      }
      receivedAmount {
        ...AmountFragment
      }
      metadata
      createdAt
      tenantId
    }
  }
}
Variables
{"input": ApproveIncomingPaymentInput}
Response
{
  "data": {
    "approveIncomingPayment": {"payment": IncomingPayment}
  }
}
Mutations

cancelIncomingPayment

Description

Cancel the incoming payment if the incoming payment is in the PENDING state

Response

Returns a CancelIncomingPaymentResponse!

Arguments
Name Description
input - CancelIncomingPaymentInput!

Example

Query
mutation CancelIncomingPayment($input: CancelIncomingPaymentInput!) {
  cancelIncomingPayment(input: $input) {
    payment {
      id
      walletAddressId
      client
      liquidity
      state
      expiresAt
      incomingAmount {
        ...AmountFragment
      }
      receivedAmount {
        ...AmountFragment
      }
      metadata
      createdAt
      tenantId
    }
  }
}
Variables
{"input": CancelIncomingPaymentInput}
Response
{
  "data": {
    "cancelIncomingPayment": {"payment": IncomingPayment}
  }
}
Mutations

cancelOutgoingPayment

Description

Cancel an outgoing payment.

Response

Returns an OutgoingPaymentResponse!

Arguments
Name Description
input - CancelOutgoingPaymentInput!

Example

Query
mutation CancelOutgoingPayment($input: CancelOutgoingPaymentInput!) {
  cancelOutgoingPayment(input: $input) {
    payment {
      id
      walletAddressId
      client
      liquidity
      state
      error
      stateAttempts
      debitAmount {
        ...AmountFragment
      }
      receiveAmount {
        ...AmountFragment
      }
      receiver
      metadata
      quote {
        ...QuoteFragment
      }
      sentAmount {
        ...AmountFragment
      }
      createdAt
      grantId
      tenantId
    }
  }
}
Variables
{"input": CancelOutgoingPaymentInput}
Response
{
  "data": {
    "cancelOutgoingPayment": {"payment": OutgoingPayment}
  }
}
Mutations

createAsset

Description

Create a new asset.

Response

Returns an AssetMutationResponse!

Arguments
Name Description
input - CreateAssetInput!

Example

Query
mutation CreateAsset($input: CreateAssetInput!) {
  createAsset(input: $input) {
    asset {
      id
      code
      scale
      liquidity
      withdrawalThreshold
      liquidityThreshold
      receivingFee {
        ...FeeFragment
      }
      sendingFee {
        ...FeeFragment
      }
      fees {
        ...FeesConnectionFragment
      }
      createdAt
      tenantId
    }
  }
}
Variables
{"input": CreateAssetInput}
Response
{"data": {"createAsset": {"asset": Asset}}}
Mutations

createAssetLiquidityWithdrawal

Description

Withdraw asset liquidity.

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - CreateAssetLiquidityWithdrawalInput!

Example

Query
mutation CreateAssetLiquidityWithdrawal($input: CreateAssetLiquidityWithdrawalInput!) {
  createAssetLiquidityWithdrawal(input: $input) {
    success
  }
}
Variables
{"input": CreateAssetLiquidityWithdrawalInput}
Response
{"data": {"createAssetLiquidityWithdrawal": {"success": false}}}
Mutations

createIncomingPayment

Description

Create an internal Open Payments incoming payment. The receiver has a wallet address on this Rafiki instance.

Response

Returns an IncomingPaymentResponse!

Arguments
Name Description
input - CreateIncomingPaymentInput!

Example

Query
mutation CreateIncomingPayment($input: CreateIncomingPaymentInput!) {
  createIncomingPayment(input: $input) {
    payment {
      id
      walletAddressId
      client
      liquidity
      state
      expiresAt
      incomingAmount {
        ...AmountFragment
      }
      receivedAmount {
        ...AmountFragment
      }
      metadata
      createdAt
      tenantId
    }
  }
}
Variables
{"input": CreateIncomingPaymentInput}
Response
{
  "data": {
    "createIncomingPayment": {"payment": IncomingPayment}
  }
}
Mutations

createIncomingPaymentWithdrawal

Description

Withdraw incoming payment liquidity.

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - CreateIncomingPaymentWithdrawalInput!

Example

Query
mutation CreateIncomingPaymentWithdrawal($input: CreateIncomingPaymentWithdrawalInput!) {
  createIncomingPaymentWithdrawal(input: $input) {
    success
  }
}
Variables
{"input": CreateIncomingPaymentWithdrawalInput}
Response
{"data": {"createIncomingPaymentWithdrawal": {"success": true}}}
Mutations

createOrUpdatePeerByUrl

Description

Create or update a peer using a URL.

Response

Returns a CreateOrUpdatePeerByUrlMutationResponse!

Arguments
Name Description
input - CreateOrUpdatePeerByUrlInput!

Example

Query
mutation CreateOrUpdatePeerByUrl($input: CreateOrUpdatePeerByUrlInput!) {
  createOrUpdatePeerByUrl(input: $input) {
    peer {
      id
      maxPacketAmount
      http {
        ...HttpFragment
      }
      asset {
        ...AssetFragment
      }
      staticIlpAddress
      name
      liquidityThreshold
      liquidity
      createdAt
      tenantId
    }
  }
}
Variables
{"input": CreateOrUpdatePeerByUrlInput}
Response
{"data": {"createOrUpdatePeerByUrl": {"peer": Peer}}}
Mutations

createOutgoingPayment

Description

Create an Open Payments outgoing payment.

Response

Returns an OutgoingPaymentResponse!

Arguments
Name Description
input - CreateOutgoingPaymentInput!

Example

Query
mutation CreateOutgoingPayment($input: CreateOutgoingPaymentInput!) {
  createOutgoingPayment(input: $input) {
    payment {
      id
      walletAddressId
      client
      liquidity
      state
      error
      stateAttempts
      debitAmount {
        ...AmountFragment
      }
      receiveAmount {
        ...AmountFragment
      }
      receiver
      metadata
      quote {
        ...QuoteFragment
      }
      sentAmount {
        ...AmountFragment
      }
      createdAt
      grantId
      tenantId
    }
  }
}
Variables
{"input": CreateOutgoingPaymentInput}
Response
{
  "data": {
    "createOutgoingPayment": {"payment": OutgoingPayment}
  }
}
Mutations

createOutgoingPaymentFromIncomingPayment

Description

Create an Open Payments outgoing payment from an incoming payment.

Response

Returns an OutgoingPaymentResponse!

Arguments
Name Description
input - CreateOutgoingPaymentFromIncomingPaymentInput!

Example

Query
mutation CreateOutgoingPaymentFromIncomingPayment($input: CreateOutgoingPaymentFromIncomingPaymentInput!) {
  createOutgoingPaymentFromIncomingPayment(input: $input) {
    payment {
      id
      walletAddressId
      client
      liquidity
      state
      error
      stateAttempts
      debitAmount {
        ...AmountFragment
      }
      receiveAmount {
        ...AmountFragment
      }
      receiver
      metadata
      quote {
        ...QuoteFragment
      }
      sentAmount {
        ...AmountFragment
      }
      createdAt
      grantId
      tenantId
    }
  }
}
Variables
{"input": CreateOutgoingPaymentFromIncomingPaymentInput}
Response
{
  "data": {
    "createOutgoingPaymentFromIncomingPayment": {
      "payment": OutgoingPayment
    }
  }
}
Mutations

createOutgoingPaymentWithdrawal

Description

Withdraw outgoing payment liquidity.

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - CreateOutgoingPaymentWithdrawalInput!

Example

Query
mutation CreateOutgoingPaymentWithdrawal($input: CreateOutgoingPaymentWithdrawalInput!) {
  createOutgoingPaymentWithdrawal(input: $input) {
    success
  }
}
Variables
{"input": CreateOutgoingPaymentWithdrawalInput}
Response
{"data": {"createOutgoingPaymentWithdrawal": {"success": false}}}
Mutations

createPeer

Description

Create a new peer.

Response

Returns a CreatePeerMutationResponse!

Arguments
Name Description
input - CreatePeerInput!

Example

Query
mutation CreatePeer($input: CreatePeerInput!) {
  createPeer(input: $input) {
    peer {
      id
      maxPacketAmount
      http {
        ...HttpFragment
      }
      asset {
        ...AssetFragment
      }
      staticIlpAddress
      name
      liquidityThreshold
      liquidity
      createdAt
      tenantId
    }
  }
}
Variables
{"input": CreatePeerInput}
Response
{"data": {"createPeer": {"peer": Peer}}}
Mutations

createPeerLiquidityWithdrawal

Description

Withdraw peer liquidity.

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - CreatePeerLiquidityWithdrawalInput!

Example

Query
mutation CreatePeerLiquidityWithdrawal($input: CreatePeerLiquidityWithdrawalInput!) {
  createPeerLiquidityWithdrawal(input: $input) {
    success
  }
}
Variables
{"input": CreatePeerLiquidityWithdrawalInput}
Response
{"data": {"createPeerLiquidityWithdrawal": {"success": false}}}
Mutations

createQuote

Description

Create an Open Payments quote.

Response

Returns a QuoteResponse!

Arguments
Name Description
input - CreateQuoteInput!

Example

Query
mutation CreateQuote($input: CreateQuoteInput!) {
  createQuote(input: $input) {
    quote {
      id
      tenantId
      walletAddressId
      receiver
      debitAmount {
        ...AmountFragment
      }
      receiveAmount {
        ...AmountFragment
      }
      createdAt
      expiresAt
      estimatedExchangeRate
    }
  }
}
Variables
{"input": CreateQuoteInput}
Response
{"data": {"createQuote": {"quote": Quote}}}
Mutations

createReceiver

Description

Create an internal or external Open Payments incoming payment. The receiver has a wallet address on either this or another Open Payments resource server.

Response

Returns a CreateReceiverResponse!

Arguments
Name Description
input - CreateReceiverInput!

Example

Query
mutation CreateReceiver($input: CreateReceiverInput!) {
  createReceiver(input: $input) {
    receiver {
      id
      walletAddressUrl
      completed
      incomingAmount {
        ...AmountFragment
      }
      receivedAmount {
        ...AmountFragment
      }
      expiresAt
      metadata
      createdAt
    }
  }
}
Variables
{"input": CreateReceiverInput}
Response
{"data": {"createReceiver": {"receiver": Receiver}}}
Mutations

createTenant

Description

As an operator, create a tenant.

Response

Returns a TenantMutationResponse!

Arguments
Name Description
input - CreateTenantInput!

Example

Query
mutation CreateTenant($input: CreateTenantInput!) {
  createTenant(input: $input) {
    tenant {
      id
      email
      apiSecret
      idpConsentUrl
      idpSecret
      publicName
      createdAt
      deletedAt
      settings {
        ...TenantSettingFragment
      }
    }
  }
}
Variables
{"input": CreateTenantInput}
Response
{"data": {"createTenant": {"tenant": Tenant}}}
Mutations

createTenantSettings

Response

Returns a CreateTenantSettingsMutationResponse

Arguments
Name Description
input - CreateTenantSettingsInput!

Example

Query
mutation CreateTenantSettings($input: CreateTenantSettingsInput!) {
  createTenantSettings(input: $input) {
    settings {
      key
      value
    }
  }
}
Variables
{"input": CreateTenantSettingsInput}
Response
{
  "data": {
    "createTenantSettings": {"settings": [TenantSetting]}
  }
}
Mutations

createWalletAddress

Description

Create a new wallet address.

Response

Returns a CreateWalletAddressMutationResponse!

Arguments
Name Description
input - CreateWalletAddressInput!

Example

Query
mutation CreateWalletAddress($input: CreateWalletAddressInput!) {
  createWalletAddress(input: $input) {
    walletAddress {
      id
      asset {
        ...AssetFragment
      }
      liquidity
      address
      publicName
      incomingPayments {
        ...IncomingPaymentConnectionFragment
      }
      quotes {
        ...QuoteConnectionFragment
      }
      outgoingPayments {
        ...OutgoingPaymentConnectionFragment
      }
      createdAt
      status
      walletAddressKeys {
        ...WalletAddressKeyConnectionFragment
      }
      additionalProperties {
        ...AdditionalPropertyFragment
      }
      tenantId
    }
  }
}
Variables
{"input": CreateWalletAddressInput}
Response
{
  "data": {
    "createWalletAddress": {
      "walletAddress": WalletAddress
    }
  }
}
Mutations

createWalletAddressKey

Description

Add a public key to a wallet address that is used to verify Open Payments requests.

Response

Returns a CreateWalletAddressKeyMutationResponse

Arguments
Name Description
input - CreateWalletAddressKeyInput!

Example

Query
mutation CreateWalletAddressKey($input: CreateWalletAddressKeyInput!) {
  createWalletAddressKey(input: $input) {
    walletAddressKey {
      id
      walletAddressId
      jwk {
        ...JwkFragment
      }
      revoked
      createdAt
    }
  }
}
Variables
{"input": CreateWalletAddressKeyInput}
Response
{
  "data": {
    "createWalletAddressKey": {
      "walletAddressKey": WalletAddressKey
    }
  }
}
Mutations

createWalletAddressWithdrawal

Description

Withdraw liquidity from a wallet address received via Web Monetization.

Response

Returns a WalletAddressWithdrawalMutationResponse

Arguments
Name Description
input - CreateWalletAddressWithdrawalInput!

Example

Query
mutation CreateWalletAddressWithdrawal($input: CreateWalletAddressWithdrawalInput!) {
  createWalletAddressWithdrawal(input: $input) {
    withdrawal {
      id
      amount
      walletAddress {
        ...WalletAddressFragment
      }
    }
  }
}
Variables
{"input": CreateWalletAddressWithdrawalInput}
Response
{
  "data": {
    "createWalletAddressWithdrawal": {
      "withdrawal": WalletAddressWithdrawal
    }
  }
}
Mutations

deleteAsset

Description

Delete an asset.

Response

Returns a DeleteAssetMutationResponse!

Arguments
Name Description
input - DeleteAssetInput!

Example

Query
mutation DeleteAsset($input: DeleteAssetInput!) {
  deleteAsset(input: $input) {
    asset {
      id
      code
      scale
      liquidity
      withdrawalThreshold
      liquidityThreshold
      receivingFee {
        ...FeeFragment
      }
      sendingFee {
        ...FeeFragment
      }
      fees {
        ...FeesConnectionFragment
      }
      createdAt
      tenantId
    }
  }
}
Variables
{"input": DeleteAssetInput}
Response
{"data": {"deleteAsset": {"asset": Asset}}}
Mutations

deletePeer

Description

Delete a peer.

Response

Returns a DeletePeerMutationResponse!

Arguments
Name Description
input - DeletePeerInput!

Example

Query
mutation DeletePeer($input: DeletePeerInput!) {
  deletePeer(input: $input) {
    success
  }
}
Variables
{"input": DeletePeerInput}
Response
{"data": {"deletePeer": {"success": true}}}
Mutations

deleteTenant

Description

Delete a tenant.

Response

Returns a DeleteTenantMutationResponse!

Arguments
Name Description
id - String!

Example

Query
mutation DeleteTenant($id: String!) {
  deleteTenant(id: $id) {
    success
  }
}
Variables
{"id": "abc123"}
Response
{"data": {"deleteTenant": {"success": false}}}
Mutations

depositAssetLiquidity

Description

Deposit asset liquidity.

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - DepositAssetLiquidityInput!

Example

Query
mutation DepositAssetLiquidity($input: DepositAssetLiquidityInput!) {
  depositAssetLiquidity(input: $input) {
    success
  }
}
Variables
{"input": DepositAssetLiquidityInput}
Response
{"data": {"depositAssetLiquidity": {"success": false}}}
Mutations

depositEventLiquidity

Use depositOutgoingPaymentLiquidity
Description

Deposit webhook event liquidity (deprecated).

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - DepositEventLiquidityInput!

Example

Query
mutation DepositEventLiquidity($input: DepositEventLiquidityInput!) {
  depositEventLiquidity(input: $input) {
    success
  }
}
Variables
{"input": DepositEventLiquidityInput}
Response
{"data": {"depositEventLiquidity": {"success": false}}}
Mutations

depositOutgoingPaymentLiquidity

Description

Deposit outgoing payment liquidity.

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - DepositOutgoingPaymentLiquidityInput!

Example

Query
mutation DepositOutgoingPaymentLiquidity($input: DepositOutgoingPaymentLiquidityInput!) {
  depositOutgoingPaymentLiquidity(input: $input) {
    success
  }
}
Variables
{"input": DepositOutgoingPaymentLiquidityInput}
Response
{"data": {"depositOutgoingPaymentLiquidity": {"success": true}}}
Mutations

depositPeerLiquidity

Description

Deposit peer liquidity.

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - DepositPeerLiquidityInput!

Example

Query
mutation DepositPeerLiquidity($input: DepositPeerLiquidityInput!) {
  depositPeerLiquidity(input: $input) {
    success
  }
}
Variables
{"input": DepositPeerLiquidityInput}
Response
{"data": {"depositPeerLiquidity": {"success": true}}}
Mutations

postLiquidityWithdrawal

Description

Post liquidity withdrawal. Withdrawals are two-phase commits and are committed via this mutation.

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - PostLiquidityWithdrawalInput!

Example

Query
mutation PostLiquidityWithdrawal($input: PostLiquidityWithdrawalInput!) {
  postLiquidityWithdrawal(input: $input) {
    success
  }
}
Variables
{"input": PostLiquidityWithdrawalInput}
Response
{"data": {"postLiquidityWithdrawal": {"success": true}}}
Mutations

revokeWalletAddressKey

Description

Revoke a public key associated with a wallet address. Open Payment requests using this key for request signatures will be denied going forward.

Response

Returns a RevokeWalletAddressKeyMutationResponse

Arguments
Name Description
input - RevokeWalletAddressKeyInput!

Example

Query
mutation RevokeWalletAddressKey($input: RevokeWalletAddressKeyInput!) {
  revokeWalletAddressKey(input: $input) {
    walletAddressKey {
      id
      walletAddressId
      jwk {
        ...JwkFragment
      }
      revoked
      createdAt
    }
  }
}
Variables
{"input": RevokeWalletAddressKeyInput}
Response
{
  "data": {
    "revokeWalletAddressKey": {
      "walletAddressKey": WalletAddressKey
    }
  }
}
Mutations

setFee

Description

Set the fee structure on an asset.

Response

Returns a SetFeeResponse!

Arguments
Name Description
input - SetFeeInput!

Example

Query
mutation SetFee($input: SetFeeInput!) {
  setFee(input: $input) {
    fee {
      id
      assetId
      type
      fixed
      basisPoints
      createdAt
    }
  }
}
Variables
{"input": SetFeeInput}
Response
{"data": {"setFee": {"fee": Fee}}}
Mutations

triggerWalletAddressEvents

Description

If automatic withdrawal of funds received via Web Monetization by the wallet address are disabled, this mutation can be used to trigger up to n withdrawal events.

Response

Returns a TriggerWalletAddressEventsMutationResponse!

Arguments
Name Description
input - TriggerWalletAddressEventsInput!

Example

Query
mutation TriggerWalletAddressEvents($input: TriggerWalletAddressEventsInput!) {
  triggerWalletAddressEvents(input: $input) {
    count
  }
}
Variables
{"input": TriggerWalletAddressEventsInput}
Response
{"data": {"triggerWalletAddressEvents": {"count": 123}}}
Mutations

updateAsset

Description

Update an existing asset.

Response

Returns an AssetMutationResponse!

Arguments
Name Description
input - UpdateAssetInput!

Example

Query
mutation UpdateAsset($input: UpdateAssetInput!) {
  updateAsset(input: $input) {
    asset {
      id
      code
      scale
      liquidity
      withdrawalThreshold
      liquidityThreshold
      receivingFee {
        ...FeeFragment
      }
      sendingFee {
        ...FeeFragment
      }
      fees {
        ...FeesConnectionFragment
      }
      createdAt
      tenantId
    }
  }
}
Variables
{"input": UpdateAssetInput}
Response
{"data": {"updateAsset": {"asset": Asset}}}
Mutations

updateIncomingPayment

Description

Update an existing incoming payment.

Response

Returns an IncomingPaymentResponse!

Arguments
Name Description
input - UpdateIncomingPaymentInput!

Example

Query
mutation UpdateIncomingPayment($input: UpdateIncomingPaymentInput!) {
  updateIncomingPayment(input: $input) {
    payment {
      id
      walletAddressId
      client
      liquidity
      state
      expiresAt
      incomingAmount {
        ...AmountFragment
      }
      receivedAmount {
        ...AmountFragment
      }
      metadata
      createdAt
      tenantId
    }
  }
}
Variables
{"input": UpdateIncomingPaymentInput}
Response
{
  "data": {
    "updateIncomingPayment": {"payment": IncomingPayment}
  }
}
Mutations

updatePeer

Description

Update an existing peer.

Response

Returns an UpdatePeerMutationResponse!

Arguments
Name Description
input - UpdatePeerInput!

Example

Query
mutation UpdatePeer($input: UpdatePeerInput!) {
  updatePeer(input: $input) {
    peer {
      id
      maxPacketAmount
      http {
        ...HttpFragment
      }
      asset {
        ...AssetFragment
      }
      staticIlpAddress
      name
      liquidityThreshold
      liquidity
      createdAt
      tenantId
    }
  }
}
Variables
{"input": UpdatePeerInput}
Response
{"data": {"updatePeer": {"peer": Peer}}}
Mutations

updateTenant

Description

Update a tenant.

Response

Returns a TenantMutationResponse!

Arguments
Name Description
input - UpdateTenantInput!

Example

Query
mutation UpdateTenant($input: UpdateTenantInput!) {
  updateTenant(input: $input) {
    tenant {
      id
      email
      apiSecret
      idpConsentUrl
      idpSecret
      publicName
      createdAt
      deletedAt
      settings {
        ...TenantSettingFragment
      }
    }
  }
}
Variables
{"input": UpdateTenantInput}
Response
{"data": {"updateTenant": {"tenant": Tenant}}}
Mutations

updateWalletAddress

Description

Update an existing wallet address.

Response

Returns an UpdateWalletAddressMutationResponse!

Arguments
Name Description
input - UpdateWalletAddressInput!

Example

Query
mutation UpdateWalletAddress($input: UpdateWalletAddressInput!) {
  updateWalletAddress(input: $input) {
    walletAddress {
      id
      asset {
        ...AssetFragment
      }
      liquidity
      address
      publicName
      incomingPayments {
        ...IncomingPaymentConnectionFragment
      }
      quotes {
        ...QuoteConnectionFragment
      }
      outgoingPayments {
        ...OutgoingPaymentConnectionFragment
      }
      createdAt
      status
      walletAddressKeys {
        ...WalletAddressKeyConnectionFragment
      }
      additionalProperties {
        ...AdditionalPropertyFragment
      }
      tenantId
    }
  }
}
Variables
{"input": UpdateWalletAddressInput}
Response
{
  "data": {
    "updateWalletAddress": {
      "walletAddress": WalletAddress
    }
  }
}
Mutations

voidLiquidityWithdrawal

Description

Void liquidity withdrawal. Withdrawals are two-phase commits and are rolled back via this mutation.

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - VoidLiquidityWithdrawalInput!

Example

Query
mutation VoidLiquidityWithdrawal($input: VoidLiquidityWithdrawalInput!) {
  voidLiquidityWithdrawal(input: $input) {
    success
  }
}
Variables
{"input": VoidLiquidityWithdrawalInput}
Response
{"data": {"voidLiquidityWithdrawal": {"success": false}}}
Mutations

withdrawEventLiquidity

Use createOutgoingPaymentWithdrawal, createIncomingPaymentWithdrawal, or createWalletAddressWithdrawal
Description

Withdraw webhook event liquidity (deprecated).

Response

Returns a LiquidityMutationResponse

Arguments
Name Description
input - WithdrawEventLiquidityInput!

Example

Query
mutation WithdrawEventLiquidity($input: WithdrawEventLiquidityInput!) {
  withdrawEventLiquidity(input: $input) {
    success
  }
}
Variables
{"input": WithdrawEventLiquidityInput}
Response
{"data": {"withdrawEventLiquidity": {"success": false}}}

Types

AccountingTransfer

Fields
Field 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.
Example
{
  "id": "4",
  "debitAccountId": 4,
  "creditAccountId": "4",
  "amount": UInt64,
  "transferType": "DEPOSIT",
  "ledger": UInt8,
  "createdAt": "abc123",
  "state": "PENDING",
  "expiresAt": "abc123"
}
Types

AccountingTransferConnection

Fields
Field Name Description
debits - [AccountingTransfer!]!
credits - [AccountingTransfer!]!
Example
{
  "debits": [AccountingTransfer],
  "credits": [AccountingTransfer]
}
Types

AdditionalProperty

Fields
Field 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.
Example
{
  "key": "abc123",
  "value": "abc123",
  "visibleInOpenPayments": false
}
Types

AdditionalPropertyInput

Fields
Input Field 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.
Example
{
  "key": "xyz789",
  "value": "xyz789",
  "visibleInOpenPayments": true
}
Types

Alg

Values
Enum Value Description

EdDSA

 EdDSA cryptographic algorithm.
Example
"EdDSA"
Types

Amount

Fields
Field 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.
Example
{
  "value": UInt64,
  "assetCode": "abc123",
  "assetScale": UInt8
}
Types

AmountInput

Fields
Input Field 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.
Example
{
  "value": UInt64,
  "assetCode": "xyz789",
  "assetScale": UInt8
}
Types

ApproveIncomingPaymentInput

Fields
Input Field Description
id - ID! Unique identifier of the incoming payment to be approved. Note: incoming payment must be PENDING.
Example
{"id": "4"}
Types

ApproveIncomingPaymentResponse

Fields
Field Name Description
payment - IncomingPayment The incoming payment that was approved.
Example
{"payment": IncomingPayment}
Types

Asset

Fields
Field 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
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!
Example
{
  "id": "4",
  "code": "xyz789",
  "scale": UInt8,
  "liquidity": UInt64,
  "withdrawalThreshold": UInt64,
  "liquidityThreshold": UInt64,
  "receivingFee": Fee,
  "sendingFee": Fee,
  "fees": FeesConnection,
  "createdAt": "abc123",
  "tenantId": "4"
}
Types

AssetEdge

Fields
Field Name Description
node - Asset! An asset node in the list.
cursor - String! A cursor for paginating through the assets.
Example
{
  "node": Asset,
  "cursor": "abc123"
}
Types

AssetMutationResponse

Fields
Field Name Description
asset - Asset The asset affected by the mutation.
Example
{"asset": Asset}
Types

AssetsConnection

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [AssetEdge!]! A list of edges representing assets and cursors for pagination.
Example
{
  "pageInfo": PageInfo,
  "edges": [AssetEdge]
}
Types

BasePayment

Fields
Field Name Description
id - ID! Unique identifier for the payment.
walletAddressId - ID! Unique identifier of the wallet address under which the payment was created.
metadata - JSONObject Additional metadata associated with the payment.
createdAt - String! The date and time that the payment was created.
client - String Information about the wallet address of the Open Payments client that created the payment.
Possible Types
BasePayment Types

IncomingPayment

OutgoingPayment

Payment

Example
{
  "id": 4,
  "walletAddressId": 4,
  "metadata": {},
  "createdAt": "xyz789",
  "client": "abc123"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CancelIncomingPaymentInput

Fields
Input Field Description
id - ID! Unique identifier of the incoming payment to be canceled. Note: incoming payment must be PENDING.
Example
{"id": "4"}
Types

CancelIncomingPaymentResponse

Fields
Field Name Description
payment - IncomingPayment The incoming payment that was canceled.
Example
{"payment": IncomingPayment}
Types

CancelOutgoingPaymentInput

Fields
Input Field 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.
Example
{"id": 4, "reason": "abc123"}
Types

CreateAssetInput

Fields
Input Field 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.
Example
{
  "code": "abc123",
  "scale": UInt8,
  "withdrawalThreshold": UInt64,
  "liquidityThreshold": UInt64,
  "idempotencyKey": "xyz789",
  "tenantId": "4"
}
Types

CreateAssetLiquidityWithdrawalInput

Fields
Input Field 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.
Example
{
  "assetId": "xyz789",
  "amount": UInt64,
  "id": "abc123",
  "idempotencyKey": "xyz789",
  "timeoutSeconds": UInt64
}
Types

CreateIncomingPaymentInput

Fields
Input Field 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.
Example
{
  "walletAddressId": "abc123",
  "expiresAt": "xyz789",
  "metadata": {},
  "incomingAmount": AmountInput,
  "idempotencyKey": "abc123"
}
Types

CreateIncomingPaymentWithdrawalInput

Fields
Input Field 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.
Example
{
  "incomingPaymentId": "abc123",
  "idempotencyKey": "xyz789",
  "timeoutSeconds": UInt64
}
Types

CreateOrUpdatePeerByUrlInput

Fields
Input Field 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.
Example
{
  "maxPacketAmount": UInt64,
  "assetId": "xyz789",
  "peerUrl": "abc123",
  "name": "xyz789",
  "liquidityThreshold": UInt64,
  "liquidityToDeposit": UInt64,
  "idempotencyKey": "abc123"
}
Types

CreateOrUpdatePeerByUrlMutationResponse

Fields
Field Name Description
peer - Peer The peer created or updated based on a URL.
Example
{"peer": Peer}
Types

CreateOutgoingPaymentFromIncomingPaymentInput

Fields
Input Field 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.
Example
{
  "walletAddressId": "xyz789",
  "incomingPayment": "abc123",
  "debitAmount": AmountInput,
  "metadata": {},
  "idempotencyKey": "abc123"
}
Types

CreateOutgoingPaymentInput

Fields
Input Field 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.
Example
{
  "walletAddressId": "abc123",
  "quoteId": "xyz789",
  "metadata": {},
  "idempotencyKey": "abc123"
}
Types

CreateOutgoingPaymentWithdrawalInput

Fields
Input Field 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.
Example
{
  "outgoingPaymentId": "xyz789",
  "idempotencyKey": "xyz789",
  "timeoutSeconds": UInt64
}
Types

CreatePeerInput

Fields
Input Field 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.
Example
{
  "maxPacketAmount": UInt64,
  "http": HttpInput,
  "assetId": "xyz789",
  "staticIlpAddress": "abc123",
  "name": "xyz789",
  "liquidityThreshold": UInt64,
  "initialLiquidity": UInt64,
  "idempotencyKey": "abc123"
}
Types

CreatePeerLiquidityWithdrawalInput

Fields
Input Field 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.
Example
{
  "peerId": "abc123",
  "amount": UInt64,
  "id": "xyz789",
  "idempotencyKey": "abc123",
  "timeoutSeconds": UInt64
}
Types

CreatePeerMutationResponse

Fields
Field Name Description
peer - Peer The peer created by the mutation.
Example
{"peer": Peer}
Types

CreateQuoteInput

Fields
Input Field 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.
Example
{
  "walletAddressId": "xyz789",
  "debitAmount": AmountInput,
  "receiveAmount": AmountInput,
  "receiver": "abc123",
  "idempotencyKey": "abc123"
}
Types

CreateReceiverInput

Fields
Input Field 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.
Example
{
  "walletAddressUrl": "xyz789",
  "expiresAt": "xyz789",
  "incomingAmount": AmountInput,
  "metadata": {},
  "idempotencyKey": "xyz789"
}
Types

CreateReceiverResponse

Fields
Field Name Description
receiver - Receiver The receiver object returned in the response.
Example
{"receiver": Receiver}
Types

CreateTenantInput

Fields
Input Field 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.
Example
{
  "id": 4,
  "email": "abc123",
  "apiSecret": "xyz789",
  "idpConsentUrl": "xyz789",
  "idpSecret": "xyz789",
  "publicName": "xyz789",
  "settings": [TenantSettingInput]
}
Types

CreateTenantSettingsInput

Fields
Input Field Description
settings - [TenantSettingInput!]! List of a settings for a tenant.
Example
{"settings": [TenantSettingInput]}
Types

CreateTenantSettingsMutationResponse

Fields
Field Name Description
settings - [TenantSetting!]! New tenant settings.
Example
{"settings": [TenantSetting]}
Types

CreateWalletAddressInput

Fields
Input Field 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.
Example
{
  "tenantId": "4",
  "assetId": "xyz789",
  "address": "xyz789",
  "publicName": "abc123",
  "idempotencyKey": "abc123",
  "additionalProperties": [AdditionalPropertyInput]
}
Types

CreateWalletAddressKeyInput

Fields
Input Field 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.
Example
{
  "walletAddressId": "abc123",
  "jwk": JwkInput,
  "idempotencyKey": "abc123"
}
Types

CreateWalletAddressKeyMutationResponse

Fields
Field Name Description
walletAddressKey - WalletAddressKey The wallet address key that was created.
Example
{"walletAddressKey": WalletAddressKey}
Types

CreateWalletAddressMutationResponse

Fields
Field Name Description
walletAddress - WalletAddress The newly created wallet address.
Example
{"walletAddress": WalletAddress}
Types

CreateWalletAddressWithdrawalInput

Fields
Input Field 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.
Example
{
  "walletAddressId": "xyz789",
  "id": "xyz789",
  "idempotencyKey": "abc123",
  "timeoutSeconds": UInt64
}
Types

Crv

Values
Enum Value Description

Ed25519

 Elliptic curve Ed25519, used in EdDSA.
Example
"Ed25519"
Types

DeleteAssetInput

Fields
Input Field 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.
Example
{"id": 4, "idempotencyKey": "xyz789"}
Types

DeleteAssetMutationResponse

Fields
Field Name Description
asset - Asset The asset that was deleted.
Example
{"asset": Asset}
Types

DeletePeerInput

Fields
Input Field 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.
Example
{
  "id": "4",
  "idempotencyKey": "xyz789"
}
Types

DeletePeerMutationResponse

Fields
Field Name Description
success - Boolean! Indicates whether the peer deletion was successful.
Example
{"success": true}
Types

DeleteTenantMutationResponse

Fields
Field Name Description
success - Boolean!
Example
{"success": true}
Types

DepositAssetLiquidityInput

Fields
Input Field 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.
Example
{
  "assetId": "xyz789",
  "amount": UInt64,
  "id": "xyz789",
  "idempotencyKey": "xyz789"
}
Types

DepositEventLiquidityInput

Fields
Input Field 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.
Example
{
  "eventId": "abc123",
  "idempotencyKey": "xyz789"
}
Types

DepositOutgoingPaymentLiquidityInput

Fields
Input Field 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.
Example
{
  "outgoingPaymentId": "abc123",
  "idempotencyKey": "xyz789"
}
Types

DepositPeerLiquidityInput

Fields
Input Field 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.
Example
{
  "peerId": "abc123",
  "amount": UInt64,
  "id": "abc123",
  "idempotencyKey": "xyz789"
}
Types

Fee

Fields
Field 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.
Example
{
  "id": "4",
  "assetId": 4,
  "type": "SENDING",
  "fixed": UInt64,
  "basisPoints": 987,
  "createdAt": "xyz789"
}
Types

FeeDetails

Fields
Input Field 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%.
Example
{"fixed": UInt64, "basisPoints": 987}
Types

FeeEdge

Fields
Field Name Description
node - Fee! A fee node in the list.
cursor - String! A cursor for paginating through the fees.
Example
{
  "node": Fee,
  "cursor": "abc123"
}
Types

FeeType

Values
Enum Value Description

SENDING

 The sender is responsible for paying the fees.

RECEIVING

 The receiver is responsible for paying the fees.
Example
"SENDING"
Types

FeesConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination information for fees.
edges - [FeeEdge!]! A list of fee edges, containing fee nodes and cursors for pagination.
Example
{
  "pageInfo": PageInfo,
  "edges": [FeeEdge]
}
Types

FilterString

Fields
Input Field Description
in - [String!]! Array of strings to filter by.
Example
{"in": ["xyz789"]}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

Http

Fields
Field Name Description
outgoing - HttpOutgoing! Details of the outgoing connection for peering.
Example
{"outgoing": HttpOutgoing}
Types

HttpIncomingInput

Fields
Input Field Description
authTokens - [String!]! Array of authorization tokens accepted by this Rafiki instance.
Example
{"authTokens": ["xyz789"]}
Types

HttpInput

Fields
Input Field Description
incoming - HttpIncomingInput Incoming connection details.
outgoing - HttpOutgoingInput! Outgoing connection details.
Example
{
  "incoming": HttpIncomingInput,
  "outgoing": HttpOutgoingInput
}
Types

HttpOutgoing

Fields
Field Name Description
authToken - String! Authorization token to be presented to the peer's Rafiki instance.
endpoint - String! Connection endpoint of the peer.
Example
{
  "authToken": "xyz789",
  "endpoint": "abc123"
}
Types

HttpOutgoingInput

Fields
Input Field Description
authToken - String! Authorization token to present at the peer's Rafiki instance.
endpoint - String! Connection endpoint of the peer.
Example
{
  "authToken": "abc123",
  "endpoint": "abc123"
}
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"4"
Types

IncomingPayment

Fields
Field 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.
Example
{
  "id": "4",
  "walletAddressId": "4",
  "client": "xyz789",
  "liquidity": UInt64,
  "state": "PENDING",
  "expiresAt": "xyz789",
  "incomingAmount": Amount,
  "receivedAmount": Amount,
  "metadata": {},
  "createdAt": "xyz789",
  "tenantId": "xyz789"
}
Types

IncomingPaymentConnection

Fields
Field 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.
Example
{
  "pageInfo": PageInfo,
  "edges": [IncomingPaymentEdge]
}
Types

IncomingPaymentEdge

Fields
Field Name Description
node - IncomingPayment! An incoming payment node in the list.
cursor - String! A cursor for paginating through the incoming payments.
Example
{
  "node": IncomingPayment,
  "cursor": "abc123"
}
Types

IncomingPaymentResponse

Fields
Field Name Description
payment - IncomingPayment The incoming payment object returned in the response.
Example
{"payment": IncomingPayment}
Types

IncomingPaymentState

Values
Enum Value Description

PENDING

 The payment is pending when it is initially created and has not started processing.

PROCESSING

 The payment is being processed after funds have started clearing into the account.

COMPLETED

 The payment is completed automatically once the expected incomingAmount is received or manually via an API call.

EXPIRED

 The payment has expired before completion, and no further funds will be accepted.
Example
"PENDING"
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123
Types

JSONObject

Description

The JSONObject scalar type represents JSON objects as specified by the ECMA-404 standard.

Example
{}
Types

Jwk

Fields
Field 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.
Example
{
  "kid": "abc123",
  "x": "xyz789",
  "alg": "EdDSA",
  "kty": "OKP",
  "crv": "Ed25519"
}
Types

JwkInput

Fields
Input Field 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.
Example
{
  "kid": "abc123",
  "x": "xyz789",
  "alg": "EdDSA",
  "kty": "OKP",
  "crv": "Ed25519"
}
Types

Kty

Values
Enum Value Description

OKP

 Octet Key Pair (OKP) key type.
Example
"OKP"
Types

LiquidityMutationResponse

Fields
Field Name Description
success - Boolean! Indicates whether the liquidity operation was successful.
Example
{"success": false}
Types

Model

Fields
Field Name Description
id - ID! Unique identifier for the entity.
createdAt - String! The date and time that the entity was created.
Possible Types
Model Types

Asset

Peer

WalletAddress

IncomingPayment

OutgoingPayment

Payment

AccountingTransfer

WalletAddressKey

WebhookEvent

Fee

Tenant

Example
{
  "id": "4",
  "createdAt": "xyz789"
}
Types

OutgoingPayment

Fields
Field 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.
Example
{
  "id": "4",
  "walletAddressId": "4",
  "client": "xyz789",
  "liquidity": UInt64,
  "state": "FUNDING",
  "error": "abc123",
  "stateAttempts": 123,
  "debitAmount": Amount,
  "receiveAmount": Amount,
  "receiver": "abc123",
  "metadata": {},
  "quote": Quote,
  "sentAmount": Amount,
  "createdAt": "xyz789",
  "grantId": "abc123",
  "tenantId": "abc123"
}
Types

OutgoingPaymentConnection

Fields
Field 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.
Example
{
  "pageInfo": PageInfo,
  "edges": [OutgoingPaymentEdge]
}
Types

OutgoingPaymentEdge

Fields
Field Name Description
node - OutgoingPayment! An outgoing payment node in the list.
cursor - String! A cursor for paginating through the outgoing payments.
Example
{
  "node": OutgoingPayment,
  "cursor": "abc123"
}
Types

OutgoingPaymentFilter

Fields
Input Field 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.
Example
{
  "receiver": FilterString,
  "walletAddressId": FilterString,
  "state": FilterString
}
Types

OutgoingPaymentResponse

Fields
Field Name Description
payment - OutgoingPayment The outgoing payment object returned in the response.
Example
{"payment": OutgoingPayment}
Types

OutgoingPaymentState

Values
Enum Value Description

FUNDING

 The payment is reserving funds and will transition to SENDING once funds are secured.

SENDING

 The payment is in progress and will transition to COMPLETED upon success.

COMPLETED

 The payment has been successfully completed.

FAILED

 The payment has failed.

CANCELLED

 The payment has been canceled.
Example
"FUNDING"
Types

PageInfo

Fields
Field 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.
Example
{
  "endCursor": "xyz789",
  "hasNextPage": true,
  "hasPreviousPage": false,
  "startCursor": "abc123"
}
Types

Payment

Fields
Field 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.
Example
{
  "id": "4",
  "type": "INCOMING",
  "walletAddressId": 4,
  "client": "abc123",
  "state": "abc123",
  "liquidity": UInt64,
  "metadata": {},
  "createdAt": "abc123"
}
Types

PaymentConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination information for the payments.
edges - [PaymentEdge!]! A list of payment edges, containing payment nodes and cursors for pagination.
Example
{
  "pageInfo": PageInfo,
  "edges": [PaymentEdge]
}
Types

PaymentEdge

Fields
Field Name Description
node - Payment! A payment node in the list.
cursor - String! A cursor for paginating through the payments.
Example
{
  "node": Payment,
  "cursor": "abc123"
}
Types

PaymentFilter

Fields
Input Field Description
type - FilterString Filter for payments based on their type.
walletAddressId - FilterString Filter for payments based on the wallet address ID.
Example
{
  "type": FilterString,
  "walletAddressId": FilterString
}
Types

PaymentType

Values
Enum Value Description

INCOMING

 Represents an incoming payment.

OUTGOING

 Represents an outgoing payment.
Example
"INCOMING"
Types

Peer

Fields
Field 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.
Example
{
  "id": "4",
  "maxPacketAmount": UInt64,
  "http": Http,
  "asset": Asset,
  "staticIlpAddress": "abc123",
  "name": "xyz789",
  "liquidityThreshold": UInt64,
  "liquidity": UInt64,
  "createdAt": "abc123",
  "tenantId": 4
}
Types

PeerEdge

Fields
Field Name Description
node - Peer! A peer node in the list.
cursor - String! A cursor for paginating through the peers.
Example
{
  "node": Peer,
  "cursor": "xyz789"
}
Types

PeersConnection

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [PeerEdge!]! A list of edges representing peers and cursors for pagination.
Example
{
  "pageInfo": PageInfo,
  "edges": [PeerEdge]
}
Types

PostLiquidityWithdrawalInput

Fields
Input Field 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.
Example
{
  "withdrawalId": "abc123",
  "idempotencyKey": "abc123"
}
Types

Quote

Fields
Field 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.
Example
{
  "id": 4,
  "tenantId": "4",
  "walletAddressId": 4,
  "receiver": "xyz789",
  "debitAmount": Amount,
  "receiveAmount": Amount,
  "createdAt": "abc123",
  "expiresAt": "xyz789",
  "estimatedExchangeRate": 987.65
}
Types

QuoteConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination information for quotes.
edges - [QuoteEdge!]! A list of quote edges, containing quote nodes and cursors for pagination.
Example
{
  "pageInfo": PageInfo,
  "edges": [QuoteEdge]
}
Types

QuoteEdge

Fields
Field Name Description
node - Quote! A quote node in the list.
cursor - String! A cursor for paginating through the quotes.
Example
{
  "node": Quote,
  "cursor": "xyz789"
}
Types

QuoteResponse

Fields
Field Name Description
quote - Quote The quote object returned in the response.
Example
{"quote": Quote}
Types

Receiver

Fields
Field 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.
Example
{
  "id": "xyz789",
  "walletAddressUrl": "abc123",
  "completed": true,
  "incomingAmount": Amount,
  "receivedAmount": Amount,
  "expiresAt": "abc123",
  "metadata": {},
  "createdAt": "xyz789"
}
Types

RevokeWalletAddressKeyInput

Fields
Input Field 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.
Example
{
  "id": "abc123",
  "idempotencyKey": "abc123"
}
Types

RevokeWalletAddressKeyMutationResponse

Fields
Field Name Description
walletAddressKey - WalletAddressKey The wallet address key that was revoked.
Example
{"walletAddressKey": WalletAddressKey}
Types

SetFeeInput

Fields
Input Field 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.
Example
{
  "assetId": 4,
  "type": "SENDING",
  "fee": FeeDetails,
  "idempotencyKey": "xyz789"
}
Types

SetFeeResponse

Fields
Field Name Description
fee - Fee The fee that was set.
Example
{"fee": Fee}
Types

SortOrder

Values
Enum Value Description

ASC

 Sort the results in ascending order.

DESC

 Sort the results in descending order.
Example
"ASC"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Types

Tenant

Fields
Field 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.
Example
{
  "id": "4",
  "email": "abc123",
  "apiSecret": "xyz789",
  "idpConsentUrl": "xyz789",
  "idpSecret": "abc123",
  "publicName": "abc123",
  "createdAt": "abc123",
  "deletedAt": "xyz789",
  "settings": [TenantSetting]
}
Types

TenantEdge

Fields
Field Name Description
node - Tenant! A tenant node in the list.
cursor - String! A cursor for paginating through the tenants.
Example
{
  "node": Tenant,
  "cursor": "xyz789"
}
Types

TenantMutationResponse

Fields
Field Name Description
tenant - Tenant!
Example
{"tenant": Tenant}
Types

TenantSetting

Fields
Field Name Description
key - String! Key for this setting.
value - String! Value of a setting for this key.
Example
{
  "key": "abc123",
  "value": "xyz789"
}
Types

TenantSettingInput

Fields
Input Field Description
key - String! Key for this setting.
value - String! Value of a setting for this key.
Example
{
  "key": "abc123",
  "value": "abc123"
}
Types

TenantsConnection

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [TenantEdge!]! A list of edges representing tenants and cursors for pagination.
Example
{
  "pageInfo": PageInfo,
  "edges": [TenantEdge]
}
Types

TransferState

Values
Enum Value Description

PENDING

 The accounting transfer is pending

POSTED

 The accounting transfer is posted

VOIDED

 The accounting transfer is voided
Example
"PENDING"
Types

TransferType

Values
Enum Value Description

DEPOSIT

 Represents a deposit transfer.

WITHDRAWAL

 Represents a withdrawal transfer.

TRANSFER

 Represents a generic transfer within Rafiki.
Example
"DEPOSIT"
Types

TriggerWalletAddressEventsInput

Fields
Input Field 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.
Example
{"limit": 123, "idempotencyKey": "abc123"}
Types

TriggerWalletAddressEventsMutationResponse

Fields
Field Name Description
count - Int The number of events that were triggered.
Example
{"count": 987}
Types

UInt64

Description

The UInt64 scalar type represents unsigned 64-bit whole numeric values. It is capable of handling values that are larger than the JavaScript Number type limit (greater than 2^53).

Example
UInt64
Types

UInt8

Description

The UInt8 scalar type represents unsigned 8-bit whole numeric values, ranging from 0 to 255.

Example
UInt8
Types

UpdateAssetInput

Fields
Input Field 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.
Example
{
  "id": "abc123",
  "withdrawalThreshold": UInt64,
  "liquidityThreshold": UInt64,
  "idempotencyKey": "xyz789"
}
Types

UpdateIncomingPaymentInput

Fields
Input Field 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.
Example
{"id": "4", "metadata": {}}
Types

UpdatePeerInput

Fields
Input Field 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.
Example
{
  "id": "xyz789",
  "maxPacketAmount": UInt64,
  "http": HttpInput,
  "staticIlpAddress": "abc123",
  "name": "xyz789",
  "liquidityThreshold": UInt64,
  "idempotencyKey": "xyz789"
}
Types

UpdatePeerMutationResponse

Fields
Field Name Description
peer - Peer The peer that was updated.
Example
{"peer": Peer}
Types

UpdateTenantInput

Fields
Input Field 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.
Example
{
  "id": "4",
  "email": "abc123",
  "apiSecret": "xyz789",
  "idpConsentUrl": "xyz789",
  "idpSecret": "xyz789",
  "publicName": "xyz789"
}
Types

UpdateWalletAddressInput

Fields
Input Field 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.
Example
{
  "id": 4,
  "publicName": "abc123",
  "status": "INACTIVE",
  "idempotencyKey": "xyz789",
  "additionalProperties": [AdditionalPropertyInput]
}
Types

UpdateWalletAddressMutationResponse

Fields
Field Name Description
walletAddress - WalletAddress The updated wallet address.
Example
{"walletAddress": WalletAddress}
Types

VoidLiquidityWithdrawalInput

Fields
Input Field 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.
Example
{
  "withdrawalId": "abc123",
  "idempotencyKey": "abc123"
}
Types

WalletAddress

Fields
Field 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
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
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
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
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.
Example
{
  "id": 4,
  "asset": Asset,
  "liquidity": UInt64,
  "address": "abc123",
  "publicName": "xyz789",
  "incomingPayments": IncomingPaymentConnection,
  "quotes": QuoteConnection,
  "outgoingPayments": OutgoingPaymentConnection,
  "createdAt": "abc123",
  "status": "INACTIVE",
  "walletAddressKeys": WalletAddressKeyConnection,
  "additionalProperties": [AdditionalProperty],
  "tenantId": "abc123"
}
Types

WalletAddressEdge

Fields
Field Name Description
node - WalletAddress! A wallet address node in the list.
cursor - String! A cursor for paginating through the wallet addresses.
Example
{
  "node": WalletAddress,
  "cursor": "abc123"
}
Types

WalletAddressKey

Fields
Field 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.
Example
{
  "id": "4",
  "walletAddressId": "4",
  "jwk": Jwk,
  "revoked": true,
  "createdAt": "abc123"
}
Types

WalletAddressKeyConnection

Fields
Field 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.
Example
{
  "pageInfo": PageInfo,
  "edges": [WalletAddressKeyEdge]
}
Types

WalletAddressKeyEdge

Fields
Field Name Description
node - WalletAddressKey! A wallet address key node in the list.
cursor - String! A cursor for paginating through the wallet address keys.
Example
{
  "node": WalletAddressKey,
  "cursor": "abc123"
}
Types

WalletAddressStatus

Values
Enum Value Description

INACTIVE

 The status after deactivating a wallet address.

ACTIVE

 The default status of a wallet address.
Example
"INACTIVE"
Types

WalletAddressWithdrawal

Fields
Field 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.
Example
{
  "id": 4,
  "amount": UInt64,
  "walletAddress": WalletAddress
}
Types

WalletAddressWithdrawalMutationResponse

Fields
Field Name Description
withdrawal - WalletAddressWithdrawal The wallet address withdrawal that was processed.
Example
{"withdrawal": WalletAddressWithdrawal}
Types

WalletAddressesConnection

Fields
Field 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.
Example
{
  "pageInfo": PageInfo,
  "edges": [WalletAddressEdge]
}
Types

WebhookEvent

Fields
Field 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.
Example
{
  "id": 4,
  "tenantId": 4,
  "type": "xyz789",
  "data": {},
  "createdAt": "xyz789"
}
Types

WebhookEventFilter

Fields
Input Field Description
type - FilterString Filter for webhook events based on their type.
Example
{"type": FilterString}
Types

WebhookEventsConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination information for webhook events.
edges - [WebhookEventsEdge!]! A list of webhook event edges, containing event nodes and cursors for pagination.
Example
{
  "pageInfo": PageInfo,
  "edges": [WebhookEventsEdge]
}
Types

WebhookEventsEdge

Fields
Field Name Description
node - WebhookEvent! A webhook event node in the list.
cursor - String! A cursor for paginating through the webhook events.
Example
{
  "node": WebhookEvent,
  "cursor": "xyz789"
}
Types

WhoamiResponse

Fields
Field Name Description
id - String!
isOperator - Boolean!
Example
{"id": "abc123", "isOperator": false}
Types

WithdrawEventLiquidityInput

Fields
Input Field 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.
Example
{
  "eventId": "abc123",
  "idempotencyKey": "xyz789"
}