Credit Request Event

Event structure and samples for Credit Request events.

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


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
bank_account object or null Object containing Bank Account information, if set, see below
client string Object containing the client information, see below
client_bank_account object or null Object containing the client Bank Account information, see below
created_by null Set to null
created_at datetime (ISO8601) Date and time the record was created
credit_date date (YYYY-MM-DD) Date set for the Credit
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_by null Set to null
edited_at datetime (ISO8601) Date and time the record was edited
event_id string The ID of the Event
event_source string This will be “API
event_type string This will be “credit_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
rti string or null Credit RTI reference, if set
submission_reference string or null Submission Reference, if set
bank_account Object Fields
Property Format Description
id string ID of the record
client Object Fields
Property Format Description
id string ID of the record
client_bank_account 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},
         "rti":{VALUE},
         "credit_date":{VALUE},
         "request_record":{
            "id":{VALUE}
         },
         "client_bank_account":{VALUE},
         "mandate":{
            "id":{VALUE}
         },
         "bank_account":{VALUE},
         "custom_reference":{VALUE},
         "submission_reference":{VALUE},
         "default_narrative":{VALUE},
         "metadata":{VALUE},
         "event_type":{VALUE},
         "message":{VALUE},
         "event_source":{VALUE}
      }
   ]
}


The fields that have been updated for this webhook are:

Field Sample Value
amount 1200
bank_account null
client:id “CL01KO5D0G80GYJERW4V”
client_bank_account null
created_by null
created_at “2024-10-14T11:44:11Z”
credit_date “2024-10-22”
custom_reference null
default_narrative null
description “test1”
edited_by null
edited_at “2024-10-14T11:44:11Z”
event_id “HI0DZO41Y8DD4K180GNL”
event_source API
event_type “credit_request.failed”
id “RR02NWLOKJYXMV2PRX5Q”
mandate:id “M01Q7ZGLJL2LE8W53EO”
message “Invalid mandate supplied”
metadata null
request_record:id “RR01LG420EJ90WJ1VQWR”
rti null
submission_reference null
{
   "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},
         "rti":{VALUE},
         "credit_date":{VALUE},
         "request_record":{
            "id":{VALUE}
         },
         "client_bank_account":{VALUE},
         "mandate":{
            "id":{VALUE}
         },
         "bank_account":{VALUE},
         "custom_reference":{VALUE},
         "submission_reference":{VALUE},
         "default_narrative":{VALUE},
         "metadata":{VALUE},
         "event_type":{VALUE},
         "message":{VALUE},
         "event_source":{VALUE}
      }
   ]
}
  • Last modified: 2024/10/14 15:10