Custom fields allow Merchants to request data from Customers when a Customer attempts a payment, or to record data against payment requests when an authorised Merchant user creates the request.
Custom fields can be pre-populated, or left blank for Customers to complete. When designed for Customers, custom fields can be set as "mandatory" or "optional".
Data recorded in a custom field is accessible via the web interface or API (using the "getPR" service). Custom fields can be created via API per payment request, using the "customPR" service.
The following field types may be configured as a custom field:
|
Field type (FlipPay) |
Field type (JSON) |
Notes |
|
text |
string |
Standard string format |
|
number |
number |
Standard number format |
|
currency |
number |
Number with 2 decimal places required E.g. 100.00 = ok 100 = not ok 100.0 = not ok |
|
date |
string |
String, formatted as: “DD-MM-YYYY” |
|
option-list |
string |
Standard string format |
|
file-upload |
file |
File |
Refer to the API documentation for details on how to configure these fields using the "customPR" service.
Custom fields created via API can have specific access controls applies to them:
- Display to Customer
- When set to TRUE, this field will be visible to a Customer on the payment page
- Example use case: set to "false" to record data against a payment request that is not for Customer viewing
- Editable by Customer
- When set to TRUE, this field may be edited by a Customer on the payment page, overriding any data that may be pre-populated in it
- Example use case: set to "true" to allow a Customer to enter data when making a payment
- Required to submit
- When set to TRUE, this field must be populated before a payment can be accepted
- Example use case: set to "true" to make the field mandatory to complete, before a Customer can make a payment
FAQ
What are some typical use cases for custom fields?
- When creating a payment request, a Merchant may wish to store a sales reference (e.g. sales date, sales person, product sold, etc) against the payment request - this may be for internal purposes only, and not displayed to Customers
- When receiving payment from a Customer, a Merchant may want to capture specific data points from a Customer (e.g. how did you hear about us, provide some feedback, select some other option) either optionally or mandatorily.
How can I access data in custom fields?
Data entered in custom fields, both by the payment request creator and the Customer, is viewable via the web interface or accessible when using the "getPR" service.
Are there limits to how many custom fields I can generate?
No.