Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
PayTo Payments

Get All PayTo Payment Initiation Requests for an Agreement

This operation is to retrieve all payment requests initiated for an agreement in the provided period (date range). Payment requests for a period of maximum one year or less than it can be retrieved at a time.

By default, all payment initiation requests (along with details) irrespective of the status will be listed via this endpoint. However, the results can be filtered based on status(es) if needed.

Request parameter descriptions:

  • status - List of valid agreement statuses. Example - Retrieve active and suspended payments only.
    • Valid values - PENDING_PAYMENT_INITIATION, PAYMENT_INITIATED, PAYMENT_INITIATION_COMPLETED, PAYMENT_INITIATION_REJECTED
  • start_date - Date range start, example - fetch all payments created between June to December 2022.
  • end_date - Date range end, example - fetch all payments created between June to December 2022.
  • size - Number of payments per page. Default value is 20.
  • page - Page number. Default value is 0.
get/agreements/{agreement_uuid}/payment_requests

Path parameters

agreement_uuidstring required
Example:d0c40d95-95b7-449b-9835-3c97c0386585

Query parameters

start_datestring required
Example:2021-11-10
end_datestring required
Example:2022-11-10
statusstring[]
sizeinteger
pageinteger

Response

Ok

total_countinteger

Total number of initiate payments available

Example response

{
  "total_count": 1,
  "initiate_payment_status_responses": [
    {
      "payment_request_uuid": "d0c40d95-95b7-449b-9835-3c97c0386585",
      "instruction_id": "BANKNTSTXXXI20180501000000000000010",
      "agreement_uuid": "d0c40d95-95b7-449b-9835-3c97c0386585",
      "agreement_id": "00000000000010008000000000000000",
      "status_description": "status description",
      "status_reason_description": "reason description",
      "payment_reconciled": true,
      "created_at": "2022-03-21 16:25:00.312368",
      "updated_at": "2022-03-22 16:25:00.312368",
      "payment_info": {
        "instruction_id": "BANKNTSTXXXI20180501000000000000010",
        "instructed_amount": "1000",
        "remittance_info": "remittance info",
        "unique_superannuation_id": "uniqueSuperannuation id",
        "unique_superannuation_code": "uniqueSuperannuation code"
      },
      "retry_attempts": {
        "count": 1,
        "retry_info": [
          {
            "instruction_id": "BANKNTSTXXXI20180501000000000000010",
            "status_description": "status description",
            "status_reason_description": "reason description",
            "created_at": "2022-03-21 16:25:00.312368",
            "updated_at": "2022-03-22 16:25:00.312368",
            "payment_info": {
              "instruction_id": "BANKNTSTXXXI20180501000000000000010",
              "instructed_amount": "1000",
              "remittance_info": "remittance info",
              "unique_superannuation_id": "uniqueSuperannuation id",
              "unique_superannuation_code": "uniqueSuperannuation code"
            }
          }
        ]
      }
    }
  ]
}