Skip to main content
Payment rules

Adding custom fields to capture more payment information

Custom fields is a paid add-on. Once it's on you can capture extra values through Agent Capture Assist or the API, store them in the transaction log, and pass them to your gateway as metadata.

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


Paytia has now introduced Custom fields as an additional licence for merchants looking to capture and send more information to Paytia through either the Agent Capture Assist interface or over the Paytia API services.

Custom fields are stored in Paytia transaction logs and where possible sent as additional metadata fields to the associated payment gateway.

 

Adding Custom fields

 

Add custom fields to capture payment info — How do I add fields to send additional custom values to Paytia and a payment

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.

Add custom fields to capture payment info — How do I add fields to send additional custom values to Paytia and a payment

 

Using the Add button Add custom fields to capture payment info — How do I add fields to send additional custom values to Paytia and a paymentAgent form settings 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

Add custom fields to capture payment info — 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 RequiredIt allows you to set if this field must be completed or not by your form users
Hide/ShowControls if the field is hidden from the user form. Hidden fields can still be passed to logs and the payment gateway (where supported)
Data typeIt 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
MaxlengthSets the maximum number of characters (including spaces) the field can hold
Field controlControls if the data captured is retained in Paytia logs only, sent to the payment gateway or stored in both locations
Payment gateway fieldShows 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

Add custom fields to capture payment info — example

 

API posting

From the API you would add the slug as a body field name.

 

Postman example

Add custom fields to capture payment info — postman

 

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.

Add custom fields to capture payment info — How do I add fields to send additional custom values to Paytia and a payment

 

Once you have all your fields added you are ready to start using the enhanced form service.



custom fieldsagent capture assistapigateway

Still need help?

Our support team is here to help. Submit a ticket and we'll get back to you within one business day.