Sign in
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"
}

Changes

Changed in 1 of the 6 revisions of this API.2

  • a3c4e27426152See the full diff
    • ○

      the endpoint scheme security HMACAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security authToken was removed from the API

      api-security-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog