Note:
The field will be disregarded if it is marked as optional and the format provided is incorrect. However, a validation error will be displayed if the field is marked as mandatory and the format provided is incorrect.
"+" - means required (for all flows)
"-" - means not required (for any flow)
For instance, in POST Create Charge flow:
+6 means that the field is required for flow number 6
-6 means that the field is not required for flow number 6
Notification Templates
Templates are used for creating email and sms notifications.
Notification Templates also provide swap values (eg {{PHONE}} or {{EMAIL}}) that will be populated from the customer, charge or subscription that triggered the notification.
Templates Resource
| field | required | type | description |
|---|---|---|---|
| body | + | string | Use custom text or/and predefined variables, in which PowerBoard automatically pulls values from customer, charge or subscription data objects. |
| label | + | string | Name of current template to identify it further |
| html | + | bool | Body could be in html or plain text format. Allowed values: true, false |
| notification_event | + | string | Event to trigger notification. |
Swap Values for templates
The notification templates can be used to load parameters from the customer or transaction into the notification. These can also be used to populate the destination (eg phone number for sms).
The full list of available swap values is:
| Field Name | Description |
|---|---|
| {{CHARGE_ID}} | PowerBoard ID for the charge |
| {{EMAIL}} | The email address for the customer associated with the event |
| {{FIRST_NAME}} | The first name for the customer associated with the event |
| {{LAST_NAME}} | The last name for the customer associated with the event |
| {{PHONE}} | The phone number for the customer associated with the event |
| {{AMOUNT}} | The amount for the transaction |
| {{CURRENCY}} | The currency for the transation |
| {{CUSTOMER_REFERENCE}} | The customer reference number provided by the merchant for the customer |
| {{CHARGE_REFERENCE}} | The reference number provided by the merchant for the transaction |
| {{CHARGE_DESCRIPTION}} | The description provided by the merchant for the transaction |
| {{CREATED_AT}} | create date for the object (eg customer, subscription) in ISO format date and time (eg 2023-12-22T10:36:08.170Z) |
| {{UPDATED_AT}} | updated date for the object (eg customer, subscription) in ISO format date and time (eg 2023-12-22T10:36:08.170Z) |