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.
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
| 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 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 |
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.
Related Articles
How do I configure my Agent Capture Assist?
Getting started with Agent Capture Assist This article outlines Agent Capture Assist functions and how to configure them. It covers the following: Initial configuration Administration console orientation Managing payments Administering users and ...User prompts in Agent Capture Assist
Adding a user prompt instruction script the users see when taking payments using the Agent Capture Assist The user prompts allows you to populate a window on the Agent Capture Assist and is used for providing information, URL help links or any other ...What details do I need from my Worldpay account to use Agent Capture Assist?
Entering Worldpay API keys during SAgent Capture Assist sign up Agent Capture Assist is currently integrated to the Worldpay UK Online payment gateway. Note: There are other gateways you maybe on so do check. https://online.worldpay.com/login As you ...How do I use Paytia Agent Capture Assist for PayPal?
How do I setup my PayPal account for Agent Capture Assist to connect? You'll need to create an API username for PayPal that's different from your main account username. You can only access PayPal via API only if you have a PayPal Premier / Business / ...How do I add a merchant account profile to a payment gateway?
Setting up payment gateway profiles on Paytia Each merchant account on the Paytia service is connected; by default to one payment provider gateway service. Customers who require the use of more than one bank account will have multiple merchant ...