Credit Card API

Online realtime API information, based on deployed code

AUTH fields

transaction_type "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
auth_typeoptionalbySignature, byAccount
cvvoptionalstring[3-4], only digits
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
user_phoneoptionalstring[7-15]
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
mid_referenceoptionalstring[16], MidReferenceValidator
date_of_birthoptionalNotEmptyString, date[`Y-m-d`]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
base_referenceoptionalstring[20]
partial_approvaloptionaltrue, false

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 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_typeoptionalbySignature, byAccount
cvvoptionalstring[3-4], only digits
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
user_phoneoptionalstring[7-15]
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
mid_referenceoptionalstring[16], MidReferenceValidator
date_of_birthoptionalNotEmptyString, date[`Y-m-d`]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
base_referenceoptionalstring[20]
partial_approvaloptionaltrue, false

AUTH3D fields

transaction_type "AUTH3D"
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
callback_url NotEmptyString
redirect_url NotEmptyString
recipient_nameoptionalstring[1-32]
recipient_last_nameoptionalstring[1-32]
recipient_birth_dateoptionaldate[`Y-m-d`]
recipient_cityoptionalstring[2-32]
recipient_account_typeoptionalstring[2-32]
recipient_account_numberoptionalstring[1-255]
recipient_countryoptionalstring[3-3], matched with ISO 3166-1 alpha-3 standard
recipient_stateoptionalstring[1-32]
recipient_addressoptionalstring[2-150]
auth_typeoptionalbySignature, byAccount
cvvoptionalstring[3-4], only digits
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
user_phoneoptionalstring[7-15]
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
mid_referenceoptionalstring[16], MidReferenceValidator
date_of_birthoptionalNotEmptyString, date[`Y-m-d`]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
base_referenceoptionalstring[20]
partial_approvaloptionaltrue, false
3ds_data:optionalobject
        threeDSCompIndoptionalY, N, U
        threeDSRequestorAuthenticationIndoptional01, 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
        threeDSRequestorChallengeIndoptional01, 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
        threeDSRequestorDecMaxTimeoptionalstring[1-5], only digits
        threeDSRequestorDecReqIndoptionalY, N
        threeDSRequestorURLoptionalstring[1-2048], UrlValidator
        threeRIIndoptional01, 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
        acctTypeoptional01, 02, 03
        acctIDoptionalstring[1-64]
        purchaseInstalDataoptionalstring[1-3], PositiveDigitsOnlyString
        recurringExpiryoptionalstring[8], date[`Ymd`]
        recurringFrequencyoptionalstring[1-4], only digits
        threeDSReqAuthDataoptionalstring[1-20000]
        threeDSReqAuthMethodoptional01, 02, 03, 04, 05, 06, 07, 08
        threeDSReqAuthTimestampoptionalstring[12], date[`YmdHi`]
        threeDSReqPriorAuthMethodoptional01, 02, 03, 04
        threeDSReqPriorAuthTimestampoptionalstring[12], date[`YmdHi`]
        threeDSReqPriorRefoptionalstring[36]
        chAccAgeIndoptional01, 02, 03, 04, 05
        chAccChangeoptionalstring[8], date[`Ymd`]
        chAccChangeIndoptional01, 02, 03, 04
        chAccDateoptionalstring[8], date[`Ymd`]
        chAccPwChangeoptionalstring[8], date[`Ymd`]
        chAccPwChangeIndoptional01, 02, 03, 04, 05
        nbPurchaseAccountoptionalstring[1-4], only digits
        paymentAccAgeoptionalstring[8], date[`Ymd`]
        paymentAccIndoptional01, 02, 03, 04, 05
        provisionAttemptsDayoptionalstring[1-3], only digits
        shipAddressUsageoptionalstring[8], date[`Ymd`]
        shipAddressUsageIndoptional01, 02, 03, 04
        shipNameIndicatoroptional01, 02
        suspiciousAccActivityoptional01, 02
        txnActivityDayoptionalstring[1-3], only digits
        txnActivityYearoptionalstring[1-3], only digits
        deliveryEmailAddressoptionalstring[1-254], valid email
        deliveryTimeframeoptional01, 02, 03, 04
        giftCardAmountoptionalstring[1-15]
        giftCardCountoptionalstring[2]
        giftCardCurroptionalstring[3]
        preOrderDateoptionalstring[8], date[`Ymd`]
        preOrderPurchaseIndoptional01, 02
        reorderItemsIndoptional01, 02
        shipIndicatoroptional01, 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_nameoptionalstring[1-32]
