smarterpaycloud:webhooks:v2:payment:structure

Payment Event - Structure

Card-JSON

{
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "client":{ 
		"id":{VALUE} 
	},
   "events":[
        {
            "id":{VALUE},
            "event_id":{VALUE},
            "legacy_id":{VALUE},
            "created_at":{VALUE},
            "collection_date":{VALUE},
            "currency_code":{VALUE},
            "amount":{VALUE},
            "payment_type":{VALUE},         
            "status":{VALUE},         
            "edited_at":{VALUE},
            "represented_collection_date":{VALUE},
            "custom_reference":{VALUE},
            "event_source":{VALUE},
            "record_type":{VALUE},
            "description":{VALUE},
            "event_type":{VALUE},
            "direct_debit":{VALUE},
            "metadata":{VALUE},
            "client":{
                "id":{VALUE}
            },
            "created_by":{
                "id":{VALUE}
            },
            "edited_by":{
                "id":{VALUE}
            },  
            "customer_account":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "recurrence_schedule":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "related_payment":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "card_payment":{
                "status_details":{VALUE},
                "status_code":{VALUE},
                "internal_payment_description":{VALUE},
                "gateway_payment_description":{VALUE},
                "authorisation_code":{VALUE},
                "transaction_id":{VALUE},
                "order_id":{VALUE},
                "charge_id":{VALUE},
                "metadata":{VALUE},
                "gateway_status":{VALUE},
                "gateway_status_code":{VALUE},
                "gateway_status_details":{VALUE},
                "card"{
                    "id":{VALUE},
                    "legacy_id":{VALUE}
                }
            }
        }
   ]
}

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

Card-Fields

Event Fields

Property	Format	Description
amount	integer	The amount of the payment in pence
card_payment	Object or null	Object containing the card_payment information. See below
client	Object	Object containing the client information. See below
collection_date	date (YYYY-MM-DD)	The Collection Date of the Payment
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
currency_code	string (ISO4217)	ISO 4217 representation of the currency used for the payment
custom_reference	string or null	The Custom reference, if set
customer_account	object or null	Object containing Customer Account information, if set. See below
description	string	The Payments description
direct_debit	null	null - Not applicable to Card Payment Events
edited_at	datetime (ISO8601)	Date and time the record was edited
edited_by	object or null	Object containing the created_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 “payment.create” or “payment.update”
id	string	The ID of the Record
legacy_id	string or null	Legacy ID of the record, if set
metadata	string or null	String used to store custom metadata, if set
mandate	null	null - Not applicable to Card Payment Events
payment_type	string	The payment type of the record. See “Property Options” below
record_type	string	The record type of the Payment. See “Property Options” below
recurrence_schedule	Object or null	Object containing the recurrence_schedule information, if set. See below
related_payment	Object or null	Object containing the related_payment information, if set. See below
represented_collection_date	date (YYYY-MM-DD)	Date the represented was collected, if set
status	string	The Status of the Payment. See “Property Options” below

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

customer_account Object Fields

Property	Format	Description
id	string	ID of the record
legacy_id	string or null	Legacy ID of the record, if set

edited_by Object Fields

Property	Format	Description
id	string	ID of the record

recurrence_schedule Object Fields

Property	Format	Description
id	string	The ID of the Record
legacy_id	string	Legacy ID of the record, if set

related_payment Object Fields

Property	Format	Description
id	string	The ID of the Record
legacy_id	string	Legacy ID of the record, if set

card_payment Object Fields

Property	Format	Description
authorisation_code	string or null	Payment Authorisation code, if set
card	object	Object containing the card information. See below
charge_id	string or null	Charge ID, if set
gateway_payment_description	string or null	Gateway payment description, if set
gateway_status	string or null	The status of the card passed by the gateway to SmarterPay, if set
gateway_status_code	string or null	A code that the gateway may pass to SmarterPay to further describe the status, if set
gateway_status_details	string or null	Additional information, based on the status, passed by the gateway to SmarterPay, if set
internal_payment_description	string or null	Internal payment description, if set
metadata	string or null	Additional client JSON initially passed in the card registration request, if set
order_id	string or null	Order ID, if set
status_code	string or null	SmarterPay's normalised status code of the card, if set
status_details	string or null	SmarterPay's additional information based on the status, if set
transaction_id	string or null	Payment Transaction ID, if set

