Receive notifications on payment events
| Field | Description | |
|---|---|---|
| id | Unique identifier for the subscription. | This field will be created by Finexio when a subscription is created. read-only. |
| event | Name of event to connect with. | type: string required |
| url | Callback URL. | type: uri required |
| content_type | Desired content type for requests to this callback. Defaults to 'application/json'. | type: string Acceptable values: [ 'application/json', 'application/x-www-form-urlencoded'] |
| created_at | Date the subscription was created on. | type: timestamp (ISO-8601) read-only |
| updated_at | Date the subscription was updated on. | type: timestamp (ISO-8601) read-only |
| subscription | Subscription Url. | type: string read-only |
| username | Basic Auth username. | type: string required |
| password | Basic Auth password. | type: string required |
| invoice_ids | This flag determines if Finexio should include payment's invoices' uuids list in webhook payload. | type: boolean optional default: false |
| payment_status | This flag determines if Finexio should include payment's status in webhook payload. | type: boolean optional default: false |
| payment_events | This flag determines if Finexio should include payment's events list in webhook payload. | type: boolean optional default: false |
| refund_reason | This flag determines if Finexio should include refund reason in webhook payload if a refund was initiated against that payment. | type: boolean optional default: false |
| instrument_number | This flag determines if Finexio should include payment's instrument number if its available. | type: boolean optional default: false |