Credit Event - Structure

JSON

{
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "client": {
        "id":{VALUE}
    },
   "events":[
      {
         "id":{VALUE},
         "event_id":{VALUE},
         "legacy_id":{VALUE},
         "amount":{VALUE},
         "credit_date":{VALUE},
         "created_at":{VALUE},
         "status":{VALUE},
         "edited_by_id":{VALUE},
         "submission_reference":{VALUE},
         "edited_at":{VALUE},
         "description":{VALUE},
         "custom_reference":{VALUE},
         "event_type":{VALUE},
         "event_source":{VALUE},
         "overriding_name":{VALUE},
         "default_narrative":{VALUE},
         "rti":{VALUE},
         "bacs_reason_code":{VALUE},
         "bacs_description":{VALUE},
         "bacs_reference":{VALUE},
         "bacs_filename":{VALUE},
         "metadata":{VALUE},
         "created_by":{
             "id":{VALUE}
         },
         "edited_by":{
             "id":{VALUE}
         },  
         "customer_account":{
             "id":{VALUE},
             "legacy_id":{VALUE}
         },
         "bank_account":{
             "id":{VALUE},
             "legacy_id":{VALUE},
             "account_name": {VALUE},
             "account_number": {VALUE},
             "sort_code": {VALUE},
             "bank_name": {VALUE}
         },         
         "mandate":{
             "id":{VALUE},
             "auddis":{VALUE}
         },  
         "originating_bank_account":{
             "id":{VALUE},
             "legacy_id":{VALUE},
             "account_name":{VALUE},
             "account_number":{VALUE},
             "sort_code":{VALUE}
         },
         "service_user_number":{
             "id":{VALUE},
             "sun_name":{VALUE},
             "sun_number":{VALUE}
         },
         "client":{
             "id":{VALUE}
         } 
  
      }
   ]
}

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

Fields

Event Fields
Property Format Description
amount integer Amount of the credit, in pence
bacs_description string or null The BACS Rejection Description, if set
bacs_filename string or null The BACS Rejection File Name, if set
bacs_reason_code string or null The BACS Rejection Reason Code, if set
bacs_reference string or null The BACS Reference, if set
bank_account object Object containing Bank Account information, see below
client object Object containing the client information, see below
created_at datetime (ISO8601) Date and time the record was created
created_by object or null Object containing the created_by information, if set, see below
credit_date date (YYYY-MM-DD) Date the credit will be collected
custom_reference string or null The Custom reference
default_narrative string or null Credit's default narrative, if set
description string The description of the Credit
edited_at datetime (ISO8601) Date and time the record was edited
edited_by object or null Object containing the edited_by information, if set, see below
event_id string The ID of the Event
event_source string The Source that triggered the event
event_type string This will be “credit.create” or “credit.update”
id string The ID of the Record
legacy_id string or null Legacy ID of the record, if set
mandate object or null Object containing the mandate information, if set, see below
metadata string or null String used to store custom metadata, if set
originating_bank_account object Object containing the Originating Bank Account information, see below
overriding_name string or null Credit's overriding account name, if set
rti string or null Credit RTI reference
service_user_number object Object containing the SUN information, see below
status string The Status of the Credit, see options below
submission_reference string The Credit reference that will be sent to bacs
bank_account Object Fields
Property Format Description
account_name string Account holder name
account_number string Account number
bank_name string Bank name
id string ID of the record
legacy_id string or null Legacy ID of the record, if set
sort_code string Sort code
client Object Fields
Property Format Description
id string ID of the record
created_by Object Fields
Property Format Description
id string ID of the record
edited_by Object Fields
Property Format Description
id string ID of the record
mandate Object Fields
Property Format Description
id string ID of the record
auddis string The Mandate's AUDDIS reference
originating_bank_account Object Fields
Property Format Description
account_name string Account holder name
account_number string Account number
id string ID of the record
legacy_id string or null Legacy ID of the record, if set
sort_code string Sort code
service_user_number Object Fields
Property Format Description
id string ID of the record
sun_name string Friendly name for the service user number
sun_number string Service user number
  • Last modified: 2023/07/03 17:02