List payouts
Surface not available yet
The finance endpoints described in this section are not published on the external gateway yet. This section describes the target contract and may change before release — confirm availability with the Integration team (api@qitech.com.br) before building against it.
Returns the paginated list of commission payouts executed (or in execution) to your account.
Request
ENDPOINT
/finance/v1/transfersMETHOD
GETQuery params
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | optional | Page number. Default: 1. |
page_size | integer | optional | Records per page. Default: 50. Maximum: 200. |
status | string | optional | Filters by payout status. |
Example call
GET /finance/v1/transfers?status=SETTLED&page=1
Response
STATUS
200Response Body
{
"items": [
{
"transfer_key": "3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
"amount": "980.10",
"status": "SETTLED",
"scheduled_date": "2026-07-21",
"settled_at": "2026-07-21T09:00:12.000Z"
},
{
"transfer_key": "4d5e6f7a-8b9c-4d0e-1f2a-3b4c5d6e7f8a",
"amount": "1250.40",
"status": "PENDING",
"scheduled_date": "2026-07-28",
"settled_at": null
}
],
"page": 1,
"page_size": 50,
"total": 2
}
Response attributes
| Field | Type | Description |
|---|---|---|
items | array | Payouts, newest first. |
page | integer | Current page. |
page_size | integer | Requested page size. |
total | integer | Total number of payouts matching the filters. |
Object in items
| Field | Type | Description |
|---|---|---|
transfer_key | string | Unique payout key — the same one referenced by the TRANSFER_SETTLED movements in the statement. |
amount | string | Net amount of the payout (carried credits minus netted clawbacks). |
status | string | Payout status. See the table below. |
scheduled_date | string | Scheduled execution date. |
settled_at | string | Settlement instant. null until settled. |
Payout statuses
| Status | Meaning |
|---|---|
PENDING | Payout assembled, awaiting execution on the scheduled date. |
PROCESSING | Transfer instruction sent, awaiting settlement. |
SETTLED | Settled in your account. Terminal status. |
FAILED | The transfer failed; it will be retried. The amounts return to your available position until the next attempt. |
Possible errors
| Status | Description |
|---|---|
400 | Invalid filter or pagination parameter. |
401 / 403 | Authentication or authorization failure. |
500 / 503 | Internal error or service unavailable — safe to retry. |