Sign in
Transactions

Returns all transactions generated within the specified due date range

Returns all transactions generated within the specified due date range. The date range must not exceed 31 days

Required Query Parameters:

  • page: The page number to return in the query
  • limit: The number of items to return per page. Maximum of 100
  • sort: The sort order of items by creation date. Allowed values: ASC (ascending) or DESC (descending)
  • due_date_start: The start of the due date range for filtering transactions
  • due_date_end: The end of the due date range for filtering transactions

Optional Query Parameters:

  • include_payments: (Default is false) Returns a payments property for each transaction, showing all associated payment methods
  • include_history: (Default is false) Returns the transaction’s notification history, along with responses (e.g., what the partner’s API responded when receiving notifications). Includes events such as settlements, receivables, and status changes
  • include_summary: (Default is false) Includes a summary at the root of the response object, with a general total of items returned in the query, including those on other pages

Include Summary: When include_summary is set to true, the response will include a summary with the following details:

  • totalTransactions: Total number of transactions returned, counting across all pages
  • totalAmount: Sum of the total transaction values across all pages (in the preferred currency)
  • totalPaid: Total number of paid transactions
  • totalPaidAmount: Total amount of the paid transactions
  • totalPaidDate1: Total number of transactions paid by the best due date
  • totalPaidAmountDate1: Total amount of transactions paid by the best due date
  • totalUnpaid: Total number of unpaid transactions
  • totalUnpaidAmount: Sum of the unpaid transaction amounts (best due date amount)
  • totalUnpaidOverdueAmount: Sum of the unpaid and overdue transaction amounts (gross amount)
  • totalCanceled: Total number of canceled transactions
  • TotalCanceledAmount: Sum of the canceled transaction amounts
  • totalSettled: Total number of settled transactions
  • TotalSettledAmount: Sum of the settled transaction amounts
  • totalVoided: Total number of voided transactions
  • TotalVoidedAmount: Sum of the voided transaction amounts
get/v2/transactions

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

due_date_startstring

Due date greater than or equal to. FORMAT: YYYY-MM-DD

due_date_endstring

Due date lower than or equal to. FORMAT: YYYY-MM-DD

include_paymentsboolean

Include all payments generated for transaction

include_historyboolean

Include transaction event history

include_summaryboolean

Include a summary of all transactions

reference_idstring

When refence_id is specified, due dates will not be considered and payments and history properties will always be returned

transaction_idstring

When transaction_id is specified, due dates will not be considered and payments and history properties will always be returned

Response

The record has been successfully getted

created_atstring required
updated_atstring
sandboxboolean required
status'PAID' | 'CANCELED' | 'SETTLED' | 'VOIDED' | 'OPEN' required

Current transaction status

paid_atstring nullable

When the transaction was paid

paid_with'PIX' | 'BANK_SLIP' | 'CREDIT_CARD' | 'DEBIT_CARD' | 'BANK_SLIP_PIX_WITH_PIX' | 'BANK_SLIP_PIX_WITH_BARCODE' nullable required

Payment method with which the transaction was paid

paid_amountnumber
transaction_idstring required

Edubank transaction id

reference_idstring required
seller_idstring required

Edubank seller id

notification_urlstring required

Example response

{
  "created_at": "2026-09-01T23:59:59+00:00",
  "updated_at": "2026-10-01T23:59:59+00:00",
  "status": "OPEN",
  "paid_at": "2026-10-01T23:59:59+00:00",
  "paid_with": "BANK_SLIP_PIX_WITH_BARCODE",
  "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_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"
    }
  ],
  "history": [
    {
      "created_at": "2026-09-01T23:59:59+00:00",
      "sent_with_success_in": "2026-09-01T23:59:59+00:00"
    }
  ]
}

Changes

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