Payment Instructions

Get available payment instructions in current organization linked to Accounts, optionally filtered by asset or payment request

get

Query parameters

assetstringOptional

accountIdstringOptional

paymentRequestIdstring · uuidOptionalPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

withBalancebooleanOptional

statusstring · enumOptionalPossible values:

billingDestinationAssetstringOptional

billingDestinationRailstring · enumOptionalPossible values:

billingTransactionCategorystring · enumOptionalPossible values:

Responses

200

Default Response

application/json

get

/api/v1/payment-instructions

HTTPcURLJavaScriptPython

GET /api/v1/payment-instructions HTTP/1.1
Accept: */*

200

Default Response

{
  "records": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "CRYPTO",
      "status": "ACTIVE",
      "asset": "text",
      "rail": "ETHEREUM",
      "paymentIdentifiers": [
        {
          "id": "text",
          "type": "BSB",
          "value": "text",
          "active": true,
          "sequenceNumber": "text",
          "amount": 1,
          "usdAmount": 1,
          "complete": true,
          "providerId": "text"
        }
      ],
      "isReadOnly": true,
      "thirdPartyDisabled": true,
      "balance": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      }
    }
  ]
}