Banco Boreal
HomeLanding
HomeLanding
  1. boletos
  • Home
  • Payment Gateway
    • auth
      • /login
      • /me
      • /refresh
    • brcode-decode
      • /brcode-decode
    • brcode-payments
      • /brcode-payments
      • /brcode-payments
      • /brcode-payments/{id}
    • pix-invoices
      • /pix-invoices
      • /pix-invoices
      • /pix-invoices/{id}
      • /pix-invoices/{id}/cancel/
    • boletos
      • /boletos/
        GET
      • boletos_create
        POST
      • boletos_read
        GET
      • boletos_update
        PUT
      • boletos_partial_update
        PATCH
      • boletos_delete
        DELETE
      • boletos_cancel
        PATCH
      • boletos_partial_update_local
        PATCH
    • transfers
      • analytics
        • transfers analytics
      • {id}
        • transfers read
      • transfers list
      • transfers create
    • receiver-accounts
      • {id}
        • receiver-accounts read
        • receiver-accounts update
        • receiver-accounts partial update
        • receiver-accounts delete
      • receiver-accounts list
      • receiver-accounts create
    • split-settings
      • split-settings update
    • split-receivers
      • {id}
        • split-receivers read
        • split-receivers update
        • split-receivers partial update
        • split-receivers delete
      • split-receivers list
      • split-receivers create
    • split-transactions
      • analytics
        • split-transactions analytics
      • {id}
        • split-transactions read
      • split-transactions list
    • balance
      • balance_list
    • statement
      • statement_list
    • organizations
      • /organizations/
      • /organizations/{id}/
      • /organizations/{id}/workspaces
    • workspaces
      • /workspaces/
      • /workspaces/host/{host}/
      • /workspaces/{id}/
      • /workspaces/{workspace_id}/members
    • event-types
      • /event-types/
    • subscriptions
      • /subscriptions
      • /subscriptions
      • /subscriptions/{id}
      • /subscriptions/{id}
  • Esquemas
    • Schemas
      • BRCodePayment
      • Address
      • Boleto
      • Account
      • WebhookSubscription
      • PixInvoice
      • Organization
      • AssetTemplate
      • Person
      • Ledger
      • Workspace
      • ProductTemplate
HomeLanding
HomeLanding
  1. boletos

boletos_cancel

PATCH
/boletos/{id}/cancel/
Cancela o boleto localmente atualizando o status para 'canceled'.

Requisição

Authorization
Adicionar o parâmetro
Authorization
a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Caminho

Parâmetros Bodyapplication/json

Exemplo
{
    "amount": -2147483648,
    "paid_amount": -2147483648,
    "fee": -2147483648,
    "fine": 0,
    "interest": 0,
    "due_date": "2019-08-24T14:15:22Z",
    "overdue_days": -2147483648,
    "name": "string",
    "tax_id": "string",
    "street": "string",
    "street_number": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "link": "string",
    "customer_id": "string",
    "transaction_id": "string",
    "tags": {},
    "discounts": {},
    "descriptions": {},
    "deleted_by": "string",
    "errors": {}
}

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/boletos//cancel/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": -2147483648,
    "paid_amount": -2147483648,
    "fee": -2147483648,
    "fine": 0,
    "interest": 0,
    "due_date": "2019-08-24T14:15:22Z",
    "overdue_days": -2147483648,
    "name": "string",
    "tax_id": "string",
    "street": "string",
    "street_number": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "link": "string",
    "customer_id": "string",
    "transaction_id": "string",
    "tags": {},
    "discounts": {},
    "descriptions": {},
    "deleted_by": "string",
    "errors": {}
}'

Respostas

🟢200OK
application/json
Body

Exemplo
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "status": "canceled",
    "amount": -2147483648,
    "paid_amount": -2147483648,
    "fee": -2147483648,
    "fine": 0,
    "interest": 0,
    "due_date": "2019-08-24T14:15:22Z",
    "overdue_days": -2147483648,
    "name": "string",
    "tax_id": "string",
    "street": "string",
    "street_number": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "line": "string",
    "link": "string",
    "bar_code": "string",
    "customer_id": "string",
    "external_id": "string",
    "transaction_id": "string",
    "tags": {},
    "discounts": {},
    "descriptions": {},
    "deleted_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "issue_date": "2019-08-24T14:15:22Z",
    "errors": {}
}
Modificado em 2025-01-16 15:15:35
Página anterior
boletos_delete
Próxima página
boletos_partial_update_local
Built with