Consultar cobrança
Retorna uma cobrança da sua conta com valores, tarifas, situação do reembolso e os dados do pagamento confirmado.
apiKeyAuthorizationBearer <token>Chave de API gerada no painel: Authorization: Bearer <chave>.
id*stringId da cobrança (o chargeId da criação).
A cobrança.
application/json- response
Cobrança com valores, tarifas e o resumo do pagamento.
id?stringId da cobrança.
kind?stringSALE para cobrança normal; DISCOUNT_MED_APPLY para desconto por devolução PIX (MED).
status?stringStatus. Uma cobrança PENDING com prazo vencido já aparece como EXPIRED.
"PENDING""PARTIAL""PAID""EXPIRED""CANCELED""FAILED""REFUNDED""RETAINED"grossAmount?stringValor cobrado.
^\d{1,20}\.\d{2}$refundedAmount?stringTotal já reembolsado.
^\d{1,20}\.\d{2}$currency?stringMoeda da cobrança.
externalReference?|O valor enviado na criação.
description?|O valor enviado na criação.
expiresAt?|Prazo para pagar.
date-timesubscriptionId?|Assinatura que gerou a cobrança, ou null para cobrança avulsa.
paymentMethod?|Meio da última tentativa ou, sem tentativa, o meio fixado na criação. null quando não há um meio único.
customerMeta?|Dados do pagador enviados na criação, com documento, e-mail e telefone mascarados.
canRefund?booleanSe a cobrança aceita reembolso agora (status e prazo). Não considera o seu saldo.
canRefundPartial?booleanSe aceita reembolso de parte do valor.
attemptIds?array<string>Ids das tentativas de pagamento.
crypto?Dados da liquidação em cripto, depois do pagamento. Todos os campos são opcionais.
cryptoTickers?array<string>Moedas cripto escolhidas na criação. Ausente quando não é cobrança em cripto ou a moeda é aberta.
partialPayment?Só em cobrança PARTIAL. Quanto já entrou e quanto falta.
createdAt?stringCriação, em UTC.
date-timeupdatedAt?stringÚltima alteração, em UTC.
date-timenetAmount?stringValor que fica com você depois das tarifas.
^\d{1,20}\.\d{2}$splitConfig?array<>|O split enviado na criação.
splitIssues?|Partes do split que não puderam ser entregues e o motivo. null quando não houve problema.
feesMeta?|Tarifas calculadas. Use totalFeeAmount (valor total das
tarifas), percentSalesFee (percentual, 0.0399 = 3,99%) e
amountPerSale (valor fixo). Em cobrança USD ou EUR paga em
reais, fxLock traz o câmbio aplicado. Outras chaves podem
aparecer; não dependa delas.
checkoutUrl?stringLink do checkout. Só enquanto a cobrança está PENDING ou PARTIAL.
urilastConfirmedAttempt?|Pagamento confirmado mais recente, ou null se ainda não houve.
cryptoDeposits?Só quando a cobrança em cripto foi paga em mais de uma transferência. Lista os depósitos e o total.
curl -X GET 'https://api.gates2b.com/charge/me/string'{ "id": "01JC8Z3R5W7Y9A1C3E5G7J9K2M", "kind": "SALE", "status": "PAID", "grossAmount": "49.90", "netAmount": "47.35", "refundedAmount": "0.00", "currency": "BRL", "externalReference": "pedido-0001", "description": "Assinatura mensal", "expiresAt": "2026-11-30T23:59:59.000Z", "subscriptionId": null, "splitConfig": null, "feesMeta": { "percentSalesFee": 0.0399, "amountPerSale": 0.56, "totalFeeAmount": 2.55 }, "customerMeta": { "name": "Maria da Silva", "document": "123******09", "email": "cl*****@example.com", "phone": null }, "canRefund": true, "canRefundPartial": true, "attemptIds": [ "0192f4c6-7d1e-7a3b-9c2d-4e5f6a7b8c9d" ], "lastConfirmedAttempt": { "id": "0192f4c6-7d1e-7a3b-9c2d-4e5f6a7b8c9d", "status": "CONFIRMED", "paymentMethod": "PIX", "providerTransactionId": "70e451d6aa994cfb96229e5b74933540", "endToEndId": "E18236120202610221403s0123456789", "payer": { "name": "Maria da Silva", "document": "12345678909" }, "createdAt": "2026-10-22T14:00:00.000Z", "updatedAt": "2026-10-22T14:03:12.000Z" }, "createdAt": "2026-10-22T14:00:00.000Z", "updatedAt": "2026-10-22T14:03:12.000Z"}Regras
- Use o id da cobrança. Na criação com
PIXouBANK_SLIP(ouCRYPTO), ele vem emchargeId, não emid. - Cobrança de outra conta responde
404, igual a uma que não existe. - Uma cobrança
PENDINGcom prazo vencido aparece comoEXPIRED.checkoutUrlsó vem enquanto a cobrança pode ser paga (PENDINGouPARTIAL). lastConfirmedAttempténullaté o pagamento ser confirmado. Depois, trazendToEndIdem PIX eauthorizationCodeem cartão, quando o processador informa.lastConfirmedAttempt.payervem sem máscara: são os dados de quem efetivamente pagou, que podem ser diferentes decustomerMeta. Trate como dado pessoal.canRefundconsidera só o status e o prazo de 7 dias. O saldo disponível é verificado no reembolso.feesMetapode trazer chaves além das documentadas. Dependa só detotalFeeAmount,percentSalesFee,amountPerSaleefxLock.