Skip to content

Maintain OMNI Initiate Payment

Overview

Initiate a payment for a specific Instalment.

Path

/v1/realpay/{merchant_number}/maintain/omni/initiate_payment/{product}

Path Parameters

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

Common Query Parameters

  • Version (string, required, default: v1)

PUT Initiate Payment

Initiate Payment for an Instalment.

Query Parameters (PUT)

  • ContractSequence (integer, required)
  • InstalmentSequence (integer, required)

Success Response (200) Schema (PUT)

PaymentInitiatePutResponse

Response Example (PUT)

{
  "PaymentInitiatePutResponse": [
    {
      "Successful": [
        {
          "ContractSequence": 4567,
          "InstalmentSequence": 8901,
          "Initiated": true
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 8899,
    "Status": "SUCCESS",
    "Version": "1.0.2",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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