Gateway API reference help

Gateway API reference help

Credit card API

Online realtime API information, based on the deployed code

AUTH fields
transaction_type "AUTH"
merchant_account string[6-32]
merchant_password string[6-32]
amount float[0.01 - 9999999]
currency string[3], upper-cased, ISO 4217 alpha-3
transaction_unique_id string[1-45]
card_exp_year string[4], only digits (2 digits accepted as 20YY), not expired
card_exp_month 1-2 digits month number string ['1'..'12'] or ['01'..'12'], not expired
card_holder string[2-32]
card_number string[13-19], only digits
country string[3], only letters, upper-cased, ISO 3166-1 alpha-3 format
first_name string[1-32]
last_name string[1-32]
user_email string[6-255], valid email
user_ip IpAddress
api_version float, > 0
auth_type optional bySignature, byAccount
cvv optional string[3-4], only digits
state optional string[2], upper-cased
city optional string[2-32]
address optional string[2-50]
zip optional string[2-10], only letters, digits, spaces and hyphens
user_phone optional string[7-16], optional '+' followed by 7-15 digits, spaces and hyphens removed
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
mid_reference optional string[16], MidReferenceValidator
date_of_birth optional NotEmptyString, date[Y-m-d]
cof_type optional CIT-initial, CIT-subsequent, MIT
base_reference optional string[20]

AUTH by token fields
transaction_type "AUTH"
merchant_account string[6-32]
merchant_password string[6-32]
token string[36]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
transaction_unique_id string[1-45]
card_holder string[2-64]
country string[2-3], matched with the ISO 3166-1 alpha-3 standard
first_name string[1-32]
last_name string[1-32]
user_email string[6-255], valid email
user_ip IpAddress
api_version float
auth_type optional bySignature, byAccount
cvv optional string[3-4], only digits
state optional string[1-32]
city optional string[2-32]
address optional string[2-150]
zip optional string[2-10]
user_phone optional string[7-15]
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
mid_reference optional string[16], MidReferenceValidator
date_of_birth optional NotEmptyString, date[Y-m-d]
cof_type optional CIT-initial, CIT-subsequent, MIT
base_reference optional string[20]

