v1

latestOpenAPI 3.0.02026-07-243678114.1 KB

Partners

Get Account by Reference

Retrieve details for a specific account using its reference. Fetch detailed information about an account, including its status and associated metadata, using the provided account reference. This endpoint is useful for verifying account existence and retrieving essential details.

get/partners/accounts/{account_ref}

Path parameters

account_refstring required

Your own account reference identifier.

Response

idinteger

Unique identifier for the account.

org_idstring

Organization ID associated with the account.

referencestring

Reference identifier for the account.

account_typestring

Type of the account.

namestring

Name of the account.

chain_idinteger

Blockchain chain ID for the account.

addressstring

Address associated with the account (if applicable).

currenciesstring[]

List of supported currencies for the account.

account_numberstring

Account number (if applicable).

sort_codestring

Sort code (if applicable).

enabledboolean

Indicates whether the account is active.

statestring

Current state of the account.

created_atstring date-time

Timestamp of when the account was created.

updated_atstring date-time

Timestamp of the last update to the account.

providerstring

Provider managing the account.

Example response

{
  "id": 3758,
  "org_id": "2Tpmnmh6GHJXumKN1oBy2u56Ima",
  "reference": "operator-1",
  "account_type": "CryptoPayIn",
  "name": "operator-1",
  "currencies": [
    "USDC",
    "DAI",
    "USDT"
  ],
  "enabled": true,
  "state": "Ready",
  "created_at": "2024-12-27T10:28:18.599Z",
  "updated_at": "2024-12-27T10:28:18.599Z",
  "provider": "BoomFi"
}