Skip to content

Reports OMNI Card Expiry

Overview

Retrieve Card Expiry Records for the specified Product and Card Expiry date range.

Path

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

Path Parameters

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

Query Parameters

  • CardExpiryStartYear (integer, required) – Start Year (YYYY)
  • CardExpiryStartMonth (integer, required) – Start Month (MM)
  • CardExpiryEndYear (integer, required) – End Year (YYYY)
  • CardExpiryEndMonth (integer, required) – End Month (MM)- Version (string, required, default: v1)

HTTP Request

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

Success Response (200) Schema

CardExpiryGetResponse

Response Example

{
  "CardExpiryGetResponse": [
    {
      "UserId": "ZA123123123123",
      "Name": "Jane",
      "Surname": "Doe",
      "CardNumber": "411111xxxxxx1111",
      "CardExpiryDate": "12-2027",
      "ContractNumber": "CNTR-00001",
      "ContractSequence": 4567
    }
  ],
  "APIResponse": {
    "CallSequence": 1010,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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