API Glossary

Header

For API operations, 3 fields are required for the header of an API post.

Fields:

Field Name	Field Value

Field Name	Field Value
`From`	`API client name`
`Authorization`	`Bearer API token`
`Content-Type`	`application/json`

Example:

Field Name	Field Value

Field Name	Field Value
`From`	`Test_APIClient`
`Authorization`	`Bearer TEXnkvZCtFucXebHYwrYLIGbkhjygvBTbxWELCCnCQJTKsx6bYNh5fOjEE`
`Content-Type`	`application/json`

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

POST Objects

Merchant Object

Field	Type	Required	Description

Field	Type	Required	Description
`id`	String	Yes	Unique merchant ID code, provided by ISX.
`return_url`	String	No	This URL is where ISX will redirect user after completing a transaction.
`transaction_webhook_url`	String	No	Using `transaction_webhook_url` field will override default URL that was set with ISX RM team every time a request is sent.

"merchant":{ "id":"default", "return_url":"https://test/completed?transaction_id=", "transaction_webhook_url":"https://test.com/v1/notification" }

Transaction Object

Field	Type	Required	Description

Field	Type	Required	Description
`id`	String	Yes	Your unique transaction identification code.
`datetime`	String	No	Date & time transaction has been recorded (JavaScript format).
`amount`	String	Yes	Transaction amount in smallest currency unit (e.g., cents if using EUR).
`currency`	String	Yes	ISO 4217 currency (alphabetic) code.
`reference`	String	Yes	Your transaction reference code.
`recurring_id`	String	No	Your unique referencing identifier of completed transaction flagged as `init_recurring`.
`init_recurring`	Boolean	No	To indicate beginning/activation of recurring series.

"transaction":{ "id":"885e3506-eb13-4d2c-bc24-e336aaf94037", "datetime":"2015-11-30T23:48:49.701Z", "amount":"3100", "currency":"AUD", "reference":"their_transaction_reference", "init_recurring":true, "recurring_id":"f7fb955_15fc0a831d7__7fa7" }

When recurring_id is provided, amount, currency & init_recurring should not be present in the request, or a validation error will occur.

Client Object

Field	Type	Required	Description

Field	Type	Required	Description
`ip`	String	Yes	Internet protocol address of client.
`first_name`	String	Yes	First name client provided.
`middle_name`	String	No	Middle name client provided.
`last_name`	String	Yes	Last name client provided.
`dob`	String	Yes (Paydentity)	Date of birth. Format: `YYYY-mm-dd`.
`gender`	String	^*Yes (Paydentity)	Gender of client. ^*Required only for German eKYC.
`email`	String	Yes	Email address of client.
`mobile`	String	Yes	International mobile phone number of client. Format: E.123. Note: no spaces allowed.
`phone_number`	String	No	International home phone number of client. Format: E.123. Note: no spaces allowed.
`residential_address_secondary`	String	No	Line 2 of client’s residential address.
`residential_address_street`	String	Yes (Paydentity)	Line 1 of client’s residential address (without street number). Format: only 24 characters allowed without special characters.
`residential_address_street_number`	String	Yes (Paydentity)	Street number of client’s residential address.
`residential_address_city`	String	Yes (Paydentity)	City (town/locality) of client’s residential address.
`residential_address_postal_code`	String	Yes (Paydentity)	Postal code of client’s residential address.
`residential_address_subdivision`	String	^*Yes (Paydentity)	ISO 3166-2 state/county/region/province/subdivision code of client’s residential address. Format: do not prefix country code. ^*Required only for US, AU & CA eKYC.
`residential_address_country`	String	Yes (Paydentity)	ISO 3166-1 country (alpha-2) of client’s residential address.
`billing_address_secondary`	String	No	Line 2 of client’s billing address.
`billing_address_street`	String	Yes	Line 1 of client’s billing address (without street number). Format: only 24 characters allowed without special characters.
`billing_address_street_number`	String	No	Street number of client’s billing address.
`billing_address_city`	String	Yes	City (town/locality) of client’s billing address.
`billing_address_postal_code`	String	Yes	Postal code of client’s billing address.
`billing_address_subdivision`	String	No	ISO 3166-2 state/county/region/province/subdivision code of client’s billing address. Format: do not prefix country code.
`billing_address_country`	String	Yes	ISO 3166-1 country (alpha-2) of billing address.
`citizen_country`	String	Yes (Paydentity)	ISO 3166-1 citizenship country (alpha-2) of client.
`birth_country`	String	No	ISO 3166-1 birth country (alpha-2) of client.

