Adding custom fields to capture more payment information
How do I add fields to send additional custom values to Paytia and a payment gateway?
Note: Custom fields is an additional licence. If you require this please contact sales@paytia.com
Custom fields are stored in Paytia transaction logs and where possible sent as additional metadata fields to the associated payment gateway.
Adding Custom fields
From the merchant portal find the Configure user screen menu and then the Data-capture sub-menu, from there you will be able to see the Custom field section.
or, if you have Paytia ' Customer Management active, the menu is located in the 'Customer management' > 'Manage form fields' sub-menu.
When you are ready to create a custom field, scroll down to the bottom of the 'Manage form fields' page. You will see a Custom fields tab, your now in the right section to get started.
Using the Add button you can create your own custom fields that are accessible to use over Paytia API services and also from inside the agent ACA screen.
Add
Description of how the fields work
Select Route* | Allows the field to be associated to a Payment rule only or a payment gateway route |
Select gateway* | Allows you to pick which payment gateway route this field data will be passed into |
| Field Name * | This is a required value. It allows you to add a text label to your new field |
| Placeholder Name * | This is a required field. It allows you to write the text form users will see when they use the field in the Paytia Agent Capture Assist interface. |
| Required/Not Required | It allows you to set if this field must be completed or not by your form users |
| Hide/Show | Controls if the field is hidden from the user form. Hidden fields can still be passed to logs and the payment gateway (where supported) |
| Data type | It allows you to set the expected data type so data is rejected if it is not found to be entered in the correct data format |
| Maxlength | Sets the maximum number of characters (including spaces) the field can hold |
Field type | Allows selection controls to be used based on Dropdown, Radio button or Input value |
| Field control | Controls if the data captured is retained in Paytia logs only, sent to the payment gateway or stored in both locations |
| Payment gateway field | Shows the field on the payment gateway this value will be sent into |
Sent to webhook (tickbox) | If you want this value passed back to your API application on transaction completion, tick this box |
Once you have created a new field Paytia will automatically create a 'slug'. The slug is the field name as it would be sent to Paytia over an API post.
Example showing 'slug' value
API posting
From the API you would add the slug as a body field name.
Postman example
Agent Capture Assist form use
Your new custom fields will be added to the form view below the last system field of 'Account number' and before the system field of 'Payment type' selection.
Once you have all your fields added you are ready to start using the enhanced form service.