Consultar uma cobrança.
Retorna uma venda pelo id público. O alcance é o mesmo da listagem: uma chave de seller abre as vendas dela, e a chave de um seller PARCEIRO abre também as da carteira — com o mesmo recorte de dado pessoal descrito em GET /charges. Exige a permissão charges:read.
Retorna uma venda pelo id público. O alcance é o mesmo da listagem: uma chave de seller abre as vendas dela, e a chave de um seller PARCEIRO abre também as da carteira — com o mesmo recorte de dado pessoal descrito em GET /charges. Exige a permissão charges:read.
Autorização
ApiKeyAuth Em: header
Parâmetros de caminho
^ch_[A-Za-z0-9]+$Corpo da resposta
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/charges/ch_xxx"{ "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 }}Criar uma cobrança. POST
Cria uma cobrança usando um meio de pagamento tokenizado, PIX ou boleto. Para cobranças no cartão, use capture_method=automatic para pagar na hora ou capture_method=manual para autorizar agora e capturar depois. Para PIX e boleto os artefatos de pagamento voltam de forma SÍNCRONA nesta resposta: uma cobrança PIX traz um objeto `pix` no topo com a imagem do QR Code (`qr_code`) e o copia-e-cola (`qr_code_text`); uma cobrança de boleto traz um objeto `boleto` no topo com o código de barras, a linha digitável e a URL do PDF. Os mesmos artefatos também chegam no webhook `charge.created` e no GET /charges/{id}, então dá para reconciliar por qualquer um dos três canais.
Capturar uma cobrança autorizada. POST
Captura uma cobrança no cartão criada com capture_method=manual e status=authorized.