Skip to main content
POST

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your API secret.

API-Timestamp
string
header
required

Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.

Path Parameters

account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42
conversion_rule_id
string<uuid>
required

Identifier of the conversion rule to receive the simulated deposit.

Body

application/json
amount
string
required

Amount to simulate as received on the conversion rule's inbound side, in its source asset.

Required string length: 1 - 64
Pattern: ^[+]?([0-9]*[1-9][0-9]*([.][0-9]*)?|[0-9]*[.][0-9]*[1-9][0-9]*)$
name
string

Payer name copied into the simulated deposit. When omitted, a fiat deposit uses the account holder's name, so it passes the payer name check. Ignored for a deposit_held outcome, which always uses a name that does not match the account holder.

Required string length: 1 - 128
outcome
enum<string>
default:deposit_success

Deposit outcome to simulate.

Available options:
deposit_failed,
deposit_held,
deposit_success
reference
string

Payment reference copied into the simulated deposit for test reconciliation. Surrounding whitespace is removed.

Required string length: 1 - 140

Response

Simulated deposit accepted for processing.

data
object
required

Result of a conversion deposit simulation request.