Skip to content

Reports Payout payment changes

Overview

Retrieve payout payment change events within a date range.

Path

/v1/realpay/{merchant_number}/reports/payo_payment_changes_report

Path Parameters

  • merchant_number (string, required)

Common Query Parameters

  • Version (string, required, default: v1)

Filter Query Parameters

  • StartDate (string, required): Format YYYY-MM-DD HH24:MI
  • EndDate (string, required): Format YYYY-MM-DD HH24:MI
  • ClientNumber (string, optional)
  • ContractNumber (string, optional)
  • ContractSequence (integer, optional)
  • PaymentSequence (integer, optional)

GET Payout Payment Changes Report

Retrieve payout payment changes.

Success Response (200) Schema

PayoPaymentChangesReportGetResponse

Response Example (200)

{
  "PayoPaymentChangesReportGetResponse": [
    {
      "ChangeDate": "2024-05-05 14:10",
      "ClientNumber": "L11306666",
      "ContractNumber": "C1603",
      "ContractSequence": 9011154048,
      "PaymentSequence": 5,
      "ChangeType": "AMEND",
      "FieldChanged": "Amount",
      "OldValue": "100.00",
      "NewValue": "150.00"
    }
  ],
  "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