v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Cancelando uma antecipação pending

Cancela uma antecipação com status pending. Enquanto a antecipação foi criada e o Pagar.me ainda não a confirmou, você pode cancelar a antecipação a qualquer momento.

post/recipients/{recipient_id}/bulk_anticipations/{bulk_anticipation_id}/cancel

Path parameters

recipient_idstring required

ID de recebedor desejado

bulk_anticipation_idstring required

ID da antecipação desejada

Response

200

idstring
statusstring
amountinteger
feeinteger
fraud_coverage_feeinteger
anticipation_feeinteger
automatic_transferboolean
typestring
timeframestring
payment_datestring
created_atstring
updated_atstring
anticipation_taxnumber

Example response

{
  "id": "ba_123456789",
  "status": "canceled",
  "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",
  "anticipation_tax": 0.018
}