---
title: "Failed NPP Payment Details"
method: GET
path: "/payment_details/failed/{instructionId}"
tags: ["Failed NPP Payment Details"]
---

# Failed NPP Payment Details

`GET /payment_details/failed/{instructionId}`

## Request

- Base URL: `https://sandbox.au-0000.api.assemblypay.com`
- URL: `https://sandbox.au-0000.api.assemblypay.com/payment_details/failed/{instructionId}`
- Auth: HTTP bearer

Show details of a specific failed **PayTo Payment** using a given :instructionId. <br /> This API would list pay-ins which failed to be reconciled on a user’s wallet along with failure details for it.

## Path parameters

- `instructionId` string, required

## Response `200`

OK

- PaymentData
  - `id` string, uuid, required
  - `debtor_name` string, required
  - `debtor_bsb` string, required
  - `debtor_account` string, required
  - `creditor_account` string, required
  - `creditor_name` string, required
  - `remittance_information` string, required
  - `type` string, required
  - `type_method` string, required
  - `error_message` 'Payment reconciliation failed on the user's wallet as the agreement associated with it is not active' | 'Payment reconciliation failed on the user's wallet as the payment initiation request associated is in invalid status' | 'Payment reconciliation failed on the user's wallet as the payment initiation request associated does not exist' | 'Payment reconciliation failed on the user's wallet as the payment initiation request provided does not match with the payment initiation request associated with the agreement' | 'Payment reconciliation failed on the user's wallet as PayTo feature is disabled for your platform. Please contact Zai support.' | 'Payment reconciliation failed on the user's wallet due to some technical error. Please contact Zai support.': Explanation why payment failed! Only available for PayTo Payments
  - `npp_details` NppDetails: Details for the NPP payment. `npp_details` will only be present when `type_method` is `npp_payin`
    - `pay_id` string, required
    - `pay_id_type` string, required
    - `clearing_system_transaction_id` string, required
    - `end_to_end_id` string, required
    - `cdtr_ref_inf` string, required
    - `ultm_cdtr_id` string, required
    - `ultmt_cdtr_schme_nm` string, required
    - `ultm_cdtr_nm` string
    - `ctgy_purp` string, required
    - `debtor_legal_name` string, required
    - `instruction_id` string: Unique identifier for the payment request generated as per NPPA guidelines. Only available for PayTo Payments
    - `agreement_id` string: Unique agreement identifier generated by NPPA. Only available for PayTo Payments
    - `agreement_uuid` string, uuid: Unique agreement identifier generated by Zai. Only available for PayTo Payments
  - `links` LinksNpp
    - `self` string, required
    - `agreements` string, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/hellozai/apis/supplementary-data-apis.md) - [All operations](https://skmtc.dev/hellozai/apis/supplementary-data-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/hellozai/apis/supplementary-data-apis/revisions/08a297b369b7?raw)