API Glossary

id

String

Yes

Unique merchant identification code, provided by ISX.

return_url

String

No

This URL is where ISX will redirect the user after completing the transaction.

transaction_webhook_url

String

No

Using “transaction_webhook_url” field will override the default URL that was set with the ISX relationship management team every time a request is sent.

id

String

Yes

Your unique transaction identification code.

datetime

String

No

Date and time transaction has been recorded (JavaScript format).

amount

String

Yes

The transaction amount in the smallest currency unit (e.g., cents if using EUR).

currency

String

Yes

ISO 4217 currency (alphabetic) code (refer to this link for more information).

reference

String

Yes

Your transaction reference code.

recurring_id

String

No

Your unique referencing identifier of a completed transaction flagged as init_recurring.

init_recurring

Boolean

No

To indicate the beginning/activation of a recurring series.

ip

String

Yes

Internet protocol address of the client.

first_name

String

Yes

First name the client provided.

middle_name

String

No

Middle name the client provided.

last_name

String

Yes

Last name the client provided.

dob

String

Yes (Paydentity)

Date of birth
Format: YYYY-mm-dd

gender

String

*Yes (Paydentity)

Gender of the client
*(Required only for German eKYC)

email

String

Yes

Email address of the client.

mobile

String

Yes

International mobile phone number of the client.
Format: E.123
Note: No spaces allowed.

phone_number

String

No

International home phone number of the client.
Format: E.123
Note: No spaces allowed.

residential_address_secondary

String

No

Line 2 of the client’s residential address.

residential_address_street

String

Yes (Paydentity)

Line 1 of the client’s residential address
(without the street number).
Format: Only 24 characters allowed without special characters.

residential_address_street_number

String

Yes (Paydentity)

Street number of the client’s residential address.

residential_address_city

String

Yes (Paydentity)

City (Town/Locality) of the client’s residential address.

residential_address_postal_code

String

Yes (Paydentity)

Postal Code of the client’s residential address.

residential_address_subdivision

String

*Yes (Paydentity)

ISO 3166-2 State / County / Region / Province / Subdivision code of the client’s residential address.
*(Required only for US, AU & CA eKYC).
Format: Do not prefix the country code.

residential_address_country

String

Yes (Paydentity)

ISO 3166-1 country (alpha-2) of the client’s residential address (refer to this link for more information).

billing_address_secondary

String

No

Line 2 of the client’s billing address.

billing_address_street

String

Yes 

Line 1 of the client’s billing address (without the street number).
Format: Only 24 characters allowed without special characters.

billing_address_street_number

String

No

Street number of the client’s billing address.

billing_address_city

String

Yes

City (Town/Locality) of the client’s billing address.

billing_address_postal_code

String

Yes 

Postal Code of the client’s billing address.

billing_address_subdivision

String

No

ISO 3166-2 State / County / Region / Province / Subdivision code of the client’s billing address.
Format: Do not prefix the country code.

billing_address_country

String

Yes 

ISO 3166-1 country (alpha-2) of the billing address (refer to this link for more information).

citizen_country

String

Yes (Paydentity)

ISO 3166-1 citizen country (alpha-2) of the client (refer to this link for more information).

birth_country

String

No

ISO 3166-1 birth country (alpha-2) of the client (refer to this link for more information).

pan

String

Yes

Primary account number, i.e., the “card number” on either a debit or a credit card.

expiration_date

String

Yes

Four-digit representation of the PAN expiration date.

cvv

String

Conditional

Card verification value.

name

String

Yes

Name of primary account holder.

acquirer_id

String

No

Force the payment route to go to specified ISX acquirer id and bypass ISX routing rules.

identifier

String

Yes

Merchant provided unique identifier for the end user account.

secret

String

No

The account secret code.

masked_pan

String

Primary account number masked, i.e. the “card number” on either a debit or a credit card.

card_brand

String

Card brand of the card number.

expiry_date

String

Four-digit representation of the PAN expiration date.

merchant_id

String

Your merchant identification code, provided by ISX.

transaction_id

String

The request transaction identification code.

reference

String

Your transaction reference code.

account

Object

Information about the account.

recurring_id

String

Referencing identifier for a completed transaction flagged as init-recurring, provided by ISX.

status

String

The current status of the recurring credential.

strength

String

The current strength of the recurring credential.

origin_transaction_id

String

The id of the transaction flagged as init-recurring and originally activated the recurring series.

origin_merchant_id

String

Your merchant identification code.

masked_pan

String

Primary account number masked, i.e. the “card number”, bound with the recurring series.

exp_date