AUTH3D fields
transaction_type "AUTH3D"
merchant_account string[6-32]
merchant_password string[6-32]
amount float[0.01 - 9999999]
currency string[3], upper-cased, ISO 4217 alpha-3
transaction_unique_id string[1-45]
card_exp_year string[4], only digits (2 digits accepted as 20YY), not expired
card_exp_month 1-2 digits month number string ['1'..'12'] or ['01'..'12'], not expired
card_holder string[2-32]
card_number string[13-19], only digits
country string[3], only letters, upper-cased, ISO 3166-1 alpha-3 format
first_name string[1-32]
last_name string[1-32]
user_email string[6-50], valid email
user_ip IpAddress (IPv4 or IPv6), max 39 characters
api_version float, > 0
callback_url NotEmptyString
redirect_url NotEmptyString
recipient_name optional string[1-32]
recipient_last_name optional string[1-32]
recipient_birth_date optional date[Y-m-d]
recipient_city optional string[2-32]
recipient_account_type optional string[2-32]
recipient_account_number optional string[1-255]
recipient_country optional string[3-3], matched with the ISO 3166-1 alpha-3 standard
recipient_state optional string[1-32]
recipient_address optional string[2-150]
auth_type optional bySignature, byAccount
cvv optional string[3-4], only digits
state optional string[2], upper-cased
city optional string[2-32]
address optional string[2-50]
zip optional string[2-10], only letters, digits, spaces and hyphens
user_phone optional string[7-16], optional '+' followed by 7-15 digits, spaces and hyphens removed
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[2-16], Genome adds prefix GEN*
descriptor_phone optional string[7-13], only digits, spaces and hyphens removed
mid_reference optional string[16], MidReferenceValidator
date_of_birth optional NotEmptyString, date[Y-m-d]
cof_type optional CIT-initial, CIT-subsequent, MIT
base_reference optional string[20]
3ds_data: optional object
    threeDSCompInd optional Y, N, U
    threeDSRequestorAuthenticationInd optional 01, 02, 03, 04, 05, 06, 07, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    threeDSRequestorChallengeInd optional 01, 02, 03, 04, 05, 06, 07, 08, 09, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    threeDSRequestorDecMaxTime optional string[1-5], only digits
    threeDSRequestorDecReqInd optional Y, N
    threeDSRequestorURL optional string[1-2048], UrlValidator
    threeRIInd optional 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    acctType optional 01, 02, 03
    acctID optional string[1-64]
    purchaseInstalData optional string[1-3], PositiveDigitsOnlyString
    recurringExpiry optional string[8], date[Ymd]
    recurringFrequency optional string[1-4], only digits
    threeDSReqAuthData optional string[1-20000]
    threeDSReqAuthMethod optional 01, 02, 03, 04, 05, 06, 07, 08
    threeDSReqAuthTimestamp optional string[12], date[YmdHi]
    threeDSReqPriorAuthMethod optional 01, 02, 03, 04
    threeDSReqPriorAuthTimestamp optional string[12], date[YmdHi]
    threeDSReqPriorRef optional string[36]
    chAccAgeInd optional 01, 02, 03, 04, 05
    chAccChange optional string[8], date[Ymd]
    chAccChangeInd optional 01, 02, 03, 04
    chAccDate optional string[8], date[Ymd]
    chAccPwChange optional string[8], date[Ymd]
    chAccPwChangeInd optional 01, 02, 03, 04, 05
    nbPurchaseAccount optional string[1-4], only digits
    paymentAccAge optional string[8], date[Ymd]
    paymentAccInd optional 01, 02, 03, 04, 05
    provisionAttemptsDay optional string[1-3], only digits
    shipAddressUsage optional string[8], date[Ymd]
    shipAddressUsageInd optional 01, 02, 03, 04
    shipNameIndicator optional 01, 02
    suspiciousAccActivity optional 01, 02
    txnActivityDay optional string[1-3], only digits
    txnActivityYear optional string[1-3], only digits
    deliveryEmailAddress optional string[1-254], valid email
    deliveryTimeframe optional 01, 02, 03, 04
    giftCardAmount optional string[1-15]
    giftCardCount optional string[2]
    giftCardCurr optional string[3]
    preOrderDate optional string[8], date[Ymd]
    preOrderPurchaseInd optional 01, 02
    reorderItemsInd optional 01, 02
    shipIndicator optional 01, 02, 03, 04, 05, 06, 07

AUTH3D by token fields
transaction_type "AUTH3D"
merchant_account string[6-32]
merchant_password string[6-32]
token string[36]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
transaction_unique_id string[1-45]
card_holder string[2-64]
country string[2-3], matched with ISO 3166-1 alpha-3 standard
first_name string[1-32]
last_name string[1-32]
user_email string[6-255], valid email
user_ip IpAddress
api_version float
recipient_name optional string[1-32]
recipient_last_name optional string[1-32]
recipient_birth_date optional date[Y-m-d]
recipient_city optional string[2-32]
recipient_account_type optional string[2-32]
recipient_account_number optional string[1-255]
recipient_country optional string[3-3], matched with ISO 3166-1 alpha-3 standard
recipient_state optional string[1-32]
recipient_address optional string[2-150]
callback_url optional NotEmptyString
redirect_url optional NotEmptyString
auth_type optional bySignature, byAccount
cvv optional string[3-4], only digits
state optional string[1-32]
city optional string[2-32]
address optional string[2-150]
zip optional string[2-10]
user_phone optional string[7-15]
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
date_of_birth optional NotEmptyString, date[Y-m-d]
cof_type optional CIT-initial, CIT-subsequent, MIT
base_reference optional string[20]
3ds_data: optional object
    threeDSCompInd optional Y, N, U
    threeDSRequestorAuthenticationInd optional 01, 02, 03, 04, 05, 06, 07, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    threeDSRequestorChallengeInd optional 01, 02, 03, 04, 05, 06, 07, 08, 09, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    threeDSRequestorDecMaxTime optional string[1-5], only digits
    threeDSRequestorDecReqInd optional Y, N
    threeDSRequestorURL optional string[1-2048], UrlValidator
    threeRIInd optional 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    acctType optional 01, 02, 03
    acctID optional string[1-64]
    purchaseInstalData optional string[1-3], PositiveDigitsOnlyString
    recurringExpiry optional string[8], date[Ymd]
    recurringFrequency optional string[1-4], only digits
    threeDSReqAuthData optional string[1-20000]
    threeDSReqAuthMethod optional 01, 02, 03, 04, 05, 06, 07, 08
    threeDSReqAuthTimestamp optional string[12], date[YmdHi]
    threeDSReqPriorAuthMethod optional 01, 02, 03, 04
    threeDSReqPriorAuthTimestamp optional string[12], date[YmdHi]
    threeDSReqPriorRef optional string[36]
    chAccAgeInd optional 01, 02, 03, 04, 05
    chAccChange optional string[8], date[Ymd]
    chAccChangeInd optional 01, 02, 03, 04
    chAccDate optional string[8], date[Ymd]
    chAccPwChange optional string[8], date[Ymd]
    chAccPwChangeInd optional 01, 02, 03, 04, 05
    nbPurchaseAccount optional string[1-4], only digits
    paymentAccAge optional string[8], date[Ymd]
    paymentAccInd optional 01, 02, 03, 04, 05
    provisionAttemptsDay optional string[1-3], only digits
    shipAddressUsage optional string[8], date[Ymd]
    shipAddressUsageInd optional 01, 02, 03, 04
    shipNameIndicator optional 01, 02
    suspiciousAccActivity optional 01, 02
    txnActivityDay optional string[1-3], only digits
    txnActivityYear optional string[1-3], only digits
    deliveryEmailAddress optional string[1-254], valid email
    deliveryTimeframe optional 01, 02, 03, 04
    giftCardAmount optional string[1-15]
    giftCardCount optional string[2]
    giftCardCurr optional string[3]
    preOrderDate optional string[8], date[Ymd]
    preOrderPurchaseInd optional 01, 02
    reorderItemsInd optional 01, 02
    shipIndicator optional 01, 02, 03, 04, 05, 06, 07

