v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Bank slip issuance

Issue bank slip

Create a bank slip and issue it to the provider. See Bank slips for more information.<br> This endpoint generates the Bank slip issuance registered event.

post/v1/bankslips-issue

Headers

Idempotency-keystring required

A UUID (without hyphens) to ensure the operation remains idempotent, allowing for operation repetition without causing unintended effects or duplication. Identifies the transaction on future events.

Request body

amountnumber required

bank slip amount.

due_datestring date required

bank slip payment due date.

descriptionstring

Description about the bank slip.

maximum_amountnumber

Maximum amount accepted when paying the bank slip.

minimum_amountnumber

Minimum amount accepted when paying the bank slip.

over_due_datestring date

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

pix_keystring

PIX key related to 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.

Example request

{
  "amount": 100,
  "due_date": "2024-07-25T00:00:00.000Z",
  "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.",
  "instructions": {
    "fine": 5,
    "interest": 10,
    "discount": {
      "amount": 10,
      "deadline": "2024-09-25T00:00:00.000Z",
      "type": "fixed"
    }
  },
  "maximum_amount": 100,
  "minimum_amount": 10,
  "over_due_date": "2024-08-25T00:00:00.000Z",
  "pix_key": "pixkey@pix.com.br",
  "issuer": "PISMO",
  "transaction_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Accepted

client_request_idstring

Unique identifier of the request controlled by the client.

external_idstring

Unique identifier of the request controlled by the provider.

statusstring

bank slip status. Possible values are CREATED, CANCELLED, REGISTERED, and ERROR.

Example response

{
  "client_request_id": "6d6bdd2c-9980-4cf1-87ff-c99dc9ce6ef4456",
  "external_id": "6d6bdd2c-9980-4cf1-87ff-c99dc9ce6ef4123",
  "status": "CREATED"
}