API Reference

Create a conversion

post
https://api.stage.payouts.com/conversion/create

Required MFA token action for this API:

  • CREATE_CONVERSION

Required permissions for this API:

  • WRITE:CONVERSIONS
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
applicationFeeOptions
array of objects

The application fee options applied to the transaction.

applicationFeeOptions
string

Amount in buy_currency that the client buys. Must be specified if sell_amount is not specified.

string
required

Currency that the client buys (in 3-letter ISO-4217 format).

string

Date on which the conversion will be settled. conversion_date defaults to current date, if funding is available, unless specified.

fundingSource
object

The funding information for this conversion. By default (when the funding object is not specified), conversions will source funds from the wallet.

metadata
object

A set of key-value pairs for storing your own data together with the conversion.

string

LockFX users must supply a valid LockFX Quote ID.

string
required

Client-generated idempotency key. Must be unique per request attempt. Conversion requests with the same request_id will be rejected. Parameter supports a maximum of 64 characters.

string

Amount in sell_currency that the client sells. Must be specified if buy_amount is not specified.

string
required

Currency that the client sells (in 3-letter ISO-4217 format).

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?