Maintain Payout contracts

Overview

Maintain Payout (Payment) Contracts (Create, Delete, Retrieve).

Path

/v1/realpay/{merchant_number}/maintain/payo/contracts/{product}

Path Parameters

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

Common Query Parameters

• Version (string, required, default: v1)

---

POST Create Payout Contract

Create a new payout contract and optionally auto-generate payments.

Request Body Schema (POST)

PayoContractPostRequest (array of PayoContractRequest)

Request Example (POST)

{
  "PayoContractPostRequest": [
    {
      "ClientNumber": "L00012",
      "ContractNumber": "C1603",
      "PaymentAmount": 123.45,
      "NumberOfPayments": 1,
      "PaymentStartDate": "YYYY-MM-DD HH24:MI",
      "FrequencyCode": "M",
      "PaymentIndicator": "PAAF"
    }
  ]
}

Success Response (200) Schema (POST)

PayoContractPostResponse

Response Example (POST)

{
  "PayoContractPostResponse": [
    {
      "Successful": [
        {
          "ClientNumber": "L00012",
          "ContractNumber": "C1603",
          "FrequencyCode": "M",
          "PaymentIndicator": "PAAF",
          "PaymentStartDate": "YYYY-MM-DD HH24:MI",
          "PaymentAmount": 123.45,
          "NumberOfPayments": 1,
          "SuccessPayments": [],
          "FailedPayments": []
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

DELETE Delete Payout Contract

Delete (cancel) a payout contract using either ClientNumber & ContractNumber or ContractSequence plus Cancel parameters.

Additional Required Query Parameters (DELETE)

• ClientNumber (string) AND ContractNumber (string) OR ContractSequence (integer)
• CancelCode (string, required): For valid codes see /general/payout_cancel_codes/{Product}
• CancelDate (string, required): Format YYYY-MM-DD HH24:MI

Success Response (200) Schema (DELETE)

PayoContractDeleteResponse

Response Example (DELETE)

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

---

GET Retrieve Payout Contract

Retrieve payout contract(s). Provide either ClientNumber & ContractNumber or ContractSequence.

Additional Query Parameters (GET)

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

Success Response (200) Schema (GET)

PayoContractGetResponse

Response Example (GET)

{
  "PayoContractGetResponse": [
    {
      "ContractSequence": 1011157571,
      "ClientNumber": "L00012",
      "ContractNumber": "C1603",
      "PaymentStartDate": "YYYY-MM-DD HH24:MI",
      "PaymentIndicator": "PAAF",
      "NumberOfPayments": 1,
      "ContractPayments": []
    }
  ],
  "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