API Configuration Settings
The API Configuration Settings page lets you control which variables are returned in your Direct Post API response. This is useful when you want your website or software to receive additional customer or transaction details back from the Gateway.
By default, the Gateway returns a standard set of response variables (plus any other fields required for the transaction type). If you need more data returned consistently, you can create a custom response format here.
How to Enable a Custom API Response Format
- Go to API Configuration Settings in the Gateway
- Check the option to enable a custom response format
- From the list of available fields, click the arrow next to each value you want included
- Example: billing company, email, first name, last name
- Arrange the selected fields in the order you want them returned
- Click Save
Important Warning
Changing the API response format can cause issues if your software expects the default configuration.
Only enable a custom format if:
- Your integration is prepared to handle the new response order, or
- A developer has updated your implementation accordingly
Confirm the warning to save your changes.
After Saving
- Selected variables will be returned in the exact order shown
- All future Direct Post API transactions will include these fields automatically
Video Walkthrough
Watch the video below for a walkthrough of enabling custom API response fields and understanding how they impact Direct Post integrations: