We decided to build an app for the Node.js Knockout that will give us a head start on developing one of our most requested features: push notifications of gateway activity. Check out PushRelay and vote for us in the Node Knockout!
Custom Fields
Custom fields need to be created in the Control Panel before they can be used in the API. Custom fields are never required, so you can safely configure them before updating your code to pass them to the gateway. However, it doesn’t work the other way around – if you send a custom field in the API that you haven’t configured in the control panel you’ll get a validation error.
Custom field values are associated with newly created transactions or customer vault records. They have two names: an API name and a display name. You will use the API name when you are passing values through with transactions or customers. The display name is what is visible in the Control Panel. All custom fields submitted in the API will be returned in the response. Only custom fields configured to be stored will be stored with the transaction or customer.
Types of Custom Fields
Pass Thru Field
Setting up a custom field as a pass thru field will cause any data entered into this field to be passed through the gateway. Data for this type of custom field is not stored in the gateway. This is intended to be used with the Transparent Redirect API.
A Stored and Pass Thru Field
In addition to being passed back in responses from the gateway, the data for a Stored and Pass Thru custom field is stored in the gateway.
See Also
- custom fields on transactions (server-to-server)
- custom fields on transactions (transparent redirect)
- custom fields on customers (transparent redirect)
- custom fields on customers (server-to-server)