Create a payout
POST {{baseUrl}}/v1/businessAccount/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.
destination object (REQUIRED) The destination bank account.
type string (REQUIRED)
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.
Request Body
{"idempotencyKey"=>"{{$guid}}", "destination"=>{"type"=>"wire", "id"=>"3016a9ca-fe2a-48f4-80d7-16ecfec1de6e"}, "amount"=>{"amount"=>"3.14", "currency"=>"USD"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"data":{"id":"a1cbd881-ee22-43ec-91cf-dfecabaea3eb","amount":{"amount":"3.14","currency":"USD"},"status":"pending","sourceWalletId":"1002753955","destination":{"type":"wire","id":"3016a9ca-fe2a-48f4-80d7-16ecfec1de6e","name":"Banco Nacional de México ****7771"},"createDate":"2024-01-16T21:55:02.452Z","updateDate":"2024-01-16T21:55:02.452Z"}}