Mandate Webhooks

Webhook structure and samples for Mandates.

Contents
Mandate Webhook - Structure
Mandate Webhook - Samples

{
 "events":
 [
  {
    "id" : {EVENTID},  
    "created_at" : {CREATEDDATE}, 
    "resource_type": {RESOURCETYPE},  
    "event_source" : {EVENTSOURCE},
    "customer_account" : {CUSTOMERACCOUNT},  
    "AUDDIS" : {AUDDIS},  
    "status" : {STATUS},  
    "description" : {DESCRIPTION},  
    "bacs_reason_code" : {BACSCODE},  
    "bacs_description" : {BACSDESCRIPTION},
    "bacs_reference" : {BACSREFERENCE},
    "bacs_filename" : {BACSFILENAME},
    "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-22T08:05:00.000Z”
resource_type	{RESOURCETYPE}	The Resource type will be mandate.	No.	String.	“mandate”
event_source	{EVENTSOURCE}	The Event code that triggered the sending of the Webhook.	No.	Integer.	“30042091”
customer_account	{CUSTOMERACCOUNT}	The Customer Account that the Mandate belongs to, if set.	Yes.	String.	“CUST00032041”
AUDDIS	{AUDDIS}	The AUDDIS Reference of the Mandate.	No.	String.	“REFP01008”
status	{STATUS}	The Status of the Mandate.	No.	String.	“new instruction”
description	{DESCRIPTION}	The description of Webhook Event.	No.	String.	“New instruction sent to BACS”
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”
reference	{REFERENCE}	The ID of the Record.	No.	String.	“M01YR6K8K9X6XG84ZLQ”

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
	cancelled by originator
	cancelled by payer
	first collection
	new instruction
	ongoing collection

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

Mandate Webhook - Sample - API Actions - Record Creation

Mandate Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432",  
    "created_at" : "2020-12-22T08:05:00.000Z", 
    "resource_type": "mandate",  
    "customer_account" : "CUST00032041",  
    "AUDDIS" : "REFP01008",  
    "status" : "new instruction",  
    "description" : "API - Mandate inserted",  
    "bacs_reason_code" : "",  
    "bacs_description" : "",
    "bacs_reference" : "",
    "bacs_filename" : ""
  }
 ]
}

Mandate Webhook - Sample - DDMS Service - Sent to Bacs

Mandate Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432",  
    "created_at" : "2020-12-22T08:05:00.000Z", 
    "resource_type": "mandate",  
    "customer_account" : "CUST00032041",  
    "AUDDIS" : "REFP01008",  
    "status" : "new instruction",  
    "description" : "SMP Service - Mandate updated (New instruction sent to BACS)",  
    "bacs_reason_code" : "",  
    "bacs_description" : "",
    "bacs_reference" : "",
    "bacs_filename" : ""
  }
 ]
}

Mandate Webhook - Sample - DDMS Service - Ready for Collection

Mandate Webhook - Structure

{
 "events":
 [
  {
    "id" : "EV000003432",  
    "created_at" : "2020-12-22T08:05:00.000Z", 
    "resource_type": "mandate",  
    "customer_account" : "CUST00032041",  
    "AUDDIS" : "REFP01008",  
    "status" : "first collection",  
    "description" : "SMP Service - Mandate updated (Mandate is available for collection)",  
    "bacs_reason_code" : "",  
    "bacs_description" : "",
    "bacs_reference" : "",
    "bacs_filename" : ""
  }
 ]
}