HEhellozai
Failed NPP Payment Details

Failed NPP Payment Details

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.

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

Path parameters

instructionIdstring required

instruction ID

Response

OK

idstring uuid required
debtor_namestring required
debtor_bsbstring required
debtor_accountstring required
creditor_accountstring required
creditor_namestring required
remittance_informationstring required
typestring required
type_methodstring 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

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "debtor_name": "ASSEMBLY TEST",
  "creditor_name": "ACME Corp Pty Ltd",
  "type": "deposit",
  "type_method": "npp_payin",
  "npp_details": {
    "pay_id": "npp@assemblypayments.com",
    "pay_id_type": "EMAIL",
    "clearing_system_transaction_id": "CTBAAUSNXXXN20191216050126353211111",
    "instruction_id": "BANKNTSTXXXI20180501000000000000010",
    "agreement_id": "ef0fcd9799431ef783204966f010603c",
    "agreement_uuid": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc"
  },
  "links": {
    "self": "/payment_details/failed/123567890",
    "agreements": "/payto/agreements/46deb476-c1a6-41eb-8eb7-26a695bbe5bc"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.