recipient_last_nameoptionalstring[1-32]
recipient_birth_dateoptionaldate[`Y-m-d`]
recipient_cityoptionalstring[2-32]
recipient_account_typeoptionalstring[2-32]
recipient_account_numberoptionalstring[1-255]
recipient_countryoptionalstring[3-3], matched with ISO 3166-1 alpha-3 standard
recipient_stateoptionalstring[1-32]
recipient_addressoptionalstring[2-150]
callback_urloptionalNotEmptyString
redirect_urloptionalNotEmptyString
auth_typeoptionalbySignature, byAccount
cvvoptionalstring[3-4], only digits
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
user_phoneoptionalstring[7-15]
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
date_of_birthoptionalNotEmptyString, date[`Y-m-d`]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
base_referenceoptionalstring[20]
partial_approvaloptionaltrue, false
3ds_data:optionalobject
        threeDSCompIndoptionalY, N, U
        threeDSRequestorAuthenticationIndoptional01, 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
        threeDSRequestorChallengeIndoptional01, 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
        threeDSRequestorDecMaxTimeoptionalstring[1-5], only digits
        threeDSRequestorDecReqIndoptionalY, N
        threeDSRequestorURLoptionalstring[1-2048], UrlValidator
        threeRIIndoptional01, 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
        acctTypeoptional01, 02, 03
        acctIDoptionalstring[1-64]
        purchaseInstalDataoptionalstring[1-3], PositiveDigitsOnlyString
        recurringExpiryoptionalstring[8], date[`Ymd`]
        recurringFrequencyoptionalstring[1-4], only digits
        threeDSReqAuthDataoptionalstring[1-20000]
        threeDSReqAuthMethodoptional01, 02, 03, 04, 05, 06, 07, 08
        threeDSReqAuthTimestampoptionalstring[12], date[`YmdHi`]
        threeDSReqPriorAuthMethodoptional01, 02, 03, 04
        threeDSReqPriorAuthTimestampoptionalstring[12], date[`YmdHi`]
        threeDSReqPriorRefoptionalstring[36]
        chAccAgeIndoptional01, 02, 03, 04, 05
        chAccChangeoptionalstring[8], date[`Ymd`]
        chAccChangeIndoptional01, 02, 03, 04
        chAccDateoptionalstring[8], date[`Ymd`]
        chAccPwChangeoptionalstring[8], date[`Ymd`]
        chAccPwChangeIndoptional01, 02, 03, 04, 05
        nbPurchaseAccountoptionalstring[1-4], only digits
        paymentAccAgeoptionalstring[8], date[`Ymd`]
        paymentAccIndoptional01, 02, 03, 04, 05
        provisionAttemptsDayoptionalstring[1-3], only digits
        shipAddressUsageoptionalstring[8], date[`Ymd`]
        shipAddressUsageIndoptional01, 02, 03, 04
        shipNameIndicatoroptional01, 02
        suspiciousAccActivityoptional01, 02
        txnActivityDayoptionalstring[1-3], only digits
        txnActivityYearoptionalstring[1-3], only digits
        deliveryEmailAddressoptionalstring[1-254], valid email
        deliveryTimeframeoptional01, 02, 03, 04
        giftCardAmountoptionalstring[1-15]
        giftCardCountoptionalstring[2]
        giftCardCurroptionalstring[3]
        preOrderDateoptionalstring[8], date[`Ymd`]
        preOrderPurchaseIndoptional01, 02
        reorderItemsIndoptional01, 02
        shipIndicatoroptional01, 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_typeoptionalbySignature, byAccount
paresoptionalNotEmptyString
cvvoptionalstring[3-4], only digits
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
merchant_user_idoptionalstring[0-64]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
partial_approvaloptionaltrue, false

SALE 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
auth_typeoptionalbySignature, byAccount
cvvoptionalstring[3-4], only digits
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
user_phoneoptionalstring[7-15]
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
mid_referenceoptionalstring[16], MidReferenceValidator
date_of_birthoptionalNotEmptyString, date[`Y-m-d`]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
base_referenceoptionalstring[20]
partial_approvaloptionaltrue, false

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_typeoptionalbySignature, byAccount
paresoptionalNotEmptyString
cvvoptionalstring[3-4], only digits
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
merchant_user_idoptionalstring[0-64]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
partial_approvaloptionaltrue, false

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_typeoptionalbySignature, byAccount
cvvoptionalstring[3-4], only digits
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
user_phoneoptionalstring[7-15]
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
date_of_birthoptionalNotEmptyString, date[`Y-m-d`]
mid_referenceoptionalstring[16], MidReferenceValidator
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
base_referenceoptionalstring[20]
partial_approvaloptionaltrue, false

