Payment Link Event - Structure

JSON

{
   "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.

Fields

Event Fields

Property Format Description
account_validation_callback boolean true or false, Link called from account validation process
amount integer Link Amount, if set
auddis string or null Mandate AUDDIS reference, if set
bank_account object or null Object containing the bank_account information, if set, see below
bank_account_custom_reference string or null String for custom reference to be set on Bank Account record, if set
card_payment_custom_reference string or null String for custom reference to be set on Card Payment record, if set
client object Object containing the bank_account information, see below
completed_at datetime or null Date and time the Payment Link was completed, if set
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
customer_account object or null Object containing the customer_account information, if set, see below
description string Description of the Payment Link
ecommerce_page object Object containing the ecommerce_page information, see below
edited_at datetime or null Date and time the record was updated
edited_by object or null Object containing the edited_by information, if set, see below
end_date date or null Schedule end date, if set
event_id string The ID of the Event
event_source string The Source that triggered the event
event_type string This will be “payment_link.create” or “payment_link.update”
expiry datetime or null Link expiry date, if set
first_collection_amount integer Schedule first collection amount, if set
first_collection_date datetime or null Schedule first collection date, if set
id string ID of the record
mandate object or null Object containing the mandate information, if set, see below
metadata string or null String for custom metadata, if set
metadata_account_validation string or null String for custom metadata to be set on Account Validation record, if set
metadata_bank_account string or null String for custom metadata to be set on Bank Account record, if set
metadata_card string or null String for custom metadata to be set on Card record, if set
metadata_customer_account string or null String for custom metadata to be set on Customer Account record, if set
metadata_mandate string or null String for custom metadata to be set on Mandate record, if set
metadata_recurrence_schedule string or null String for custom metadata to be set on Recurrence Schedule record, if set
recurrence_schedule object or null Object containing the recurrence_schedule information, if set, see below
recurrence_schedule_custom_reference string or null String for custom reference to be set on Recurrence Schedule record, if set
return_url string or null Link return URL, if set
start_date datetime or null Start date of a Recurrence Schedule, if set
status string Link status. Can be “active”, “expired”
url string System generated url to use the Payment Link
visited_at datetime or null Date and time the Payment Link was visited, if set
bank_account Object Fields
Property Format Description
id string The ID of the Record
legacy_id string or null Legacy ID of the record, if set
client Object Fields
Property Format Description
id string The ID of the Record
created_by Object Fields
Property Format Description
id string The ID of the Record
customer_account Object Fields
Property Format Description
id string The ID of the Record
legacy_id string or null Legacy ID of the record, if set
ecommerce_page Object Fields
Property Format Description
id string The ID of the Record
edited_by Object Fields
Property Format Description
id string The ID of the Record
mandate Object Fields
Property Format Description
id string The ID of the Record
recurrence_schedule Object Fields
Property Format Description
id string The ID of the Record