Payment Webhooks

Webhook structure and samples for Payments.

Contents
Payment Webhook - Structure
Payment Webhook - Samples

Payment Webhook - Structure

{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


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-11T08:05:00.000Z”
resource_type {RESOURCETYPE} The Resource type will be Payment. No String “payment”
reference {REFERENCE} The ID of the Payment. No String “PM00841339”
status {STATUS} The Status of the Payment. No String “indemnity_claimed”
description {DESCRIPTION} The description of Webhook Event. No String “indemnity debit applied”
event_source {EVENTSOURCE} The Event code that triggered the sending of the Webhook. No Integer “30052091”
bacs_reason_code {BACSCODE} The BACS Rejection Reason Code. Yes String “DDICA1”
bacs_description {BACSDESCRIPTION} The BACS Rejection Description. Yes String “amount and or date of dd differs”
collection_date {COLLECTIONDATE} The Collection Date of the Payment. No Date “2020-12-08”
amount {AMOUNT} The amount of the payment. No Decimal “23.57”
debit_date {DEBITDATE} The Debit date of the Payment No Date “2020-12-08”
bacs_reference {BACSREFERENCE} The BACS Reference. Yes String “XYZ0012345-0012345”
bacs_filename {BACSFILENAME} The BACS Rejection File Name. Yes String “Addacs020419111111”
record_type {RECORDTYPE} The record type of the Payment, for example direct_debit. No String “direct_debit”
custom_reference {CUSTOMREFERENCE} The Custom reference. Yes String “custref123”
customer_account {CUSTOMERACCOUNT} The Customer Account that the Payment belongs to, if set. Yes String “CUST00032041”
card_id {CARDID} Card Payments: ID of the parent Card Record. Yes String “ED3CA3B7-6F63-49DE-B924-C2D50CFB2B50”
payment_type {PAYMENTTYPE} Card Payments: Payment type, for example Ecommerce. Yes String “Ecommerce”
status_details {STATUSDETAILS} Card Payments: SmarterPay's additional information based on the status. Yes String “”
status_code {STATUSCODE} Card Payments: SmarterPay's normalised status code of the card. Yes String “”
currency_code {CURRENCYCODE} ISO 4217 representation of the currency used for the card payment. Yes ISO4217 “GBP”
internal_payment_description {INTERNALPAYMENTDESCRIPTION} Card Payments: Internal payment description. Yes String “Payment from Ecommerce Page”
gateway_payment_description {GATEWAYPAYMENTDESCRIPTION} Card Payments: Gateway payment description. Yes String “”
authorisation_code {AUTHORISATIONCODE} Card Payments: Payment Authorisation code. Yes String “9342690”
transaction_id {TRANSACTIONID} Card Payments: Payment Transaction ID. Yes String “859328DF-A7B9-51B3-C274-EF546390B29F”
order_id {ORDERID} Card Payments: Order ID. Yes String “”
charge_id {CHARGEID} Card Payments: Charge ID. Yes String “ed3ca3b7-6f63-49de-b924-c2d50cfb2b50”
metadata {METADATA} Card Payments: Additional client JSON initially passed in the card registration request that is sent with every webhook. Yes String “”
gateway_status {GATEWAYSTATUS} Card Payments: The status of the card passed by the gateway to SmarterPay. Yes String “Ok”
gateway_status_code {GATEWAYSTATUSCODE} Card Payments: A code that the gateway may pass to SmarterPay to further describe the status. Yes String “0000”
gateway_status_details {GATEWAYSTATUSDETAILS} Card Payments: Additional information, based on the status, passed by the gateway to SmarterPay. Yes String “The Authorisation was Successful.”
related_payment_id {RELATEDPAYMENTID} Card Payments: Related Payment ID. Yes String “0”
reference {REFERENCE} The ID of the Record. No. String “P01QY3LJOKWM6LPE61O”

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
payment_type
Ecommerce
MOTO
record_type bank_transfer
direct_debit
card_payment
status cancelled
failed
indemnity_claimed
pending_submission
submitted
successful


Payment Webhook - Samples


Quick Links
Payment Webhook - Sample - API ActionsPayment Webhook - Sample - DDMS Service
Payment Webhook - Sample - BACS rejection codes - ADDACSPayment Webhook - Sample - BACS rejection codes - ARUDD
Payment Webhook - Sample - BACS rejection codes - AUDDISPayment Webhook - Sample - BACS rejection codes - DDICA
Payment Webhook - Sample - Input Reports



Payment Webhook - Sample - API Actions


Payment Webhook - Sample - API Actions - Record Creation

Payment Webhook - Structure 

{
 "events":
 [
  {
   "id":"EV000003432",
   "created_at":"2020-12-22T08:05:00.000Z",
   "resource_type":"payment",
   "description":"SMP Service - Payment inserted",
   "event_source" : "20052091",
   "reference":"PM00841339",
   "status":"pending_submission",
   "bacs_reason_code":"",
   "bacs_description":"",
   "collection_date":"2020-12-08",
   "amount":23.57,
   "debit_date":"",
   "bacs_reference":"",
   "bacs_filename":"",
   "record_type":"direct_debit",
   "custom_reference":"",
   "customer_account":"CUST00034657",
   "card_id":"",
   "payment_type":"ongoing collection",
   "status_details":"",
   "status_code":"",
   "currency_code":"GBP",
   "internal_payment_description":"",
   "gateway_payment_description":"",
   "authorisation_code":"",
   "transaction_id":"",
   "order_id":"",
   "charge_id":"",
   "metadata":"",
   "gateway_status":"",
   "gateway_status_code":"",
   "gateway_status_details":"",
   "related_payment_id":"0"
   }
 ]
}



Payment Webhook - Sample - DDMS Service


Payment Webhook - Sample - DDMS Service - Record Creation

Payment Webhook - Structure 

{
 "events":
 [
  {
   "id":"EV000003432",
   "created_at":"2020-12-22T08:05:00.000Z",
   "resource_type":"payment",
   "description":"SMP Service - Payment inserted",
   "event_source" : "30052091",
   "reference":"PM00841339",
   "status":"pending_submission",
   "bacs_reason_code":"",
   "bacs_description":"",
   "collection_date":"2020-12-08",
   "amount":23.57,
   "debit_date":"",
   "bacs_reference":"",
   "bacs_filename":"",
   "record_type":"direct_debit",
   "custom_reference":"",
   "customer_account":"CUST00034657",
   "card_id":"",
   "payment_type":"ongoing collection",
   "status_details":"",
   "status_code":"",
   "currency_code":"GBP",
   "internal_payment_description":"",
   "gateway_payment_description":"",
   "authorisation_code":"",
   "transaction_id":"",
   "order_id":"",
   "charge_id":"",
   "metadata":"",
   "gateway_status":"",
   "gateway_status_code":"",
   "gateway_status_details":"",
   "related_payment_id":"0"
   }
 ]
}


Payment Webhook - Sample - DDMS Service - Sent to Bacs

Payment Webhook - Structure 

{
 "events":
 [
  {
   "id":"EV000003432",
   "created_at":"2020-12-22T08:05:00.000Z",
   "resource_type":"payment",
   "description":"SMP Service - Payment updated (Payment sent to BACS)",
   "event_source" : "30052091",
   "reference":"PM00841339",
   "status":"submitted",
   "bacs_reason_code":"",
   "bacs_description":"",
   "collection_date":"2020-12-08",
   "amount":23.57,
   "debit_date":"",
   "bacs_reference":"",
   "bacs_filename":"",
   "record_type":"direct_debit",
   "custom_reference":"",
   "customer_account":"CUST00034657",
   "card_id":"",
   "payment_type":"ongoing collection",
   "status_details":"",
   "status_code":"",
   "currency_code":"GBP",
   "internal_payment_description":"",
   "gateway_payment_description":"",
   "authorisation_code":"",
   "transaction_id":"",
   "order_id":"",
   "charge_id":"",
   "metadata":"",
   "gateway_status":"",
   "gateway_status_code":"",
   "gateway_status_details":"",
   "related_payment_id":"0"
   }
 ]
}


Payment Webhook - Sample - DDMS Service - Set to Successful

Payment Webhook - Structure 

{
 "events":
 [
  {
   "id":"EV000003432",
   "created_at":"2020-12-22T08:05:00.000Z",
   "resource_type":"payment",
   "description":"SMP Service - Payment updated (Payment settled)",
   "event_source" : "31052002",
   "reference":"PM00841339",
   "status":"successful",
   "bacs_reason_code":"",
   "bacs_description":"",
   "collection_date":"2020-12-08",
   "amount":23.57,
   "debit_date":"",
   "bacs_reference":"",
   "bacs_filename":"",
   "record_type":"direct_debit",
   "custom_reference":"",
   "customer_account":"CUST00034657",
   "card_id":"",
   "payment_type":"ongoing collection",
   "status_details":"",
   "status_code":"",
   "currency_code":"GBP",
   "internal_payment_description":"",
   "gateway_payment_description":"",
   "authorisation_code":"",
   "transaction_id":"",
   "order_id":"",
   "charge_id":"",
   "metadata":"",
   "gateway_status":"",
   "gateway_status_code":"",
   "gateway_status_details":"",
   "related_payment_id":"0"
   }
 ]
}

Payment Webhook - Sample - BACS rejection codes - ADDACS

Payment Webhook - Sample - Rejection Report - ADDACS 0

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ADDACS0
bacs_description instruction cancelled - refer to payer
bacs_reference 2022080301S102184102
bacs_filename Addacs020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ADDACS 1

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ADDACS1
bacs_description instruction cancelled by payer
bacs_reference 2022080301S102184102
bacs_filename Addacs020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ADDACS 2

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ADDACS2
bacs_description payer deceased
bacs_reference 2022080301S102184102
bacs_filename Addacs020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ADDACS 3

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ADDACS3
bacs_description instruction cancelled, account transferred
bacs_reference 2022080301S102184102
bacs_filename Addacs020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ADDACS B

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ADDACSB
bacs_description account closed
bacs_reference 2022080301S102184102
bacs_filename Addacs020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ADDACS D

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ADDACSD
bacs_description advance notice disputed
bacs_reference 2022080301S102184102
bacs_filename Addacs020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ADDACS R

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ADDACSR
bacs_description instruction reinstated
bacs_reference 2022080301S102184102
bacs_filename Addacs020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}

