EDedubank
Transactions

Get all transactions

Retrieve all transactions associated with the SELLER-ID

get/v1/transactions

Request

  • Base URL
    https://api.edubank.com.br (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or API key in header authorization
    • or API key in header authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

pagestring required

Select the page

limitstring required

Limits the number of objects returned, which can be between 1 and 100

sort'ASC' | 'DESC' required

Determine how to sort the list by object creation date

reference_idstring

To find a transaction with a specific reference_id

payment_received_at_range_gtestring

Payments expected on a date greater than. FORMAT: YYYY-MM-DD

payment_received_at_range_ltestring

Payments expected on a date lower than. FORMAT: YYYY-MM-DD

Response

The record has been successfully getted

company_logo_urlstring

URL with the company logo. This logo will be displayed on the checkout page

company_namestring

Company name that will be displayed on the checkout page

company_datastring

Company data that will be displayed on the checkout page

lose_discount_forstring[]

Payment methods that should lose the applied discount

seller_idstring required

Edubank seller id

transaction_idstring required

Edubank transaction id

settledboolean required

The transaction was confirmed manually. The term "settled" is equivalent to "mark as paid"

canceledboolean required

The transaction has been canceled

payment_confirmedboolean required

Informs if the payment has already been confirmed

successfully_paidboolean required

Informs whether the payment operation was successful

payment_amountnumber

Confirmed payment amount

reference_idstring required

Reference ID of your application VARCHAR(500)

buyer_idstring required

Edubank buyer 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

transaction_limit_datestring required

Deadline to use this transaction for payment

transaction_descriptionstring

Description of the sale for payment

seller_card_feesstring[] required

Seller installment card fees

pix_feesstring required

Seller pix fees

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 response

{
  "company_logo_url": "Optional",
  "company_name": "Optional",
  "company_data": "Optional",
  "seller_id": "117a97d225337dmf96bb0b883a1019sj",
  "buyer": {
    "id": "39c784f7bf754698aa078a261cf42439",
    "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"
    }
  },
  "transaction_id": "117a97d2253e4a22a7bb0b883a10242c",
  "reference_id": "my_ref_518",
  "buyer_id": "11eff0fe1b3b4ece9f930088d797261f",
  "expires_in": "2026-10-01T23:59:59+00:00",
  "transaction_limit_date": "2027-09-01",
  "transaction_description": "Sale of tickets for the show on the 30th",
  "seller_card_fees": [
    0.1111,
    0.2222,
    0.3333,
    0.4444,
    0.5555,
    0.6666,
    0.7777,
    0.8888,
    0.9999,
    1.101,
    1.1111,
    1.1212
  ],
  "pix_fees": "0.5000",
  "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",
  "payments": [
    {
      "create_at": "2026-09-01T23:59:59+00:00",
      "update_at": "2026-10-01T23:59:59+00:00",
      "payment_id": "d03918d2253e4a22a7bb0b88lap2039d",
      "payment_type": "PIX",
      "payment_received_at": "2026-09-01T23:59:59+00:00",
      "fees": "0.00"
    }
  ]
}

Changes

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