Skip to main content
GET
Consultar cobrança

Authorizations

Authorization
string
header
required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Path Parameters

id
string
required

ID da cobrança, no formato TypeID com prefixo pi_.

Pattern: ^pi_[0-9a-z]{26}$
Example:

"pi_01h455vb4pex5vsknk084sn02r"

Response

Operação realizada com sucesso

id
string
required
read-only

ID único da cobrança, no formato TypeID com prefixo pi_.

Pattern: ^pi_[0-9a-z]{26}$
Example:

"pi_01h455vb4pex5vsknk084sn02r"

object
enum<string>
required

Tipo do objeto. Sempre 'payment_intent'.

Available options:
payment_intent
Example:

"payment_intent"

amount
integer
required

Valor a cobrar em centavos. R$ 99,90 = 9990.

Example:

9990

attempts
integer
required

Quantas tentativas de cobrança já foram feitas.

Example:

1

created
integer<int64>
required
read-only

Timestamp Unix da criação da cobrança.

Example:

1704672000

currency
enum<string>
required

Moeda do valor. Sempre 'brl' (Real brasileiro).

Available options:
brl
Example:

"brl"

customer
string
required

ID do cliente cobrado, no formato TypeID com prefixo cus_.

Pattern: ^cus_[0-9a-z]{26}$
Example:

"cus_01h455vb4pex5vsknk084sn02p"

due_at
integer<int64>
required

Timestamp Unix do vencimento da cobrança.

Example:

1704758400

invoice
string
required

ID da fatura que a cobrança liquida, no formato TypeID com prefixo in_.

Pattern: ^in_[0-9a-z]{26}$
Example:

"in_01h455vb4pex5vsknk084sn02q"

live_mode
boolean
required

Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente.

Example:

true

max_attempts
integer
required

Limite de tentativas antes de a cobrança parar de ser reprocessada.

Example:

3

status
enum<string>
required

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.
Available options:
pending,
processing,
paid,
failed,
refunding,
refunded,
discarded
Example:

"pending"

installments
integer | null

Número de parcelas da cobrança no cartão. 1 para cobrança à vista.

Example:

1

last_payment_error
object | null

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.

next_attempt
integer | null

Timestamp Unix da próxima tentativa automática. null quando não há retentativa agendada.

Example:

1704844800

payment_method_type
string | null

Meio de pagamento pelo qual o dinheiro se moveu, derivado da transação gerada pela cobrança. null enquanto nenhum checkout escolheu um meio.

Available options:
pix,
card,
null
Example:

"pix"

status_transitions
object

Timestamps de quando a cobrança mudou de status. Campos são null se a transição ainda não ocorreu.

subscription
string | null

ID da assinatura que originou a fatura (se aplicável), no formato TypeID com prefixo sub_.

Example:

"sub_01h455vb4pex5vsknk084sn02s"