Create Payout

Create a new payout.

To test different scenarios for each market, please refer to the Examples tab on the right side of the screen.

Each market has a dedicated example. Use the following amounts to simulate specific statuses:

99997 or 99996 → COMPLETED, 99999 or 99998 → ERROR, any other amount → IN PROGRESS.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 100

Id of the transaction defined by the user. If the id already exists, the transaction cannot be carried out.

number
required

Transaction amount

sourceAccount
object
deprecated

Source account information. Preferably, use the sourceAccountId field instead of this one.

string

Source account ID. Account from which the transaction will be made.

uri
length between 1 and 2083

Specifies the URL to which the callback will be sent when the transaction status changes. The callback is sent as a POST request with a JSON body containing the transaction details, using the same schema as the Get Payout endpoint.

destinationAccount
required
Headers
integer

ID of a child company for authentication. If not provided, the parent company will be authenticated.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json