Sign in
Transactions

Create a transaction and generate bank slip with pix

This version allows you to create a Bank Slip with Pix. The new PDF layout includes the Pix code

bank_slip_link is set to HTML by default

Limitations

  • Only 2 discounts will be included, even if the transaction has more
post/v2/transactions/bank-slip

Request body

reference_idstring required

Reference ID of your application VARCHAR(500)

transaction_limit_datestring required

Deadline to use this transaction for payment

transaction_descriptionstring

Description of the sale for payment

sandboxboolean required

Defines whether the account is in test or production mode

is_pinpad_transactionboolean

Defines that a transaction is pinpad. In this case, the transaction may respect some specific parameters, such as a different pix fees

notification_urlstring required

URL that will receive a POST call when the transaction changes

bank_slip_link'PDF' | 'HTML'

Indicates whether the PDF of the bank slip or the HTML should be returned. DEFAULT is HTML

Example request

{
  "reference_id": "my_ref_518",
  "transaction_limit_date": "2027-09-01",
  "transaction_description": "Sale of tickets for the show on the 30th",
  "sandbox": true,
  "transaction_items": [
    {
      "item": "Tuition",
      "amount": "80000",
      "reference": "11/12",
      "note": "November tuition"
    }
  ],
  "transaction_details": {
    "amount": 10000,
    "due_date": "2026-10-01",
    "payment_limit_date": "2027-01-01",
    "body_instructions": [
      "Do not allow payment after 2027-01-01"
    ],
    "late_fee": {
      "mode": "PERCENTAGE",
      "amount": "2.00"
    },
    "interest": {
      "mode": "DAILY_PERCENTAGE",
      "amount": "0.033"
    },
    "discount": {
      "mode": "FIXED",
      "date_1": "2026-09-21",
      "amount_1": 3000,
      "date_2": "2026-09-25",
      "amount_2": 2500,
      "date_3": "2026-09-27",
      "amount_3": 2000
    }
  },
  "split_rules": [
    {
      "amount": 9550,
      "percentage": "0.1234",
      "processing_fee": "MAIN"
    }
  ],
  "notification_url": "https://api.domain.com.br/v1/edubank-notification",
  "buyer": {
    "first_name": "John",
    "last_name": "Zeisivig",
    "email": "teste@teste.com",
    "taxpayer_id": "76537741807",
    "birthdate": "1990-01-05",
    "phone_number": "21987440889",
    "address": {
      "city": "Rio de Janeiro",
      "number": "143",
      "state_code": "RJ",
      "street": "R. Marquês de Abrantes",
      "neighborhood": "Flamengo",
      "zip": "22230061",
      "country_code": "BR"
    }
  }
}

Response

The object has been successfully created

status_codenumber required

Status code

transaction_idstring required

Edubank transaction id

transaction_typestring required

Type of transaction performed. CARD/PIX/BANK_SLIP/BANK_SLIP_PIX

statusstring required

Current transaction status

payment_idstring required

Payment id

bank_slip_linkstring

URL for payment slip

bank_slip_barcodestring

Barcode for payment slip

bank_slip_digitable_linestring

Digitable line for payment slip

bank_slip_document_numberstring

"Our number" from the bank slip

pix_qrcodestring

Pix qrcode

pix_base64string

Pix qrcode image in base64

pix_expirationstring

Pix expiration

Example response

{
  "status_code": 200
}

Changes

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