AUTH by PaRes fields
transaction_type "AUTH"
merchant_account string[6-32]
merchant_password string[6-32]
transaction_unique_id string[1-45]
reference string[20]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
api_version float
auth_type optional bySignature, byAccount
pares optional NotEmptyString
cvv optional string[3-4], only digits
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
merchant_user_id optional string[0-64]
cof_type optional CIT-initial, CIT-subsequent, MIT

SALE fields
transaction_type "SALE"
merchant_account string[6-32]
merchant_password string[6-32]
amount float[0.01 - 9999999]
currency string[3], upper-cased, ISO 4217 alpha-3
transaction_unique_id string[1-45]
card_exp_year string[4], only digits (2 digits accepted as 20YY), not expired
card_exp_month 1-2 digits month number string ['1'..'12'] or ['01'..'12'], not expired
card_holder string[2-32]
card_number string[13-19], only digits
country string[3], only letters, upper-cased, ISO 3166-1 alpha-3 format
first_name string[1-32]
last_name string[1-32]
user_email string[6-255], valid email
user_ip IpAddress
api_version float, > 0
auth_type optional bySignature, byAccount
cvv optional string[3-4], only digits
state optional string[2], upper-cased
city optional string[2-32]
address optional string[2-50]
zip optional string[2-10], only letters, digits, spaces and hyphens
user_phone optional string[7-16], optional '+' followed by 7-15 digits, spaces and hyphens removed
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
mid_reference optional string[16], MidReferenceValidator
date_of_birth optional NotEmptyString, date[Y-m-d]
cof_type optional CIT-initial, CIT-subsequent, MIT
base_reference optional string[20]

SALE by PaRes fields
transaction_type "SALE"
merchant_account string[6-32]
merchant_password string[6-32]
transaction_unique_id string[1-45]
reference string[20]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
api_version float
auth_type optional bySignature, byAccount
pares optional NotEmptyString
cvv optional string[3-4], only digits
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
merchant_user_id optional string[0-64]
cof_type optional CIT-initial, CIT-subsequent, MIT

SALE by token fields
transaction_type "SALE"
merchant_account string[6-32]
merchant_password string[6-32]
token string[36]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
transaction_unique_id string[1-45]
card_holder string[2-64]
country string[2-3], matched with ISO 3166-1 alpha-3 standard
first_name string[1-32]
last_name string[1-32]
user_email string[6-255], valid email
user_ip IpAddress
api_version float
auth_type optional bySignature, byAccount
cvv optional string[3-4], only digits
state optional string[1-32]
city optional string[2-32]
address optional string[2-150]
zip optional string[2-10]
user_phone optional string[7-15]
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
date_of_birth optional NotEmptyString, date[Y-m-d]
mid_reference optional string[16], MidReferenceValidator
cof_type optional CIT-initial, CIT-subsequent, MIT
base_reference optional string[20]

