Cancelar boleto (Banking)

🔽
DELETE: urlServidor/v1/marketplace/billets/:id

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 DELETE\
--location '{{urlServidor}/v1/marketplace/billets/:id' \
--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
id	string	Sim	ID - Identificador único do boleto.

Exemplo de Resposta

A resposta será composta por um objeto contendo os detalhes do boleto

{
    "_id": "6821f2afb2abfde4f6175e96",
    "type": "BILLET",
    "gateway_key": "27a8e123-370d-4d85-a7c0-dbdac27e5362",
    "establishment_id": "15005085",
    "establishment": {
        "id": 15005085,
        "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": "34193108400000010001090005848577892998860000",
    "digitable_line": "34191090080584857789529988600002310840000001000",
    "url": null,
    "status": "CANCELED",
    "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": "6821f2afb2abfde4f6175e9d"
        },
        {
            "name": "interest",
            "mode": "MONTHLY_PERCENTAGE",
            "amount": 1,
            "_id": "6821f2afb2abfde4f6175e9e"
        },
        {
            "name": "discount",
            "mode": "PERCENTAGE",
            "amount": 1,
            "limit_date": "2025-05-17T00:00:00.000Z",
            "_id": "6821f2afb2abfde4f6175e9f"
        }
    ],
    "recharge": true,
    "gateway_authorization": "CELCOIN",
    "request_origin": "API",
    "created_at": "2025-05-12T13:07:59.217Z",
    "updated_at": "2025-05-13T13:22:45.347Z",
    "__v": 0,
    "pix_emv": "00020101021226980014br.gov.bcb.pix2576qrcode-h.pix.celcoin.com.br/pixqrcode/v2/cobv/790c1365a52ad35f31bab897bb230a5204000053039865802BR5912EC Cobrancas6007Vitoria62070503***63044C1E",
    "transaction_id": "79d596f6-0c3a-4a1d-b58b-a761bc4adc26",
    "client": {
        "first_name": "Antonio",
        "last_name": "Francisco",
        "document": "43878902077",
        "email": "[email protected]",
        "_id": "6821f2afb2abfde4f6175e97"
    }
}

Descrição dos Campos do Response

Nome	Tipo	Descrição
`\_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 (CANCELED).
`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.