SALE or AUTH by ApplePay 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_dayoptionalDayNumberStringValidator
user_phoneoptionalstring[7-15]
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
auth_typeoptionalbySignature, byAccount
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
partial_approvaloptionaltrue, false

SALE by GooglePay 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_dayoptionalDayNumberStringValidator
user_phoneoptionalstring[7-15]
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
auth_typeoptionalbySignature, byAccount
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
partial_approvaloptionaltrue, false

SALE3D fields

transaction_type "SALE3D"
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
callback_url NotEmptyString
redirect_url NotEmptyString
recipient_nameoptionalstring[1-32]
recipient_last_nameoptionalstring[1-32]
recipient_birth_dateoptionaldate[`Y-m-d`]
recipient_cityoptionalstring[2-32]
recipient_account_typeoptionalstring[2-32]
recipient_account_numberoptionalstring[1-255]
recipient_countryoptionalstring[3-3], matched with ISO 3166-1 alpha-3 standard
recipient_stateoptionalstring[1-32]
recipient_addressoptionalstring[2-150]
auth_typeoptionalbySignature, byAccount
cvvoptionalstring[3-4], only digits
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
user_phoneoptionalstring[7-15]
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
mid_referenceoptionalstring[16], MidReferenceValidator
date_of_birthoptionalNotEmptyString, date[`Y-m-d`]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
base_referenceoptionalstring[20]
dynamic_3doptionaltrue, false
partial_approvaloptionaltrue, false
3ds_data:optionalobject
        threeDSCompIndoptionalY, N, U
        threeDSRequestorAuthenticationIndoptional01, 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
        threeDSRequestorChallengeIndoptional01, 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
        threeDSRequestorDecMaxTimeoptionalstring[1-5], only digits
        threeDSRequestorDecReqIndoptionalY, N
        threeDSRequestorURLoptionalstring[1-2048], UrlValidator
        threeRIIndoptional01, 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
        acctTypeoptional01, 02, 03
        acctIDoptionalstring[1-64]
        purchaseInstalDataoptionalstring[1-3], PositiveDigitsOnlyString
        recurringExpiryoptionalstring[8], date[`Ymd`]
        recurringFrequencyoptionalstring[1-4], only digits
        threeDSReqAuthDataoptionalstring[1-20000]
        threeDSReqAuthMethodoptional01, 02, 03, 04, 05, 06, 07, 08
        threeDSReqAuthTimestampoptionalstring[12], date[`YmdHi`]
        threeDSReqPriorAuthMethodoptional01, 02, 03, 04
        threeDSReqPriorAuthTimestampoptionalstring[12], date[`YmdHi`]
        threeDSReqPriorRefoptionalstring[36]
        chAccAgeIndoptional01, 02, 03, 04, 05
        chAccChangeoptionalstring[8], date[`Ymd`]
        chAccChangeIndoptional01, 02, 03, 04
        chAccDateoptionalstring[8], date[`Ymd`]
        chAccPwChangeoptionalstring[8], date[`Ymd`]
        chAccPwChangeIndoptional01, 02, 03, 04, 05
        nbPurchaseAccountoptionalstring[1-4], only digits
        paymentAccAgeoptionalstring[8], date[`Ymd`]
        paymentAccIndoptional01, 02, 03, 04, 05
        provisionAttemptsDayoptionalstring[1-3], only digits
        shipAddressUsageoptionalstring[8], date[`Ymd`]
        shipAddressUsageIndoptional01, 02, 03, 04
        shipNameIndicatoroptional01, 02
        suspiciousAccActivityoptional01, 02
        txnActivityDayoptionalstring[1-3], only digits
        txnActivityYearoptionalstring[1-3], only digits
        deliveryEmailAddressoptionalstring[1-254], valid email
        deliveryTimeframeoptional01, 02, 03, 04
        giftCardAmountoptionalstring[1-15]
        giftCardCountoptionalstring[2]
        giftCardCurroptionalstring[3]
        preOrderDateoptionalstring[8], date[`Ymd`]
        preOrderPurchaseIndoptional01, 02
        reorderItemsIndoptional01, 02
        shipIndicatoroptional01, 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_nameoptionalstring[1-32]
