Sign in
Transactions

Create a transaction

Creating Transactions for Future Payment Association

In the case where the transaction allows the bank slip payment method, the property transaction_details.payment_limit_date must be later than transaction_details.due_date

SANDBOX Mode

  • The SANDBOX mode enables you to generate transactions within a controlled testing environment.

  • In case a transaction is initiated under the SANDBOX mode and is associated with a credit card payment, an immediate response indicating success or failure will be generated based on the provided credit card number, as detailed earlier.

  • For transactions involving a PIX or BANK_SLIP payment method, utilize the v1/transactions/{transaction_id}/settle endpoint to simulate the payment process. This will trigger a payment notification to be sent to the notification_url specified within the transaction.

post/v1/transactions

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

allows_pixboolean required

Allows you to pay with pix

allows_credit_cardboolean required

Allows you to pay with credit card

allows_bank_slipboolean required

Allows you to pay with bank slip

notification_urlstring required

URL that will receive a POST call when the transaction changes

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,
  "allows_pix": true,
  "allows_credit_card": true,
  "allows_bank_slip": 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

transaction_idstring required

Edubank transaction id

amount_to_pay_todaynumber

Amount to be paid today. Ex: 2010 = 20.10

expires_instring

Deadline to allow a credit card or pix payment to be made with this transaction. Default: creation date

status_codenumber required

Status code

Example response

{
  "transaction_id": "117a97d2253e4a22a7bb0b883a10242c",
  "expires_in": "2026-10-01T23:59:59+00:00",
  "status_code": 200
}

Changes

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