getList funding endpoints

Required capabilityfunding_endpoints.read

Authentication: Send Authorization: Bearer <access_token>.

Lists deposit-side endpoints for the selected rail. Crypto endpoints route to the custody rails backend; fiat endpoints are delegated to fiat-rails-service and scoped to the supplied account_ref. On fiat resources, fiat_routing.bank_details carries the receive details a provider issues — provider_payment_reference (required says whether a payment without it can fail), account_holder_address, bank_address and correspondent_bank — always present, null when the provider issued none. provider_payment_reference is the provider's own reference, separate from the pooled ISO 11649 reference.

Parameters

Name Location Type Required Description and constraints
account_ref query string Yes pattern: ^(master-accounts|client-accounts)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
rail_class query "fiat" / "crypto" Yes
status query "provisioning" / "active" / "failed" / "disabled" / "retired" No
asset query string No pattern: ^[A-Z0-9]{1,16}$
page_size query integer No Cursor pagination page size. The canonical contract accepts integers from 1 to 500. minimum: 1; maximum: 500; default: 100
page_token query string No Opaque cursor returned by a previous page.

Request

Request URL

GET
GET /funding-endpoints

Responses

Response

application/json
{
  "items": [
    {
      "account_ref": "client-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "asset": "USDC",
      "created_at": "2026-05-01T10:00:00Z",
      "crypto_routing": {
        "asset": "USDC",
        "endpoint": {
          "address": "0xAbCd1234567890AbCd1234567890AbCd12345678",
          "memo": null
        },
        "network": "ethereum"
      },
      "fiat_rail": null,
      "fiat_routing": null,
      "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "network": "ethereum",
      "rail_class": "crypto",
      "status": "active",
      "updated_at": "2026-05-01T10:00:00Z"
    },
    {
      "account_ref": "client-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "asset": "USD",
      "created_at": "2026-05-01T10:00:00Z",
      "crypto_routing": null,
      "failure": null,
      "fiat_rail": "fedwire",
      "fiat_routing": {
        "asset": "USD",
        "attribution_mode": "virtual_account",
        "bank_details": null,
        "beneficiary_name": null,
        "fiat_rail": "fedwire",
        "reference": null
      },
      "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "rail_class": "fiat",
      "status": "provisioning",
      "updated_at": "2026-05-01T10:00:00Z"
    }
  ],
  "next_page_token": null
}

Operation succeeded.

Response 200 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
items object[] Yes
next_page_token string or null Yes

Additional fields are not accepted.

application/json body.items

Type: object[].

