Accounts

This section covers the different types of accounts supported by the Partner API, including primary accounts and virtual accounts.

Our platform provides two options for accounts on partner platform, Primary Accounts and Virtual Accounts. For both types, account creation is an asynchronous operation on the platform, that's why once request is sent and response received, you might need to wait until account is ready.

Account statuses

You can use Get Account Details API to pull current account status, you can initiate payments or other interactions once you see it's READY

Status	Description
INITIALIZING	Account is not ready to use.
READY	Account ready to use.
SUSPENDED	Account suspended for AML or compliance reasons.
CLOSED	Account permanently closed.

All fund activities for both primary and virtual accounts booked in separate isolated ledgers that maintains separate balances.

Primary Accounts

Primary accounts can be used for a variety of purposes, such as facilitating cross-border transactions, receiving payments from multiple sources, and managing finances for e-commerce businesses.

Please refer to Primary Accounts section for more information about how to create primary accounts.

Primary Accounts

Virtual Accounts

Virtual accounts requires an existing primary account as a parent, and it uses the same currency and safe-guarding relationship as the parent account.

Please refer to Virtual Accounts section for more information about how to create virtual accounts.

Virtual Accounts

List accounts

You can get all the accounts created under your partner organisation using the following API.

Get all accounts

GEThttps://api.algbralabs.com/v1/partner/accounts

Query parameters

Header parameters

Response

200

List of accounts available to the partner

Body

application/json

id*string (uuid)

partnerId*string (uuid)

primaryAccountId*nullable string (uuid)

type*enum

PRIMARYVIRTUAL

currencyCode*enum

Example: "GBP"

AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNSZLETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSEKCHECHWSYPTWDTJSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPTXAGAFAFIMADPESPFRFAOKAORRURATSAYMAZMBYBBYRBECBEFBELBADBRBBRRBGJCYPCSKECSECVGQEEEKXEUGEKDDMDEMGHCGHPGRDGWEITLIEPLVLZALLTLLUCLUFLULMGFMLFMTLMROMZENLGPLZPTEROKSTDCSDSKKSITRHDESAESBSDDSRGTJRTPETRLTMMUAKUSSVEBVEFYUDZRNZMKZWNZWR

createDate*string (date-time)

identifiers*array of PartnerAccountIdentifierResponse (object)

state*PartnerAccountStateResponse (object)

balance*PartnerAccountBalanceResponse (object)

Request

JavaScriptCurl

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

Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "partnerId": "123e4567-e89b-12d3-a456-426614174000",
    "primaryAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "PRIMARY",
    "currencyCode": "GBP",
    "createDate": "2024-07-27T06:36:47.924Z",
    "identifiers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "UK_ACCOUNT",
        "beneficiary": "text",
        "bankAddress": "text",
        "data": {
          "type": "UK_ACCOUNT",
          "sortCode": "010102",
          "accountNumber": "12345678"
        },
        "createDate": "2024-07-27T06:36:47.924Z"
      }
    ],
    "state": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "INITIALIZING",
      "lastUpdated": "2024-07-27T06:36:47.924Z",
      "createDate": "2024-07-27T06:36:47.924Z"
    },
    "balance": {
      "currency": "GBP",
      "availableBalance": 0,
      "ledgerBalance": 0,
      "pendingCredits": 0
    }
  }
]

Get Account Details

GEThttps://api.algbralabs.com/v1/partner/accounts/{accountId}

Path parameters

:accountId*string

Header parameters

Response

200

Returns the account details

Body

application/json

id*string (uuid)

partnerId*string (uuid)

primaryAccountId*nullable string (uuid)

type*enum

PRIMARYVIRTUAL

currencyCode*enum

Example: "GBP"

AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNSZLETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSEKCHECHWSYPTWDTJSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPTXAGAFAFIMADPESPFRFAOKAORRURATSAYMAZMBYBBYRBECBEFBELBADBRBBRRBGJCYPCSKECSECVGQEEEKXEUGEKDDMDEMGHCGHPGRDGWEITLIEPLVLZALLTLLUCLUFLULMGFMLFMTLMROMZENLGPLZPTEROKSTDCSDSKKSITRHDESAESBSDDSRGTJRTPETRLTMMUAKUSSVEBVEFYUDZRNZMKZWNZWR

createDate*string (date-time)

identifiers*array of PartnerAccountIdentifierResponse (object)

state*PartnerAccountStateResponse (object)

balance*PartnerAccountBalanceResponse (object)

Request

JavaScriptCurl

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

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "primaryAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "PRIMARY",
  "currencyCode": "GBP",
  "createDate": "2024-07-27T06:36:47.924Z",
  "identifiers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "UK_ACCOUNT",
      "beneficiary": "text",
      "bankAddress": "text",
      "data": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      },
      "createDate": "2024-07-27T06:36:47.924Z"
    }
  ],
  "state": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "INITIALIZING",
    "lastUpdated": "2024-07-27T06:36:47.924Z",
    "createDate": "2024-07-27T06:36:47.924Z"
  },
  "balance": {
    "currency": "GBP",
    "availableBalance": 0,
    "ledgerBalance": 0,
    "pendingCredits": 0
  }
}