Sign in

v1

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

Get invoice

Get and validate invoice given access key in path. The access key is created via the Register receivable endpoint.

Pismo works with a third-party (B3) who registers the invoices.

This endpoint generates 4 possible events:

  1. Request to third-party fails - <a href="https://developers.pismo.io/events/docs/depositary-invoice-validation-request-failure-1" target="_blank">invoice_validation_request_failure-1</a>
  2. Request to third-party succeeds - <a href="https://developers.pismo.io/events/docs/depositary-invoice-validation-request-success-1" target="_blank">invoice_validation_request_success-1</a>
  3. Third-party validation fails- <a href="https://developers.pismo.io/events/docs/depositary-invoice-validation-failure-1" target="_blank">invoice_validation_failure-1</a>
  4. Third-party validation succeeds - <a href="https://developers.pismo.io/events/docs/depositary-invoice-validation-success-1" target="_blank">invoice_validation_success-1</a>
get/v1/invoices/{access_key}

Path parameters

access_keystring required

Client-generated identifier. Must be 44 characters. Created via the Register receivable endpoint.

Response

Success message is sent to the client while an invoice validation is processed asynchronously,

access_keystring

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

messagestring

Message

Example response

{
  "access_key": "KAB6J8903CNMH01892749JKSNOAXMCA7199382ABCERL",
  "message": "Credit rights update request is being processed"
}