Bank slip issuance

Get issued bank slip

Retrieve a previously issued bank slip from the provider. This endpoint only returns one bank slip at a time.

get/v1/bankslips-issue/client-requests/{clientRequestId}

Request

Base URL
https://sandbox.pismolabs.io/integrated-payments
URL
https://sandbox.pismolabs.io/integrated-payments/v1/bankslips-issue/client-requests/{clientRequestId}
Auth
HTTP bearer

Path parameters

clientRequestIdstring required

Client request ID returned using the bank slip issue endpoint.

Headers

x-idempotency-keystring required

Unique identifier (UUID) to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

Response

Response Body

account_idinteger

Pismo Platform Account ID.

amountnumber

Bank slip amount.

bar_codestring

Bar code encoding bank slip information such as the bank code, currency code, check digit, due date, amount, and beneficiary information.

client_request_idstring

Client request ID.

correlation_idstring

Correlation ID.

created_atstring

Date on which the resource was created.

descriptionstring

Description detailing the bank slip.

digitable_linestring

Digitable line.<br> For example on a Brazilian bank slip, the digitable line contains numerical payment information encoding details like the payment amount, due date, beneficiary information, and other transaction-specific data.

due_datestring

Bank slip due date in ISO 8601 format.

external_idstring

External ID.

idstring

Bank slip ID.

org_idstring

Organization ID.

over_due_datestring

Last day to accept bank slip payments. After this date, the bank slip is not paid.

paid_amountnumber

Bank slip paid amount.

pix_emvstring

The emv string that is used to pay (Pix Copia e Cola). Can be used to generate the QRCode image representation.

pix_keystring

PIX key related to the bank slip.

providerstring

The name of the provvider that issues the bank slip.

issuerstring

The name of the provider that issues the bank slip.

transaction_idstring

Transaction ID related to the bank slip issue. This is the ID that links the bank slip to the specific transaction performed in the payments API. It can be used for tracking, reconciliation, and reference purposes when managing bank slips and their associated transactions.

statusstring

status of issued bankslip

updated_atstring

Date on which the bank slip is updated.

Example response

{
  "account_id": 123,
  "amount": 100,
  "bar_code": "6049000117010051039060004359977819483000015380998174912864",
  "client_request_id": "6d6bdd2c-9980-4cf1-87ff-123",
  "correlation_id": "c537939d-5442-48b6-8b84-66465ba68880",
  "created_at": "2024-07-24T00:00:00Z",
  "debtor": {
    "city": "New York",
    "complement": "Complement",
    "document_number": "00000000000",
    "name": "John Doe",
    "neighborhood": "Neighborhood",
    "number": "123",
    "state": "UF",
    "street": "Street",
    "zip_code": "00000000"
  },
  "description": "Long description.",
  "digitable_line": "60490001170100510390600043599778194830000153809",
  "due_date": "2024-07-25T00:00:00Z",
  "external_id": "6d6bdd2c-9980-4cf1-87ff-456",
  "id": "050d8e9b-586e-4419-af13-d7c6be012fb2",
  "instructions": {
    "fine": 5,
    "interest": 10,
    "discount": {
      "amount": 10,
      "deadline": "2024-09-25T00:00:00.000Z",
      "type": "fixed"
    }
  },
  "org_id": "TN-000000000-00000-00000-0000-00000000000000",
  "over_due_date": "2024-07-25T00:00:00Z",
  "paid_amount": 100,
  "pix_emv": "00020101021226980014br.gov.bcb.pix2576qrcode-h.pix.provider.com.br/pixqrcode/v2/cobv/cf8aebf27395133f638ca19870a5ef5204000053039865802BR5916",
  "pix_key": "pixkey@pix.com.br",
  "provider": "BTG",
  "issuer": "PISMO",
  "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "REGISTERED",
  "updated_at": "2024-07-25T00:00:00Z"
}

Changes

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