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/08/10 16:53