/gateway/bolepix/{id}/cancel - Preâmbulo Bank Conta Digital

Requisição

Parâmetros Path

id

string

requerido

Id da cobrança.

Parâmetros Header

Authorization

string

requerido

Exemplo:

Bearer {Token JWT}

Parâmetros Bodyapplication/json

cancellationReason

string

requerido

Motivo do cancelamento

>= 1 Caracteres<= 255 Caracteres

Exemplo

{
    "cancellationReason": "string"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.contadigital.preambulobank.com.br/gateway/bolepix//cancel' \
--header 'Authorization: Bearer {Token JWT}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cancellationReason": "string"
}'

Respostas

🟢200Success

application/json

Body

retorno

object | null

opcional

id

string

requerido

Id.

amount

number

requerido

Valor

status

string

requerido

Status.

createdAt

string <date-time>

requerido

Data de criação.

dueDate

string <date>

requerido

Data de vencimento.

link

string

requerido

URL da cobrança.

CanceledAt

string <date-time>

requerido

Data de cancelamento.

CancellationReason

string

requerido

Motivo do cancelamento.

payer

object

requerido

Pagador

discount

object | null

opcional

Desconto.

fine

object | null

opcional

Multa.

interest

object | null

opcional

Juros.

rebate

object | null

opcional

Rebate.

pixQrcode

object

requerido

Dados para pagamento por PIX.

bankSlip

object

requerido

Dados para pagamento por boleto.

paymentMethod

enum<string> | enum<null>

opcional

Método de pagamento.

Valores permitidos:

bank-slippix-qrcode

paymentAmount

number | null

opcional

Valor pago.

paymentDate

string <date-time> | null

opcional

Data do pagamento.

canceledAt

string <date-time> | null

opcional

Data de cancelamento.

cancellationReason

string | null

opcional

Motivo do cancelamento

alertas

array [object {2}]

opcional

mensagem

string | null

opcional

tipo

enum<integer> <int32>

opcional

Valores permitidos:

123456789

erros

array [object {4}]

opcional

mensagem

string | null

opcional

tipo

enum<integer> <int32>

opcional

Valores permitidos:

123456789

campoNome

string | null

opcional

elemento

string | null

opcional

Exemplo

{
    "retorno": {
        "id": "string",
        "amount": 0,
        "status": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "dueDate": "2019-08-24",
        "link": "string",
        "CanceledAt": "2019-08-24T14:15:22Z",
        "CancellationReason": "string",
        "payer": {
            "name": "string",
            "document": "string",
            "email": "string",
            "address": {
                "street": "string",
                "number": "string",
                "neighborhood": "string",
                "city": "string",
                "state": "string",
                "postalCode": "string",
                "extra": "string"
            }
        },
        "discount": {
            "amount": 0,
            "type": "fixed_amount",
            "date": "2019-08-24"
        },
        "fine": {
            "amount": 0,
            "type": "fixed_amount",
            "date": "2019-08-24"
        },
        "interest": {
            "amount": 0,
            "type": "fixed_amount",
            "date": "2019-08-24"
        },
        "rebate": {
            "amount": 0,
            "type": "percentual"
        },
        "pixQrcode": {
            "key": "string"
        },
        "bankSlip": {
            "number": "string",
            "barCode": "string",
            "digitableLine": "string"
        },
        "paymentMethod": "bank-slip",
        "paymentAmount": 0,
        "paymentDate": "2019-08-24T14:15:22Z",
        "canceledAt": "2019-08-24T14:15:22Z",
        "cancellationReason": "string"
    },
    "alertas": [
        {
            "mensagem": "string",
            "tipo": 1
        }
    ],
    "erros": [
        {
            "mensagem": "string",
            "tipo": 1,
            "campoNome": "string",
            "elemento": "string"
        }
    ]
}