Skip to content

Reports OMNI Future Transactions

Overview

Retrieve a list of future Instalment Transactions within the specified date range for the Product.

Path

/v1/realpay/{merchant_number}/reports/omni/future_transactions/{product}

Path Parameters

  • merchant_number (string, required)
  • product (string, required) – Product Code

Query Parameters

  • StartDate (string, required, format: YYYY-MM-DD)
  • EndDate (string, required, format: YYYY-MM-DD)- Version (string, required, default: v1)

HTTP Request

GET /v1/realpay/{merchant_number}/reports/omni/future_transactions/{product}

Success Response (200) Schema

FutureTransactionsGetResponse

Response Example

{
  "FutureTransactionsGetResponse": [
    {
      "UserId": "ZA123123123123",
      "ContractNumber": "CNTR-00001",
      "ContractSequence": 4567,
      "Name": "Jane",
      "Surname": "Doe",
      "BeneficiaryNumber": 919191,
      "BeneficiaryName": "My Company Name",
      "ProductDescription": "Debit Order",
      "InstalmentSequence": 8901,
      "InstalmentActionDate": "2024-12-25 00:00",
      "InstalmentAmount": 8333.0,
      "InstalmentStatus": "ACTIVE",
      "Currency": "ZAR",
      "FrequencyCode": "M",
      "Mobile": "0821234567",
      "DialCode": "+27",
      "Email": "jane.doe@example.com"
    }
  ],
  "APIResponse": {
    "CallSequence": 3030,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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