Skip to main content
GET
/
v1
/
payout-requests
/
{payoutRequestId}
Get payout request by ID
curl --request GET \
  --url https://api-global.fastpaybrasil.com/v1/payout-requests/{payoutRequestId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "2vorkDcXyvzifL63YX09S9VqcnI",
  "merchantId": "36OO3bcGjhPjjF3tzrqOGcmQuKo",
  "amount": 10000,
  "currency": "BRL",
  "payoutFee": 100,
  "netAmount": 9900,
  "status": "pending",
  "externalAccountDetails": {
    "type": "pix",
    "pixKey": "12345678000199"
  },
  "rejectionReason": null,
  "processedAt": null,
  "createdAt": "2025-12-04T18:45:52.988Z",
  "updatedAt": "2025-12-04T18:45:52.988Z"
}

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
integer

Gross amount requested (in cents)

Example:

10000

​
currency
string

Currency (always BRL for submerchants)

Example:

"BRL"

​
payoutFee
integer

Calculated payout fee (in cents)

Example:

100

​
netAmount
integer

Net amount that will be transferred after fee deduction

Example:

9900

​
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"