Create conversion
Creates a one-shot conversion.
A conversion handles the rails (pull from source, push to destination) for a single trade. Pricing is delegated to the Swaps API; supply swap_quote_id to lock a previously created quote, or omit it to settle at market when the deposit lands.
The from.source.type field selects how funds are sourced:
balance— debit the account’s existing ledger balance. Synchronous: the response returnsstatus: completedwithto.amountandfeespopulated. Noinboundblock is returned.external_wallet— PWS provisions a single-use deposit address (returned underinbound). The partner pushes funds to that address; the conversion progresses asynchronously throughpending_deposit→converting→settling→completed.
For a recurring inbound endpoint that fires on every matching credit, use POST /v1/conversion-rules instead.
Authorizations
Headers
Client-generated UUIDv4 for safe retries. Sent as the Idempotency-Key HTTP header. Replayed responses include the Idempotent-Replayed: true header.
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
ID of the account the request applies to. This refers to one of the accounts held by the user the request is acting on behalf of (typically the user's main account, but any of the user's accounts is accepted). Routes the request to that specific account container. Canonical identifier for an account in the Payward public API.
14 - 42Body
Request to create a one-shot conversion.
Pricing: omit swap_quote_id for indicative pricing (executes at market when the deposit lands); supply swap_quote_id to lock a previously created Swap quote. The supplied from/to assets must match the locked quote.
Source side of a conversion request. asset.amount is optional: omit it to convert whatever the inbound deposit credits (price-locked or indicative); set it to convert a fixed amount (required for source.type: balance).
Destination side of a conversion request. The amount delivered is computed from the source amount and the trade rate, so only the asset reference (symbol + type) is supplied here.
Optional ID of a Swap quote to lock. Mutually compatible with both source types.
1 - 64Partner-supplied identifier for this conversion in the partner's system. Echoed back on the response.
128Response
Successful response
A conversion resource.
Lifecycle for push-sourced conversions: pending_deposit → converting → settling → completed. Balance-sourced conversions skip pending_deposit. Terminal failures populate failure_reason; expired push-sourced conversions land in expired.