Skip to content
English - United Kingdom
  • There are no suggestions because the search field is empty.

Frequently Asked Questions (FAQ)

What are the prerequisites?
 

API Client Name, Bearer API Token, Content Type
Production Environment: https://api.isxpay.com/gateway/service/v1/authorization
Refer to the Getting Started page for more information.

The word Bearer must be present in the API token or else an error will result.

 
How can I find API header information?
 

The API Header information such as API Client Name, Bearer API Token, and Content Type are provided by the ISX relationship management team.

The word Bearer must be present in the API token or else an error will result.

 
What are the required fields in order to create a transaction?
 

Acquiring (required fields)

The API call requires information about billing address to proceed with a payment:
• first_name
• last_name
• email
• mobile
• billing_address_street
• billing_address_street_number
• billing_address_city
• billing_address_postal_code
• billing_address_country

Paydentity (required fields)

The API call requires additional information of the end user from the cardholder, such as residential address, to proceed with a payment:
• first_name
• last_name
• dob
• gender
• email
• mobile
• billing_address_street
• billing_address_street_number
• billing_address_city
• billing_address_postal_code
• billing_address_country
• residential_address_street
• residential_address_street_number
• residential_address_city
• residential_address_postal_code
• residential_address_subdivision (US,AU,CA)
• residential_address_country
• citizen_country

Additional parameters are mandatory based on the country:
US, AU, CA – residential_address_subdivision valid state (for countries that have states).

Information about the required fields are also provided in the Client Object.

 
What are the formats of mandatory fields?
 
 
 
 

Field

Format

first_name

Only 24 characters are allowed without any special characters (maximum length: 255 chars).

dob

YYYY-mm-dd

mobile

E.123 mobile should be within 5-15 characters (including prefix code). No spaces are allowed.

phone_number

E.123 phone number should be within 5-15 characters (including prefix code). No spaces are allowed.

billing_address_street

Only 24 characters are allowed without any special characters (maximum length: 255 chars).

residential_address_street

Only 24 characters are allowed without any special characters (maximum length: 255 chars).

 
 
 
How are notifications received?
 

All the required information in the transaction is sent to the notification URL provided.
For more details, refer to the Notifications page.

 
How do I accept or reject a transaction in a manual review?
 

Request URL: POST/v1/tasks/ID/accept
Request URL: POST /v1/tasks/ID/reject
For more details, refer to the Actions page.

 
How do I cancel a transaction?
 

Request URL: POST /v1/transaction/ISX-transaction-ID/cancel
For more details, refer to the Actions page.

 
How is a language changed?
 

Refer to the Supported Languages page.

 
What is the difference between an event and a state?
 

The event field describes a system action that has been triggered, either automatically or by an operator.
The state field by itself is the overall reported state of the transaction and should be the only field that third parties take any action on.
The compound state is a combination of the state appended with a reason. This field is informational only and is subject to change without notice.
The filtered state (if specified) will be used when required by the end user’s browser.