Getting Accounts | Partner Banking Docs

Partner Banking Docs

Home Status

Get all accounts

GETapi-url/v1/partner/accounts

Query parameters

Header parameters

Response

List of accounts available to the partner

Body

itemsarray of object

metaobject

Request

const response = await fetch('api-url/v1/partner/accounts?types=PRIMARY&primaryAccountId=123e4567-e89b-12d3-a456-426614174000&states=READY&page=1&limit=10', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "partnerId": "123e4567-e89b-12d3-a456-426614174000",
      "primaryAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "PRIMARY",
      "currencyCode": "GBP",
      "createDate": "2025-02-05T06:49:06.827Z",
      "identifiers": [
        {
          "type": "UK_ACCOUNT",
          "beneficiary": "text",
          "bankAddress": "text",
          "data": {
            "type": "UK_ACCOUNT",
            "sortCode": "010102",
            "accountNumber": "12345678"
          }
        }
      ],
      "state": "INITIALIZING",
      "balance": {
        "currency": "GBP",
        "availableBalance": 1,
        "ledgerBalance": 1,
        "pendingCredits": 1
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "itemCount": 10,
    "itemsPerPage": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}

Get account

GETapi-url/v1/partner/accounts/{accountId}

Path parameters

accountId*string

Header parameters

Response

Returns the account details

Body

id*string (uuid)

customerId*string (uuid)

partnerId*string (uuid)

primaryAccountId*nullable string (uuid)

type*enum

PRIMARYVIRTUAL

currencyCode*enum

Example: "GBP"

AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNSZLETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSEKCHECHWSYPTWDTJSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPTXAGAFAFIMADPESPFRFAOKAORRURATSAYMAZMBYBBYRBECBEFBELBADBRBBRRBGJCYPCSKECSECVGQEEEKXEUGEKDDMDEMGHCGHPGRDGWEITLIEPLVLZALLTLLUCLUFLULMGFMLFMTLMROMZENLGPLZPTEROKSTDCSDSKKSITRHDESAESBSDDSRGTJRTPETRLTMMUAKUSSVEBVEFYUDZRNZMKZWNZWR

createDate*string (date-time)

identifiers*array of object

state*enum

Account state

INITIALIZINGREADYBLOCKEDCLOSEDSUSPENDED

balance*object

Request

const response = await fetch('api-url/v1/partner/accounts/{accountId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "primaryAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "PRIMARY",
  "currencyCode": "GBP",
  "createDate": "2025-02-05T06:49:06.827Z",
  "identifiers": [
    {
      "type": "UK_ACCOUNT",
      "beneficiary": "text",
      "bankAddress": "text",
      "data": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      }
    }
  ],
  "state": "INITIALIZING",
  "balance": {
    "currency": "GBP",
    "availableBalance": 1,
    "ledgerBalance": 1,
    "pendingCredits": 1
  }
}

Get customer accounts

GETapi-url/v1/partner/customers/{customerId}/accounts

Path parameters

customerId*string

Query parameters

Header parameters

Response

List of accounts available to the partner

Body

itemsarray of object

metaobject

Request

const response = await fetch('api-url/v1/partner/customers/{customerId}/accounts?types=PRIMARY&primaryAccountId=123e4567-e89b-12d3-a456-426614174000&states=READY&page=1&limit=10', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "partnerId": "123e4567-e89b-12d3-a456-426614174000",
      "primaryAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "PRIMARY",
      "currencyCode": "GBP",
      "createDate": "2025-02-05T06:49:06.827Z",
      "identifiers": [
        {
          "type": "UK_ACCOUNT",
          "beneficiary": "text",
          "bankAddress": "text",
          "data": {
            "type": "UK_ACCOUNT",
            "sortCode": "010102",
            "accountNumber": "12345678"
          }
        }
      ],
      "state": "INITIALIZING",
      "balance": {
        "currency": "GBP",
        "availableBalance": 1,
        "ledgerBalance": 1,
        "pendingCredits": 1
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "itemCount": 10,
    "itemsPerPage": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}

Get customer account

GETapi-url/v1/partner/customers/{customerId}/accounts/{accountId}

Path parameters

customerId*string

accountId*string

Header parameters

Response

Returns the account details

Body

id*string (uuid)

customerId*string (uuid)

partnerId*string (uuid)

primaryAccountId*nullable string (uuid)

type*enum

PRIMARYVIRTUAL

currencyCode*enum

Example: "GBP"

createDate*string (date-time)

identifiers*array of object

state*enum

Account state

INITIALIZINGREADYBLOCKEDCLOSEDSUSPENDED

balance*object

Request

const response = await fetch('api-url/v1/partner/customers/{customerId}/accounts/{accountId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "primaryAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "PRIMARY",
  "currencyCode": "GBP",
  "createDate": "2025-02-05T06:49:06.827Z",
  "identifiers": [
    {
      "type": "UK_ACCOUNT",
      "beneficiary": "text",
      "bankAddress": "text",
      "data": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      }
    }
  ],
  "state": "INITIALIZING",
  "balance": {
    "currency": "GBP",
    "availableBalance": 1,
    "ledgerBalance": 1,
    "pendingCredits": 1
  }
}