SALE or AUTH by Apple Pay fields
transaction_type "SALE|AUTH"
merchant_account string[6-32]
merchant_password string[6-32]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
transaction_unique_id string[1-45]
card_exp_year string[4], only digits
card_exp_month 2 digits month number string ['01'..'12']
card_holder string[2-64]
card_number string[13-19], only digits, Luhn algorithm
country string[2-3], matched with ISO 3166-1 alpha-3 standard
first_name string[1-32]
last_name string[1-32]
user_email string[6-255], valid email
user_ip IpAddress
api_version float
payment_method ApplePay, GooglePay
card_exp_day optional DayNumberStringValidator
user_phone optional string[7-15]
state optional string[1-32]
city optional string[2-32]
address optional string[2-150]
zip optional string[2-10]
auth_type optional bySignature, byAccount
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
cof_type optional CIT-initial, CIT-subsequent, MIT
mid_reference optional string[16], MidReferenceValidator

SALE by Google Pay fields
transaction_type "SALE"
merchant_account string[6-32]
merchant_password string[6-32]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
transaction_unique_id string[1-45]
card_exp_year string[4], only digits
card_exp_month 2 digits month number string ['01'..'12']
card_holder string[2-64]
card_number string[13-19], only digits, Luhn algorithm
country string[2-3], matched with ISO 3166-1 alpha-3 standard
first_name string[1-32]
last_name string[1-32]
user_email string[6-255], valid email
user_ip IpAddress
api_version float
payment_method ApplePay, GooglePay
card_exp_day optional DayNumberStringValidator
user_phone optional string[7-15]
state optional string[1-32]
city optional string[2-32]
address optional string[2-150]
zip optional string[2-10]
auth_type optional bySignature, byAccount
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
cof_type optional CIT-initial, CIT-subsequent, MIT
mid_reference optional string[16], MidReferenceValidator

SALE3D fields
transaction_type "SALE3D"
merchant_account string[6-32]
merchant_password string[6-32]
amount float[0.01 - 9999999]
currency string[3], upper-cased, ISO 4217 alpha-3
transaction_unique_id string[1-45]
card_exp_year string[4], only digits (2 digits accepted as 20YY), not expired
card_exp_month 1-2 digits month number string ['1'..'12'] or ['01'..'12'], not expired
card_holder string[2-32]
card_number string[13-19], only digits
country string[3], only letters, upper-cased, ISO 3166-1 alpha-3 format
first_name string[1-32]
last_name string[1-32]
user_email string[6-50], valid email
user_ip IpAddress (IPv4 or IPv6), max 39 characters
api_version float, > 0
callback_url NotEmptyString
redirect_url NotEmptyString
recipient_name optional string[1-32]
recipient_last_name optional string[1-32]
recipient_birth_date optional date[Y-m-d]
recipient_city optional string[2-32]
recipient_account_type optional string[2-32]
recipient_account_number optional string[1-255]
recipient_country optional string[3-3], matched with ISO 3166-1 alpha-3 standard
recipient_state optional string[1-32]
recipient_address optional string[2-150]
auth_type optional bySignature, byAccount
cvv optional string[3-4], only digits
state optional string[2], upper-cased
city optional string[2-32]
address optional string[2-50]
zip optional string[2-10], only letters, digits, spaces and hyphens
user_phone optional string[7-16], optional '+' followed by 7-15 digits, spaces and hyphens removed
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[2-16], Genome adds prefix GEN*
descriptor_phone optional string[7-13], only digits, spaces and hyphens removed
mid_reference optional string[16], MidReferenceValidator
date_of_birth optional NotEmptyString, date[Y-m-d]
cof_type optional CIT-initial, CIT-subsequent, MIT
base_reference optional string[20]
dynamic_3d optional true, false
3ds_data: optional object
    threeDSCompInd optional Y, N, U
    threeDSRequestorAuthenticationInd optional 01, 02, 03, 04, 05, 06, 07, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    threeDSRequestorChallengeInd optional 01, 02, 03, 04, 05, 06, 07, 08, 09, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    threeDSRequestorDecMaxTime optional string[1-5], only digits
    threeDSRequestorDecReqInd optional Y, N
    threeDSRequestorURL optional string[1-2048], UrlValidator
    threeRIInd optional 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    acctType optional 01, 02, 03
    acctID optional string[1-64]
    purchaseInstalData optional string[1-3], PositiveDigitsOnlyString
    recurringExpiry optional string[8], date[Ymd]
    recurringFrequency optional string[1-4], only digits
    threeDSReqAuthData optional string[1-20000]
    threeDSReqAuthMethod optional 01, 02, 03, 04, 05, 06, 07, 08
    threeDSReqAuthTimestamp optional string[12], date[YmdHi]
    threeDSReqPriorAuthMethod optional 01, 02, 03, 04
    threeDSReqPriorAuthTimestamp optional string[12], date[YmdHi]
    threeDSReqPriorRef optional string[36]
    chAccAgeInd optional 01, 02, 03, 04, 05
    chAccChange optional string[8], date[Ymd]
    chAccChangeInd optional 01, 02, 03, 04
    chAccDate optional string[8], date[Ymd]
    chAccPwChange optional string[8], date[Ymd]
    chAccPwChangeInd optional 01, 02, 03, 04, 05
    nbPurchaseAccount optional string[1-4], only digits
    paymentAccAge optional string[8], date[Ymd]
    paymentAccInd optional 01, 02, 03, 04, 05
    provisionAttemptsDay optional string[1-3], only digits
    shipAddressUsage optional string[8], date[Ymd]
    shipAddressUsageInd optional 01, 02, 03, 04
    shipNameIndicator optional 01, 02
    suspiciousAccActivity optional 01, 02
    txnActivityDay optional string[1-3], only digits
    txnActivityYear optional string[1-3], only digits
    deliveryEmailAddress optional string[1-254], valid email
    deliveryTimeframe optional 01, 02, 03, 04
    giftCardAmount optional string[1-15]
    giftCardCount optional string[2]
    giftCardCurr optional string[3]
    preOrderDate optional string[8], date[Ymd]
    preOrderPurchaseInd optional 01, 02
    reorderItemsInd optional 01, 02
    shipIndicator optional 01, 02, 03, 04, 05, 06, 07

