Skip to content

Report Mandate changes

Overview

Retrieve mandate change events within a date range for a product.

Path

/v1/realpay/{merchant_number}/reports/mandate_changes_report/{product}

Path Parameters

  • merchant_number (string, required)
  • product (string, required)

Common Query Parameters

  • Version (string, required, default: v1)

Filter Query Parameters

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

GET Mandate Changes Report

Retrieve mandate changes.

Success Response (200) Schema

MandateChangesReportGetResponse

Response Example (200)

{
  "MandateChangesReportGetResponse": [
    {
      "ChangeDate": "2024-05-06 12:20",
      "ClientNumber": "L11306666",
      "ContractNumber": "C1603",
      "ContractSequence": 9011154048,
      "MandateType": "F",
      "ChangeType": "FREEZE",
      "FieldChanged": "Status",
      "OldValue": "ACTIVE",
      "NewValue": "FROZEN"
    }
  ],
  "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