APIs
Sub-processorsAbout PismoContact us

Register receivable

post
https://api-sandbox.pismolabs.io/credit-rights-receivable/v1/credit-rights

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 B3 - a large financial market infrastructure provider in Brazil - to register invoices.

If creation fails, a credit_rights_registration_failure-1 event is generated. If creation succeeds, a credit_rights_registration_success-1 event is generated

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
enum
required
1 to 2

Credit receivable type:

1 - Mercantile 2 - Service

Allowed:
string
required
length between 1 and 100

Debtor name

string
required
length ≤ 14

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.

number
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.

string
required
length between 3 and 12

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

int32
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).

string
required
length between 1 and 40

Client-assigned internal number.

int64
required

Invoice number. Generated when receivable is created.

int64
required

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

number
required

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

date
required

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

string
required
length between 1 and 100

Lender name

string
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.

string
required

Maturity date. Format = yyyy-mm-dd. Must be equal to today or later.

int32
enum
required
1 to 6

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.

Allowed:
int32
enum
required
1 to 2

Payment Status: 1 - PAID
2 - UNPAID

Allowed:
int64
required

Recorder account

string
length between 1 and 44

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

int32
enum
1 to 1

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.

Allowed:
credit_operations
array of objects
length between 1 and 2147483647
credit_operations
string
length between 1 and 15

Contact number

number

Gurantor percentage

date

Operation date. Format = yyyy-mm-dd.

date

Operation maturity. Format = yyyy-mm-dd.

string
length between 1 and 50

Operation type. You need to configure the operation types with Pismo.

number

Operation value. Must be positive or zero. Can be up to 16 digits and two decimal places.

date

Debtor signing date. Format = yyyy-mm-dd

string
length ≤ 500

Receivable description

string
length between 1 and 100

Guarantor name

date

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

string

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

string
length between 1 and 100

Owner name

Responses

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago