Credit Transfer Batch Failed Webhook event

Failed vs Rejected Batch

It is important to distinguish between FAILED and REJECTED states, which both indicate unsuccessful processing but have different implications:

  • A FAILED Batch occurs when the entire Batch fails validation checks before individual Credit Transfers (CTs) are created. This is a Batch-level failure triggered by a common error affecting the whole Batch. The Batch is marked as FAILED, and no CTs are created.
  • REJECTED applies when individual CTs within a Batch fail specific validations during processing. This is a transaction-level failure, and a Batch can be marked as REJECTED even if only one CT fails. A REJECTED Batch can also have a mix of rejected and failed CTs.

The following table summarises the key differences:

Feature FAILED REJECTED
Scope Batch-level Transaction-level (can include Batch-level failures)
Trigger Failure of Batch-level validations Failure of individual CT validations during processing
CT Creation No CTs are created CTs are created, but some/all may fail or be rejected
Error Reporting rejectDetails on the Batch object rejectDetails on individual CT objects (and potentially the Batch)
Example Reason Invalid originator account, incorrect total amount Insufficient funds for a specific CT

Webhook Message Details

This Webhook has the following event type:

Webhook Event Type Description
CreditTransferBatchFailed Triggered where a Credit Transfer Batch transitions to status = FAILED

Webhook Event Message Details

The following table describes the details of the Webhook notification:

Parent Parameter Type Mandatory/Optional Description
root eventTimestamp number Mandatory The Unix epoch timestamp
root eventType string Mandatory CreditTransferBatchFailed
root resourceReference string optional This can be the business reference of the resource, useful when filtering events via the Webhooks area of the Nuapay Console.
root resourceReferenceType string optional This can be a business reference of the resource, useful when filtering events via the Webhooks area of the Nuapay Console.
root resourceUri string Mandatory This is the URI of the resource. Use the URI to retrieve more details - see Retrieve Credit Transfer Batch.
root resourceId string Mandatory The encoded technical ID of the resource being referenced in the event.
root resourceType string Mandatory This is the type of the resource to which the URI is related. In this case it is a Credit Transfer Batch resource.
root reasonCode string optional The SEPA Reason Code, the Bacs Reason Code (depending on the scheme) or the Application Reason Code (where a Batch has been rejected prior be being passed to Clearing).
root resourceOwner string Mandatory This is the identifier of the merchant resource to which this notification is linked.
root resourceRemittanceInformation string optional Null.

JSON Sample

The following is an example of a Credit Transfer Batch Rejection event JSON:

Headers:

POST http://example.com/webhooks
Content-Type: application/json;charset=UTF-8
x-signature: 123ab01d030dee864fb44cc65a3be52ae591f46cde8d14d3e72fbc3790e4a304
Content-Length: 261
X-Request-Id: dc645679-71a5-498d-bb29-ec027948c7c1

JSON Request Body

{

 "eventTimestamp": 1501169079000,
 "eventType": "CreditTransferBatchFailed",    
 "resourceReference": "E2E123456",
 "resourceReferenceType": "Reference",   
 "resourceUri": "/credittransfers/batches/rn4y5qgv2p",
 "resourceId": "rn4y5qgv2p",
 "resourceType": "CreditTransferBatch",
 "reasonCode": "CTC001",
 "resourceOwner": "878UJK",
 "resourceRemittanceInformation": null

}