Bunne Docs
Cobranças

Cancelar uma cobrança agendada antes da execução.

Cancela uma cobrança em `scheduled` antes do `execute_at` (transita `scheduled` -> `canceled`). Depois que o executor reivindica a cobrança ela não é mais cancelável e a resposta é `charge_not_cancelable` (409). Exige a permissão charges:create.

POST
/charges/{id}/cancel

Cancela uma cobrança em scheduled antes do execute_at (transita scheduled -> canceled). Depois que o executor reivindica a cobrança ela não é mais cancelável e a resposta é charge_not_cancelable (409). Exige a permissão charges:create.

Autorização

ApiKeyAuth
AutorizaçãoBearer <token>

Em: header

Parâmetros de caminho

id*string
Match^ch_[A-Za-z0-9]+$

Parâmetros de cabeçalho

Idempotency-Key?string
Tamanho1 <= length <= 255

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/charges/ch_xxx/cancel" \  -H "Idempotency-Key: order_123_attempt_1"
{  "id": "string",  "object": "charge",  "status": "scheduled",  "amount_cents": 1,  "discount": {    "amount_cents": 0,    "list_amount_cents": 0  },  "currency": "BRL",  "payment_method": "credit_card",  "capture_method": "automatic",  "captured": true,  "installments": 1,  "buyer": {    "name": "string",    "email": "user@example.com",    "phone": "string",    "document": "string",    "document_type": "cpf",    "ip": "string",    "address": {      "line_1": "string",      "line_2": "string",      "zip_code": "string",      "city": "string",      "state": "string",      "country": "string"    }  },  "acquirer_code": "string",  "acquirer_transaction_id": "string",  "authorization_code": "string",  "acquirer_return_code": "string",  "acquirer_return_message": "string",  "refused_reason": "string",  "next_action": {    "type": "three_ds_challenge",    "three_ds": {      "authentication_id": "string",      "acquirer": "string",      "sdk_payload": {}    }  },  "metadata": {},  "split": [    {      "recipient_seller_id": "string",      "amount_cents": 1    }  ],  "scheduled_for": "2019-08-24T14:15:22Z",  "canceled_at": "2019-08-24T14:15:22Z",  "paid_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "request_id": "req_xxx",  "presentment": {    "currency": "USD",    "amount_cents": 0  },  "fx": {    "base_currency": "BRL",    "rate_micros": 0,    "quoted_at": "2019-08-24T14:15:22Z"  },  "pix": {    "qr_code": "string",    "qr_code_text": "string",    "expires_at": "2019-08-24T14:15:22Z"  },  "boleto": {    "barcode": "string",    "digitable_line": "string",    "pdf_url": "http://example.com",    "due_date": "2019-08-24"  },  "reservation": {    "id": "string",    "object": "string",    "check_in": "2019-08-24",    "check_out": "2019-08-24",    "nights": 0,    "code": "string",    "channel": "string",    "status": "confirmed",    "rate_type": "refundable",    "guarantee_nights": 0,    "guest_name": "string"  },  "seller_id": "string",  "partner_surcharge": {    "amount_cents": 0,    "released_cents": 0  }}

Capturar uma cobrança autorizada. POST

Captura uma cobrança no cartão criada com capture_method=manual e status=authorized.

Concluir uma cobrança com 3-D Secure. POST

Conclui uma cobrança em requires_action depois que o cliente executa o desafio 3DS. Autoriza apenas na adquirente vinculada no momento do prepare; um confirm duplicado é um replay idempotente.