Partner Banking Docs
HomeStatus
  • Introduction
  • Getting Started
    • Partner Onboarding
    • Security
    • Authentication
    • Payload Signing
    • API Hosts
  • Concepts
    • API Connectivity Test
    • Accounts
      • Primary Accounts
      • Virtual Accounts
      • Getting Accounts
      • Balances Explained
    • Payments
      • Payment Simulation
      • Inbound Payments
      • Internal Payments
      • Counterparty Validation
      • Outbound Payments
      • Payment Details
        • Payment Details with ID
        • Payment Details with External Reference
    • Transactions
      • Activity Feed
    • Webhooks
      • Webhook Guidelines
      • Supported Events
      • Testing Webhooks
  • Full Specification
  • Return Home
Powered by GitBook
On this page

Was this helpful?

  1. Concepts

Accounts

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

PreviousAPI Connectivity TestNextPrimary Accounts

Last updated 5 months ago

Was this helpful?

Our platform provides two options for accounts on partner platform, and . 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.

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.

List accounts

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

Get Account Details

Virtual Accounts
Primary Accounts
Primary Accounts
Virtual Accounts

Get all accounts

get
Query parameters
primaryAccountIdstring · uuid | nullableRequired
pagenumberRequiredDefault: 1
limitnumber · max: 100RequiredDefault: 10
Header parameters
authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Responses
200
List of accounts available to the partner
application/json
Responseall of
objectOptional
and
400
Input validation error
application/json
422
Unprocessable entity
application/json
get
GET /v1/partner/accounts?types=PRIMARY&primaryAccountId=123e4567-e89b-12d3-a456-426614174000&states=INITIALIZING&page=1&limit=10 HTTP/1.1
Host: api-url
Accept: */*
{
  "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-05-19T15:48:37.882Z",
      "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

get
Path parameters
accountIdstringRequired
Header parameters
authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Responses
200
Returns the account details
application/json
400
Input validation error
application/json
403
Forbidden
application/json
404
Account not found
application/json
422
Unprocessable entity
application/json
get
GET /v1/partner/accounts/{accountId} HTTP/1.1
Host: api-url
Accept: */*
{
  "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-05-19T15:48:37.882Z",
  "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
  }
}
  • Account statuses
  • Primary Accounts
  • Virtual Accounts
  • List accounts
  • GETGet all accounts
  • Get Account Details
  • GETGet account