Fired when the status of a payment has changed.
Name | Type | Description | Notes |
---|---|---|---|
webhook_type | str | `PAYMENT_INITIATION` | |
webhook_code | str | `PAYMENT_STATUS_UPDATE` | |
payment_id | str | The `payment_id` for the payment being updated | |
new_payment_status | PaymentInitiationPaymentStatus | ||
old_payment_status | PaymentInitiationPaymentStatus | ||
original_reference | str, none_type | The original value of the reference when creating the payment. | |
original_start_date | date, none_type | The original value of the `start_date` provided during the creation of a standing order. If the payment is not a standing order, this field will be `null`. | |
adjusted_start_date | date, none_type | The start date sent to the bank after adjusting for holidays or weekends. Will be provided in ISO 8601 format (YYYY-MM-DD). If the start date did not require adjustment, or if the payment is not a standing order, this field will be `null`. | |
timestamp | datetime | The timestamp of the update, in ISO 8601 format, e.g. `"2017-09-14T14:42:19.350Z"` | |
environment | WebhookEnvironmentValues | ||
transaction_id | str, none_type | The transaction ID that this payment is associated with, if any. This is present only when a payment was initiated using virtual accounts. | [optional] |
adjusted_reference | str, none_type | The value of the reference sent to the bank after adjustment to pass bank validation rules. | [optional] |
error | PlaidError | [optional] | |
any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |