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
​
amount
string
required

Positive whole number in base units of currency (e.g. satoshis, 10^-6 for USDT and USDC)

Pattern: ^[0-9]+$
​
currency
string
required

Alphabetic currency code, upper-cased by the server

Maximum string length: 10
​
idempotency_key
string
required

A retry with the same key returns the original transfer

Maximum string length: 100
​
recipient_company_id
string<uuid>
required

The receiving organisation; cannot be your own

​
reference
string
required

Your unique reference for this transfer.

Maximum string length: 100

Response

Created

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

Fields are omitted when empty.

​
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.