Skip to main content
GET
/
v1
/
payout-requests
List payout requests
curl --request GET \
  --url https://api-global.fastpaybrasil.com/v1/payout-requests \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ],
  "page": 1,
  "pages": 10,
  "total": 100,
  "size": 10
}

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}'.

Query Parameters

​
merchantId
string

Filter by submerchant ID

Example:

"36OO3bcGjhPjjF3tzrqOGcmQuKo"

​
status
enum<string>

Filter by request status

Available options:
pending,
approved,
rejected
Example:

"pending"

​
currency
string

Filter by currency

Example:

"BRL"

​
createdAt
string<date>

Filter by creation date

Example:

"2025-12-01"

​
processedAt
string<date>

Filter by processing date

Example:

"2025-12-04"

​
page
integer
default:1

Page number (starts at 1)

Example:

1

​
size
integer
default:10

Number of items per page

Example:

20

​
orderBy
string

Order results by fields (comma-separated). Prefix with - for descending order.

Example:

"createdAt,-amount"

Response

Successfully retrieved the list of payout requests

​
data
object[]

Array of payout requests in the current page

​
page
integer

Current page number

Example:

1

​
pages
integer

Total number of pages available

Example:

10

​
total
integer

Total number of payout requests across all pages

Example:

100

​
size
integer

Number of payout requests per page

Example:

10