Skip to main content
POST
Create payout request

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Use the JWT token obtained from the login endpoint in the Authorization header as 'Bearer {token}'.

Path Parameters

merchantId
string
required

ID of the submerchant requesting the payout

Example:

"2vorkDcXyvzifL63YX09S9VqcnI"

Body

application/json
amount
number
required

Payout amount in reais (BRL). Accepts decimals (e.g., 100.50 = R$ 100.50). Minimum R$ 1.00.

Required range: x >= 1
Example:

100

Response

Payout request created successfully

id
string

Unique identifier of the created payout request

Example:

"2vorkDcXyvzifL63YX09S9VqcnI"