Sign in

v1

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

Get credit rights

Get credit rights with internal number.

get/v1/credit-rights/{internalNumber}

Path parameters

internalNumberstring required

Client-assigned internal number.

Response

Success

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.

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

credit_rights_receivable_type1 | 2

Credit receivable type:

1 - Mercantile 2 - Service

debtor_document_numberstring

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.

debtor_namestring

Debtor name

debtor_signing_datestring date

Debtor signing date. Format = yyyy-mm-dd

descriptionstring

Challenge result

face_valuenumber

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.

guarantor_namestring

Guarantor name

holding_numberstring

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

ibge_codeinteger

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

Client-assigned internal number.

interop_holding_numberstring

Client-assigned interoperation holding number. Called holding_number when passed in the Register receivable endpoint.

invoice_numberinteger

Invoice number. Generated when receivable is created.

invoice_serieinteger

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

invoice_total_valuenumber

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

issuing_datestring

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

lender_document_numberstring

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.

lender_namestring

Lender name

lender_signing_datestring date

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

maturity_datestring date

Deposit maturity date in YYYY-MM-DD format

org_idstring

Organization ID

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

payment_method1 | 2 | 3 | 4 | 5 | 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.

payment_status1 | 2

Payment Status: 1 - PAID
2 - UNPAID

recorder_accountinteger

Recorder account

status'PENDING' | 'PROCESSING' | 'CANCELLED' | 'SETTLED' | 'PROCESSED'

PENDING: Charge is scheduled and waiting for the cycle to close. PROCESSING: Cycle closing process has started and is awaiting completion. CANCELLED: Charge canceled due to link cancellation. SETTLED: Amount is zero and/or minimum_spend_to_charge has not been reached. PROCESSED: Charge was posted on the statement."

updated_atstring date-time

Datetime program calendar strategy was updated. Format = YYYY-MM-DDTHH:MM:SS:MM

Example response

{
  "access_key": "KAB6J8903CNMH01892749JKSNOAXMCA7199382ABCERL",
  "collateral_type": 1,
  "created_at": "2024-09-12T16:46:16.43663522",
  "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_name": "Bonnie Ann Clyde",
  "debtor_signing_date": "2023-06-07",
  "description": "Challenge expired",
  "face_value": 499.23,
  "guarantor_name": "Lansky Loan",
  "holding_number": "1234.8",
  "ibge_code": 3304557,
  "internal_number": "5eae1070-28cc-4e99-ad45-c380731d5c0a",
  "interop_holding_number": "017917411A",
  "invoice_number": 88,
  "invoice_serie": 1,
  "invoice_total_value": 5678.99,
  "issuing_date": "2019-07-03T17:23:18Z",
  "lender_document_number": "51407165000113",
  "lender_name": "Al Dente",
  "lender_signing_date": "2023-06-22",
  "maturity_date": "2024-04-20",
  "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
  "owner_document_number": "51008931000177",
  "owner_name": "Biff Wellington",
  "payment_method": 2,
  "payment_status": 1,
  "recorder_account": 12345678,
  "status": "PENDING",
  "updated_at": "2024-09-12T16:46:16.43663522"
}