Consultar cobrança
Consultar uma cobrança existente na sua conta pelo ID. É o mesmo objeto que
chega em data.object nos eventos payment_intent.*.
Limite de taxa: 100 requisições por minuto por chave de API.
Authorizations
A chave de API usada para autenticar a requisição e identificar a sua conta.
Exemplo: Authorization: ApiKey my-secure-key
Path Parameters
ID da cobrança, no formato TypeID com prefixo pi_.
^pi_[0-9a-z]{26}$"pi_01h455vb4pex5vsknk084sn02r"
Response
Operação realizada com sucesso
ID único da cobrança, no formato TypeID com prefixo pi_.
^pi_[0-9a-z]{26}$"pi_01h455vb4pex5vsknk084sn02r"
Tipo do objeto. Sempre 'payment_intent'.
payment_intent "payment_intent"
Valor a cobrar em centavos. R$ 99,90 = 9990.
9990
Quantas tentativas de cobrança já foram feitas.
1
Timestamp Unix da criação da cobrança.
1704672000
Moeda do valor. Sempre 'brl' (Real brasileiro).
brl "brl"
ID do cliente cobrado, no formato TypeID com prefixo cus_.
^cus_[0-9a-z]{26}$"cus_01h455vb4pex5vsknk084sn02p"
Timestamp Unix do vencimento da cobrança.
1704758400
ID da fatura que a cobrança liquida, no formato TypeID com prefixo in_.
^in_[0-9a-z]{26}$"in_01h455vb4pex5vsknk084sn02q"
Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente.
true
Limite de tentativas antes de a cobrança parar de ser reprocessada.
3
Status atual da cobrança.
- pending: Aguardando processamento.
- processing: Em processamento na adquirente.
- paid: Paga.
- failed: Recusada; pode ser retentada até
max_attempts. - refunding: Estorno solicitado.
- refunded: Estornada.
- discarded: Substituída por um checkout que assumiu a fatura.
pending, processing, paid, failed, refunding, refunded, discarded "pending"
Número de parcelas da cobrança no cartão. 1 para cobrança à vista.
1
Motivo da última tentativa recusada, ou null enquanto nenhuma
tentativa falhou. É zerado quando uma nova tentativa começa.
O código da adquirente não sai do sistema: a Simplo é multiadquirente por desenho, e estes seis códigos continuam válidos quando a mesma fatura for cobrada por outra adquirente.
Timestamp Unix da próxima tentativa automática.
null quando não há retentativa agendada.
1704844800
Meio de pagamento pelo qual o dinheiro se moveu, derivado da transação
gerada pela cobrança. null enquanto nenhum checkout escolheu um meio.
pix, card, null "pix"
Timestamps de quando a cobrança mudou de status. Campos são null se a transição ainda não ocorreu.
ID da assinatura que originou a fatura (se aplicável), no formato TypeID com prefixo sub_.
"sub_01h455vb4pex5vsknk084sn02s"

