/gateway/bolepix - Preâmbulo Bank Conta Digital

Requisição

Parâmetros Query

page

integer

opcional

Pagina atual.

limit

integer

opcional

Número de itens por página.

>= 1<= 100

Padrão:

100

subAccountId

string <uuid>

opcional

Id da subconta.

createdAtStart

string <date>

opcional

Data de criação a partir de.

createdAtEnd

string <date>

opcional

Data de criação até.

dueDateStart

string <date>

opcional

Data de vencimento a partir de.

dueDateEnd

string <date>

opcional

Data de vencimento até.

status

string

opcional

Status.

payerDocument

string

opcional

Documento do pagador.

Parâmetros Header

Authorization

string

requerido

Exemplo:

Bearer {Token JWT}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.contadigital.preambulobank.com.br/gateway/bolepix?page&limit&subAccountId&createdAtStart&createdAtEnd&dueDateStart&dueDateEnd&status&payerDocument' \
--header 'Authorization: Bearer {Token JWT}'

Respostas

🟢200Success

application/json

Body

page

integer

requerido

Pagina atual.

count

integer

requerido

Quantidade de itens retornados.

totalCount

integer

requerido

Quantidade total de itens.

totalPages

integer

requerido

Quantidade total de páginas.

items

array [object {18}]

requerido

Itens.

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.

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

opcional

Dados para pagamento por PIX.

bankSlip

object

opcional

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

Exemplo

{
    "page": 0,
    "count": 0,
    "totalCount": 0,
    "totalPages": 0,
    "items": [
        {
            "id": "string",
            "amount": 0,
            "status": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "dueDate": "2019-08-24",
            "link": "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"
        }
    ]
}