Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Receivable

Register receivable

Register an account receivable - Brazil only. A receivable represents money expected to be collected from an entity (debtor) who has purchased products or services, but has not yet paid for them in full. The lender, the person or entity owed the money, can sell this debt to a new owner, who may package it as part of another financial instrument, in much the same way a mortgage is sold to become part of a mortgage-backed security.

Pismo works with <a href="https://www.b3.com.br/en_us/" target="_blank">B3</a> - a large financial market infrastructure provider in Brazil - to register invoices.

If creation fails, a <a href="https://developers.pismo.io/events/docs/depositary-credit-rights-registration-failure-1" target="_blank">credit_rights_registration_failure-1</a> event is generated. If creation succeeds, a <a href="https://developers.pismo.io/events/docs/depositary-credit-rights-registration-success-1" target="_blank">credit_rights_registration_success-1</a> event is generated

post/v1/credit-rights

Request body

credit_rights_receivable_type1 | 2 required

Credit receivable type:

1 - Mercantile 2 - Service

debtor_namestring required

Debtor name

debtor_document_numberstring required

Debtor document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Fisicas number (Brazil). Must not be the same as the lender document number.

face_valuenumber required

Face value refers to the nominal or stated value of a financial instrument or asset, typically printed or stated on the instrument itself. It represents the initial value assigned to the instrument at the time of issuance or purchase.

holding_numberstring required

Holding number - the number of the invoice (min size 1, max size 9) + '.' + the number of installments (min 1 - max 99).

ibge_codeinteger required

IBGE stands for Instituto Brasileiro de Geografia e Estatística, which translates to the Brazilian Institute of Geography and Statistics. This Brazilian national statistical agency is responsible for collecting and providing official data on various aspects of the country. An IBGE code is a specific numerical code assigned to various administrative divisions and geographical areas in Brazil.

For this application, the IBGE code identifies the town and must have 7 digits (1000000 to 9999999).

internal_numberstring required

Client-assigned internal number.

invoice_numberinteger required

Invoice number. Generated when receivable is created.

invoice_serieinteger required

Invoice series number. "Serie" is the Portuguese word for "series".

invoice_total_valuenumber required

Invoice total value. Can be up to 16 digits and two decimal places.

issuing_datestring required

Date/time when card was issued in RFC3339 format, i.e., 2019-07-03T17:23:18Z

lender_namestring required

Lender name

lender_document_numberstring required

Lender document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Fisicas number (Brazil). Should not be the same as the debtor document number.

maturity_datestring date required

Deposit maturity date in YYYY-MM-DD format

payment_method1 | 2 | 3 | 4 | 5 | 6 required

Payment method:

1 - Boleto: The Boleto payment method is a popular payment system in Brazil. It is a widely used alternative to traditional credit card payments and bank transfers. Boleto Bancário, commonly referred to as "Boleto," is a payment voucher that allows individuals and businesses to make payments for goods and services.

2 - TED: The TED (Transferência Eletrônica Disponível) payment method is a popular electronic funds transfer system in Brazil. It is commonly used for interbank transfers, allowing individuals and businesses to transfer funds between different financial institutions within the country.

3 - DOC: The DOC (Documento de Ordem de Crédito) payment method is another electronic funds transfer system in Brazil, similar to TED (Transferência Eletrônica Disponível). DOC is primarily used for interbank transfers but differs from TED in terms of timing, limits, and processing.

4 - Dinheiro: "Dinheiro" is the Portuguese word for "money" or a general term for cash payments. Cash is a widely used payment method in various countries, including Brazil, where the official currency is the Brazilian Real (BRL).

5 - Título: "Titulo" means title in Portuguese.

6 - Pix: The Pix payment method is a new and instant electronic payment system introduced by the Central Bank of Brazil. It was launched in November 2020 and has gained significant popularity in a short period. Pix allows individuals and businesses to make real-time transfers and payments between different financial institutions in Brazil. It operates 24/7, including weekends and holidays, providing a fast and alternative to traditional payment methods such as TED and DOC transfers.

payment_status1 | 2 required

Payment Status: 1 - PAID
2 - UNPAID

recorder_accountinteger required

Recorder account

access_keystring

Client-generated identifier. This field is used for the Get invoice endpoint.

collateral_type1

Collateral type:

1 - Aval. In Brazil, the term "aval collateral" refers to a specific type of collateral used in financial transactions. "Aval" is a Portuguese term that means "endorsement" or "guarantee," and it is commonly used in the Brazilian financial system. Aval collateral is a form of guarantee where a third party, known as the "avalista" or guarantor, pledges their assets or credit worthiness to secure a loan or financial obligation on behalf of the borrower. The avalista becomes jointly liable for the debt and agrees to fulfill the obligations if the borrower fails to do so.

debtor_signing_datestring date

Debtor signing date. Format = yyyy-mm-dd

descriptionstring

Challenge result

guarantor_namestring

Guarantor name

lender_signing_datestring date

Lender signing date. Format = yyyy-mm-dd. Must be before or equal to today.

owner_document_numberstring

Owner document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil).

owner_namestring

Owner name

Example request

{
  "debtor_name": "Bonnie Ann Clyde",
  "face_value": 499.23,
  "holding_number": "1234.8",
  "ibge_code": 3304557,
  "internal_number": "5eae1070-28cc-4e99-ad45-c380731d5c0a",
  "invoice_number": 88,
  "invoice_serie": 1,
  "invoice_total_value": 5678.99,
  "issuing_date": "2019-07-03T17:23:18Z",
  "lender_name": "Al Dente",
  "lender_document_number": "51407165000113",
  "maturity_date": "2024-04-20",
  "payment_method": 2,
  "payment_status": 1,
  "recorder_account": 12345678,
  "access_key": "KAB6J8903CNMH01892749JKSNOAXMCA7199382ABCERL",
  "collateral_type": 1,
  "credit_operations": [
    {
      "contact_number": "+14158675309",
      "guarantee_percentage": 5,
      "operation_date": "2023-06-06",
      "operation_maturity": "2023-09-08",
      "operation_type": "DELETE",
      "operation_value": 234.5
    }
  ],
  "debtor_signing_date": "2023-06-07",
  "description": "Challenge expired",
  "guarantor_name": "Lansky Loan",
  "lender_signing_date": "2023-06-22",
  "owner_document_number": "51008931000177",
  "owner_name": "Biff Wellington"
}

Response

Success message is sent to the client while registration is processed asynchronously

messagestring

Credit receivable response message

recorder_accountinteger

Recorder account number