Card Event - Sample - General

Card Event - Sample - Record Creation

The fields that have been updated for this webhook are:

Field	Sample Value
id	“CD0175OW1YJVQK8X29LV”
legacy_id	null
event_id	“HI08EXYR6K8KEY84ZLQV”
created_at	“2024-04-09T09:38:29Z”
edited_at	“2024-04-09T09:38:29Z”
custom_reference	null
event_type	“card_payment.create”
event_source	“API”
payment_gateway	“OpayoPi”
card_type	null
card_number_ending	null
card_expiry_date	null
name_on_card	null
internal_payment_description	null
gateway_payment_description	null
gateway_payee_id	null
gateway_card_id	null
transaction_type	“MOTO”
status	“pending”
status_details	null
status_code	null
currency_code	“GBP”
initial_amount	2750
metadata	null
gateway_status	null
gateway_status_code	null
gateway_status_details	null
card_holder_address_line1	null
card_holder_address_line2	null
card_holder_address_city	null
card_holder_address_postal_code	null
card_holder_address_country_code	null
card_holder_address_state_code	null
allow_repeat_payments	true
client:id	“CL01LG420EJ9DP1VQWR9”
created_by	null
edited_by	null
payment_gateway_profile:id	“PG01RZO41Y8DOJ0GNLW7”
payment_gateway_profile:description	“Opayo Payment Gateway”
customer_account:id	“CA01ZO41Y8DZ19P0GNLW”
customer_account:legacy_id	null

{
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "client":
	{ 
	  "id":{VALUE} 
	},
   "events":[
      {
         "id":{VALUE},
         "legacy_id":{VALUE},
         "event_id":{VALUE},
         "created_at":{VALUE},
         "edited_at":{VALUE},
         "custom_reference":{VALUE},
         "event_type":{VALUE},
         "event_source":{VALUE},
         "payment_gateway":{VALUE},
         "card_type":{VALUE},
         "card_number_ending":{VALUE},
         "card_expiry_date":{VALUE},
         "name_on_card":{VALUE},
         "internal_payment_description":{VALUE},
         "gateway_payment_description":{VALUE},
         "gateway_payee_id":{VALUE},
         "gateway_card_id":{VALUE},
         "transaction_type":{VALUE},
         "status":{VALUE},
         "status_details":{VALUE},
         "status_code":{VALUE},
         "currency_code":{VALUE},
         "initial_amount":{VALUE},
         "metadata":{VALUE},
         "gateway_status":{VALUE},
         "gateway_status_code":{VALUE},
         "gateway_status_details":{VALUE},
         "card_holder_address_line1":{VALUE},
         "card_holder_address_line2":{VALUE},
         "card_holder_address_city":{VALUE},
         "card_holder_address_postal_code":{VALUE},
         "card_holder_address_country_code":{VALUE},
         "card_holder_address_state_code":{VALUE},
         "allow_repeat_payments":{VALUE},
         "client":{
             "id":{VALUE}
         },
         "created_by":{
             "id":{VALUE}
         },
         "edited_by":{
             "id":{VALUE}
         },  
         "payment_gateway_profile":{
             "id":{VALUE},
             "description":{VALUE}
         },
         "customer_account":{
            "id":{VALUE},
            "legacy_id":{VALUE}
         }
      }
   ]
}

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

Card Event - Sample - Record Update

Card Event - Structure

The fields that have been updated for this webhook are:

Field	Sample Value
event_id	“HI08EXYR6K8KEY84ZLQV”
created_at	“2024-04-09T09:38:29Z”
edited_at	“2024-04-09T09:38:29Z”
event_type	“card_payment.update”
event_source	“API”
card_type	“Visa”
card_number_ending	“0006”
card_expiry_date	“2025-01-31”
internal_payment_description	“Payment from Ecommerce Page”
status	“failed”
gateway_status	“Error”
gateway_status_code	“1021”
gateway_status_details	“This release amount will exceed the amount of the original transaction”

{
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "client":
	{ 
	  "id":{VALUE} 
	},
   "events":[
      {
         "id":{VALUE},
         "legacy_id":{VALUE},
         "event_id":{VALUE},
         "created_at":{VALUE},
         "edited_at":{VALUE},
         "custom_reference":{VALUE},
         "event_type":{VALUE},
         "event_source":{VALUE},
         "payment_gateway":{VALUE},
         "card_type":{VALUE},
         "card_number_ending":{VALUE},
         "card_expiry_date":{VALUE},
         "name_on_card":{VALUE},
         "internal_payment_description":{VALUE},
         "gateway_payment_description":{VALUE},
         "gateway_payee_id":{VALUE},
         "gateway_card_id":{VALUE},
         "transaction_type":{VALUE},
         "status":{VALUE},
         "status_details":{VALUE},
         "status_code":{VALUE},
         "currency_code":{VALUE},
         "initial_amount":{VALUE},
         "metadata":{VALUE},
         "gateway_status":{VALUE},
         "gateway_status_code":{VALUE},
         "gateway_status_details":{VALUE},
         "card_holder_address_line1":{VALUE},
         "card_holder_address_line2":{VALUE},
         "card_holder_address_city":{VALUE},
         "card_holder_address_postal_code":{VALUE},
         "card_holder_address_country_code":{VALUE},
         "card_holder_address_state_code":{VALUE},
         "allow_repeat_payments":{VALUE},
         "client":{
             "id":{VALUE}
         },
         "created_by":{
             "id":{VALUE}
         },
         "edited_by":{
             "id":{VALUE}
         },  
         "payment_gateway_profile":{
             "id":{VALUE},
             "description":{VALUE}
         },
         "customer_account":{
            "id":{VALUE},
            "legacy_id":{VALUE}
         }
      }
   ]
}

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