Skip to content

Reports Transactions

Overview

Retrieve transactions within a date range with optional filters.

Path

/v1/realpay/{merchant_number}/reports/transactions_report

Path Parameters

  • merchant_number (string, required)

Common Query Parameters

  • Version (string, required, default: v1)

Filter Query Parameters (required unless stated optional)

  • StartDate (string, required): Format YYYY-MM-DD HH24:MI
  • EndDate (string, required): Format YYYY-MM-DD HH24:MI
  • Product (string, optional)
  • ClientNumber (string, optional)
  • ContractNumber (string, optional)
  • ContractSequence (integer, optional)
  • MandateType (string, optional)
  • TrackingCode (string, optional)
  • DebitSequenceType (string, optional)

GET Transactions Report

Retrieve transactions report data.

Success Response (200) Schema

TransactionsReportGetResponse

Response Example (200)

{
  "TransactionsReportGetResponse": [
    {
      "TransactionDate": "2024-05-02 08:30",
      "ClientNumber": "L11306666",
      "ContractNumber": "C1603",
      "ContractSequence": 9011154048,
      "MandateType": "F",
      "DebitSequenceType": "OOFF",
      "TrackingCode": "03",
      "TransactionType": "TT2",
      "Amount": 350.00,
      "Status": "POSTED"
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

  • 400 BadRequest
  • 401 Unauthorized
  • 404 NotFound
  • 500 InternalError
  • 503 ServiceUnavailable