recipient_last_nameoptionalstring[1-32]
recipient_birth_dateoptionaldate[`Y-m-d`]
recipient_cityoptionalstring[2-32]
recipient_account_typeoptionalstring[2-32]
recipient_account_numberoptionalstring[1-255]
recipient_countryoptionalstring[3-3], matched with ISO 3166-1 alpha-3 standard
recipient_stateoptionalstring[1-32]
recipient_addressoptionalstring[2-150]
auth_typeoptionalbySignature, byAccount
cvvoptionalstring[3-4], only digits
stateoptionalstring[1-32]
cityoptionalstring[2-32]
addressoptionalstring[2-150]
zipoptionalstring[2-10]
user_phoneoptionalstring[7-15]
merchant_user_idoptionalstring[0-64]
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
date_of_birthoptionalNotEmptyString, date[`Y-m-d`]
cof_typeoptionalCIT-initial, CIT-subsequent, MIT
base_referenceoptionalstring[20]
partial_approvaloptionaltrue, false
3ds_data:optionalobject
        threeDSCompIndoptionalY, N, U
        threeDSRequestorAuthenticationIndoptional01, 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
        threeDSRequestorChallengeIndoptional01, 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
        threeDSRequestorDecMaxTimeoptionalstring[1-5], only digits
        threeDSRequestorDecReqIndoptionalY, N
        threeDSRequestorURLoptionalstring[1-2048], UrlValidator
        threeRIIndoptional01, 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
        acctTypeoptional01, 02, 03
        acctIDoptionalstring[1-64]
        purchaseInstalDataoptionalstring[1-3], PositiveDigitsOnlyString
        recurringExpiryoptionalstring[8], date[`Ymd`]
        recurringFrequencyoptionalstring[1-4], only digits
        threeDSReqAuthDataoptionalstring[1-20000]
        threeDSReqAuthMethodoptional01, 02, 03, 04, 05, 06, 07, 08
        threeDSReqAuthTimestampoptionalstring[12], date[`YmdHi`]
        threeDSReqPriorAuthMethodoptional01, 02, 03, 04
        threeDSReqPriorAuthTimestampoptionalstring[12], date[`YmdHi`]
        threeDSReqPriorRefoptionalstring[36]
        chAccAgeIndoptional01, 02, 03, 04, 05
        chAccChangeoptionalstring[8], date[`Ymd`]
        chAccChangeIndoptional01, 02, 03, 04
        chAccDateoptionalstring[8], date[`Ymd`]
        chAccPwChangeoptionalstring[8], date[`Ymd`]
        chAccPwChangeIndoptional01, 02, 03, 04, 05
        nbPurchaseAccountoptionalstring[1-4], only digits
        paymentAccAgeoptionalstring[8], date[`Ymd`]
        paymentAccIndoptional01, 02, 03, 04, 05
        provisionAttemptsDayoptionalstring[1-3], only digits
        shipAddressUsageoptionalstring[8], date[`Ymd`]
        shipAddressUsageIndoptional01, 02, 03, 04
        shipNameIndicatoroptional01, 02
        suspiciousAccActivityoptional01, 02
        txnActivityDayoptionalstring[1-3], only digits
        txnActivityYearoptionalstring[1-3], only digits
        deliveryEmailAddressoptionalstring[1-254], valid email
        deliveryTimeframeoptional01, 02, 03, 04
        giftCardAmountoptionalstring[1-15]
        giftCardCountoptionalstring[2]
        giftCardCurroptionalstring[3]
        preOrderDateoptionalstring[8], date[`Ymd`]
        preOrderPurchaseIndoptional01, 02
        reorderItemsIndoptional01, 02
        shipIndicatoroptional01, 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]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
api_version float
auth_typeoptionalbySignature, byAccount
merchant_domain_nameoptionalstring[0-255]
merchant_affiliate_idoptionalstring[0-255]
merchant_product_nameoptionalstring[0-255]
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
merchant_user_idoptionalstring[0-64]

CHECK fields

transaction_type "CHECK"
merchant_account string[6-32]
merchant_password string[6-32]
api_version float
auth_typeoptionalbySignature, byAccount
referenceoptionalstring[20]
transaction_unique_idoptionalstring[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_typeoptionalbySignature, 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_typeoptionalbySignature, 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]
api_version float
auth_typeoptionalbySignature, byAccount
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
merchant_user_idoptionalstring[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]
amount float[0 - 9999999.9999], FractionalPartLengthValidator
currency string[3]
api_version float
auth_typeoptionalbySignature, byAccount
descriptor_merchantoptionalstring[0-255]
descriptor_phoneoptionalstring[0-255]
merchant_user_idoptionalstring[0-64]
base_referenceoptionalstring[20]

Status codes list

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