Account Types

Creating an Account

Create an account for a customer via Create Account

POST /v1/accounts

The account will be created in the legal name of the customer it is associated with. The account_name field is used for internal reference purposes only and does not determine the account holder name displayed on the payment scheme. The account owner name is always taken from the customer record.

📘

Before creating an account, the customer must first be approved and successfully onboarded to the relevant currency. See Currency Onboarding for more details.

Retrieving Accounts

List all accounts for your organisation via List All Accounts

GET /v1/accounts

List accounts for a specific customer via List Customer Accounts

GET /v1/customers/{customer_id}/accounts

Get a single account via Get Account

GET /v1/accounts/{account_id}

Example account response:

{
  "id": "018c584f-158d-71ed-abe2-9895ea3e6544",
  "customer_id": "018c355c-2413-16df-509f-40e71b142eb3",
  "external_id": null,
  "account_name": "AED Payouts",
  "status": "open",
  "current_balance": 1000000,
  "available_balance": 1000000,
  "default_details": {
    "iban": "AE080037164338245868134"
  },
  "currency": "AED",
  "account_type": "virtual"
}

📘

Balances are returned in minor currency units (i.e. 1000000 = 10,000.00 AED).

Updating an Account

Update an account's name or external ID via Update Account

PATCH /v1/accounts/{account_id}

Account Confirmation Letter

Download an account confirmation letter via Get Account Confirmation Letter

GET /v1/accounts/{account_id}/confirmation-letter

Account Balance History

Retrieve an account's balance history over time via Get Account Balance History

GET /v1/accounts/{account_id}/history

Funding an Account

In production, accounts are funded by sending a payment to the account’s IBAN or account details. Once the funds have been received and settled, an inbound_local_payment_settled webhook event is triggered to notify your integration.

In sandbox, you can fund an account directly using the Simulate Inbound Payment endpoint. This allows you to test inbound payment flows without sending real funds.