SALE3D by token fields
transaction_type "SALE3D"
merchant_account string[6-32]
merchant_password string[6-32]
token string[36]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
transaction_unique_id string[1-45]
card_holder string[2-64]
country string[2-3], matched with ISO 3166-1 alpha-3 standard
first_name string[1-32]
last_name string[1-32]
user_email string[6-255], valid email
user_ip IpAddress
api_version float
callback_url NotEmptyString
redirect_url NotEmptyString
recipient_name optional string[1-32]
recipient_last_name optional string[1-32]
recipient_birth_date optional date[Y-m-d]
recipient_city optional string[2-32]
recipient_account_type optional string[2-32]
recipient_account_number optional string[1-255]
recipient_country optional string[3-3], matched with ISO 3166-1 alpha-3 standard
recipient_state optional string[1-32]
recipient_address optional string[2-150]
auth_type optional bySignature, byAccount
cvv optional string[3-4], only digits
state optional string[1-32]
city optional string[2-32]
address optional string[2-150]
zip optional string[2-10]
user_phone optional string[7-15]
merchant_user_id optional string[0-64]
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
date_of_birth optional NotEmptyString, date[Y-m-d]
cof_type optional CIT-initial, CIT-subsequent, MIT
base_reference optional string[20]
3ds_data: optional object
    threeDSCompInd optional Y, N, U
    threeDSRequestorAuthenticationInd optional 01, 02, 03, 04, 05, 06, 07, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    threeDSRequestorChallengeInd optional 01, 02, 03, 04, 05, 06, 07, 08, 09, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    threeDSRequestorDecMaxTime optional string[1-5], only digits
    threeDSRequestorDecReqInd optional Y, N
    threeDSRequestorURL optional string[1-2048], UrlValidator
    threeRIInd optional 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99
    acctType optional 01, 02, 03
    acctID optional string[1-64]
    purchaseInstalData optional string[1-3], PositiveDigitsOnlyString
    recurringExpiry optional string[8], date[Ymd]
    recurringFrequency optional string[1-4], only digits
    threeDSReqAuthData optional string[1-20000]
    threeDSReqAuthMethod optional 01, 02, 03, 04, 05, 06, 07, 08
    threeDSReqAuthTimestamp optional string[12], date[YmdHi]
    threeDSReqPriorAuthMethod optional 01, 02, 03, 04
    threeDSReqPriorAuthTimestamp optional string[12], date[YmdHi]
    threeDSReqPriorRef optional string[36]
    chAccAgeInd optional 01, 02, 03, 04, 05
    chAccChange optional string[8], date[Ymd]
    chAccChangeInd optional 01, 02, 03, 04
    chAccDate optional string[8], date[Ymd]
    chAccPwChange optional string[8], date[Ymd]
    chAccPwChangeInd optional 01, 02, 03, 04, 05
    nbPurchaseAccount optional string[1-4], only digits
    paymentAccAge optional string[8], date[Ymd]
    paymentAccInd optional 01, 02, 03, 04, 05
    provisionAttemptsDay optional string[1-3], only digits
    shipAddressUsage optional string[8], date[Ymd]
    shipAddressUsageInd optional 01, 02, 03, 04
    shipNameIndicator optional 01, 02
    suspiciousAccActivity optional 01, 02
    txnActivityDay optional string[1-3], only digits
    txnActivityYear optional string[1-3], only digits
    deliveryEmailAddress optional string[1-254], valid email
    deliveryTimeframe optional 01, 02, 03, 04
    giftCardAmount optional string[1-15]
    giftCardCount optional string[2]
    giftCardCurr optional string[3]
    preOrderDate optional string[8], date[Ymd]
    preOrderPurchaseInd optional 01, 02
    reorderItemsInd optional 01, 02
    shipIndicator optional 01, 02, 03, 04, 05, 06, 07

