v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Retornando antecipações

Retorna uma lista contendo objetos de antecipações.

get/recipients/{recipient_id}/bulk_anticipations

Path parameters

recipient_idstring required

Query parameters

countstring

Retorna n resultados, com um máximo de 1000

pagestring

Útil para implementação de uma paginação de resultados

amountstring

Filtro de amount

feestring

Filtro de fee

anticipation_feestring

Filtro de anticipation fee

idstring

ID da antecipação procurada

payment_datestring

Data de pagamento procurada

Response

200

idstring

statusstring

amountinteger

feeinteger

fraud_coverage_feeinteger

anticipation_feeinteger

automatic_transferboolean

typestring

timeframestring

payment_datestring

created_atstring

updated_atstring

{"stackTrail":"paths:/recipients/{recipient_id}/bulk_anticipations:get:responses:200:content:application/json:schema:items:properties:anticipation_tax","oasType":"schema","type":"unknown"}

Example response

[
  {
    "id": "ba_123456789",
    "status": "approved",
    "amount": 100000,
    "fee": 5000,
    "anticipation_fee": 3000,
    "type": "spot",
    "timeframe": "start",
    "payment_date": "2025-08-20T00:00:00.000Z",
    "created_at": "2025-08-19T14:23:00.000Z",
    "updated_at": "2025-08-20T10:15:00.000Z"
  }
]