Skip to main content
POST

Authorizations

​
X-Auth-Client
string
header
required

Your workspace client id.

All calls must include four headers:

  • X-Auth-Client — your workspace client id
  • X-Auth-Timestamp — Unix seconds
  • X-Auth-Nonce — 16-byte random hex
  • X-Auth-Signature — hex(HMAC-SHA256( {client_id}:{timestamp}:{nonce}:{raw_body}, client_secret))

The playground computes the timestamp, nonce and signature for you.

​
X-Playground-Client-Secret
string
header
required

Your sandbox client secret. The playground uses it to sign the request in your browser and removes it before the request is sent. Never send your client secret as a header in your own integration.

Body

application/json
​
from_amount
string
required

Decimal amount in major units of from_currency; greater than 0 and at most 1000000000

Maximum string length: 30
​
from_currency
string
required

NGN, BTC, USDT or USDC, case-insensitive (trimmed and upper-cased). One of from_currency and to_currency must be NGN and they must differ.

Maximum string length: 10
Pattern: ^\s*[A-Za-z]+\s*$
​
idempotency_key
string
required

Your unique key for this conversion, so a retry is safe.

Maximum string length: 100
​
to_currency
string
required

NGN, BTC, USDT or USDC, case-insensitive (trimmed and upper-cased).

Maximum string length: 10
Pattern: ^\s*[A-Za-z]+\s*$

Response

Created. Not returned today (see the description); the shape is the conversion record a quote-backed execute produces, with status pending or debited when settlement is left to the recovery worker.

Successful responses are wrapped in this envelope, and so are errors a handler answers itself (request body and field validation, some not-found and conflict cases, ORG_NOT_ACTIVE): success is false and error carries a code and message. Errors raised by authentication and by the services behind a handler are a Problem instead.

​
success
boolean
required

true on success

​
timestamp
string<date-time>
required

When the response was written.

​
data
object

The payload; its shape is given per operation. Omitted when there is none.

​
error
object
​
message
string

Human-readable summary; omitted when empty.

​
metadata
object

List metadata. Page lists set page, per_page, total and total_pages; offset and cursor lists set limit, offset, has_more and next_cursor. Zero and empty fields are omitted, and metadata is absent when nothing is set.

​
request_id
string

Set on error envelopes: the request's correlation id (req_ followed by a UUID), the same value as the X-Correlation-ID response header. Quote it to support.