SETTLE fields
transaction_type "SETTLE"
merchant_account string[6-32]
merchant_password string[6-32]
transaction_unique_id string[1-45]
reference string[20], last 16 characters hexadecimal
amount float[0.01 - 9999999]
currency string[3], upper-cased, ISO 4217 alpha-3
api_version float, > 0
auth_type optional bySignature, byAccount
merchant_domain_name optional string[0-255]
merchant_affiliate_id optional string[0-255]
merchant_product_name optional string[0-255]
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
merchant_user_id optional string[0-64]

CHECK fields
transaction_type "CHECK"
merchant_account string[6-32]
merchant_password string[6-32]
api_version float, > 0
auth_type optional bySignature, byAccount
reference optional string[20], last 16 characters hexadecimal
transaction_unique_id optional string[1-45]

CARD_HASH fields
transaction_type "CARD_HASH"
api_version float
merchant_account string[6-32]
merchant_password string[6-32]
card_number string[13-19], only digits, Luhn algorithm
auth_type optional bySignature, byAccount

TOKENIZE fields
transaction_type "TOKENIZE"
merchant_account string[6-32]
merchant_password string[6-32]
card_exp_year string[4], only digits
card_exp_month 2 digits month number string ['01'..'12']
card_holder string[2-64]
card_number string[13-19], only digits, Luhn algorithm
api_version float
auth_type optional bySignature, byAccount

VOID fields
transaction_type "VOID"
merchant_account string[6-32]
merchant_password string[6-32]
transaction_unique_id string[1-45]
reference string[20], last 16 characters hexadecimal
api_version float, > 0
auth_type optional bySignature, byAccount
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
merchant_user_id optional string[0-64]

REFUND fields
transaction_type "REFUND"
merchant_account string[6-32]
merchant_password string[6-32]
transaction_unique_id string[1-45]
reference string[20], last 16 characters hexadecimal
amount float[0.01 - 9999999]
currency string[3], upper-cased, ISO 4217 alpha-3
api_version float, > 0
auth_type optional bySignature, byAccount
descriptor_merchant optional string[0-255]
descriptor_phone optional string[0-255]
merchant_user_id optional string[0-64]
base_reference optional string[20]

