Skip to main content

List schedules

This endpoint aims to provide details of all schedules made by the integration partner, including boletos and collection invoices.

Boleto

This is the conventional boleto (with digitable lines not starting with the digit 8). It is registered with the Interbank Payment Clearinghouse (CIP/Núclea) and can be paid at financial institutions and payment institutions authorized to operate by the Central Bank.

Collection Invoice

This type of charge is issued by utility companies (water, electricity, telephone, and gas bills) and public entities (taxes). They are not registered with the Interbank Payment Clearinghouse (CIP/Núclea) and, therefore, do not return the same information as a boleto.

Request​

ENDPOINT
/account/ACCOUNT_KEY/payment_schedules
MÉTODO
GET

Request Path Params​

FieldTypeDescriptionCharacters
account_key *uuidv4Unique account identification key.36

Request Query String Params​

FieldTypeDescription
request_control_keyuuidv4Unique identification key for the client's request.
payment_schedule_keyuuidv4Unique schedule identification key.
payment_typeenumPayment type.
date_fromstringStart date. Format "YYYY-MM-DD".
date_tostringEnd date. Format "YYYY-MM-DD".
pagestringRequested page number. 1 by default.
page_sizestringRequested page size in the query. 30 by default and maximum value.

Enumerators payment_type​

EnumeratorTypeDescription
bank_slipstringBoleto
collection_slipstringCollection invoice

Response​

Success Response​

STATUS
200
Response Body: Payment query
{
  "data": [
    {
       "payment_key":"c4325104-d60b-44f3-aae4-49155564a2ea",
       "request_control_key":"b713b2f6-2f48-4d18-b0c9-7186e4edf189",
       "payer_name":"COOPERATIVA INDUSTRIAL MURILO",
       "payer_document_number":"00037025000160",
       "source_account_key":"6dc89d57-fac7-4643-b151-cd2ca0a7f68f",
       "paid_amount":1050.1,
       "payment_date":"2024-04-03",
       "payment_type":"bank_slip",
       "bank_slip": {
            "bank_slip_key":"95080ffd-3ac5-48d7-b3fe-659e4aaba81a",
            "barcode":"00193967000009910000000003615574000000002417",
            "digitable_line":"00190000090361557400500000024174396700000991000",
            "payer_name":"COOPERATIVA TESTE",
            "payer_document_number":"00037025000160",
            "beneficiary_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
            "beneficiary_trading_name":"TESTE EQUIPAMENTOS E SERVICOS LTDA",
            "beneficiary_document_number":"52069937000117",
            "beneficiary_bank_ispb":"00000000",
            "guarantor_name":null,
            "guarantor_document_number":null,
            "expiration_date":"2024-03-29",
            "max_payment_data": "2026-03-29",
            "partial_payment_indicator":"allowed",
            "registered_payment_amount":9029.0,
            "nominal_amount":9910.0,
            "total_amount":10129.1,
            "rebate_amount":0.0,
            "discount_amount":0.0,
            "fine_amount":0.0,
            "interest_amount":219.1
        },
       "collection_slip":null,
       "payment_schedule_status":"scheduled"
    },
    {
      "payment_key": "33860ad0-bcb0-47b7-bbe7-c7e3ec2fc61a",
      "request_control_key": "ae4508df-f2cb-4e28-9f04-a19b7f2758c9",
      "payer_name": "COOPERATIVA INDUSTRIAL MURILO",
      "payer_document_number": "62069937000118",
      "source_account_key": "daae79e6-ee8b-449f-aa1e-96959d5d5a72",
      "paid_amount": 1389.21,
      "payment_date": "2024-04-30",
      "payment_type": "collection_slip",
      "bank_slip": null,
      "collection_slip": {
        "barcode": null,
        "digitable_line": "836200000138892100450006762142420244046000010192",
        "collection_name": "CIA ULTRAGAZ SA-COD",
        "collection_document_number": "00394460005887",
        "expiration_date": "2024-04-15",
        "total_amount": 1389.21
      },
      "payment_schedule_status": "scheduled"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 30
  }
}

Response Body Params​

FieldTypeDescription
payment_key *uuid4Unique payment identification key.
request_control_key *uuid4Unique identification key for the client's request.
payer_name *stringName of the effective payer.
payer_document_number *stringDocument number of the effective payer (CPF/CNPJ).
source_account_key *uuid4Key of the debited account.
paid_amount *numberAmount effectively paid.
payment_date *stringPayment date.
payment_type *enumPayment type.
bank_slipobjectBoleto.
collection_slipobjectCollection invoice.
payment_schedule_status *enumSchedule status.

Enumerators payment_type​

EnumeratorTypeDescription
bank_slipstringBoleto
collection_slipstringCollection invoice

Enumerators payment_schedule_status​

EnumeratorDescription
pending_2fa_approvalSchedule pending two-factor authentication (2FA)
scheduledPayment successfully scheduled
executedThe payment related to the schedule was successfully executed
rejectedThe payment related to the schedule was rejected
canceledSchedule canceled
errorError during scheduling

Object bank_slip​

FieldTypeDescription
barcode *stringBarcode.
digitable_line *stringDigitable line.
payer_name *stringPayer's name.
payer_document_number *stringPayer's document number (CPF/CNPJ).
beneficiary_name *stringBeneficiary's name.
beneficiary_trading_namestringBeneficiary's trade name.
beneficiary_document_number *stringBeneficiary's document number (CPF/CNPJ).
beneficiary_bank_ispb *stringISPB code of the beneficiary's bank.
guarantor_namestringName of the guarantor.
guarantor_document_numberstringGuarantor's document number (CPF/CNPJ).
expiration_date *stringDue date.
max_payment_date *stringMaximum payment date.
partial_payment_indicator *enumPartial payment indicator.
registered_payment_amountstringTotal registered payment amount.
nominal_amount *numberOriginal amount.
total_amount *numberTotal amount.
rebate_amount *numberRebate amount.
discount_amount *numberDiscount amount.
fine_amount *numberFine amount.
interest_amount *numberInterest amount.

Enumerators partial_payment_indicator​

EnumeratorTypeDescription
allowedstringAllowed
not_allowedstringNot allowed

Object collection_slip​

FieldTypeDescription
barcode *stringBarcode.
digitable_line *stringDigitable line.
collection_name *stringName of the agreement.
collection_document_number *stringDocument number of the agreement (CPF/CNPJ).
expiration_date *stringDue date.
total_amount *numberTotal amount.

Error Response​

STATUS
4XX
Response Body
{
    "title": "Título",
    "description": "Description in english",
    "translation": "Description in portuguese",
    "code": "Código"
}
HTTP CodeQI CodeTitleDescription (eng)Description (pt-br)
400BIP000026Bad RequestInvalid payment date format. The correct format is YYYY-MM-DD.Formato de data de pagamento inválido. O formato correto é YYYY-MM-DD.
400BIP000027Bad RequestInvalid integer value for page or size query string parameters.Valor inválido para parâmetros de página ou tamanho de página.
400BIP000047Bad RequestInvalid payment type.Tipo de pagamento inválido.