Skip to main content
GET
Returns one conversion record. This is the status source of truth: in external mode, poll this endpoint until status is completed or failed — never treat the execute 201 as final. Detail reads keep working even while conversions are disabled platform-wide.

Authorization

Dual auth — a secret API key with the conversions:read scope, or a dashboard JWT with the conversions:view permission. Dashboard sessions must belong to a merchant_admin, merchant_member or super_admin role; API-key callers are gated by scope only. See the Authentication guide. Rate limit: the global default.
On completed, reconcile your books against creditAmountStr — the exact amount actually credited, as a decimal string — never against toAmount or the quote. It is normally at least the quoted minimum, but a late-deposit shortfall fill can complete below it. On failed, the full source amount (commission included) was credited back; render merchantMessage.

Path parameters

string
required
The conversion id. A malformed id is 400 INVALID_ID; a foreign or unknown id is 404 CONVERSION_NOT_FOUND (the response never reveals whether an id exists under another account).

Response fields

The full record shape is documented in Conversion record fields. Key fields for polling:
string
One of initializing, pending, processing, completed, failed, cancelled — see the status lifecycle. Poll until completed or failed.
string
External mode: the exact amount credited as a decimal string — normally at least the quoted minimum, but a late-deposit shortfall fill can be lower. Reconcile on this, not on toAmount or the quote.
string
Merchant-safe explanation of a terminal outcome. The only failure text you should ever render.
Never returned (stripped at the API boundary): the internal error text, the provider request id, the provider deposit address, the exact funding amounts and both on-chain transaction hashes. Do not build against them.

Errors

See also