Payment Webhook - Sample - BACS rejection codes - ARUDD

Payment Webhook - Sample - Rejection Report - ARUDD 0

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD0
bacs_description refer to payer
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD 1

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD1
bacs_description instruction cancelled
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ARUDD1
bacs_description instruction cancelled
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD 2

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD2
bacs_description payer deceased
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ARUDD2
bacs_description payer deceased
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD 3

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD3
bacs_description account transferred
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ARUDD3
bacs_description account transferred
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD 4

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD4
bacs_description advance notice disputed
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD 5

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD5
bacs_description no account (or wrong account type)
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ARUDD5
bacs_description no account (or wrong account type)
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD 6

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD6
bacs_description no instruction
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ARUDD6
bacs_description no instruction
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD 7

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD7
bacs_description amount differs
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD 8

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD8
bacs_description amount not yet due
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD 9

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDD9
bacs_description presentation overdue
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD A

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDDA
bacs_description service user differs
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ARUDDA
bacs_description service user differs
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - ARUDD B

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description payment failed
status failed
bacs_reason_code ARUDDB
bacs_description account closed
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code ARUDDB
bacs_description account closed
bacs_reference 2022080301S102184102
bacs_filename Arudd020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}

Payment Webhook - Sample - BACS rejection codes - AUDDIS

