Sign in

v4

latestOpenAPI 3.0.3UNLICENSED2026-08-0896235396.5 KB
ledger-offramp accounts

Create offramp account

Create offramp account with beneficiary id.

post/ledger/offramp-accounts

Request body

payoutCurrencystring required

Currency in which payouts will be made to the beneficiary.

beneficiaryIdstring uuid required

Identifier of an existing beneficiary to be linked to the offramp account. Should be in the same currency as payoutCurrency.

Example request

{
  "payoutCurrency": "KES"
}

Response

Offramp account created

idstring uuid required

Unique identifier for the offramp account.

payoutCurrencystring required
status'ACTIVE' | 'INACTIVE' | 'SUSPENDED'

Status of the offramp account.

createdDatestring date-time

Example response

{
  "payoutCurrency": "KES"
}