---
title: "Get All PayTo Payment Initiation Requests for an Agreement"
method: GET
path: "/agreements/{agreement_uuid}/payment_requests"
tags: ["PayTo Payments"]
---

# Get All PayTo Payment Initiation Requests for an Agreement

`GET /agreements/{agreement_uuid}/payment_requests`

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.

## Path parameters

- `agreement_uuid` string, required

## Query parameters

- `start_date` string, required
- `end_date` string, required
- `status` string[]
- `size` integer
- `page` integer

## Response `200`

Ok

- InitiatePaymentListResponse — List of Initiate Payment Status details.
  - `total_count` integer — Total number of initiate payments available
  - `initiate_payment_status_responses` InitiatePaymentStatusResponse[] — List of Initiate Payment requests.
    - `payment_request_uuid` string — Unique identifier for the payment request in UUID format.
    - `instruction_id` string — Unique identifier for each payment and retry request generated as per NPPA guidelines.
    - `agreement_uuid` string — Unique agreement identifier.
    - `agreement_id` string — Unique agreement identifier generated by NPPA.
    - `status` 'PENDING_PAYMENT_INITIATION' | 'PAYMENT_INITIATED' | 'PAYMENT_INITIATION_COMPLETED' | 'PAYMENT_INITIATION_REJECTED' — Possible statuses for payment or retry requests:<table><tr><td>Code</td><td>Description</td></tr><tr><td>PENDING_PAYMENT_INITIATION</td><td>Payment request is pending for initiation.</td></tr><tr><td>PAYMENT_INITIATED</td><td>Payment request is initiated.</td></tr><tr><td>PAYMENT_INITIATION_COMPLETED</td><td>Payment request is completed.</td></tr><tr><td>PAYMENT_INITIATION_REJECTED</td><td>Payment request is rejected.</td></tr></table>
    - `status_description` string — Free text field to provide description status
    - `status_reason_code` string — Free text field to provide reason code:<table><tr><td>Reason Code</td><td>Description</td><td>Retry eligible</td></tr><tr><td>ClearingAndSettlementError </td><td>An error occurred during clearing and settlement of the payment. Please retry the same payment again or contact Zai support.</td><td>Yes</td></tr><tr><td>PayeeBankOffline </td><td>Payee institution is offline. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>PayerAccountNumberInvalid </td><td>Payer account details or PayID provided is invalid or does not exist within NPP. Please update the agreement with correct account details and try again.</td><td>No</td></tr><tr><td>PayeeAccountNumberInvalid </td><td>Payee account details provided is invalid or does not exist within NPP. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>PayerAccountClosed </td><td>Payer account provided is closed. Please update the agreement with correct account details and try again.</td><td>No</td></tr><tr><td>InsufficientFunds </td><td>Payer account has insufficient funds at the moment. Please contact the payer and retry the same payment again after funds availability.</td><td>Yes</td></tr><tr><td>BlockedAccount </td><td>Account provided is temporarily blocked. Please retry the same payment again after some time or contact the payer.</td><td>Yes</td></tr><tr><td>PayeeAccountClosed </td><td>Payee account provided is closed. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>PayerAccountTypeInvalid </td><td>Payer account type is invalid - unable to debit funds within NPP. Please update the agreement with correct account details and try again or contact the payer.</td><td>No</td></tr><tr><td>PayeeAccountTypeInvalid </td><td>Payee account type is invalid - unable to credit funds within NPP. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>UnexpectedError </td><td>Unexpected error occurred while processing the payment initiation request. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>TransactionForbiddenOnPayerAccount</td><td>Either the Payer account does not allow debits within NPP or agreement to debit the account is not active. Please update the agreement with correct account details and try again or contact the Payer.</td><td>No</td></tr><tr><td>NPPTransactionNotSupported </td><td>Payee institution has rejected the NPP payment from Payer institution. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>UnspecifiedReason </td><td>Payment initiation request has been rejected by the Payer institution without any specified reason.</td><td>Yes</td></tr><tr><td>RequestedByPayer </td><td>Payment rejection has been requested by the Payer. Please contact the Payer or retry the same payment again.</td><td>Yes</td></tr><tr><td>UndisclosedReason </td><td>Payment has been rejected due to undisclosed reasons.</td><td>No</td></tr><tr><td>RequestedByPayer-UnspecifiedReason </td><td>Payment has been rejected by the Payer without any specified reason. Please retry the same payment again or contact the Payer.</td><td>Yes</td></tr><tr><td>Prohibited </td><td>Payment has been rejected as it is considered prohibited.</td><td>No</td></tr><tr><td>RequestedByPayerBank-UnspecifiedReason</td><td>Payment has been rejected by the Payer institution without any specified reason. Please try again or contact the Payer institution.</td><td>No</td></tr><tr><td>PayeeNotOnAllowlistOfPayer </td><td>Payee not on the allowlist/trusted list of the Payer. Please try again or contact the Payer.</td><td>No</td></tr><tr><td>PayeeOnBlocklistOfPayer </td><td>Payee is blocked/blacklisted by the Payer. Please try again or contact the Payer.</td><td>No</td></tr><tr><td>ExceedsMaxAllowedDirectDebitTransactions </td><td>The payment request exceeds the maximum number of direct debit transactions allowed on the Payer account. Please retry the same payment again or contact the Payer.</td><td>Yes</td></tr><tr><td>ExceedsMaxAllowedDirectDebitTransactionAmount</td><td>The payment amount requested exceeds the maximum amount that can be debited from the Payer account via direct debit. Please retry the same payment again or contact the Payer.</td><td>Yes</td></tr><tr><td>UnexpectedError-RetrySamePayment </td><td>Unexpected error occurred while processing the payment initiation request. Please retry the same payment again or contact Zai support.</td><td>Yes</td></tr><tr><td>PayerUnavailable </td><td>Payer institution is unavailable. Please retry the same payment again or contact the Payer.</td><td>Yes</td></tr><tr><td>InvalidPayerPayID </td><td>PayID details of the Payer are no longer valid. Please update the agreement with correct details and try again or contact the Payer.</td><td>No</td></tr><tr><td>PayerBSBNotNPPReachable </td><td>Payer BSB is not NPP reachable. Please update the agreement with correct details and try again or contact the Payer.</td><td>No</td></tr><tr><td>PayerNotNPPReachable </td><td>Payer is no longer reachable on NPP. Please try again or cancel the agreement.</td><td>No</td></tr><tr><td>PayeeNotNPPReachable </td><td>Payee is no longer reachable on NPP. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>IncorrectPayerPayID </td><td>PayID details of the Payer are no longer valid as the PayID has been ported incorrectly. Please update the agreement with correct details and try again or contact the Payer.</td><td>No</td></tr><tr><td>NotRetryEligible </td><td>Retries are allowed only if the payment has been rejected with retry eligible rejection reasons.</td><td>No</td></tr><tr><td>EndToEndIDInvalidOrMissing </td><td>EndToEndID is either invalid or missing. Please correct the end to end id and retry the same payment again.</td><td>Yes</td></tr><tr><td>Non-CompliantPayment </td><td>Payment amount is not as per the agreed payment terms and conditions. Please correct the amount and retry the same payment again.</td><td>Yes</td></tr><tr><td>NPPLimitExceeded </td><td>Payment amount requested exceeds the agreed limits for the Payer account. Please correct the amount and retry the same payment again.</td><td>Yes</td></tr><tr><td>UnrecognisedInitiatingParty </td><td>The Payer has requested the payment rejection as the Initiating party is not recognised by them. Please try again or contact the Payer.</td><td>No</td></tr><tr><td>UnknownPayer </td><td>The payment has been rejected by the Payer institution as the Payer is not known as per records. Please try again or contact the Payer.</td><td>No</td></tr><tr><td>PayeeBSBNotNPPReachable </td><td>Payee BSB is not NPP reachable. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>PayerNameOrAddressDetailsMissing </td><td>Payer name or address details are missing. Please update the agreement with complete Payer details and try again.</td><td>No</td></tr><tr><td>PayeeNameOrAddressDetailsMissing </td><td>Payee name or address details are missing. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>UnknownReason </td><td>Payment has been rejected due to unknown reason.</td><td>No</td></tr><tr><td>PayeeUnavailable </td><td>Payee institution is unavailable. Please retry the same payment again or contact Zai support.</td><td>Yes</td></tr><tr><td>PayerNameMissing </td><td>Payer name is missing. Please update the agreement with complete Payer details and try again.</td><td>No</td></tr><tr><td>PayeeNameMissing </td><td>Payee name is missing in the agreement. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>UnsupportedCurrency </td><td>Unable to debit funds in AUD from the provided Payer account.</td><td>No</td></tr><tr><td>AmountExceedsMaxNPPLimit </td><td>Payment amount either exceeds the maximum allowed NPP limit of $99,999,999,999 or maximum allowed NPP limit for the Payer account.</td><td>No</td></tr></table>
    - `status_reason_description` string — Free text field to provide reason description.
    - `payment_reconciled` boolean — Indicator to say whether the payment has been reconciled successfully on user's wallet or not.
    - `created_at` string — Payment request creation date.
    - `updated_at` string — Payment request modification date.
    - `payment_info` PaymentInfo — Payment Request details. **Property descriptions**: - **instruction_id** - Unique identifier for the payment request generated as per NPPA guidelines. This identifier is used to identify the payment uniquely with NPPA and payer as well. - **instructed_amount** - Specifies the amount to be debited the from debtor's bank account before deduction of charges. - **last_payment** - Indicates that it is the last payment associated with the agreement. Post this, the agreement will be marked as CANCELLED automatically and no further payments can be requested on this agreement. - **end_to_end_id** - Unique identification to unambiguously identify the payment. This identification is passed on, unchanged, throughout the entire end-to-end chain. It is recommended to provide this identifier which can be passed between entities to identify the payment during queries/investigations if any. If not provided, debtor reference (if available) from the agreement will be populated. If none available, default value "NOTPROVIDED" will be populated in the payment initiation request. - **remittance_info** - Free text field to provide any narrative for the payment. - **unique_superannuation_code** - For agreements created with PURPOSE_CODE = PENS (pension payments), this should be the USI number for the superannuation fund. - **unique_superannuation_id** - For agreements created with PURPOSE_CODE = PENS (pension payments), this should be the USI - code indicating the identifier to whom the superannuation fund will be provided.
      - `instruction_id` string — Unique identifier for each payment and retry request generated as per NPPA guidelines.
      - `instructed_amount` string — Specifies an amount in cents
      - `last_payment` boolean — Indicates a "Yes" or "No" type of answer for an element.
      - `end_to_end_id` string — Specifies a character string with a maximum length of 35 characters.
      - `remittance_info` string — Specifies a character string with a maximum length of 280 characters.
      - `unique_superannuation_id` string — Specifies a character string with a maximum length of 35 ASCII printable characters.
      - `unique_superannuation_code` string — Specifies a character string with a maximum length of 35 ASCII printable characters.
    - `retry_attempts` RetryAttempts — List of retry attempts for the payment request. **Property descriptions**: - **count** - Payment retry count. - **retry_info** - Payment information for each retry attempt, listed in descending order of retry attempts.
      - `count` integer — Retries count.
      - `retry_info` RetryInfo[] — Retry info for initiate payment.
        - `instruction_id` string — Unique identifier for each payment and retry request generated as per NPPA guidelines.
        - `status` 'PAYMENT_REJECTED' — Possible statuses for payment or retry requests:<table><tr><td>Code</td><td>Description</td></tr><tr><td>PAYMENT_INITIATION_REJECTED</td><td>Payment request is rejected.</td></tr></table>
        - `status_description` string — Free text field to provide description status:
        - `status_reason_code` string — Free text field to provide reason code:<table><tr><td>Reason Code</td><td>Description</td><td>Retry eligible</td></tr><tr><td>ClearingAndSettlementError </td><td>An error occurred during clearing and settlement of the payment. Please retry the same payment again or contact Zai support.</td><td>Yes</td></tr><tr><td>PayeeBankOffline </td><td>Payee institution is offline. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>PayerAccountNumberInvalid </td><td>Payer account details or PayID provided is invalid or does not exist within NPP. Please update the agreement with correct account details and try again.</td><td>No</td></tr><tr><td>PayeeAccountNumberInvalid </td><td>Payee account details provided is invalid or does not exist within NPP. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>PayerAccountClosed </td><td>Payer account provided is closed. Please update the agreement with correct account details and try again.</td><td>No</td></tr><tr><td>InsufficientFunds </td><td>Payer account has insufficient funds at the moment. Please contact the payer and retry the same payment again after funds availability.</td><td>Yes</td></tr><tr><td>BlockedAccount </td><td>Account provided is temporarily blocked. Please retry the same payment again after some time or contact the payer.</td><td>Yes</td></tr><tr><td>PayeeAccountClosed </td><td>Payee account provided is closed. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>PayerAccountTypeInvalid </td><td>Payer account type is invalid - unable to debit funds within NPP. Please update the agreement with correct account details and try again or contact the payer.</td><td>No</td></tr><tr><td>PayeeAccountTypeInvalid </td><td>Payee account type is invalid - unable to credit funds within NPP. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>UnexpectedError </td><td>Unexpected error occurred while processing the payment initiation request. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>TransactionForbiddenOnPayerAccount</td><td>Either the Payer account does not allow debits within NPP or agreement to debit the account is not active. Please update the agreement with correct account details and try again or contact the Payer.</td><td>No</td></tr><tr><td>NPPTransactionNotSupported </td><td>Payee institution has rejected the NPP payment from Payer institution. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>UnspecifiedReason </td><td>Payment initiation request has been rejected by the Payer institution without any specified reason.</td><td>Yes</td></tr><tr><td>RequestedByPayer </td><td>Payment rejection has been requested by the Payer. Please contact the Payer or retry the same payment again.</td><td>Yes</td></tr><tr><td>ClearingAndSettlementError </td><td>An error occurred during clearing and settlement of the payment. Please retry the same payment again or contact Zai support.</td><td>Yes</td></tr><tr><td>UndisclosedReason </td><td>Payment has been rejected due to undisclosed reasons.</td><td>No</td></tr><tr><td>RequestedByPayer-UnspecifiedReason </td><td>Payment has been rejected by the Payer without any specified reason. Please retry the same payment again or contact the Payer.</td><td>Yes</td></tr><tr><td>Prohibited </td><td>Payment has been rejected as it is considered prohibited.</td><td>No</td></tr><tr><td>RequestedByPayerBank-UnspecifiedReason</td><td>Payment has been rejected by the Payer institution without any specified reason. Please try again or contact the Payer institution.</td><td>No</td></tr><tr><td>PayeeNotOnAllowlistOfPayer </td><td>Payee not on the allowlist/trusted list of the Payer. Please try again or contact the Payer.</td><td>No</td></tr><tr><td>PayeeOnBlocklistOfPayer </td><td>Payee is blocked/blacklisted by the Payer. Please try again or contact the Payer.</td><td>No</td></tr><tr><td>ExceedsMaxAllowedDirectDebitTransactions </td><td>The payment request exceeds the maximum number of direct debit transactions allowed on the Payer account. Please retry the same payment again or contact the Payer.</td><td>Yes</td></tr><tr><td>ExceedsMaxAllowedDirectDebitTransactionAmount</td><td>The payment amount requested exceeds the maximum amount that can be debited from the Payer account via direct debit. Please retry the same payment again or contact the Payer.</td><td>Yes</td></tr><tr><td>UnexpectedError-RetrySamePayment </td><td>Unexpected error occurred while processing the payment initiation request. Please retry the same payment again or contact Zai support.</td><td>Yes</td></tr><tr><td>PayerUnavailable </td><td>Payer institution is unavailable. Please retry the same payment again or contact the Payer.</td><td>Yes</td></tr><tr><td>InvalidPayerPayID </td><td>PayID details of the Payer are no longer valid. Please update the agreement with correct details and try again or contact the Payer.</td><td>No</td></tr><tr><td>PayerBSBNotNPPReachable </td><td>Payer BSB is not NPP reachable. Please update the agreement with correct details and try again or contact the Payer.</td><td>No</td></tr><tr><td>PayerNotNPPReachable </td><td>Payer is no longer reachable on NPP. Please try again or cancel the agreement.</td><td>No</td></tr><tr><td>PayeeNotNPPReachable </td><td>Payee is no longer reachable on NPP. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>IncorrectPayerPayID </td><td>PayID details of the Payer are no longer valid as the PayID has been ported incorrectly. Please update the agreement with correct details and try again or contact the Payer.</td><td>No</td></tr><tr><td>NotRetryEligible </td><td>Retries are allowed only if the payment has been rejected with retry eligible rejection reasons.</td><td>No</td></tr><tr><td>EndToEndIDInvalidOrMissing </td><td>EndToEndID is either invalid or missing. Please correct the end to end id and retry the same payment again.</td><td>Yes</td></tr><tr><td>Non-CompliantPayment </td><td>Payment amount is not as per the agreed payment terms and conditions. Please correct the amount and retry the same payment again.</td><td>Yes</td></tr><tr><td>NPPLimitExceeded </td><td>Payment amount requested exceeds the agreed limits for the Payer account. Please correct the amount and retry the same payment again.</td><td>Yes</td></tr><tr><td>UnrecognisedInitiatingParty </td><td>The Payer has requested the payment rejection as the Initiating party is not recognised by them. Please try again or contact the Payer.</td><td>No</td></tr><tr><td>UnknownPayer </td><td>The payment has been rejected by the Payer institution as the Payer is not known as per records. Please try again or contact the Payer.</td><td>No</td></tr><tr><td>PayeeBSBNotNPPReachable </td><td>Payee BSB is not NPP reachable. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>PayerNameOrAddressDetailsMissing </td><td>Payer name or address details are missing. Please update the agreement with complete Payer details and try again.</td><td>No</td></tr><tr><td>PayeeNameOrAddressDetailsMissing </td><td>Payee name or address details are missing. Please try again or contact Zai support.</td><td>No</td></tr><tr><td>UnknownReason </td><td>Payment has been rejected due to unknown reason.</td><td>No</td></tr><tr><td>PayeeUnavailable </td><td>Payee institution is unavailable. Please retry the same payment again or contact Zai support.</td><td>Yes</td></tr><tr><td>PayerNameMissing </td><td>Payer name is missing. Please update the agreement with complete Payer details and try again.</td><td>No</td></tr><tr><td>UnsupportedCurrency </td><td>Unable to debit funds in AUD from the provided Payer account.</td><td>No</td></tr><tr><td>AmountExceedsMaxNPPLimit </td><td>Payment amount either exceeds the maximum allowed NPP limit of $99,999,999,999 or maximum allowed NPP limit for the Payer account.</td><td>No</td></tr>
        - `status_reason_description` string — Free text field to provide reason description.
        - `created_at` string — Payment request creation date.
        - `updated_at` string — Payment request modification date.
        - `payment_info` PaymentInfo — Payment Request details. **Property descriptions**: - **instruction_id** - Unique identifier for the payment request generated as per NPPA guidelines. This identifier is used to identify the payment uniquely with NPPA and payer as well. - **instructed_amount** - Specifies the amount to be debited the from debtor's bank account before deduction of charges. - **last_payment** - Indicates that it is the last payment associated with the agreement. Post this, the agreement will be marked as CANCELLED automatically and no further payments can be requested on this agreement. - **end_to_end_id** - Unique identification to unambiguously identify the payment. This identification is passed on, unchanged, throughout the entire end-to-end chain. It is recommended to provide this identifier which can be passed between entities to identify the payment during queries/investigations if any. If not provided, debtor reference (if available) from the agreement will be populated. If none available, default value "NOTPROVIDED" will be populated in the payment initiation request. - **remittance_info** - Free text field to provide any narrative for the payment. - **unique_superannuation_code** - For agreements created with PURPOSE_CODE = PENS (pension payments), this should be the USI number for the superannuation fund. - **unique_superannuation_id** - For agreements created with PURPOSE_CODE = PENS (pension payments), this should be the USI - code indicating the identifier to whom the superannuation fund will be provided.
          - `instruction_id` string — Unique identifier for each payment and retry request generated as per NPPA guidelines.
          - `instructed_amount` string — Specifies an amount in cents
          - `last_payment` boolean — Indicates a "Yes" or "No" type of answer for an element.
          - `end_to_end_id` string — Specifies a character string with a maximum length of 35 characters.
          - `remittance_info` string — Specifies a character string with a maximum length of 280 characters.
          - `unique_superannuation_id` string — Specifies a character string with a maximum length of 35 ASCII printable characters.
          - `unique_superannuation_code` string — Specifies a character string with a maximum length of 35 ASCII printable characters.

