Listar boletos (Banking)

🔽
GET urlServidor/v1/marketplace/billets

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
x-token	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request GET \
--location '{{urlServidor}/v1/marketplace/billets' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Query

Key	Tipo	Obrigatório	Descrição
filters	string	Não	JSON com filtros. Campos filtráveis: status,type,risk
search	string	Não	Valor a ser pesquisado em vários campos.
sorters	string	Não	JSON com lista de ordenadores. Campos ordenáveis: Campos ordenáveis: id,created_at,updated_at,name1
perPage	number	Não	Limitado ao máximo de 100 por página.
page	number	Não	Página atual.

Exemplo de Resposta

A resposta será composta por um objeto contendo os detalhes das transações do tipo boleto


{
    "total": 1,
    "page": 1,
    "limit": 20,
    "data": [
        {
            "_id": "681ce25446d10c8cb1761836",
            "type": "BILLET",
            "gateway_key": "217b63e9-535a-40cd-a502-30ff14d51aeb",
            "establishment": {
                "id": 155085,
                "first_name": "EC Cobranças",
                "last_name": null,
                "document": "10068114001",
                "account_number": "300543394162",
                "account_check_digit": "8"
            },
            "marketplace": {
                "id": 26,
                "nickname": "Parceiro - Integrações",
                "first_name": "Webhooks Integrações",
                "last_name": "API Integrações",
                "document": "60274849000185"
            },
            "representative": {
                "id": 63,
                "first_name": "EC Cobranças",
                "last_name": null,
                "document": "10068114001"
            },
            "fees_banking": {
                "name": "Pacote de Tarifa Bancária Comercial",
                "description": "Pacote de Tarifa Bancária Comercial",
                "fees": 250
            },
            "description": "Venda por Boleto",
            "amount": 750,
            "original_amount": 1000,
            "barcode": "34199108400000010001090005834127892998860000",
            "digitable_line": "34191090080583412789529988600002910840000001000",
            "url": "https://billets/10068114001/billet-1746723447030.pdf",
            "status": "PENDING",
            "expiration_at": "2025-05-17T12:00:00.000Z",
            "payment_limit_date": "2025-05-18T00:00:00.000Z",
            "fees": 250,
            "billing_instructions": [
                {
                    "name": "late_fee",
                    "mode": "PERCENTAGE",
                    "amount": 1,
                    "_id": "681ce25446d10c8cb176183d"
                },
                {
                    "name": "interest",
                    "mode": "MONTHLY_PERCENTAGE",
                    "amount": 1,
                    "_id": "681ce25446d10c8cb176183e"
                },
                {
                    "name": "discount",
                    "mode": "PERCENTAGE",
                    "amount": 1,
                    "limit_date": "2025-05-17T00:00:00.000Z",
                    "_id": "681ce25446d10c8cb176183f"
                }
            ],
            "recharge": true,
            "gateway_authorization": "CELCOIN",
            "request_origin": "API",
            "created_at": "2025-05-08T16:56:52.311Z",
            "updated_at": "2025-05-08T16:57:28.124Z",
            "__v": 0,
            "pix_emv": "080014br.gov.bcb.pix2576qrcode-h.pix.celcoin.com.br/pixqrcode/v2/cobv/28981a312552e952537777dc3264f95204000053039865802BR5912EC Cobrancas6007Vitoria62070503***6304BFF5",
            "transaction_id": "2a7f6292-9339-49d7-b1bb-0ed159adb477",
            "client": {
                "first_name": "Antonio",
                "last_name": "Francisco",
                "document": "43878902077",
                "email": "[email protected]",
                "_id": "681ce25446d10c8cb1761837"
            }
        },
]
}

Descrição dos Campos do Response

Nome	Tipo	Descrição
`total`	number	Quantidade total de boletos encontrados.
`page`	number	Página atual da listagem.
`perPage`	number	Quantidade de registros por página.
`lastPage`	number	Número da última página disponível.
`data`	array	Lista com os boletos encontrados.
Data
`_id`	string	Identificador único do boleto.
`type`	string	Tipo da transação (`BILLET`) - Boleto.
`gateway_key`	string	Identificador no gateway bancário.
`establishment_id`	string	ID do estabelecimento vinculado ao boleto.
`description`	string	Descrição do boleto.
`amount`	number	Valor final do boleto, considerando encargos ou descontos.
`original_amount`	number	Valor original do boleto.
`barcode`	string	Código de barras do boleto.
`digitable_line`	string	Linha digitável do boleto.
`url`	string	Link para visualização ou download do boleto.
`status`	string	Status atual do boleto (ex: PENDING, PAID, EXPIRED).
`expiration_at`	string	Data de vencimento do boleto
`payment_limit_date`	string	Data limite para pagamento do boleto.
`fees`	number	Valor total de taxas cobradas no boleto.
`recharge`	boolean	Indica se o boleto é utilizado para recarga.
`pix_emv`	string	Código EMV do Pix para pagamento via copia e cola.
fees_banking
`name`	string	Nome do banco.
`description`	string	Descrição da cobrança bancária.
`fees`	number	Valor das taxas bancárias aplicadas.
Establishment
`name`	string	Nome do estabelecimento.
`description`	string	Descrição do estabelecimento.
`fees`	number	Taxas aplicadas ao estabelecimento.
Client
`first_name`	string	Nome ou razão social do cliente.
`last_name`	string	Sobrenome ou nome fantasia.
`document`	string	CPF ou CNPJ do cliente.
`email`	string	E-mail do cliente.
Client.address
`street`	string	Endereço do cliente
`number`	string	Número do endereço
`complement`	string	Complemento do endereço
`neighborhood`	string	Bairro
`city`	string	Cidade
`state`	string	Estado: [ AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MS, MT, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO ]
`zip_code`	string	CEP (somente números).
billet_instructions
`booklet`	boolean	Indica se o boleto é parte de um carnê.
`description`	string	Descrição exibida nas instruções do boleto.
billet_instructions.late_fee
`mode`	string	Tipo de multa (ex: PERCENTUAL ou VALOR_FIXO).
`amount`	number	Valor da multa.
billet_instructions.interest
`mode`	string	Tipo de multa (ex: PERCENTUAL ou VALOR_FIXO).
`amount`	number	Valor dos juros.
billet_instructions.discount
`mode`	string	Tipo de multa (ex: PERCENTUAL ou VALOR_FIXO).
`amount`	number	Valor do desconto.
`limit_date`	string	Data limite para aplicação do desconto.

Para mais informações, consulte a documentação oficial da Paytime.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.