Sign in
Payment Accounts

Get payment account by ID

Changed on

Returns a single payment account.

get/api/payment-accounts/{id}

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/payment-accounts/{id}
  • Auth: none required

Path parameters

idstring uuid required

Payment account ID

Response

Payment account

account_holder_idstring uuid required
account_numberstring nullable

Bank account number (PCI-DSS sensitive — tokenise before storing)

account_type'bank_account' | 'card' | 'wallet' | 'crypto_wallet' required
bank_namestring nullable

Name of the account's bank

card_panstring nullable

Card PAN last-4 or token (PCI-DSS — never store raw PAN)

counterparty_idstring uuid nullable
currencystring nullable

ISO 4217 3-letter currency code (e.g. USD, EUR, GBP)

enabled_regimesstring[] nullable
external_idstring nullable

Caller-supplied SoE upsert key (unique per tenant when set)

ibanstring nullable

International Bank Account Number (IBAN)

idstring uuid
inserted_atstring date-time
ledger_account_idstring uuid nullable
legal_entity_idstring uuid nullable
payment_account_numberstring nullable

Opaque internal payment account number

routing_numberstring nullable

Bank routing / sort code

status'active' | 'suspended' | 'blocked' nullable
swift_bicstring nullable

SWIFT/BIC code of the account's bank

tenant_idstring uuid required
updated_atstring date-time
wallet_addressstring nullable

On-chain wallet address (the actual identifier funds settle to). Set together with wallet_chain when account_type = :crypto_wallet.

wallet_chainstring nullable

Blockchain / asset ticker the wallet_address lives on (e.g. "BTC", "ETH", "TRON"). Disambiguates same-format addresses across chains.

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "account_number": "",
  "account_type": "bank_account",
  "bank_name": "",
  "card_pan": "",
  "counterparty_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "currency": "",
  "enabled_regimes": [
    ""
  ],
  "external_id": "",
  "iban": "",
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "ledger_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "legal_entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "payment_account_number": "",
  "routing_number": "",
  "status": "active",
  "swift_bic": "",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "updated_at": "2020-04-20T16:20:00Z",
  "wallet_address": "",
  "wallet_chain": ""
}

Changes

  • e99ccd17df53Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 5105f6199e7dRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status