Maintain Payout payments

Overview

Maintain Payout Payments (Create, Edit, Retrieve).

Path

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

Path Parameters

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

Common Query Parameters

• Version (string, required, default: v1)

---

POST Create Payout Payment

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

Request Body Schema (POST)

PayoPaymentPostRequest (array of PaymentRequest)

Request Example (POST)

{
  "PayoPaymentPostRequest": [
    {
      "ClientNumber": "L00012",
      "ContractNumber": "C1603",
      "PaymentDate": "YYYY-MM-DD HH24:MI",
      "PaymentAmount": 123.45,
      "PaymentIndicator": "PAAF"
    }
  ]
}

Success Response (200) Schema (POST)

PayoPaymentsPostResponse

Response Example (POST)

{
  "PayoPaymentsPostResponse": [
    {
      "Successful": [
        {
          "ClientNumber": "L00012",
          "ContractNumber": "C1603",
          "PaymentDate": "YYYY-MM-DD HH24:MI",
          "PaymentAmount": 123.45,
          "PaymentIndicator": "PAAF"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

PUT Edit Payout Payment

Edit an existing payout payment. Identify with PaymentSequence and (ClientNumber & ContractNumber) OR ContractSequence.

Request Body Schema (PUT)

PaymentPutRequest (array of PaymentRequest)

Request Example (PUT)

{
  "PaymentPutRequest": [
    {
      "ClientNumber": "L00012",
      "ContractNumber": "C1603",
      "PaymentDate": "YYYY-MM-DD HH24:MI",
      "PaymentAmount": 200.00,
      "PaymentIndicator": "PAAF",
      "PaymentSequence": 1
    }
  ]
}

Success Response (200) Schema (PUT)

PaymentPutResponse

Response Example (PUT)

{
  "PaymentPutResponse": [
    {
      "Successful": [
        {
          "ClientNumber": "L00012",
          "ContractNumber": "C1603",
          "PaymentDate": "YYYY-MM-DD HH24:MI",
          "PaymentAmount": 200.00,
          "PaymentIndicator": "PAAF",
          "PaymentSequence": 1
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

---

GET Retrieve Payout Payments

Retrieve payout payment(s).

Additional Query Parameters (GET)

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

Success Response (200) Schema (GET)

PaymentGetResponse

Response Example (GET)

{
  "PaymentGetResponse": [
    {
      "ClientNumber": "L00012",
      "ContractSequence": 1011157571,
      "ContractNumber": "C1603",
      "PaymentStatus": "A",
      "ResponseCode": "EPB005"
    }
  ],
  "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