Skip to main content
POST
Create offramp account
Creates an offramp account linked to a fiat beneficiary.

Authorizations

x-api-key
string
header
required

Requires authentication via API key and HMAC signature.

  • x-api-key: Your API key generated from your Onboard Business dashboard.
  • x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds
  • x-signature: SHA256 HMAC HEX signature calculated over t={x-timestamp}&{requestBody} using your API Secret.

Body

application/json
payoutCurrency
string
required

Currency in which payouts will be made to the beneficiary.

Example:

"KES"

beneficiaryId
string<uuid>
required

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

Response

Offramp account created

id
string<uuid>
required

Unique identifier for the offramp account.

beneficiary
object
required

Fiat beneficiary object

payoutCurrency
string
required
Example:

"KES"

status
enum<string>

Status of the offramp account.

Available options:
ACTIVE,
INACTIVE,
SUSPENDED
createdDate
string<date-time>