Payment Link Event - Sample - General

Payment Link Event - Structure

The fields that have been updated for this webhook are:

Field Sample Value
account_validation_callback false
amount 903
auddis null
bank_account null
bank_account_custom_reference null
card_payment_custom_reference null
client:id “CL01KO5D0G80GYJERW4V”
completed_at null
created_at “2024-10-15T14:15:58Z”
created_by null
customer_account:id “CA01W3ZN7JWEYQNJGEX5”
customer_account:legacy_id null
description “Ongoing Schedule”
ecommerce_page:id “EP021NWLOKJY0K8RX5QM”
edited_at null
edited_by null
end_date null
event_id “HI0E75OW1YJVK08X29LV”
event_source API
event_type “payment_link.create”
expiry null
first_collection_amount 0
first_collection_date null
id “PL01KVQY3LJOZNPE61OG”
mandate null
metadata null
metadata_account_validation null
metadata_bank_account null
metadata_card null
metadata_customer_account null
metadata_mandate null
metadata_recurrence_schedule null
recurrence_schedule null
recurrence_schedule_custom_reference null
return_url null
start_date null
status “active”
url "https://ecomv2.smarterpaycloud.com/?setup=ABC123DEF456&payment=ABC123DEF456&page=ABC123DEF456"
visited_at null
{
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "client":{
      "id":{VALUE}
   },
   "events":[
      {
         "id":{VALUE},
         "event_id":{VALUE},
         "created_at":{VALUE},
         "edited_at":{VALUE},
         "created_by":{VALUE},
         "edited_by":{VALUE},
         "client":{
            "id":{VALUE}
         },
         "event_source":{VALUE},
         "event_type":{VALUE},
         "url":{VALUE},
         "amount":{VALUE},
         "description":{VALUE},
         "bank_account_custom_reference":{VALUE},
         "recurrence_schedule_custom_reference":{VALUE},
         "card_payment_custom_reference":{VALUE},
         "auddis":{VALUE},
         "customer_account":{
            "id":{VALUE},
            "legacy_id":{VALUE}
         },
         "bank_account":{VALUE},
         "mandate":{VALUE},
         "recurrence_schedule":{VALUE},
         "ecommerce_page":{
            "id":{VALUE}
         },
         "status":{VALUE},
         "expiry":{VALUE},
         "return_url":{VALUE},
         "visited_at":{VALUE},
         "completed_at":{VALUE},
         "account_validation_callback":{VALUE},
         "start_date":{VALUE},
         "end_date":{VALUE},
         "first_collection_amount":{VALUE},
         "first_collection_date":{VALUE},
         "metadata":{VALUE},
         "metadata_customer_account":{VALUE},
         "metadata_bank_account":{VALUE},
         "metadata_mandate":{VALUE},
         "metadata_recurrence_schedule":{VALUE},
         "metadata_card":{VALUE},
         "metadata_account_validation":{VALUE}
      }
   ]
}

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

  • Last modified: 2024/10/18 10:26