Maintain Instalments

Overview

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

Path

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

Path Parameters

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

Common Query Parameters

• Version (string, required, default: v1)

---

POST Create Instalment

Create a new instalment. One of (ClientNumber & ContractNumber) OR ContractSequence must be supplied.

Request Body Schema (POST)

InstalmentPostRequest (array of Instalment)

Request Example (POST)

{
  "InstalmentPostRequest": [
    {
      "ClientNumber": "L00012",
      "ContractNumber": "C1603",
      "InstalmentActionDate": "YYYY-MM-DD HH24:MI",
      "TrackingCode": "03",
      "InstalmentAmount": 123.45,
      "DebitSequenceType": "OOFF",
      "CTCAmount": 10.05
    }
  ]
}

Success Response (200) Schema (POST)

InstalmentPostResponse

Response Example (POST)

{
  "InstalmentPostResponse": [
    {
      "Successful": [
        {
          "ClientNumber": "L00012",
          "ContractNumber": "C1603",
          "InstalmentActionDate": "YYYY-MM-DD HH24:MI",
          "TrackingCode": "03",
          "InstalmentAmount": 123.45,
          "DebitSequenceType": "OOFF"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

PUT Edit Instalment

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

Request Body Schema (PUT)

InstalmentPutRequest (array of Instalment)

Request Example (PUT)

{
  "InstalmentPutRequest": [
    {
      "ClientNumber": "L00012",
      "ContractNumber": "C1603",
      "InstalmentSequence": 1,
      "InstalmentActionDate": "YYYY-MM-DD HH24:MI",
      "TrackingCode": "03",
      "InstalmentAmount": 150.00,
      "DebitSequenceType": "OOFF"
    }
  ]
}

Success Response (200) Schema (PUT)

InstalmentPutResponse

Response Example (PUT)

{
  "InstalmentPutResponse": [
    {
      "Successful": [
        {
          "ClientNumber": "L00012",
          "ContractNumber": "C1603",
          "InstalmentSequence": 1,
          "InstalmentActionDate": "YYYY-MM-DD HH24:MI",
          "TrackingCode": "03",
          "InstalmentAmount": 150.00,
          "DebitSequenceType": "OOFF"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

DELETE Delete Instalment

Delete an instalment.

Additional Required Query Parameters (DELETE)

• ClientNumber (string) AND ContractNumber (string) OR ContractSequence (integer)
• InstalmentSequence (integer, required)

Success Response (200) Schema (DELETE)

InstalmentDeleteResponse

Response Example (DELETE)

{
  "InstalmentDeleteResponse": [
    {
      "Successful": [
        {
          "ContractSequence": 9011154048,
          "InstalmentSequence": 1,
          "ClientNumber": "L00012",
          "ContractNumber": "C1603"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

GET Retrieve Instalments

Retrieve instalment(s).

Additional Query Parameters (GET)

• ClientNumber (string, optional)
• ContractNumber (string, optional)
• ContractSequence (integer, optional)
• InstalmentSequence (integer, optional)

Success Response (200) Schema (GET)

InstalmentGetResponse

Response Example (GET)

{
  "InstalmentGetResponse": [
    {
      "ClientNumber": "L00012",
      "ContractSequence": 9011154048,
      "ContractNumber": "C1603",
      "InstalmentSequence": 1,
      "InstalmentActionDate": "YYYY-MM-DD HH24:MI",
      "TrackingCode": "03",
      "InstalmentAmount": 123.45,
      "DebitSequenceType": "OOFF",
      "InstalmentStatus": "A"
    }
  ],
  "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