Sign in

v1

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

Update receivable

Update receivable for fields passed.

If updating the status fails, a <a href="https://developers.pismo.io/events/docs/depositary-credit-rights-status-change-failure-1" target="_blank">credit_rights_status_change_failure-1</a> event is generated. If updating the status succeeds, a <a href="https://developers.pismo.io/events/docs/depositary-credit-rights-status-change-success-1" target="_blank">credit_rights_status_change_success-1</a> event is generated.

If updating any other fields besides status fails, a <a href="https://developers.pismo.io/events/docs/depositary-credit-rights-change-failure-1" target="_blank">credit_rights_change_failure-1</a> event is generated. If updating a non-status field succeeds, a <a href="https://developers.pismo.io/events/docs/depositary-credit-rights-change-success-1" target="_blank">credit_rights_change_success-1</a> event is generated.

patch/v1/credit-rights/{internalNumber}

Path parameters

internalNumberstring required

Client-assigned internal number.

Request body

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

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

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

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

updated_face_valuenumber

Updated face value.

updated_maturity_datestring

Updated maturity date. Format = yyyy-mm-dd.

Example request

{
  "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",
  "ibge_code": 3304557,
  "lender_signing_date": "2023-06-22",
  "owner_document_number": "51008931000177",
  "owner_name": "Biff Wellington",
  "payment_method": 2,
  "payment_status": 1,
  "updated_face_value": 456.99,
  "updated_maturity_date": "2023-09-14"
}

Response

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

internal_numberstring

Client-assigned internal number.

messagestring

Message

Example response

{
  "internal_number": "5eae1070-28cc-4e99-ad45-c380731d5c0a",
  "message": "Credit rights update request is being processed"
}