Payment Request Event

Event structure and samples for Payment Requests events.

These events are raised when the bulk API cannot create a record in SmarterPay Cloud..

Contents
Payment Request Event - Structure
Payment Request Event - Samples

Payment Request Event - Structure

Note: Version 2 Webhooks can contain more that one event per webhook. Please see “V2 Webhook Structure” for more details.


Event Fields
Property Format Description
amount integer Amount of the credit, in pence
client string Object containing the client information, see below
collection_date date (YYYY-MM-DD) Date set for the Payment
created_at datetime (ISO8601) Date and time the record was created
created_by null Set to null
custom_reference string or null Custom Reference text, if set
default_narrative string or null Default Narrative text, if set
description string Description text
edited_at datetime (ISO8601) Date and time the record was edited
edited_by null Set to null
event_id string The ID of the Event
event_source string This will be “API”
event_type string This will be “payment_request.failed”
id string The ID of the Record
mandate object or null Object containing Mandate information, if set, see below
metadata string or null Custom metadata, if set
message string Reason for record not being able to be inserted
request_record object Object containing the Request Record information, see below
client Object Fields
Property Format Description
id string ID of the record
mandate Object Fields
Property Format Description
id string ID of the record
request_record Object Fields
Property Format Description
id string ID of the record

Note: Property display order for documentation purposes, actual order may vary. 

{
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "client":{
      "id":{VALUE}
   },
   "events":[
      {
         "description":{VALUE},
         "client":{
            "id":{VALUE}
         },
         "id":{VALUE},
         "event_id":{VALUE},
         "created_by":{VALUE},
         "created_at":{VALUE},
         "amount":{VALUE},
         "edited_by":{VALUE},
         "edited_at":{VALUE},
         "collection_date":{VALUE},
         "request_record":{
            "id":{VALUE}
         },
         "mandate":{
            "id":{VALUE}
         },
         "custom_reference":{VALUE},
         "default_narrative":{VALUE},
         "metadata":{VALUE},
         "event_type":{VALUE},
         "message":{VALUE},
         "event_source":{VALUE}
      }
   ]
}

Payment Request Event - Samples

Payment Request Event - Sample - Failed Request


The fields that have been updated for this webhook are:

Field Sample Value
amount 1200
client:id “CL01KO5D0G80GYJERW4V”
collection_date “2024-10-22”
created_at “2024-10-14T11:44:11Z”
created_by null
custom_reference null
default_narrative null
description “test1”
edited_at “2024-10-14T11:44:11Z”
edited_by null
event_id “HI0DZO41Y8DD4K180GNL”
event_source “API”
event_type “payment_request.failed”
id “RR02NWLOKJYXMV2PRX5Q”
mandate:id “M01Q7ZGLJL2LE8W53EO”
message “No mandate provided”
metadata null
request_record:id “RR01LG420EJ90WJ1VQWR” 
{
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "client":{
      "id":{VALUE}
   },
   "events":[
      {
         "description":{VALUE},
         "client":{
            "id":{VALUE}
         },
         "id":{VALUE},
         "event_id":{VALUE},
         "created_by":{VALUE},
         "created_at":{VALUE},
         "amount":{VALUE},
         "edited_by":{VALUE},
         "edited_at":{VALUE},
         "collection_date":{VALUE},
         "request_record":{
            "id":{VALUE}
         },
         "client_bank_account":{VALUE},
         "mandate":{
            "id":{VALUE}
         },
         "custom_reference":{VALUE},
         "default_narrative":{VALUE},
         "metadata":{VALUE},
         "event_type":{VALUE},
         "message":{VALUE},
         "event_source":{VALUE}
      }
   ]
}