Credit Webhooks
Webhook structure and samples for Credits.
Credit Webhook - Structure
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Webhooks are sent out of SmarterPay Cloud as a JSON array.
The JSON Syntax Rules are:
- Data is in name/value pairs, for example {“id” : “EV000003432”}.
- Data is separated by commas.
- Curly braces hold objects.
- Square brackets hold arrays.
| Property | Variable | Description | Empty Values (1) | Format | Example |
|---|---|---|---|---|---|
| id | {EVENTID} | The ID of the Webhook Event. | No. | String. | “EV000003432” |
| created_at | {CREATEDDATE} | The Date that event was created. | No. | ISO8601. | “2020-12-22T08:05:00.000Z” |
| resource_type | {RESOURCETYPE} | The Resource type will be credit. | No. | String. | “credit” |
| event_source | {EVENTSOURCE} | The Event code that triggered the sending of the Webhook. | No. | Integer. | “10022091” |
| reference | {REFERENCE} | The ID of the Credit. | No. | String. | “CR00015894” |
| status | {STATUS} | The Status of the Credit. | No. | String. | “successful” |
| description | {DESCRIPTION} | The description of Webhook Event. | No. | String. | “credit settled” |
| bacs_reason_code | {BACSCODE} | The BACS Rejection Reason Code. | Yes. | String. | “ADDACS2” |
| bacs_description | {BACSDESCRIPTION} | The BACS Rejection Description. | Yes. | String. | “payer deceased” |
| bacs_reference | {BACSREFERENCE} | The BACS Reference. | Yes. | String. | “XYZ0012345-0012345” |
| bacs_filename | {BACSFILENAME} | The BACS Rejection File Name. | Yes. | String. | “Addacs020419111111” |
| custom_reference | {CUSTOMREFERENCE} | The Custom reference. | Yes. | String. | “custref123” |
Notes:
(1) Empty Values - The property will always be in the Webhook, however the value of the property may be an empty string (“”).
| Property | Possible Values |
|---|---|
| status | cancelled |
| failed | |
| submitted | |
| successful |
Credit Webhook - Samples
Credit Webhook - Sample - BACS rejection codes - ADDACS
Credit Webhook - Sample - Rejection Report - ADDACS 2
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ADDACS2 |
| bacs_description | payer deceased |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Addacs020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ADDACS 3
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ADDACS3 |
| bacs_description | instruction cancelled, account transferred |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Addacs020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ADDACS B
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ADDACSB |
| bacs_description | account closed |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Addacs020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - BACS rejection codes - ARUCS
Credit Webhook - Sample - Rejection Report - ARUCS 0
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Rejection
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | ARUCS0 |
| bacs_description | invalid details |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUCS0 |
| bacs_description | invalid details |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ARUCS 2
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Rejection
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | ARUCS2 |
| bacs_description | beneficiary deceased |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUCS2 |
| bacs_description | beneficiary deceased |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ARUCS 3
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Rejection
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | ARUCS3 |
| bacs_description | account transferred |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUCS3 |
| bacs_description | account transferred |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ARUCS 5
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Rejection
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | ARUCS5 |
| bacs_description | account number not recognised |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUCS5 |
| bacs_description | account number not recognised |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ARUCS B
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Rejection
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | ARUCSB |
| bacs_description | account closed |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUCSB |
| bacs_description | account closed |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ARUCS C
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Rejection
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | ARUCSC |
| bacs_description | requested by remitter |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUCSC |
| bacs_description | requested by remitter |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arucs020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - BACS rejection codes - ARUDD
Credit Webhook - Sample - Rejection Report - ARUDD 2
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUDD2 |
| bacs_description | payer deceased |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arudd020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ARUDD 3
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUDD3 |
| bacs_description | account transferred |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arudd020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ARUDD 5
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUDD5 |
| bacs_description | no account (or wrong account type) |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arudd020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - ARUDD B
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | ARUDDB |
| bacs_description | account closed |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Arudd020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - BACS rejection codes - AUDDIS
Credit Webhook - Sample - Rejection Report - AUDDIS 2
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | AUDDIS2 |
| bacs_description | payer deceased |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Auddis020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - AUDDIS 3
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | AUDDIS3 |
| bacs_description | instruction cancelled, account transferred |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Auddis020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - AUDDIS 5
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | AUDDIS5 |
| bacs_description | no account |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Auddis020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - AUDDIS B
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | AUDDISB |
| bacs_description | account closed |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Auddis020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - AUDDIS F
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | AUDDISF |
| bacs_description | invalid account type |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Auddis020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - AUDDIS G
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | AUDDISG |
| bacs_description | bank will not accept direct debits on account |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Auddis020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - AUDDIS K
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | AUDDISK |
| bacs_description | instruction cancelled by bank |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Auddis020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - AUDDIS L
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | AUDDISL |
| bacs_description | incorrect payers account details |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Auddis020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Rejection Report - AUDDIS N
The fields that have been updated for this webhook are:
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | AUDDISN |
| bacs_description | transaction disallowed at payers branch |
| bacs_reference | XYZ0012345-0012345 |
| bacs_filename | Auddis020419111111.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports
Credit Webhook - Sample - Input Reports - INPUT C
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTC |
| bacs_description | destination sorting code and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTC |
| bacs_description | destination sorting code and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT D
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTD |
| bacs_description | destination sorting code and orginating account number were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTD |
| bacs_description | destination sorting code and orginating account number were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT E
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTE |
| bacs_description | recipients sort code is invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTE |
| bacs_description | recipients sort code is invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT F
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTF |
| bacs_description | type of account and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTF |
| bacs_description | type of account and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT G
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTG |
| bacs_description | type of account and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTG |
| bacs_description | type of account and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT H
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTH |
| bacs_description | destination sorting code and type of account and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTH |
| bacs_description | destination sorting code and type of account and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT I
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTI |
| bacs_description | destination sorting code and type of account and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTI |
| bacs_description | destination sorting code and type of account and originating sorting code were invalid on the item |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT J
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTJ |
| bacs_description | destination sorting code and type of account were invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTJ |
| bacs_description | destination sorting code and type of account were invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT K
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTK |
| bacs_description | type of account was invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTK |
| bacs_description | type of account was invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT L
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTL |
| bacs_description | Multiple fields including destination account number and destination account name were invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTL |
| bacs_description | Multiple fields including destination account number and destination account name were invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT M
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTM |
| bacs_description | destination account number and destination account name were invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTM |
| bacs_description | destination account number and destination account name were invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT O
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTO |
| bacs_description | reference number was invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTO |
| bacs_description | reference number was invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT P
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTP |
| bacs_description | The originating account is valid but the originating account does not support the currency of the file |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTP |
| bacs_description | The originating account is valid but the originating account does not support the currency of the file |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT T
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTT |
| bacs_description | Originator Account details are invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTT |
| bacs_description | Originator Account details are invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT U
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTU |
| bacs_description | unpaid Direct Debit reference was in error |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTU |
| bacs_description | unpaid Direct Debit reference was in error |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT X
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTX |
| bacs_description | originator’s service user number was invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTX |
| bacs_description | originator’s service user number was invalid |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT Y
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTY |
| bacs_description | transaction code unacceptable for destination sort code |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTY |
| bacs_description | transaction code unacceptable for destination sort code |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}
Credit Webhook - Sample - Input Reports - INPUT Z
The fields that have been updated for this webhook are:
Submitted Credit that triggered the Input Report
| Field | Sample Value |
|---|---|
| description | credit failed |
| status | failed |
| bacs_reason_code | INPUTZ |
| bacs_description | unpaid Direct Debit reference and other fields were in error |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
Future Pending Credits
| Field | Sample Value |
|---|---|
| description | credit cancelled |
| status | cancelled |
| bacs_reason_code | INPUTZ |
| bacs_description | unpaid Direct Debit reference and other fields were in error |
| bacs_reference | 2022080301S102184102 |
| bacs_filename | ReftInput020822080046.xml |
{
"events":
[
{
"id" : {EVENTID} ,
"created_at" : {CREATEDDATE},
"resource_type": {RESOURCETYPE},
"event_source" : {EVENTSOURCE},
"reference" : {REFERENCE},
"status" : {STATUS},
"description" : {DESCRIPTION},
"bacs_reason_code" : {BACSCODE},
"bacs_description" : {BACSDESCRIPTION},
"bacs_reference" : {BACSREFERENCE},
"bacs_filename" : {BACSFILENAME},
"custom_reference" : {CUSTOMREFERENCE}
}
]
}