Adding custom fields to capture more payment information

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


Paytia has now introduced Custom fields as an additional licence for merchants looking to capture and send more information to Paytia through either the Secure Virtual Terminal 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

 


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 SVT 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 Secure Virtual Terminal 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


 

API posting

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

 

Postman example


 

Secure Virtual Terminal 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

    • Data-capture

      Customizing data capture This article outlines the payment history category and how to configure. It covers the following: Contents of data-capture Address-verification system (AVS) Contents of data-capture On the left-hand side of the Paytia ...
    • Webhooks sent from Paytia to API users for the payment capture IVR flow

      Paytia IVR webhook flow The initial post into Paytia will return a URL for the Paytia iframe. If you do not want to use the iframe you can ignore that response post ‘url’ value. Note: Paytia will maintain the reference_id value throughout the payment ...
    • Payment links report

      How do I access information about the payment links sent to customers? Payment links logs and report Payment links are a licensed service on the Paytia platform. If your portal or user screens do not have the following reports and you would like ...
    • What payment types does Paytia support?

      Paytia enables multiple types of transaction to be made over the phone. This article explains the different options The Paytia platform is integrated with the payment gateways of banks and payment service providers. This allows merchants to process ...
    • What payment gateway accounts can be used with Paytia?

      Below is a list of payment gateway accounts which can currently be used with Paytia's services. Stripe Worldpay PayPal Opayo Global Payments Verifone Lloyds Cardnet Barclaycard Trust Payments Elavon Don't see your payment provider listed? We always ...