PIpismo
Bank slip issuance

List issued bank slips

Retrieve a list of issued bank slips.

get/v1/bankslips-issue

Request

  • Base URL
    https://sandbox.pismolabs.io/integrated-payments
  • URL
    https://sandbox.pismolabs.io/integrated-payments/v1/bankslips-issue
  • Auth
    HTTP bearer

Query parameters

perPagestring

Receipts per page. Min=1, max=100, default=20.

pagestring

Current page. min=1 default=1

order'asc' | 'desc'

Result ordering is done on bank slip creation datetime. Default is desc.

beginDatetimestring datetime

Begin datetime filter. ISO 8601 format - yyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ.

endDatetimestring datetime

End datetime filter. ISO 8601 format - syyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ.

statusstring

Status of issued bank slip.

Response

Response Body

Example response

{
  "items": [
    {
      "account_id": 123,
      "client_request_id": "6d6bdd2c-9980-4cf1-87ff-123",
      "correlation_id": "c537939d-5442-48b6-8b84-66465ba68880",
      "created_at": "2024-07-24T00:00:00Z",
      "due_date": "2024-07-25T00:00:00Z",
      "external_id": "6d6bdd2c-9980-4cf1-87ff-456",
      "id": "050d8e9b-586e-4419-af13-d7c6be012fb2",
      "org_id": "TN-000000000-00000-00000-0000-00000000000000",
      "over_due_date": "2024-07-25T00:00:00Z",
      "provider": "BTG",
      "issuer": "PISMO",
      "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "REGISTERED",
      "updated_at": "2024-07-25T00:00:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_items": 100,
    "total_pages": 10
  }
}

Changes

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