Credit Webhooks

Webhook structure and samples for Credits.


{
 "events":
 [
  {
    "id" : {EVENTID} ,
    "created_at" : {CREATEDDATE},
    "resource_type": {RESOURCETYPE},
    "event_source" : {EVENTSOURCE},
    "reference" : {REFERENCE},
    "status" : {STATUS},
    "description" : {DESCRIPTION},
    "bacs_reason_code" : {BACSCODE},
    "bacs_description" : {BACSDESCRIPTION},
    "bacs_reference" : {BACSREFERENCE},
    "bacs_filename" : {BACSFILENAME},
    "custom_reference" : {CUSTOMREFERENCE}
  }
 ]
}

Webhooks are sent out of SmarterPay Cloud as a JSON array.
The JSON Syntax Rules are:

  • Data is in name/value pairs, for example {“id” : “EV000003432”}.
  • Data is separated by commas.
  • Curly braces hold objects.
  • Square brackets hold arrays.


Property Variable Description Empty
Values (1)
Format Example
id {EVENTID} The ID of the Webhook Event. No. String. “EV000003432”
created_at {CREATEDDATE} The Date that event was created. No. ISO8601. “2020-12-22T08:05:00.000Z”
resource_type {RESOURCETYPE} The Resource type will be credit. No. String. “credit”
event_source {EVENTSOURCE} The Event code that triggered the sending of the Webhook. No. Integer. “10022091”
reference {REFERENCE} The ID of the Credit. No. String. “CR00015894”
status {STATUS} The Status of the Credit. No. String. “successful”
description {DESCRIPTION} The description of Webhook Event. No. String. “credit settled”
bacs_reason_code {BACSCODE} The BACS Rejection Reason Code. Yes. String. “ADDACS2”
bacs_description {BACSDESCRIPTION} The BACS Rejection Description. Yes. String. “payer deceased”
bacs_reference {BACSREFERENCE} The BACS Reference. Yes. String. “XYZ0012345-0012345”
bacs_filename {BACSFILENAME} The BACS Rejection File Name. Yes. String. “Addacs020419111111”
custom_reference {CUSTOMREFERENCE} The Custom reference. Yes. String. “custref123”

Notes:
(1) Empty Values - The property will always be in the Webhook, however the value of the property may be an empty string (“”).


Property Possible Values
status cancelled
failed
submitted
successful



Credit Webhook - Sample - ADDACS 2

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "ADDACS2",
    "bacs_description" : "payer deceased",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ADDACS 3

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "ADDACS3",
    "bacs_description" : "instruction cancelled, account transferred",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ADDACS B

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "ADDACSB",
    "bacs_description" : "account closed",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}



Credit Webhook - Sample - ARUCS 0

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit failed",
    "bacs_reason_code" : "ARUCS0",
    "bacs_description" : "invalid details",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ARUCS 2

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit failed",
    "bacs_reason_code" : "ARUCS2",
    "bacs_description" : "beneficiary deceased",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ARUCS 3

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit failed",
    "bacs_reason_code" : "ARUCS3",
    "bacs_description" : "account transferred",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ARUCS 5

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit failed",
    "bacs_reason_code" : "ARUCS5",
    "bacs_description" : "account number not recognised",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ARUCS B

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit failed",
    "bacs_reason_code" : "ARUCSB",
    "bacs_description" : "account closed",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ARUCS C

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit failed",
    "bacs_reason_code" : "ARUCSC",
    "bacs_description" : "requested by remitter",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}



Credit Webhook - Sample - ARUDD 2

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "ARUDD2",
    "bacs_description" : "payer deceased",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ARUDD 3

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "ARUDD3",
    "bacs_description" : "account transferred",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ARUDD 5

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "ARUDD5",
    "bacs_description" : "no account (or wrong account type)",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - ARUDD B

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "ARUDDB",
    "bacs_description" : "account closed",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}



Credit Webhook - Sample - AUDDIS 2

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "AUDDIS2",
    "bacs_description" : "payer deceased",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - AUDDIS 3

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "AUDDIS3",
    "bacs_description" : "instruction cancelled, account transferred",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - AUDDIS 5

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "AUDDIS5",
    "bacs_description" : "no account",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - AUDDIS B

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "AUDDISB",
    "bacs_description" : "account closed",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - AUDDIS F

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "AUDDISF",
    "bacs_description" : "invalid account type",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - AUDDIS G

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "AUDDISG",
    "bacs_description" : "bank will not accept direct debits on account",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - AUDDIS K

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "AUDDISK",
    "bacs_description" : "instruction cancelled by bank",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - AUDDIS L

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "AUDDISL",
    "bacs_description" : "incorrect payers account details",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}


Credit Webhook - Sample - AUDDIS N

Credit Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432" ,
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "credit",
    "reference" : "CR00015894",
    "status" : "cancelled",
    "description" : "credit cancelled",
    "bacs_reason_code" : "AUDDISN",
    "bacs_description" : "transaction disallowed at payers branch",
    "bacs_reference" : "XYZ0012345-0012345",
    "bacs_filename" : "Addacs020419111111",
    "custom_reference" : ""
   }
 ]
}
  • Last modified: 2021/09/24 12:35