Pular para o conteúdo principal
GET
Consultar recarga de saldo

Autorizações

Authorization
string
header
obrigatório

Credencial OAuth da Base39 com os escopos profile e user:org:read, ou chave de API pertencente à organização. A organização e o autor são obtidos da autenticação.

Parâmetros de caminho

id
string
obrigatório

Identificador da recarga. Identificador Base39 da recarga.

Pattern: ^topup_[a-f0-9]{32}$

Resposta

Recarga pertencente à organização autenticada.

object
string
obrigatório

Tipo da recarga de saldo.

Allowed value: "balance_topup"
id
string
obrigatório

Identificador Base39 da recarga.

Pattern: ^topup_[a-f0-9]{32}$
amount
integer
obrigatório

Valor da recarga em centavos de real.

Intervalo obrigatório: x <= 9007199254740991
currency
string
obrigatório

Moeda da recarga: real brasileiro.

Allowed value: "BRL"
status
enum<string>
obrigatório

Situação da recarga; o saldo é creditado após a confirmação do pagamento.

Opções disponíveis:
creating,
active,
paid,
canceled,
expired,
failed,
review
created_at
integer
obrigatório

Instante da criação em milissegundos UTC.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
expires_at
integer
obrigatório

Limite exclusivo da validade em milissegundos UTC.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
paid_at
integer | null
obrigatório

Instante confirmado do pagamento; nulo enquanto não confirmado.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
transaction_id
string | null
obrigatório

Identificador do crédito no extrato; nulo antes da confirmação.

pix_copy_paste
string | null
obrigatório

Código Pix copia e cola; disponível enquanto a cobrança está ativa.