Skip to main content
GET
Get payout request by ID

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

payoutRequestId
string
required

ID of the payout request

Example:

"2vorkDcXyvzifL63YX09S9VqcnI"

Response

Payout request found successfully

id
string

Unique identifier of the request

Example:

"2vorkDcXyvzifL63YX09S9VqcnI"

merchantId
string

ID of the submerchant that requested the payout

Example:

"36OO3bcGjhPjjF3tzrqOGcmQuKo"

amount
number

Gross amount requested (in reais / BRL)

Example:

100

currency
string

Currency (always BRL for submerchants)

Example:

"BRL"

payoutFee
number

Calculated payout fee (in reais / BRL)

Example:

1

netAmount
number

Net amount that will be transferred after fee deduction (in reais / BRL)

Example:

99

status
enum<string>

Current status

Available options:
pending,
approved,
rejected
Example:

"pending"

externalAccountDetails
object

Account details for payout (PIX with CNPJ)

rejectionReason
string | null

Rejection reason (only if status = 'rejected')

Example:

null

processedAt
string<date-time> | null

Processing date/time (only if approved or rejected)

Example:

null

createdAt
string<date-time>

Creation date/time

Example:

"2025-12-04T18:45:52.988Z"

updatedAt
string<date-time>

Last update date/time

Example:

"2025-12-04T18:45:52.988Z"

Legal name of the submerchant (included in the list response).

Example:

"ACME PAGAMENTOS LTDA"

merchantEmail
string

Contact email of the submerchant (included in the list response).