Transactions

Create a transaction and make the payment directly with a credit card

Create a transaction and make the payment directly with a credit card.

Data Only - Optional property (Fees can be included in transactions where data_only is not sent)

DataOnly is a protocol similar to 3D Secure (3DS) with the primary goal of reducing fraud rates and increasing approval rates compared to common transactions. By collecting more comprehensive data from the client during the transaction process, issuers can make more informed decisions based on a deeper analysis of the data provided.

Information required for data only

color_depth (number, default: 24):

  • Represents the color depth of the palette used to display images, measured in bits per pixel. It indicates how many bits are used to represent the color of each pixel, which impacts the quality of colors displayed on the screen. This value can be obtained from the client browser using the window.screen.colorDepth property.

device_type (string, default: BROWSER)

  • Indicates the type of device on which authentication occurs. Helps to identify the usage environment and tailor the user experience to the device. The default value is BROWSER, but it can vary based on the client's device. This information can be obtained from the client browser through user-agent analysis.

java_enabled (boolean, default: false)

  • A boolean field indicating whether the client browser has the capability to run Java. It returns true if Java support is enabled and false otherwise. This value can be obtained from the client browser using the navigator.javaEnabled() property.

language (string, default: BR)

  • Represents the browser's preferred language in IETF BCP 47 format, containing between 1 and 8 characters. It can be used to adapt the interface to the user's language preference. This value can be obtained from the client browser using the navigator.language property.

screen_height (number, default: 500)

  • Represents the total height of the client's screen in pixels. The value can be obtained from the client browser using the screen.height property.

screen_width (number, default: 500)

  • Represents the total width of the client's screen in pixels. The value can be obtained from the client browser using the screen.width property.

time_zone_offset (number, default: -3)

  • Represents the time difference, in hours, between UTC and the local time of the cardholder's browser. The value typically ranges between -12 and +14. This can be obtained from the client browser using new Date().getTimezoneOffset() and converting it from minutes to hours (with the sign reversed).

ip_address (string, example: 10.0.0.1)

  • Represents the client's IP address (IPv4) used to uniquely identify a device on the network. This value can be obtained from the client browser via the navigator.connection property or using external IP detection services. If not provided, the IP address will be automatically extracted from the request made.

All fields:

"data_only": {
  "color_depth": 24,
  "screen_width": 2560,
  "screen_height": 1440,
  "java_enabled": false,
  "device_type": "BROWSER",
  "language": "BR",
  "time_zone_offset": -3,
  "ip_address": "200.164.21.168"
}

Mandatory fields only:

"data_only": {
  "color_depth": 24,
  "screen_width": 2560,
  "screen_height": 1440,
  "java_enabled": false
}
post/v1/transactions/cards

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

encrypted_cardstring required

Encrypted edubank card data

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",
  "encrypted_card": "U2FsdGVkX19sBR6NRhBCEmNyN3DJCHgjLZy2Z6cIMFWhO3vFhP+0C4npjEaNbtzmHGbsMhYTunhmExBJDLpVwPpZy9CBM4RN1MYxZ7MZFIWv2vnGTwUmf+MAo1RT2MvMT+UgAdyVE3TOY+UlNZ0nnXKsUExPsCJYdt748fazyxst6CcLwZA1zCZuikxoRK/h+7mLWMEIUzXQevqdZCh/tEZKxr2Fkz0VEuH8ETa4G27hpwAVrEdq1uixHBiGSlq6",
  "data_only": {
    "ip_address": "10.0.0.1"
  }
}

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

card_brandstring

Flag of the credit card used

bank_slip_digitable_linestring

Digitable line for payment slip

pix_base64string

Pix qrcode image in base64

Example response

{
  "status_code": 200
}

Changes

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