application/json body.items item
Field Type Required Description and constraints
account_ref string Yes pattern: ^(master-accounts|client-accounts)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
asset string or null No
created_at string Yes format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
crypto_routing object or null No
failure object or null No
fiat_rail "sepa_credit_transfer" / "faster_payments" / "swift" / "local_bank_transfer" / "fedwire" or null No
fiat_routing object or null No
id string Yes format: uuid; pattern: ^([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)$
network string or null No
rail_class "fiat" / "crypto" Yes
status "provisioning" / "active" / "failed" / "disabled" / "retired" Yes
updated_at string Yes format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Additional fields are not accepted.

application/json body.items item.asset

At least one alternative must match.

application/json body.items item.asset: alternative 1

Currency code (ISO-4217 or on-chain ticker)

Type: string. pattern: ^[A-Z0-9]{1,16}$

application/json body.items item.asset: alternative 2

Type: null.

application/json body.items item.crypto_routing

At least one alternative must match.

application/json body.items item.crypto_routing: alternative 1
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
endpoint object No No additional fields
network string Yes minLength: 1

Additional fields are not accepted.

application/json body.items item.crypto_routing: alternative 1.endpoint
Field Type Required Description and constraints
address string Yes minLength: 1; maxLength: 256
memo string or null Yes

Additional fields are not accepted.

application/json body.items item.crypto_routing: alternative 1.endpoint.memo

At least one alternative must match.

application/json body.items item.crypto_routing: alternative 1.endpoint.memo: alternative 1

Type: string.

application/json body.items item.crypto_routing: alternative 1.endpoint.memo: alternative 2

Type: null.

application/json body.items item.crypto_routing: alternative 2

Type: null.

application/json body.items item.failure

At least one alternative must match.

application/json body.items item.failure: alternative 1
Field Type Required Description and constraints
code "party_profile_incomplete" / "party_not_supported" / "party_already_provisioned" / "provider_rejected" / "manual_review_required" / "provisioning_unavailable" Yes
retryable boolean Yes

Additional fields are not accepted.

application/json body.items item.failure: alternative 2

Type: null.

application/json body.items item.fiat_rail

At least one alternative must match.

application/json body.items item.fiat_rail: alternative 1

Type: "sepa_credit_transfer" / "faster_payments" / "swift" / "local_bank_transfer" / "fedwire".

application/json body.items item.fiat_rail: alternative 2

Type: null.

application/json body.items item.fiat_routing

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
attribution_mode "virtual_account" / "payment_reference" Yes
bank_details object or object or null No
beneficiary_name string or null No
fiat_rail "sepa_credit_transfer" / "faster_payments" / "swift" / "local_bank_transfer" / "fedwire" Yes
reference string or null No

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1

Exactly one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1
Field Type Required Description and constraints
account_holder_address object or null No
account_holder_name string Yes minLength: 1; maxLength: 140
bank_address object or null No Postal address of the bank that holds the account.
bank_name string or null Yes
bic string or null Yes
correspondent_bank object or null No
country string Yes pattern: ^[A-Z]{2}$
iban string Yes minLength: 1; maxLength: 34
provider_payment_reference object or null No
scheme "iban" Yes

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 1.postal_code

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 1.postal_code: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 1.region

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 1.region: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.account_holder_address: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address

Postal address of the bank that holds the account.

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 1.postal_code

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 1.postal_code: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 1.region

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 1.region: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_address: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_name

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_name: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bank_name: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bic

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bic: alternative 1

Type: string. minLength: 1; maxLength: 11

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.bic: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1
Field Type Required Description and constraints
name string Yes minLength: 1; maxLength: 140
account_number string or null Yes
address object or null Yes
bic string Yes minLength: 1; maxLength: 11

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.account_number

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.account_number: alternative 1

Type: string. minLength: 1; maxLength: 64

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.account_number: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 1.postal_code

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 1.postal_code: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 1.region

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 1.region: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 1.address: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.correspondent_bank: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.provider_payment_reference

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.provider_payment_reference: alternative 1
Field Type Required Description and constraints
required boolean Yes
value string Yes minLength: 1; maxLength: 140

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 1.provider_payment_reference: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2
Field Type Required Description and constraints
account_holder_address object or null No
account_holder_name string Yes minLength: 1; maxLength: 140
account_number string Yes minLength: 1; maxLength: 64
account_type "checking" / "savings" or null No Checking or savings. Required by some payout rails (a US domestic wire); null or absent where the rail has no such concept.
bank_address object or null No Postal address of the bank that holds the account.
bank_name string or null Yes
bic string or null Yes
correspondent_bank object or null No
country string Yes pattern: ^[A-Z]{2}$
provider_payment_reference object or null No
routing_codes object[] Yes minItems: 1; maxItems: 16
scheme "local_account" Yes

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 1.postal_code

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 1.postal_code: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 1.region

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 1.region: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_holder_address: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_type

Checking or savings. Required by some payout rails (a US domestic wire); null or absent where the rail has no such concept.

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_type: alternative 1

Type: "checking" / "savings".

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.account_type: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address

Postal address of the bank that holds the account.

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 1.postal_code

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 1.postal_code: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 1.region

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 1.region: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_address: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_name

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_name: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bank_name: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bic

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bic: alternative 1

Type: string. minLength: 1; maxLength: 11

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.bic: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1
Field Type Required Description and constraints
name string Yes minLength: 1; maxLength: 140
account_number string or null Yes
address object or null Yes
bic string Yes minLength: 1; maxLength: 11

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.account_number

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.account_number: alternative 1

Type: string. minLength: 1; maxLength: 64

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.account_number: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 1.postal_code

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 1.postal_code: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 1.region

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 1.region: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 1.address: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.correspondent_bank: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.provider_payment_reference

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.provider_payment_reference: alternative 1
Field Type Required Description and constraints
required boolean Yes
value string Yes minLength: 1; maxLength: 140

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.provider_payment_reference: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.routing_codes

Type: object[]. minItems: 1; maxItems: 16

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 1: alternative 2.routing_codes item
Field Type Required Description and constraints
type string Yes minLength: 1; maxLength: 64
value string Yes minLength: 1; maxLength: 64

Additional fields are not accepted.

application/json body.items item.fiat_routing: alternative 1.bank_details: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.beneficiary_name

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.beneficiary_name: alternative 1

Type: string.

application/json body.items item.fiat_routing: alternative 1.beneficiary_name: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 1.reference

At least one alternative must match.

application/json body.items item.fiat_routing: alternative 1.reference: alternative 1

Type: string.

application/json body.items item.fiat_routing: alternative 1.reference: alternative 2

Type: null.

application/json body.items item.fiat_routing: alternative 2

Type: null.

application/json body.items item.network

At least one alternative must match.

application/json body.items item.network: alternative 1

Type: string.

application/json body.items item.network: alternative 2

Type: null.

application/json body.next_page_token

At least one alternative must match.

application/json body.next_page_token: alternative 1

Type: string. minLength: 1

application/json body.next_page_token: alternative 2

Type: null.

Response 400 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 401 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object or null No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer or null No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 403 schema

Content type: application/json.

See response 401 schema.

Response 500 schema

Content type: application/json.

See response 401 schema.

Response 502 schema

Content type: application/json.

See response 400 schema.

Response 503 schema

Content type: application/json.

See response 400 schema.