## Other responses

- `400` — Bad Request <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1058</td><td>Invalid Request: Failed to read the request.</td></tr>"<tr><td>PAYT-ERR-1052</td><td>Invalid Data: [FieldName] provided should contain any of the values [Acceptable values].</td></tr><tr><td>PAYT-ERR-1053</td><td>Invalid Data: [FieldName] provided is invalid. Expected format [DateFormat].</td></tr><tr><td>PAYT-ERR-2601</td><td>Invalid Date Range: Start date should be before end date.</td></tr><tr><td>PAYT-ERR-2602</td><td>Invalid Date Range: Range provided should be less than or maximum upto a year.</td></tr></table>
- `401` — Unauthorised <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1000</td><td>Invalid or missing authorisation token.</td></tr></table>
- `403` — Forbidden <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1001</td><td>PayTo feature not available.</td></tr></table>
- `404` — Not Found <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2400</td><td>Agreement with provided uuid does not exist.</td></tr></table>
- `500` — Internal Server Error <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1003</td><td>An error occurred processing your request. Please try again.</td></tr></table>

---

[API](https://skmtc.net/hellozai/apis/assembly-api.md) · [All operations](https://skmtc.net/hellozai/apis/assembly-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hellozai/assembly-api/versions/60b528b2e015/schema)