Credit Transfer Reject Webhook event
Trigger: A PAIN.002 Import with a Credit Transfer rejection OR a Credit Transfer payment initially created with a future execution date is rejected for insufficient funds when processed on that future execution date (the payment is rejected with a Nuapay CT042 - ‘Insufficient funds’ error code).
Tip: Webhooks may be updated from time to time and it is important to consider the Versioning and Backward Compatibility guidelines when developing your solution. We recommend that your handler ignores new fields it is not expecting; any new fields that may be added will provide new information, which may be safely ignored.
Webhook Message Details
This Webhook has the following event types:
Webhook Event Type | Description |
CreditTransferReject | Triggered where a PAIN.002 import updates a Credit Transfer transaction to status = REJECTED |
CreditTransferCancel | Triggered where a PAIN.002 import updates a Credit Transfer transaction to status = CANCELLED. A Credit Transfer is updated to CANCELLED where the SEPA Reason Code is one of the following: CUST, CUTA, DUPL, UPAY |
Tip: Where a future-dated Credit Transfer is rejected for insufficient funds, an internal Nuapay error (CT042) is applied. This is an internal reject i.e. the transaction is rejected prior to being passed to Clearing.
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 | Either CreditTransferReject or CreditTransferCancel |
root | resourceTechnicalId | number | Mandatory | Unique identifier |
root | resourceReference | string | optional | This can be the business reference of the resource, useful when filtering events via the Webhooks area of the Developer Dashboard. |
root | resourceReferenceType | string | optional | This can be a business reference of the resource, useful when filtering events via the Webhooks area of the Developer Dashboard. |
root | resourceUri | string | Mandatory | This is the URI of the resource. Use the URI to retrieve more details - see Retrieve Credit Transfer. |
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 resource. |
root | reasonCode | string | optional | The The SEPA Reason Code or the Bacs Reason Code (depending on the scheme) |
root | resourceOwner | string | Mandatory | This is the identifier of the merchant resource to which this notification is linked. |
root | resourceRemittanceInformation | string | optional | Remittance information related to the transaction. |
JSON Sample
The following is an example of a Credit Transfer 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": "CreditTransferCancel",
"resourceReference": "321-CTAB-234-GFT",
"resourceReferenceType": "EndToEndId",
"resourceUri": "/beneficiaries/qj29pkgnbx/credittransfers/yabcdwgrg23",
"resourceType": "CreditTransfer",
"reasonCode": "CUST",
"resourceOwner": "tc47ygrg72",
"resourceRemittanceInformation": null
}