PIpismo
Receivable

Validate receivable

Validate a receivable's uniqueness in the credit rights registry.

post/v1/credit-rights/unicity

Request

  • Base URL
    https://api-sandbox.pismolabs.io/credit-rights-receivable
  • URL
    https://api-sandbox.pismolabs.io/credit-rights-receivable/v1/credit-rights/unicity
  • Auth
    HTTP bearer

Request body

Example request

{
  "params": {
    "face_value": 499.23,
    "interop_holding_number": "017917411A",
    "lender_document_number": "51407165000113",
    "maturity_date": "2023-06=22"
  }
}

Response

Success response

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.

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.

interop_holding_numberstring

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

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.

maturity_datestring

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

messagestring

Message

Example response

{
  "face_value": 499.23,
  "interop_holding_number": "017917411A",
  "lender_document_number": "51407165000113",
  "maturity_date": "2023-06=22",
  "message": "Credit rights update request is being processed"
}

Changes

No recorded changes to this operation across all 1 revision of this API.