Create a payout

POST {{baseUrl}}/v1/payouts

Create a crypto payout.

The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts:

Body Params

idempotencyKey string (REQUIRED) Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

source object A source wallet location.

• type string (REQUIRED)

• id string (REQUIRED) The id of the wallet.

• identities array

destination object (REQUIRED) The destination.

• type string (REQUIRED) The destination type.

• id string (REQUIRED) Unique system generated identifier for the entity.

amount object (REQUIRED)

• amount string (REQUIRED) Magnitude of the amount, in units of the currency, with a ..

• currency string (REQUIRED) Currency code for the amount.

toAmount object

• currency string (REQUIRED) Currency code for the amount.

Request Body

{"idempotencyKey"=>"{{$guid}}", "destination"=>{"type"=>"address_book", "id"=>"b8627ae8-732b-4d25-b947-1df8f4007a29"}, "amount"=>{"amount"=>"3.14", "currency"=>"BTC"}, "source"=>{"type"=>"wallet", "id"=>"12345", "identities"=>[{"type"=>"business", "name"=>"Satoshi Nakamoto", "addresses"=>[{"line1"=>"100 Money Street", "city"=>"Boston", "district"=>"MA", "postalCode"=>"01234", "country"=>"US", "line2"=>"Suite 1"}, {"line1"=>"100 Money Street", "city"=>"Boston", "district"=>"MA", "postalCode"=>"01234", "country"=>"US", "line2"=>"Suite 1"}]}, {"type"=>"individual", "name"=>"Satoshi Nakamoto", "addresses"=>[{"line1"=>"100 Money Street", "city"=>"Boston", "district"=>"MA", "postalCode"=>"01234", "country"=>"US", "line2"=>"Suite 1"}, {"line1"=>"100 Money Street", "city"=>"Boston", "district"=>"MA", "postalCode"=>"01234", "country"=>"US", "line2"=>"Suite 1"}]}]}, "toAmount"=>{"currency"=>"ETH"}}

HEADERS

RESPONSES

status: Created

{"data":{"id":"154e9724-2f07-42d7-87a6-7afbac92d06e","destination":{"type":"address_book","id":"2b9f9ed9-ac9d-5f6e-954b-a29e03ee3259"},"amount":{"amount":"3001.00","currency":"USD"},"toAmount":{"currency":"ETH"},"createDate":"2024-01-17T21:39:51.687286Z","updateDate":"2024-01-17T21:39:51.687286Z","sourceWalletId":"1000594146","status":"pending"}}