Skip to main content

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/transfers
METHOD
GET

Query params

ParameterTypeRequiredDescription
pageintegeroptionalPage number. Default: 1.
page_sizeintegeroptionalRecords per page. Default: 50. Maximum: 200.
statusstringoptionalFilters by payout status.
Example call
GET /finance/v1/transfers?status=SETTLED&page=1

Response

STATUS
200
Response 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

FieldTypeDescription
itemsarrayPayouts, newest first.
pageintegerCurrent page.
page_sizeintegerRequested page size.
totalintegerTotal number of payouts matching the filters.

Object in items

FieldTypeDescription
transfer_keystringUnique payout key — the same one referenced by the TRANSFER_SETTLED movements in the statement.
amountstringNet amount of the payout (carried credits minus netted clawbacks).
statusstringPayout status. See the table below.
scheduled_datestringScheduled execution date.
settled_atstringSettlement instant. null until settled.

Payout statuses

StatusMeaning
PENDINGPayout assembled, awaiting execution on the scheduled date.
PROCESSINGTransfer instruction sent, awaiting settlement.
SETTLEDSettled in your account. Terminal status.
FAILEDThe transfer failed; it will be retried. The amounts return to your available position until the next attempt.

Possible errors

StatusDescription
400Invalid filter or pagination parameter.
401 / 403Authentication or authorization failure.
500 / 503Internal error or service unavailable — safe to retry.