Payment Webhook - Sample - Rejection Report - AUDDIS 1

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDIS1
bacs_description instruction cancelled by payer
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS 2

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDIS2
bacs_description payer deceased
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS 3

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDIS3
bacs_description instruction cancelled, account transferred
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS 5

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDIS5
bacs_description no account
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS 6

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDIS6
bacs_description no instruction
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS B

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISB
bacs_description account closed
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS F

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISF
bacs_description invalid account type
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS G

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISG
bacs_description bank will not accept direct debits on account
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS H

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISH
bacs_description instruction expired
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS I

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISI
bacs_description payer reference is not unique
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS K

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISK
bacs_description instruction cancelled by bank
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS L

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISL
bacs_description incorrect payers account details
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS M

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISM
bacs_description transaction code/user status incompatible
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS N

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISN
bacs_description transaction disallowed at payers branch
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS O

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISO
bacs_description invalid reference
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS P

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISP
bacs_description payers name not present
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - AUDDIS Q

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code AUDDISQ
bacs_description service username is blank
bacs_reference 2022080301S102184102
bacs_filename Auddis020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}

Payment Webhook - Sample - BACS rejection codes - DDICA

Payment Webhook - Sample - Rejection Report - DDICA 1

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description indemnity debit applied
status indemnity_claimed
bacs_reason_code DDICA1
bacs_description amount and or date of dd differs
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - DDICA 2

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description indemnity debit applied
status indemnity_claimed
bacs_reason_code DDICA2
bacs_description no advance notice received
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - DDICA 3

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description indemnity debit applied
status indemnity_claimed
bacs_reason_code DDICA3
bacs_description ddi cancelled by paying bank
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code DDICA3
bacs_description ddi cancelled by paying bank
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - DDICA 4

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description indemnity debit applied
status indemnity_claimed
bacs_reason_code DDICA4
bacs_description payer has cancelled ddi direct with service user
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code DDICA4
bacs_description payer has cancelled ddi direct with service user
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - DDICA 5

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description indemnity debit applied
status indemnity_claimed
bacs_reason_code DDICA5
bacs_description no instruction held
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code DDICA5
bacs_description no instruction held
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - DDICA 6

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description indemnity debit applied
status indemnity_claimed
bacs_reason_code DDICA6
bacs_description signature on ddi is fraudulent
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code DDICA6
bacs_description signature on ddi is fraudulent
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - DDICA 7

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description indemnity debit applied
status indemnity_claimed
bacs_reason_code DDICA7
bacs_description claim raised at service users request
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Rejection Report - DDICA 8

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Rejection
Field Sample Value
description indemnity debit applied
status indemnity_claimed
bacs_reason_code DDICA8
bacs_description service user name disputed
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml
Future Pending Payments
Field Sample Value
description payment cancelled
status cancelled
bacs_reason_code DDICA8
bacs_description service user name disputed
bacs_reference 2022080301S102184102
bacs_filename Ddica020419111111.xml 
{
 "events":
 [
  {
   "id" : {EVENTID},
   "created_at" : {CREATEDDATE},
   "resource_type": {RESOURCETYPE},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}

Payment Webhook - Sample - Input Reports

Payment Webhook - Sample - Input Reports - INPUT C

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT D

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT E

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment failed
status failed
bacs_reason_code INPUTE
bacs_description recipients sort code is invalid
bacs_reference 2022080301S102184102
bacs_filename ReftInput020822080046.xml
Future Pending Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT F

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT G

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT H

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT I

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT J

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT K

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment failed
status failed
bacs_reason_code INPUTK
bacs_description type of account was invalid
bacs_reference 2022080301S102184102
bacs_filename ReftInput020822080046.xml
Future Pending Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT L

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT M

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT O

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment failed
status failed
bacs_reason_code INPUTO
bacs_description reference number was invalid
bacs_reference 2022080301S102184102
bacs_filename ReftInput020822080046.xml
Future Pending Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT P

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT T

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment failed
status failed
bacs_reason_code INPUTT
bacs_description Originator Account details are invalid
bacs_reference 2022080301S102184102
bacs_filename ReftInput020822080046.xml
Future Pending Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT U

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT X

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT Y

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}


Payment Webhook - Sample - Input Reports - INPUT Z

Payment Webhook - Structure

The fields that have been updated for this webhook are:

Submitted Payment that triggered the Input Report
Field Sample Value
description payment 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 Payments
Field Sample Value
description payment 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},
   "reference" : {REFERENCE},
   "status" : {STATUS},
   "description" : {DESCRIPTION},
   "event_source": {EVENTSOURCE},
   "bacs_reason_code" : {BACSCODE},
   "bacs_description" : {BACSDESCRIPTION},
   "collection_date": {COLLECTIONDATE},
   "amount": {AMOUNT},
   "debit_date": {DEBITDATE} ,
   "bacs_reference" : {BACSREFERENCE},
   "bacs_filename" : {BACSFILENAME},
   "record_type" : {RECORDTYPE},
   "custom_reference" : {CUSTOMREFERENCE},
   "customer_account" : {CUSTOMERACCOUNT},
   "card_id" : {CARDID},
   "payment_type" : {PAYMENTTYPE},
   "status_details" : {STATUSDETAILS},
   "status_code" : {STATUSCODE},
   "currency_code" : {CURRENCYCODE},
   "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION},
   "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION},
   "authorisation_code" : {AUTHORISATIONCODE},
   "transaction_id" : {TRANSACTIONID},
   "order_id" : {ORDERID},
   "charge_id" : {CHARGEID},
   "metadata" : {METADATA},
   "gateway_status" : {GATEWAYSTATUS},
   "gateway_status_code" : {GATEWAYSTATUSCODE},
   "gateway_status_details" : {GATEWAYSTATUSDETAILS},
   "related_payment_id" : {RELATEDPAYMENTID},
   "reference": {REFERENCE}
   }
 ]
}
  • Last modified: 2022/11/23 12:08