Maintain Instalments

Overview

Maintain Instalments (Create, Edit, Delete, Retrieve).

Path

/v1/realpay/{merchant_number}/maintain/mandate_initiate_records/{product}

Path Parameters

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

Common Query Parameters

• Version (string, required, default: v1)

---

PUT Edit Mandate Initiate Record

Edit an existing instalment. Identify with InstalmentSequence and (ClientNumber & ContractNumber) OR ContractSequence.

Request Body Schema (PUT)

MandateInitiatePutRecordsRequest (array of Instalment)

Request Example (PUT)

{
  "MandateInitiatePutRecordsRequest": [
    {
      "ContractSequence": 9011154048,
      "MandateInitiateStatusCode": "R",
      "ClientNumber": "L00012",
      "MandateType": "F",
      "TransactionType": "TT2",
      "MandateActionDate": "YYYY-MM-DD HH24:MI",
      "FrequencyCode": "MNTH",
      "CollectionDay": 25,
      "DebitSequenceType": "OOFF",
      "AdjustmentCategory": "N",
      "AdjustmentAmount": 123.45,
      "AdjustmentRate": "7.25",
      "TrackingYN": "N",
      "TrackingCode": "03",
      "ContractNumber": "C1603",
      "FirstCollectionDate": "YYYY-MM-DD HH24:MI",
      "FirstCollectionAmount": 123.45,
      "InstalmentStartDate": "YYYY-MM-DD HH24:MI",
      "InstalmentAmount": 123.45,
      "MaximumAmount": 123.45,
      "NumberOfInstalments": 1,
      "RMS": "N"
    }
  ]
}

Success Response (200) Schema (PUT)

MandateInitiatePutRecordsResponse

Response Example (PUT)

{
  "MandateInitiatePutRecordsResponse": [
    {
      "ContractSequence": 9011154048,
      "MandateInitiateStatusCode": "R",
      "ClientNumber": "L00012",
      "MandateType": "F",
      "TransactionType": "TT2",
      "MandateActionDate": "YYYY-MM-DD HH24:MI",
      "FrequencyCode": "MNTH",
      "CollectionDay": 25,
      "DebitSequenceType": "OOFF",
      "AdjustmentCategory": "N",
      "AdjustmentAmount": 123.45,
      "AdjustmentRate": "7.25",
      "TrackingYN": "N",
      "TrackingCode": "03",
      "ContractNumber": "C1603",
      "FirstCollectionDate": "YYYY-MM-DD HH24:MI",
      "FirstCollectionAmount": 123.45,
      "InstalmentStartDate": "YYYY-MM-DD HH24:MI",
      "InstalmentAmount": 123.45,
      "MaximumAmount": 123.45,
      "NumberOfInstalments": 1,
      "RMS": "N"
    }
  ]
}

---

DELETE Cancel Mandate Initiate Record

Cancel Mandate Initiate Record.

Additional Required Query Parameters (DELETE)

• ClientNumber (string) AND ContractNumber (string) OR ContractSequence (integer)

Success Response (200) Schema (DELETE)

InstalmentDeleteResponse

Response Example (DELETE)

{
  "MandateInitiateDeleteRecordsResponse": [
    {
      "Successful": [
        {
          "ClientNumber": "L00012",
          "ContractSequence": 9011154048,
          "ContractNumber": "C1603",
          "MandateProduct": "ADCTT1",
          "MandateType": "F",
          "TransactionType": "TT2",
          "MandateActionDate": "YYYY-MM-DD HH24:MI",
          "FrequencyCode": "MNTH",
          "CollectionDay": 25,
          "DebitSequenceType": "OOFF",
          "AdjustmentCategory": "N",
          "AdjustmentAmount": 123.45,
          "AdjustmentRate": "7.25",
          "TrackingYN": "N",
          "TrackingCode": "03",
          "FirstCollectionDate": "YYYY-MM-DD HH24:MI",
          "FirstCollectionAmount": 123.45,
          "InstalmentStartDate": "YYYY-MM-DD HH24:MI",
          "InstalmentAmount": 123.45,
          "MaximumAmount": 123.45,
          "FirstInitiationDate": "YYYY-MM-DD HH24:MI",
          "NumberOfInstalments": 1,
          "MandateInitiateStatusCode": "A",
          "MandateInitiateResult": "NRSP",
          "MandateBankReference": "0233201807170000001628",
          "MandateAuthorizationChannel": "INTERNETBANKING",
          "BankCode": 4,
          "BranchCode": 250655,
          "AccountType": 1,
          "AccountNumber": 18720129622,
          "AccountHolderName": "J Smith"
        }
      ],
      "Failed": [
        {
          "ClientNumber": "L00012",
          "ContractSequence": 9011154048,
          "ContractNumber": "C1603",
          "MandateProduct": "ADCTT1",
          "MandateType": "F",
          "TransactionType": "TT2",
          "MandateActionDate": "YYYY-MM-DD HH24:MI",
          "FrequencyCode": "MNTH",
          "CollectionDay": 25,
          "DebitSequenceType": "OOFF",
          "AdjustmentCategory": "N",
          "AdjustmentAmount": 123.45,
          "AdjustmentRate": "7.25",
          "TrackingYN": "N",
          "TrackingCode": "03",
          "FirstCollectionDate": "YYYY-MM-DD HH24:MI",
          "FirstCollectionAmount": 123.45,
          "InstalmentStartDate": "YYYY-MM-DD HH24:MI",
          "InstalmentAmount": 123.45,
          "MaximumAmount": 123.45,
          "FirstInitiationDate": "YYYY-MM-DD HH24:MI",
          "NumberOfInstalments": 1,
          "MandateInitiateStatusCode": "A",
          "MandateInitiateResult": "NRSP",
          "MandateBankReference": "0233201807170000001628",
          "MandateAuthorizationChannel": "INTERNETBANKING",
          "BankCode": 4,
          "BranchCode": 250655,
          "AccountType": 1,
          "AccountNumber": 18720129622,
          "AccountHolderName": "J Smith",
          "Failures": [
            {
              "FailureCode": "FDCMIT11",
              "FailureDescription": "First instalment date must be greater than sysdate"
            }
          ]
        }
      ]
    }
  ],
  "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