Accounts

List of active accounts in organization

get

Responses

200

Default Response

application/json

get

/api/v1/accounts

HTTPcURLJavaScriptPython

GET /api/v1/accounts HTTP/1.1
Accept: */*

200

Default Response

{
  "records": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "baseCurrency": "text",
      "aggregatedBalance": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      },
      "isReadOnly": true
    }
  ]
}

Get account

get

Path parameters

accountIdstring · uuidRequiredPattern: ^([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)$

Responses

200

Default Response

application/json

idstring · uuidRequiredPattern: ^([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)$

namestringRequired

baseCurrencystringRequired

aggregatedBalanceany ofRequired

or

undefined · enum · nullableOptionalPossible values:

isReadOnlybooleanRequired

get

/api/v1/accounts/{accountId}

HTTPcURLJavaScriptPython

GET /api/v1/accounts/{accountId} HTTP/1.1
Accept: */*

200

Default Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "baseCurrency": "text",
  "aggregatedBalance": {
    "amount": "text",
    "asset": "text",
    "scale": 1
  },
  "isReadOnly": true
}

Get available payment instructions for account

get

Path parameters

accountIdstring · uuidRequiredPattern: ^([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)$

Responses

200

Default Response

application/json

404

Default Response

application/json

get

/api/v1/accounts/{accountId}/payment-instructions

HTTPcURLJavaScriptPython

GET /api/v1/accounts/{accountId}/payment-instructions HTTP/1.1
Accept: */*

{
  "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
      },
      "topUpBillingEnabled": true,
      "minimumAmount": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      },
      "fixedFee": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      },
      "percentageFee": 1
    }
  ]
}

Update account name

patch

Path parameters

accountIdstring · uuidRequiredPattern: ^([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)$

Body

application/json

namestring · min: 3 · max: 100Required

Responses

200

Default Response

application/json

idstring · uuidRequiredPattern: ^([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)$

namestringRequired

baseCurrencystringRequired

404

Default Response

application/json

patch

/api/v1/accounts/{accountId}/name

HTTPcURLJavaScriptPython

PATCH /api/v1/accounts/{accountId}/name HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "baseCurrency": "text"
}