card Object Fields

Property	Format	Description
id	string	ID of the record
legacy_id	string or null	Legacy ID of the record, if set

DD-JSON

{
    "id":{VALUE},
    "idempotency_key":{VALUE},
    "sent_at":{VALUE},
    "client":{ 
		"id":{VALUE} 
	},
    "events":[
        {
            "id":{VALUE},
            "legacy_id":{VALUE},
            "created_at":{VALUE},
            "collection_date":{VALUE},
            "currency_code":{VALUE},
            "amount":{VALUE},
            "payment_type":{VALUE},          
            "status":{VALUE},            
            "edited_at":{VALUE},
            "represented_collection_date":{VALUE},
            "custom_reference":{VALUE},          
            "event_source":{VALUE},
            "record_type":{VALUE},
            "description":{VALUE},
            "event_type":{VALUE},
            "metadata":{VALUE},         
            "client":{
                "id":{VALUE}
            },
            "created_by":{
                "id":{VALUE}
            },
            "edited_by":{
                "id":{VALUE}
            },  
            "customer_account":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "recurrence_schedule":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "related_payment":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "direct_debit":{
                "bacs_reference":{VALUE},
                "bacs_filename":{VALUE},
                "bacs_reason_code":{VALUE},
                "bacs_description":{VALUE},
                "paying_bank_reference":{VALUE},
                "overriding_name":{VALUE},
                "default_narrative":{VALUE},
                "users_reference":{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}
                },
                "mandate":{
                    "id":{VALUE},
                    "auddis":{VALUE}
                }                
            },          
            "card_payment":{VALUE}
        }
    ]
 }

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

DD-Fields

Event Fields

Property	Format	Description
amount	integer	The amount of the payment in pence
card_payment	null	null - Not applicable to Direct Debit Payment Events
client	Object	Object containing the client information. See below
collection_date	date (YYYY-MM-DD)	The Collection Date of the Payment
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
custom_reference	string or null	The Custom reference,if set
customer_account	object or null	Object containing Customer Account information, if set. See below
description	string	The Payments description
direct_debit	Object	Object containing the direct_debit information. See below
edited_at	datetime (ISO8601)	Date and time the record was edited
edited_by	object or null	Object containing the created_by information, if set. See below
event_source	string	The Source that triggered the event
event_type	string	This will be “payment.create” or “payment.update”
id	string	The ID of the Record
legacy_id	string or null	Legacy ID of the record, if set
metadata	string or null	String used to store custom metadata, if set
mandate	Object or null	Object containing the mandate information, if set. See below
payment_type	string	The payment type of the record. See “Property Options” below
record_type	string	The record type of the Payment. See “Property Options” below
recurrence_schedule	Object or null	Object containing the recurrence_schedule information, if set. See below
related_payment	Object or null	Object containing the related_payment information, if set. See below
represented_collection_date	date (YYYY-MM-DD)	Date the represented was collected, if set
status	string	The Status of the Payment. See “Property Options” below

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

customer_account Object Fields

Property	Format	Description
id	string	ID of the record
legacy_id	string or null	Legacy ID of the record, if set

edited_by Object Fields

Property	Format	Description
id	string	ID of the record

recurrence_schedule Object Fields

Property	Format	Description
id	string	The ID of the Record
legacy_id	string	Legacy ID of the record, if set

related_payment Object Fields

Property	Format	Description
id	string	The ID of the Record
legacy_id	string	Legacy ID of the record, if set

direct_debit Object Fields

Property	Format	Description
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
default_narrative	string or null	Payments default narrative, if set
mandate	object	Object containing the mandate information. See below
originating_bank_account	object	Object containing the originating_bank_account information. See below
overriding_name	string or null	Payment overriding name, if set
paying_bank_reference	string or null	The Paying Bank Reference, if set
service_user_number	object	Object containing the service_user_number information. See below
users_reference	string or null	Payment reference, if set

mandate Object Fields

Property	Format	Description
auddis	string	The Mandate/AUDDIS Reference of the Mandate
id	string	The ID of the Record

originating_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

service_user_number Object Fields

Property	Format	Description
id	string	The ID of the Record
sun_name	string	Friendly name for the service user number
sun_number	string	Service user number