Recurrence Schedule Webhooks

Webhook structure and samples for Recurrence Schedules.

Contents
Recurrence Schedule Webhook - Structure
Recurrence Schedule Webhook - Samples

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

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 recurrenceschedule.	No.	String.	“recurrenceschedule”
event_source	{EVENTSOURCE}	The Event code that triggered the sending of the Webhook.	No.	Integer.	“30042091”
reference	{REFERENCE}	The ID of the Recurrence Schedule.	No.	String.	“RS00841339”
auddis	{AUDDIS}	The ID (AUDDIS Reference) of the Mandate.	No.	String.	“REFP01008”
status	{STATUS}	The Status of the Recurrence Schedule.	No.	String.	“inactive”
description	{DESCRIPTION}	The description of Webhook Event.	No.	String.	“recurrence schedule cancelled”
bacs_reason_code	{BACSCODE}	The BACS Rejection Reason Code.	Yes.	String.	“ADDACS0”
bacs_description	{BACSDESCRIPTION}	The BACS Rejection Description.	Yes.	String.	“instruction cancelled - refer to payer”
bacs_reference	{BACSREFERENCE}	The BACS Reference.	Yes.	String.	“XYZ0012345-0012345”
bacs_filename	{BACSFILENAME}	The BACS Rejection File Name.	Yes.	String.	“Addacs020419111111”

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	active
	inactive

Quick Links
Recurrence Schedule Webhook - Sample - API Actions	Recurrence Schedule Webhook - Sample - DDMS Service
Recurrence Schedule Webhook - Sample - BACS rejection codes - ADDACS	Recurrence Schedule Webhook - Sample - BACS rejection codes - ARUDD
Recurrence Schedule Webhook - Sample - BACS rejection codes - AUDDIS	Recurrence Schedule Webhook - Sample - BACS rejection codes - DDICA
Recurrence Schedule Webhook - Sample - Input Reports

Recurrence Schedule Webhook - Sample - API Actions - Record Creation

Recurrence Schedule Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432",
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "recurrenceschedule",
    "event_source" : "20062091",
    "reference" : "RS00841339",
    "auddis" : "REFP01008" ,
    "status" : "active",
    "description" : "API - Scheduled Payment inserted",
    "bacs_reason_code" : "",
    "bacs_description" : "",
    "bacs_reference" : "",
    "bacs_filename" : ""
  }
 ]
}

Recurrence Schedule Webhook - Sample - DDMS Service - Record Updated

Recurrence Schedule Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432",
    "created_at" : "2020-12-22T08:05:00.000Z",
    "resource_type": "recurrenceschedule",
    "event_source" : "30062000",
    "reference" : "RS00841339",
    "auddis" : "REFP01008" ,
    "status" : "active",
    "description" : "SMP Service - Scheduled Payment updated",
    "bacs_reason_code" : "",
    "bacs_description" : "",
    "bacs_reference" : "",
    "bacs_filename" : ""
  }
 ]
}