"client":{ "first_name":"Shana", "last_name":"Barrows", "billing_address_street":"AU", "billing_address_street_number":"42", "billing_address_secondary":"PO Box 24", "billing_address_city":"Ashfield", "billing_address_postal_code":"2131", "billing_address_subdivision":"NSW", "billing_address_country":"AU", "email":"shana.barrows@mail.com", "mobile":"+61434444444" }

"client":{ "ip":"225.148.60.236", "title":"Ms", "first_name":"Shana", "middle_name":"Michelle", "last_name":"Barrows", "dob":"1981-10-01", "gender":"female", "residential_address_street":"Arthur Street", "residential_address_secondary":"PO Box 24", "residential_address_street_number":"42", "residential_address_city":"Ashfield", "residential_address_postal_code":"2131", "residential_address_subdivision":"NSW", "residential_address_country":"AU", "billing_address_street":"AU", "billing_address_secondary":"PO Box 24", "billing_address_city":"Ashfield", "billing_address_postal_code":"2131", "billing_address_subdivision":"NSW", "billing_address_country":"AU", "citizen_country":"AU", "birth_country":"AU", "email":"shana.barrows@mail.com", "mobile":"+61434444444", "phone_number":"+61393677777" }

Cardholder Object

Field	Type	Required	Description

Field	Type	Required	Description
`pan`	String	Yes	Primary account number (i.e., card number) on debit or credit card.
`expiration_date`	String	Yes	4-digit representation of PAN expiration date.
`cvv`	String	Conditional	Card verification value.
`name`	String	Yes	Name of primary account holder.

"cardholder":{ "pan":"4111117056800097", "expiration_date":"0618", "cvv":"234", "name":"Shana Barrows" }

Payment Route Object

Field	Type	Required	Description

Field	Type	Required	Description
`acquirer_id`	String	No	Force a payment route to go to specified ISX acquirer ID & bypass ISX routing rules.

"payment_route":{ "acquirer_id":"override-acquirer" }

Account Object

Field	Type	Required	Description

Field	Type	Required	Description
`identifier`	String	Yes	Merchant provided unique identifier for end user account.
`secret`	String	No	Account secret code.

"account":{ "identifier":"123456", "secret":"083daa84-77b6-4817-a4f3-5771779c1c82" }

GET Objects

Card Reference Object

Field	Type	Description

Field	Type	Description
`masked_pan`	String	Primary account number masked (i.e. card number) on debit or credit card.
`card_brand`	String	Card brand of debit or credit card.
`expiry_date`	String	4-digit representation of PAN expiration date.

"account":{ "masked_pan":"411111....0097", "card_brand":"VISA", "expiry_date":"1222" }

Original Message Object

Field	Type	Description

Field	Type	Description
`merchant_id`	String	Your merchant identification code, provided by ISX.
`transaction_id`	String	Request transaction identification code.
`reference`	String	Your transaction reference code.
`account`	Object	Info about account.

{ "merchant_id":"default", "transaction_id":"their_transaction_id", "reference":"their_transaction_reference", "account":{ "identifier_type":"ID", "identifier":"unique_CRM_code", "secret":"SOLLIP", "full_name":"Firstname Lastname" } }

Recurring Credential Object

Field	Type	Description

Field	Type	Description
`recurring_id`	String	Referencing identifier for completed transaction flagged as `init-recurring`, provided by ISX.
`status`	String	Current status of recurring credential.
`strength`	String	Current strength of recurring credential.
`origin_transaction_id`	String	ID of transaction flagged as `init-recurring` & originally activated recurring series.
`origin_merchant_id`	String	Your merchant identification code.
`masked_pan`	String	Primary account number masked (i.e., card number) bound with recurring series.
`exp_date`	String	Representation of bound card number expiration date.
`recurring_type`	String	Registered type of recurring operation.
`amount`