Status codes list
0 Transaction processed successfully
1 General internal service error
2 Internal DB error
3 General service error
4 Access denied
5 Grouped validation error
10 General internal service communication error
11 Internal timeout
12 Internal SSL error
1000 Merchant gate error
1001 Request format error
1002 [field] not present in request
1003 Internal communication error
1004 Invalid [field] in request message
1005 Unsupported API version
1006 [field] should not be present in request
2000 General MMS error
2001 Incorrect value in merchant account or pass field
2002 Country is not available
2003 Merchant account exists but not active
2004 Transaction is not allowed to account
2005 MID is not active
2006 There is no currency configured for account
2007 Amount is below or above amount restrictions
2008 Access from this IP-address is not available
2009 Merchant is not activated
2010 Gate is not active
2011 Entity already exists
2012 Entity not found
2013 Bad API credentials
3000 General processing error
3001 Transaction ID/Order ID is already used
3002 Token not found or invalid
3003 Reference not found or invalid
3004 It is not possible to void the the provided reference
3005 It is not possible to refund the provided reference
3006 Transaction is chargebacked
3007 Illegal interval between AUTH and SETTLE/VOID, between AUTH 3D and SETTLE/SALE
3008 Transaction was already voided
3009 Transaction was already refunded
3010 Transaction was already settled
3011 MID doesn't support the card type
3012 Account doesn't support 3D secure
3013 Account support only 3D secure transaction
3014 There was no transaction found on your Check request
3015 Bank MID doesn't support the currency
3016 Amount in settle transaction is incorrect
3017 Bank MID access credentials are incorrect
3018 Bank refused the connection
3019 Request cannot be validated
3020 Chargeback is invalid
3021 Transaction is blocked by routing
3022 The amount is incorrect
3023 Transaction is aborted by the customer
3024 Transaction is expired
3134 Transaction is expired
3135 Bank Soft Decline. 3D verification required by issuer
3025 Transaction is completed
3028 Transaction is not matched
3027 Pending MSISDN found
3029 3DS Malformed configuration
3036 Pending by PSP
3100 Transaction declined by bank network
3101 Insufficient funds
3102 Card lost or stolen
3103 3d secure authentication failed
3104 Invalid CVV
3105 Card expired due to expiry date or expiry date is not correct
3106 Bank cannot process selected amount
3107 Invalid card number
3108 It is not possible to issue refund due to bank limit
3109 Timeout between PSP and bank
3110 Not all required data was provided to the specific bank
3111 Access error to a bank acquirer
3112 Card type is not supported by MID
3113 Transaction type is not supported by MID
3114 Currency is not supported by MID
3115 Refund not possible by bank
3116 Country is not supported by MID
3117 Malformed bank response
3118 Connection error between PSP and bank
3119 Referal or restricted card
3120 Risk Bank Decline
3121 Invalid acquirer token
3122 Invalid acquirer reference
3123 Card 3D secure is not enabled
3124 Unknown acquirer processing status
3125 Acquirer internal error
3126 Withdrawal frequency limit exceeded
3127 Bank negative list
3128 Fraud bank decline
3129 Authorization declined
3130 Revocation of authorization order
3131 Repeats not allowed by operator
3132 Recurring is stopped by the customer
3133 Unexpected acquirer behavior
3136 Pending by bank
3140 Transaction declined by issuer
3150 Invalid transaction
3157 Transaction not permitted
3170 Invalid or closed account
3200 Declined by anti-fraud system
3201 Sent for manual review by anti-fraud system
3202 Volume limit exceeded
3203 Refund limit exceeded
3220 Declined by anti-fraud trust lists
3221 Sent for manual review by anti-fraud trust lists
3300 General payout error
3310 Payout validation error
3311 Invalid mid reference
3330 Unregistered card
4000 General reconciliation error
4001 Reconciliation data is not ready
4002 Reconciliation total amount doesn't match
4003 Reconciliation total count doesn't match
4004 General FRS error
4005 Balance is not available
4006 Currency is not available
4007 Exceeded amount
5000 General QoD error
5001 Unsupported QoD API version
5002 Invalid [time] fields order
6000 General internal auth failure
6001 Wrong credentials
6002 Access denied
6003 The user already exists
6004 The user is not found
6005 The role is not found
6006 The permission is not found
6007 The token is expired
6008 The token is not found
6009 The user is temporary blocked
6010 The password is expired
6011 The password is invalid
6012 The password is previously used
6013 Recovery key have been used
6014 Request totp from user
6016 The guest is temporary blocked
7000 Internal payment gate error
7101 Internal payment gate sender error
7102 External communication error
7103 External communication timeout
7201 Encrypt error
8000 General internal stats failure
8001 Date range is too long for selected aggregation interval
8002 Date from could not be greater than to
10000 General card error
10001 Entity already exists

Prev

State and province codes

Next

SEPA Payout API

On this page