v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
Registro de Boleto

Listar Registros de Boleto.

Listar Registros de Boleto.

get/v1/bank_billet_registrations

Query parameters

pageinteger

Número da Página

per_pageinteger

Quantidade de registros por página

registered_fromstring date

A partir da Data de registro.

registered_tostring date

Até a Data de registro.

bank_billet_idstring

ID do Boleto.

bank_billet_account_idstring

ID da Carteira.

Headers

User-Agentstring

Informar um e-mail válido para contatos.

Response

Sucesso na listagem de registros de boleto

idinteger

ID do Registro de Boleto

bank_billet_idinteger nullable

ID do Boleto.

bank_billet_account_idinteger nullable

ID da Carteira.

status'0' | '1' | '2'

Situação do registro:

  • 0 Erro
  • 1 Sucesso
  • 2 Serviço indisponível
registered_atstring date-time nullable

Data e hora do registro.

error_messagestring nullable

Mensagem de erro do registro.

failed_atstring date-time nullable

Data e hora da falha.

fails_countinteger nullable

Quantidade de falhas em tentativas de registrar o boleto.

retry_blockedboolean nullable

Retentativa bloqueada.

created_atstring date-time nullable

Data e hora de criação do registro

updated_atstring date-time nullable

Data e hora da última atualização do registro