Introduction

Security

Please make sure to read the appendix Security before proceeding to use this API.

Version

To see the current version and details of recent changes, please see the Changelog.

Tribe reserves the right to append Conditional 'C' and/or Optional 'O' fields without prior notice. The client's system/application should be prepared to accept the appended fields. All such changes will be Backward Compatible and shouldn't change the application logic.

All Backward Incompatible changes (related to the mandatory 'M' field) will be introduced ONLY with a new PM API version release.

Actions

Account

Create

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
  "access_key": "%YOUR_ACCESS_KEY%",
  "access_api_id": "%YOUR_API_ID%",
  "access_api_key": "%YOUR_ACCESS_API_KEY%",
  "action": "createAccount",
  "api_version": "1.2",
  "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
  "currency_ison": "840",
  "account_status": "A",
  "access_level": 0,
  "program_id": 1,
  "fee_group_id": 1,
  "cards": [],
  "limit_group_id": 6,
  "skip_holder_validation": 0,
  "holder_id": 1,
  "holder_access_level": 0,
  "holder_title": "Mr",
  "holder_first_name": "John",
  "holder_last_name": "Smith",
  "holder_address_line_1": "Bridge St",
  "holder_address_line_2": "London",
  "holder_address_line_3": "United Kingdom",
  "holder_address_line_4": "Europe",
  "holder_country_ison": "440",
  "holder_zipcode": "12345",
  "holder_city": "City",
  "holder_state": "State",
  "holder_phone_number": "142544544",
  "holder_email": "email@email.com",
  "holder_date_of_birth": "1989-10-10",
  "holder_ip_address": "8.8.8.8",
  "holder_limit_group_id": 10,
  "holder_industry_id": null,
  "holder_date_of_company_incorporation": null,
  "holder_locale": "en_US",
  "kyc_completion_level": 0,
  "kyc_document_expiration_date": "2019-05-26"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed createAccount.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
currency_ison M N 3 Account currency ison.
account_status M A 1 Account status
access_level O N 0-1000 If not provided, the default value will be set by the program.
program_id M N 1-20 Program ID
risk_rules_group_id O N 1-20 If not provided, the risk rule group ID will be set by the program.
fee_group_id O N 1-20 If not provided, the fee group ID will be set by the program.
cards O EXT-LIST - A list of cards IDs
limit_group_id O N 1-20 If not provided, the fee group ID will be set by the program.
skip_holder_validation M [0,1] 1 If the value is 0 - Card and Holder validation will be performed. If the value is 1, any Card can be assigned to the Holder.
holder_id O N 1-20 If not provided a new holder will be registered, otherwise an existing holder will be assigned.
holder_title O ANS 1-7 Optional if holder_id isn’t provided.
holder_type O N 1 0 - personal, 1 - business. Default value: 0
holder_access_level O N 0-1000 If not provided the default value will be set by the program.
holder_business_name C ANS 1-50 Mandatory if holder_type = 1
holder_first_name C AS 1-50 Mandatory if holder_id isn’t provided. Allowed symbols are combined of 2 from Default charsets and Holder additional charset field which can be selected on the program
holder_last_name C AS 1-50 Mandatory if holder_id isn’t provided. Allowed symbols are combined of 2 from Default charsets and Holder additional charset field which can be selected on the program
holder_address_line_1 C ANS 1-100 Mandatory if holder_id isn’t provided. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
holder_address_line_2 O ANS 1-100 Optional if holder_id isn’t provided. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
holder_address_line_3 O ANS 1-100 Optional if holder_id isn’t provided. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
holder_address_line_4 O ANS 1-100 Optional if holder_id isn’t provided. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
holder_country_ison C N 3 Mandatory if holder_id isn’t provided.
holder_zipcode C ANS 1-9 Mandatory if holder_id isn’t provided.
holder_city C ANS 1-50 Mandatory if holder_id isn’t provided. Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
holder_state O ANS 1-50 Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
holder_phone_number C N 6-15 Mandatory if holder_id isn’t provided.
holder_email O ANS 6-100 Optional if holder_id isn’t provided.
holder_date_of_birth O ANS 10 Optional if holder_id isn’t provided.
holder_ip_address O ANS 7-15 Optional if holder_id isn’t provided.
holder_limit_group_id O N 1-20 If not provided, the default limit group id will be set by the program. Note: if the program does not have a holder limit group it will not be set.
holder_industry_id O N 4 Industry ID
holder_date_of_company_incorporation O ANS 10 Format: Y-m-d, example: 2020-06-24.
holder_locale O AS 1-15 Language code identifiers
kyc_completion_level O N 1 Optional if holder_id isn’t provided.
kyc_document_expiration_date O ANS 10 Optional if holder_id isn’t provided.
{
  "access_key": "%YOUR_ACCESS_KEY%",
  "access_api_id": "%YOUR_API_ID%",
  "access_api_key": "%YOUR_ACCESS_API_KEY%",
  "action": "createAccount",
  "api_version": "1.2",
  "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
  "currency_ison": "840",
  "account_status": "A",
  "access_level": 0,
  "program_id": 1,
  "fee_group_id": 1,
  "cards": [],
  "limit_group_id": 6,
  "skip_holder_validation": 0,
  "holder_id": 1,
  "holder_access_level": 0,
  "holder_title": "Mr",
  "holder_first_name": "John",
  "holder_last_name": "Smith",
  "holder_address_line_1": "Bridge St",
  "holder_address_line_2": "London",
  "holder_address_line_3": "United Kingdom",
  "holder_address_line_4": "Europe",
  "holder_country_ison": "440",
  "holder_zipcode": "12345",
  "holder_city": "City",
  "holder_state": "State",
  "holder_phone_number": "142544544",
  "holder_email": "email@email.com",
  "holder_date_of_birth": "1989-10-10",
  "holder_ip_address": "8.8.8.8",
  "holder_limit_group_id": 10,
  "holder_industry_id": null,
  "holder_date_of_company_incorporation": null,
  "holder_locale": "en_US",
  "kyc_completion_level": 0,
  "kyc_document_expiration_date": "2019-05-26"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has been finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success.
data / id M N Account id.
data / holder_id M N Account owner id.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
  "status": "success",
  "data": {
    "id": 223,
    "holder_id": 200
  },
  "duplicated": 0 
}

Change status

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeAccountStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 206,
    "account_status": "R",
    "reason_code": 3,
    "note": "Customer decision"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed changeAccountStatus.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
account_id M N 1-20
account_status M S 1 Account status
reason_code O N 1-20 Status change reason code
note O ANS 1-255 A short description which explains why account status has been changed.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeAccountStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 206,
    "account_status": "R",
    "reason_code": 3,
    "note": "Customer decision"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Change program

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
  "access_key": "%YOUR_ACCESS_KEY%",
  "access_api_id": "%YOUR_API_ID%",
  "access_api_key": "%YOUR_ACCESS_API_KEY%",
  "action": "changeAccountProgramId",
  "api_version": "1.2",
  "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
  "account_id": 206,
  "account_program_id": 503
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed changeAccountProgramId.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
account_id M N 1-20
account_program_id M N 1-20 Should be the new Program ID and must be a valid account program assigned to the Programme Manager
{
  "access_key": "%YOUR_ACCESS_KEY%",
  "access_api_id": "%YOUR_API_ID%",
  "access_api_key": "%YOUR_ACCESS_API_KEY%",
  "action": "changeAccountProgramId",
  "api_version": "1.2",
  "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
  "account_id": 206,
  "account_program_id": 503
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "duplicated": 0,
    "data": []
}

Get

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getAccounts",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getAccounts.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used. Access level can impact the returned list size.
card_id C N 1-20 Required if account ID is empty
account_id C N 1-20 Required if card ID is empty
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getAccounts",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success.
data / id M N Account id.
data / holder_id M N Account owner id.
data / currency_ison M N Account currency ison.
data / available_balance M N Available card balance.
data / settled_balance M N Settled card balance.
data / reserved_balance M N Reserved balance. Funds suspended by the processor until the dispute is resolved.
data / account_status M A Account status. Account status
data / status_change_reason_code O N Status change reason code
data / status_change_note O ANS
data / date_updated M N Unix timestamp of last account activity.
data / program_id M N Program id.
data / limit_group_id M N Limit group id or null if group is not set.
data / fee_group_id M N Fee group id.
data / risk_group_id M N Risk group id.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "id": 206,
            "holder_id": 206,
            "currency_ison": "826",
            "available_balance": 500,
            "settled_balance": 500,
            "reserved_balance": 0,
            "account_status": "A",
            "status_change_reason_code": null,
            "status_change_note": null,
            "date_updated": 1547649491,
            "program_id": 1,
            "fee_group_id": 1,
            "limit_group_id": 1
        }
    ],
    "duplicated": 0
}

Assign to risk rule group

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignAccountToRiskRuleGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 206,
    "risk_rule_group_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed assignAccountToRiskRuleGroup.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
account_id M N 1-20
risk_rule_group_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignAccountToRiskRuleGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 206,
    "risk_rule_group_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "duplicated": 0,
    "data": []
}

Assign to limit rule group

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignAccountToLimitRuleGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 206,
    "limit_group_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed assignAccountToLimitRuleGroup.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
account_id M N 1-20
limit_group_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignAccountToLimitRuleGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 206,
    "limit_group_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "duplicated": 0,
    "data": []
}

Assign to fee rule group

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignAccountToFeeRuleGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 206,
    "fee_group_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed assignAccountToFeeRuleGroup.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
account_id M N 1-20
fee_group_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignAccountToFeeRuleGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 206,
    "fee_group_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "duplicated": 0,
    "data": []
}

Card

Activate

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "activateCard",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "card_pan": "5500010020001056",
    "card_cvc2": "075",
    "card_expiration_year": "2021",
    "card_expiration_month": "09"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed activateCard.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N 1-20
card_request_id O N 1-20 If present, it will be validated.
card_pan O N 16-19 If present, it will be validated.
card_cvc2 O N 3 If present, it will be validated.
card_expiration_year O N 4 If present, it will be validated.
card_expiration_month O N 2 If present, it will be validated.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "activateCard",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "card_pan": "5500010020001056",
    "card_cvc2": "075",
    "card_expiration_year": "2021",
    "card_expiration_month": "09"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Assign to fee group

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignCardToFeesGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "fees_group_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed assignCardToFeesGroup.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N 1-20
fees_group_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignCardToFeesGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "fees_group_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Assign to limit group

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignCardToLimitsGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "limits_group_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed assignCardToLimitsGroup.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N 1-20
limits_group_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignCardToLimitsGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "limits_group_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Assign to usage group

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignCardToUsageGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "usages_group_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed assignCardToUsageGroup.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N 1-20
usages_group_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignCardToUsageGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "usages_group_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Assign to risk rule group

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignCardToRiskRuleGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "risk_rules_group_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed assignCardToRiskRuleGroup.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N 1-20
risk_rules_group_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignCardToRiskRuleGroup",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "risk_rules_group_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Change scheme account updates status

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeCardSchemeAccountUpdatesStatus",
    "api_version": "1.2",
    "card_id": 123528,
    "participating": 0
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed. changeCardSchemeAccountUpdatesStatus.
api_version M NS Fixed. 1.2.
card_id M N 1-20
participating M [0,1] 1 1 if participating in the 'Scheme Account Updates' service, else 0
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeCardSchemeAccountUpdatesStatus",
    "api_version": "1.2",
    "card_id": 123528,
    "participating": 0
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Change status

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeCardStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "status": "T",
    "reason_code": 13,
    "note": "Card has been suspended"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed. changeCardStatus.
api_version M NS Fixed. 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N 1-20
status M A 1 Card Status Note: Card status can be changed only if card was activated by calling ActivateCard method.
Blocked card status "B" is final and can't be undone.
reason_code O N 1-20 Status change reason code
note O ANS 1-255 A short description which explains why card status has been changed.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeCardStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "status": "T",
    "reason_code": 13,
    "note": "Card has been suspended"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Create

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "createCard",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_program_id": 1,
    "card_currency_ison": "840",
    "card_country_ison": "826",
    "card_virtual": 0,
    "card_reference_id": "123456",
    "card_name_line_3": "John Smith",
    "card_name_line_4": null,
    "card_product_id": 1,
    "card_fee_group_id": 1,
    "card_limit_group_id": 1,
    "account_limit_group_id": 8,
    "holder_limit_group_id": 14,
    "card_usage_group_id": 1,
    "card_design_id": 1,
    "card_pin": "5522",
    "holder_access_level": 0,
    "holder_title": "Mr",
    "holder_first_name": "John",
    "holder_last_name": "Smith",
    "holder_address_line_1": "Bridge St",
    "holder_country_ison": "826",
    "holder_zipcode": "SW1A 2PW",
    "holder_city": "Westminster",
    "holder_state": "London",
    "holder_phone_number": "142544544",
    "holder_email": "email@email.com",
    "holder_date_of_birth": "1989-10-10",
    "holder_ip_address": "8.8.8.8",
    "holder_industry_id": null,
    "holder_date_of_company_incorporation": null,
    "holder_locale": "en_US",
    "delivery_title": "Mr",
    "delivery_first_name": "John",
    "delivery_last_name": "Smith",
    "delivery_address_line_1": "Bridge St",
    "delivery_country_ison": "826",
    "delivery_zipcode": "SW1A 2PW",
    "delivery_city": "Westminster",
    "delivery_state": "London",
    "order_shipping_method": 1,
    "order_delivery_code": "14",
    "order_language": "ENG",
    "bulk_address_line_1": "Bridge St",
    "bulk_country_ison": "826",
    "bulk_zipcode": "SW1A 2PW",
    "bulk_city": "Westminster",
    "bulk_state": "London",
    "kyc_completion_level": 0,
    "kyc_document_expiration_date": "2019-06-05",
    "risk_rules_group_id": 1,
    "acs_password": "0rF0Bh",
    "auto_conversion": 0,
    "access_level": 0
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed createCard.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_program_id M N
card_currency_ison O EXT-LIST 3 If not provided, the currency ison will be set by program’s default currency. If LIST is provided, an account for each currency will be created and assigned to the card. First currency from the LIST will be marked as default currency for the card.
Note: if account_id provided, card_currency_ison must be empty.
card_country_ison M N 3
card_virtual M [0,1] 0 - physical, 1 - virtual.
card_reference_id O AN 1-50 Reference ID in the client’s system.
card_name_line_3 M ANS 3-26 Card emboss name line 1. Allowed symbols are combined of 1 from Default charsets and Emboss additional charset field which can be selected on the program
card_name_line_4 O ANS 3-50 Card emboss name line 2. Allowed symbols are combined of 4 from Default charsets and Emboss additional charset field which can be selected on the program
track_data_first_name O ANS 1-26 Used to override default card chip name generation. Chip name is combined with track_data_last_name. Combined length cannot exceed 26 characters. Charset 1 used from Default charsets |
track_data_last_name O ANS 1-26 Used to override default card chip name generation. Chip name is combined with track_data_first_name. Combined length cannot exceed 26 characters Charset 1 used from Default charsets
card_product_id O N 1-20 If not provided, the default card product id will be set by the program.
card_fee_group_id O N 1-20 If not provided, the default fee group id will be set by the program.
card_limit_group_id O N 1-20 If not provided, the default limit group id will be set by the program.
card_validity_period O N 1-300 If not provided, the default validity period (months) will be set by the program.
account_limit_group_id O N 1-20 If not provided, the default limit group id will be set by the program. Note: if the program does not have an account limit group, it will not be set.
holder_limit_group_id O N 1-20 If not provided, the default limit group id will be set by the program. Note: if the program does not have a holder limit group, it will not be set.
card_usage_group_id O N 1-20 If not provided, the default card usage group id will be set by the program.
card_design_id O N 1-20 If not provided, the default card design id will be set by the program.
card_pin O N 4 Provided value cannot be all the same or sequential digits. If not provided, a random PIN will be generated.
account_id O EXT-LIST 1-20 If not provided, new account(-s) will be created for provided currency(-ies), overwise, the card will be assigned to the account(-s).
Note: if card_currency_ison is provided, then account_id must be empty.
account_owner_id C EXT-LIST 1-20 Holder id(-s) of the account(-s) provided in the account_id field. Mandatory if account_id is provided. If account_id is a LIST, then a LIST of the account owners for each account should be provided while maintaining the same order.
card_thermal_line_1 O ANS 1-50 Text for thermal line1.
card_thermal_line_2 O ANS 1-50 Text for thermal line2.
holder_id O N 1-20 If not provided, a new holder will be registered, otherwise an existing holder will be assigned.
holder_title O ANS 1-7 Optional if holder_id isn’t provided.
holder_type O N 1 0 - personal, 1 - business. Default value: 0
holder_access_level O N 0-1000 If not provided, the default value will be set by the program.
holder_business_name C ANS 1-50 Mandatory if holder_type = 1
holder_first_name C AS 1-50 Mandatory if holder_id isn’t provided. Allowed symbols are combined of 2 from Default charsets and Holder additional charset field which can be selected on the program
holder_last_name C AS 1-50 Mandatory if holder_id isn’t provided. Allowed symbols are combined of 2 from Default charsets and Holder additional charset field which can be selected on the program
holder_address_line_1 C ANS 1-100 Mandatory if holder_id isn’t provided. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
holder_address_line_2 O ANS 1-100 Optional if holder_id isn’t provided. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
holder_address_line_3 O ANS 1-100 Optional if holder_id isn’t provided. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
holder_address_line_4 O ANS 1-100 Optional if holder_id isn’t provided. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
holder_country_ison C N 3 Mandatory if holder_id isn’t provided.
holder_zipcode C ANS 1-9 Mandatory if holder_id isn’t provided.
holder_city C ANS 1-50 Mandatory if holder_id isn’t provided. Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
holder_state O ANS 1-50 Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
holder_phone_number C N 6-15 Mandatory if holder_id isn’t provided.
holder_email O ANS 6-100 Optional if holder_id isn’t provided.
holder_date_of_birth O ANS 10 Optional if holder_id isn’t provided.
holder_ip_address O ANS 7-15 Optional if holder_id isn’t provided.
holder_industry_id O N 4 Industry ID
holder_date_of_company_incorporation O ANS 10 Format: Y-m-d, example: 2020-06-24.
holder_locale O AS 1-15 Language code identifiers
delivery_title O ANS 1-7 Ignored for virtual cards.
delivery_first_name C AS 1-50 Mandatory for a physical card order. Allowed symbols are combined of 2 from Default charsets and Address additional charset field which can be selected on the program
delivery_last_name C AS 1-50 Mandatory for a physical card order. Allowed symbols are combined of 2 from Default charsets and Address additional charset field which can be selected on the program
delivery_address_line_1 C ANS 1-100 Mandatory for a physical card order. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
delivery_address_line_2 O ANS 1-100 Ignored for virtual cards. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
delivery_address_line_3 O ANS 1-100 Ignored for virtual cards. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
delivery_address_line_4 O ANS 1-100 Ignored for virtual cards. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
delivery_country_ison C N 3 Mandatory for a physical card order.
delivery_zipcode C ANS 1-9 Mandatory for a physical card order.
delivery_city C ANS 1-50 Mandatory for a physical card order. Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
delivery_state O ANS 1-50 Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
order_shipping_method C N 1-20 Shipping method id. Mandatory for a physical card order.
order_delivery_code O AN 1-10 Delivery code used for grouping bulk orders. Used when a group of cards has to be sent to a specific address. Optional for physical cards.
order_fulfil_1 O AN 1-10 Additional fulfillment parameter, possible values must be agreed separately.
order_fulfil_2 O AN 1-10 Additional fulfillment parameter, possible values must be agreed separately.
order_language O A 3 Language for carrier content.
bulk_address_line_1 C ANS 1-100 Mandatory for bulk orders (order_delivery_code is provided). Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
bulk_address_line_2 O ANS 1-100 Used only for bulk orders. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
bulk_address_line_3 O ANS 1-100 Used only for bulk orders. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
bulk_address_line_4 O ANS 1-100 Used only for bulk orders. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
bulk_country_ison C N 3 Mandatory for bulk orders (order_delivery_code is provided).
bulk_zipcode C ANS 1-9 Mandatory for bulk orders (order_delivery_code is provided).
bulk_city C ANS 1-50 Mandatory for bulk orders (order_delivery_code is provided). Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
bulk_state O ANS 1-50 Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
kyc_completion_level O N 1 Optional if holder_id isn’t provided.
kyc_document_expiration_date O ANS 10 Optional if holder_id isn’t provided.
risk_rules_group_id O N 1-20 If not provided, the default risk rules group id will be set by the program.
acs_password O AN 6-128 If not provided, the default password will be generated.
auto_conversion O N 1 Enable/disable auto conversion (if not provided, the default value will be set by the program).
access_level O N 0-1000 If not provided, the default value will be set by the program.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "createCard",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_program_id": 1,
    "card_currency_ison": "840",
    "card_country_ison": "826",
    "card_virtual": 0,
    "card_reference_id": "123456",
    "card_name_line_3": "John Smith",
    "card_name_line_4": null,
    "card_product_id": 1,
    "card_fee_group_id": 1,
    "card_limit_group_id": 1,
    "account_limit_group_id": 8,
    "holder_limit_group_id": 14,
    "card_usage_group_id": 1,
    "card_design_id": 1,
    "card_pin": "5522",
    "holder_access_level": 0,
    "holder_title": "Mr",
    "holder_first_name": "John",
    "holder_last_name": "Smith",
    "holder_address_line_1": "Bridge St",
    "holder_country_ison": "826",
    "holder_zipcode": "SW1A 2PW",
    "holder_city": "Westminster",
    "holder_state": "London",
    "holder_phone_number": "142544544",
    "holder_email": "email@email.com",
    "holder_date_of_birth": "1989-10-10",
    "holder_ip_address": "8.8.8.8",
    "holder_industry_id": null,
    "holder_date_of_company_incorporation": null,
    "holder_locale": "en_US",
    "delivery_title": "Mr",
    "delivery_first_name": "John",
    "delivery_last_name": "Smith",
    "delivery_address_line_1": "Bridge St",
    "delivery_country_ison": "826",
    "delivery_zipcode": "SW1A 2PW",
    "delivery_city": "Westminster",
    "delivery_state": "London",
    "order_shipping_method": 1,
    "order_delivery_code": "14",
    "order_language": "ENG",
    "bulk_address_line_1": "Bridge St",
    "bulk_country_ison": "826",
    "bulk_zipcode": "SW1A 2PW",
    "bulk_city": "Westminster",
    "bulk_state": "London",
    "kyc_completion_level": 0,
    "kyc_document_expiration_date": "2019-06-05",
    "risk_rules_group_id": 1,
    "acs_password": "0rF0Bh",
    "auto_conversion": 0,
    "access_level": 0
}

Response

Parameter M Type Description
status M A Success / error
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success.
data / card_id M N Card id.
data / card_request_id M N Card number id.
data / holder_id M N Holder id.
data / account_id M N Default account id.
data / pan O N Primary account number. Agreeable, can be plain/masked/encrypted/absent.
data / pin O N PIN code. Agreeable, can be plain/encrypted/absent. Note: For virtual card this field will be empty.
data / cvc2 O N Card verification code 2. Agreeable, can be plain/encrypted/absent.
data / expiration O OBJ Expiration date object. Agreeable, can be present or absent.
data / expiration / year M N Card expiration year.
data / expiration / month M N Card expiration month.
data / acs_password M AN ACS password.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "card_id": 123528,
        "card_request_id": 123,
        "holder_id": 206,
        "account_id": 206,
        "pan": "1234567891234567",
        "pin": "1234",
        "cvc2": "075",
        "expiration": {
            "year": "2021",
            "month": "09"
        },
        "acs_password": "0rF0Bh"
    },
    "duplicated": 0
}

Get CVC2

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCvc2",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0, 
    "card_id": 123528
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getCvc2.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
card_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCvc2",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0, 
    "card_id": 123528
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success.
data / cvc2 M N Card verification code 2. Agreeable, can be plain/encrypted/absent.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "cvc2": "075"
    },
    "duplicated": 0
}

Get details

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardDetails",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getCardDetails.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value will be used from the client's credentials.
card_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardDetails",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success.
data / card_id M N Card Id.
data / reference_number C ANS
data / holder_id M N Holder id.
data / primary_account_id M N Primary account id.
data / virtual M N 0 - physical, 1 - virtual.
data / program_id M N
data / invalid_pin_tries M N
data / invalid_pin_tries_max_limit M N
data / product_id M N
data / sub_product_id M N
data / fees_group_id C N
data / limits_group_id C N
data / usages_group_id C N
data / risk_group_id C N
data / status M A Card Status
data / status_change_reason_code O N Status change reason code
data / status_change_note O ANS
data / pin_status M N 0 - ok, 1 - blocked.
data / default_currency_ison M N
data / country_ison M N
data / service_code M N
data / card_design_id M N
data / name_line_3 C ANS
data / name_line_4 C ANS
data / expiry_month M N Agreeable, can be present or absent.
data / expiry_year M N Agreeable, can be present or absent.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "card_id": 123528,
        "reference_number": "123456",
        "holder_id": 206,
        "primary_account_id": 206,
        "virtual": 0,
        "program_id": 1,
        "invalid_pin_tries": 0,
        "invalid_pin_tries_max_limit": 5,
        "product_id": 1,
        "sub_product_id": 1,
        "fees_group_id": 1,
        "limits_group_id": 1,
        "usages_group_id": 1,
        "status": "A",
        "status_change_reason_code": null,
        "status_change_note": null,
        "pin_status": 0,
        "default_currency_ison": "826",
        "country_ison": "826",
        "service_code": "201",
        "card_design_id": 1,
        "name_line_3": "John",
        "name_line_4": "Smith",
        "expiry_month": "05",
        "expiry_year": "2023"
    },
    "duplicated": 0
}

Get number

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardNumber",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getCardNumber.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
card_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardNumber",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success.
data / pan M N Card primary account number. Agreeable, can be plain/masked/encrypted.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "pan": "1234567891234567"
    },
    "duplicated": 0
}

Get pin

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getPin",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getPin.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
card_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getPin",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}

Response

Parameter M Type Description
status M A Success / error
data C OBJ Response data object. Mandatory if status = success.
data / pin M N Card PIN code. Agreeable, can be plain/encrypted.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "pin": "1234"
    },
    "duplicated": 0
}

Get status

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": "123528"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getCardStatus.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
card_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": "123528"
}

Response

Parameter M Type Description
status M A Success / error
data C OBJ Response data object. Mandatory if status = success.
data / card_status M A Card Status
data / reason_code O N Status change reason code
data / note O ANS
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "card_status": "T",
        "reason_code": 13,
        "note": "Card has been suspended"
    },
    "duplicated": 0
}

Reissue

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "reissueCard",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 1,
    "generate_new_pan": 0,
    "generate_new_pin": 1,
    "virtual": 1,
    "card_pin": "2573",
    "card_name_line_3": "John Smith",
    "card_name_line_4": null,
    "delivery_title": "Mr",
    "delivery_first_name": "John",
    "delivery_last_name": "Smith",
    "delivery_address_line_1": "Bridge St",
    "delivery_country_ison": "826",
    "delivery_zipcode": "SW1A 2PW",
    "delivery_city": "Westminster",
    "delivery_state": "London",
    "order_shipping_method": 1,
    "order_delivery_code": "14",
    "order_language": "ENG",
    "bulk_address_line_1": "Bridge St",
    "bulk_country_ison": "826",
    "bulk_zipcode": "SW1A 2PW",
    "bulk_city": "Westminster",
    "bulk_state": "London",
    "auto_conversion": 0,
    "access_level": 0
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed reissueCard.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N
generate_new_pan O N 1 0 - keep the initial card number. 1 - generate a new card number. Default value: 0.
generate_new_pin O N 1 0 - keep previous PIN. 1 - generate a new card PIN. Default value: 1. When switching the card from virtual to physical, value must be - 1.
virtual O N 1 0 - physical, 1 - virtual. If the card's original type changes, the card will be converted as well.
card_pin O N 4 Will be ignored if new PIN generating is not enabled. If card_pin value is provided, PIN will be applied to the card, otherwise if value is not provided - a random PIN will be generated.`
card_program_id C N 20 If the card type is changed from virtual to physical (or vice versa), then this field is mandatory
card_fee_group_id O N 20 If the card type is changed from virtual to physical (or vice versa), then this field is optional
card_limit_group_id O N 20 If the card type is changed from virtual to physical (or vice versa), then this field is optional
card_usage_group_id O N 20 If the card type is changed from virtual to physical (or vice versa), then this field is optional
card_design_id O N 20 If the card type is changed from virtual to physical (or vice versa), then this field is optional
risk_rules_group_id O N 20 If the card type is changed from virtual to physical (or vice versa), then this field is optional
card_name_line_3 M ANS 3-26 Card emboss name line 1. Allowed symbols are combined of 1 from Default charsets and Emboss additional charset field which can be selected on the program
card_name_line_4 O ANS 2-50 Card emboss name line 2. Allowed symbols are combined of 4 from Default charsets and Emboss additional charset field which can be selected on the program
track_data_first_name O ANS 1-26 Used to override default card chip name generation. Chip name is combined with track_data_last_name. Combined length cannot exceed 26 characters. Charset 1 used from Default charsets |
track_data_last_name O ANS 1-26 Used to override default card chip name generation. Chip name is combined with track_data_first_name. Combined length cannot exceed 26 characters Charset 1 used from Default charsets
delivery_title O ANS 1-7 Ignored for virtual cards.
delivery_first_name C AS 1-50 Mandatory for a physical card order. Allowed symbols are combined of 2 from Default charsets and Address additional charset field which can be selected on the program
delivery_last_name C AS 1-50 Mandatory for a physical card order. Allowed symbols are combined of 2 from Default charsets and Address additional charset field which can be selected on the program
delivery_address_line_1 C ANS 1-100 Mandatory for a physical card order. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
delivery_address_line_2 O ANS 1-100 Ignored for virtual cards. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
delivery_address_line_3 O ANS 1-100 Ignored for virtual cards. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
delivery_address_line_4 O ANS 1-100 Ignored for virtual cards. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
delivery_country_ison C N 3 Mandatory for a physical card order.
delivery_zipcode C ANS 1-9 Mandatory for a physical card order.
delivery_city C ANS 1-50 Mandatory for a physical card order. Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
delivery_state O ANS 1-50 Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
order_shipping_method C N 1-20 Mandatory for a physical card order.
order_delivery_code O AN 1-10 Ignored for virtual cards.
order_fulfil_1 O AN 1-10 Additional fulfillment parameter, possible values must be agreed separately.
order_fulfil_2 O AN 1-10 Additional fulfillment parameter, possible values must be agreed separately.
order_language O A 3 Language for carrier content.
bulk_address_line_1 C ANS 1-100 Mandatory for bulk orders (order_delivery_code is provided). Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
bulk_address_line_2 O ANS 1-100 Used only for bulk orders. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
bulk_address_line_3 O ANS 1-100 Used only for bulk orders. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
bulk_address_line_4 O ANS 1-100 Used only for bulk orders. Allowed symbols are combined of 4 from Default charsets and Address additional charset field which can be selected on the program
bulk_country_ison C N 3 Mandatory for bulk orders (order_delivery_code is provided).
bulk_zipcode C ANS 1-9 Mandatory for bulk orders (order_delivery_code is provided).
bulk_city C ANS 1-50 Mandatory for bulk orders (order_delivery_code is provided). Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
bulk_state O ANS 1-50 Allowed symbols are combined of 6 from Default charsets and Address additional charset field which can be selected on the program
auto_conversion O N 1 Enable/disable auto conversion (if not provided and the new program is not provided as well, the value will be left as the originally set card value, otherwise if the value is not provided, but the new program is provided, the value will be validated with the program's permission).
access_level O N 0-1000 If not provided, the default value will be set by the program.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "reissueCard",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 1,
    "generate_new_pan": 0,
    "generate_new_pin": 1,
    "virtual": 1,
    "card_pin": "2573",
    "card_name_line_3": "John Smith",
    "card_name_line_4": null,
    "delivery_title": "Mr",
    "delivery_first_name": "John",
    "delivery_last_name": "Smith",
    "delivery_address_line_1": "Bridge St",
    "delivery_country_ison": "826",
    "delivery_zipcode": "SW1A 2PW",
    "delivery_city": "Westminster",
    "delivery_state": "London",
    "order_shipping_method": 1,
    "order_delivery_code": "14",
    "order_language": "ENG",
    "bulk_address_line_1": "Bridge St",
    "bulk_country_ison": "826",
    "bulk_zipcode": "SW1A 2PW",
    "bulk_city": "Westminster",
    "bulk_state": "London",
    "auto_conversion": 0,
    "access_level": 0
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success.
data / card_id M N Card id.
data / holder_id M N Holder id.
data / account_id M N Default account id.
data / card_request_id M N Card number id.
data / pan O N Primary account number. Agreeable, can be plain/masked/encrypted/absent.
data / pin O N PIN code. Agreeable, can be plain/encrypted/absent. Note: For a virtual card this field will be empty.
data / cvc2 O N Card verification code 2. Agreeable, can be plain/encrypted/absent.
data / expiration O OBJ Expiration date object. Agreeable, can be present or absent.
data / expiration / year M N Card expiration year.
data / expiration / month M N Card expiration month.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "card_id": 123528,
        "card_request_id": 1,
        "holder_id": 206,
        "account_id": 206,
        "pan": "1234567891234567",
        "pin": "1234",
        "cvc2": "075",
        "expiration": {
            "year": "2021",
            "month": "09"
        },
        "acs_password": "N7bNNk"
    },
    "duplicated": 0
}

Set pin

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "setPin",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "pin": "1234"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed setPin.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N 1-20
pin M N 4 Cannot be all the same digits or all sequential digits.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "setPin",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "pin": "1234"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Unblock pin

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "unblockPin",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed unblockPin.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "unblockPin",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Get design

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getDesign",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "program_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getDesign.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
program_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getDesign",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "program_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object list. Mandatory if status = success. Empty for this call.
data / card_design_id M N Card design id.
data / card_design_name M ANS Card design name.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "card_design_id": 2,
            "name": "First card design"
        },
        {
            "card_design_id": 3,
            "name": "Second card design"
        }
    ],
    "duplicated": 0
}

Get ACS password

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardAcsPassword",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getCardAcsPassword.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
card_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardAcsPassword",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success.
data / acs_password M AN ACS password. Agreeable, can be plain/encrypted/absent.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "acs_password": "0rF0Bh"
    },
    "duplicated": 0
}

Change ACS password

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeCardAcsPassword",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "acs_password": "0rF0Bh"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed. changeCardAcsPassword.
api_version M NS Fixed. 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M N 1-20
acs_password M AN 6-128
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeCardAcsPassword",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123528,
    "acs_password": "0rF0Bh"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Create ACS Merchant Whitelist Rule

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "createCardAcsMerchantWhitelistRule",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "rule_name": "My rule 1",
    "card_id": 123456,
    "rule_code": "123e4567-e89b-12d3-a456-426614174000",
    "acquirer_bin_merchant_id": "123456789+987654321,623456789+187654321",
    "merchant_country_ison": "826",
    "maximum_amount": 50000,
    "maximum_amount_currency_ison": "840"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed createCardAcsMerchantWhitelistRule.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
rule_name M ANS 1-70 An arbitrary rule name for further referencing the created rule.
card_id M N 1-20
acquirer_bin_merchant_id C ANS 65536 Comma separated Acquirer BIN and Merchant ID combinations concatenated by a plus symbol "+". Example: 123456789+987654321. At least one of the following fields must be provided: acquirer_bin_merchant_id, mcc, merchant_country_ison, merchant_name.
mcc C ANS 65536 Comma separated merchant category codes. Each code length is exactly 4 digits. Example: 6011,5987,0095. At least one of the following fields must be provided: acquirer_bin_merchant_id, mcc, merchant_country_ison, merchant_name.
merchant_country_ison C ANS 65536 Comma separated merchant ISO 3166-1 numeric three-digit country codes. Example: 840,826,445. At least one of the following fields must be provided: acquirer_bin_merchant_id, mcc, merchant_country_ison, merchant_name.
merchant_name C LIST - Array of merchant names as ANS strings. Example: ["Company ABC", "COMPANY XYZ"]. At least one of the following fields must be provided: acquirer_bin_merchant_id, mcc, merchant_country_ison, merchant_name.
rule_code O ANS 36 An optional unique identifier for reference to the created rule.
maximum_amount O N 1-15 Maximum payment amount until which the rule will apply. Payments for higher amounts will not have this rule applied. Amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
maximum_amount_currency_ison C N 3 If maximum_amount is given, this field is required. ISO 4217 numeric three-digit currency code in which the maximum_amount value is given.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "createCardAcsMerchantWhitelistRule",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "rule_name": "My rule 1",
    "card_id": 123456,
    "rule_code": "123e4567-e89b-12d3-a456-426614174000",
    "acquirer_bin_merchant_id": "123456789+987654321,623456789+187654321",
    "merchant_country_ison": "826",
    "maximum_amount": 50000,
    "maximum_amount_currency_ison": "840"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request not duplicated. When duplicated = 1, and original request processing has been finished, original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
data / rule_id M N Unique ID identifying the created rule.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "rule_id": 1337
    },
    "duplicated": 0
}

Confirm authentication

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "authenticationConfirm",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "auth_request_id": 16148572783490,
    "confirmation_status": "Y",
    "oob_auth_method": 3,
    "validation_value": "71629565"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed authenticationConfirm.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
auth_request_id M N 1-20 Unique authentication request ID.
confirmation_status M A 1 Authentication confirmation status
oob_auth_method M N 1-2 OOB (Out-of-Band) authentication method
validation_value O ANS 1-8 If provided then this value is validated against original value.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "authenticationConfirm",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "auth_request_id": 16148572783490,
    "confirmation_status": "Y",
    "oob_auth_method": 3,
    "validation_value": "71629565"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request not duplicated. When duplicated = 1, and original request processing has been finished, original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {},
    "duplicated": 0
}

External payment

Assign address to account

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignExternalPaymentAddress",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 73,
    "epm_method_id": 1,
    "currency_ison": "826",
    "country_ison": "826",
    "card_id": 103500,
    "account_name": "John Smith",
    "risk_score": 3
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed assignExternalPaymentAddress.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
account_id M N 1-20
epm_method_id M N 1-20
currency_ison M N 3
country_ison O N 3 If not provided country ISON will be set from the holder data.
card_id O N 1-20
account_name O AN 1-70 Allowed symbols are combined of 5 from Default charsets and Holder additional charset field which is selected from the cards program
risk_score O N Account holder risk score.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignExternalPaymentAddress",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "account_id": 73,
    "epm_method_id": 1,
    "currency_ison": "826",
    "country_ison": "826",
    "card_id": 103500,
    "account_name": "John Smith",
    "risk_score": 3
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C LIST Response data object list. Mandatory if status = success.
data / id M N External payment address ID.
data / access_level M N
data / active M N 1 - active, 0 - not active.
data / account_number C AN Mandatory if it was provided by an external provider.
data / account_name M AN
data / iban C AN Mandatory if it was provided by an external provider.
data / sort_code C AN Mandatory if it was provided by an external provider.
data / bic C AN Mandatory if it was provided by an external provider.
data / direct_credit_enabled M N 1 - enabled, 0 - disabled.
data / direct_debit_enabled M N 1 - enabled, 0 - disabled.
data / inbound_enabled M N 1 - enabled, 0 - disabled.
data / outbound_enabled M N 1 - enabled, 0 - disabled.
data / epm_method_id M N External payment method ID.
data / epm_type_id M N External payment type ID.
data / account_id M N
data / account_type M N Account type
data / card_id O N
data / holder_id C N Mandatory if account_type = 1 (account).
data / currency_ison M N
data / country_ison M N
data / assignment_state M N External payment address assignment state
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "id": 1,
            "access_level": 0,
            "active": 1,
            "account_number": "35276395",
            "account_name": "Test Tester",
            "iban": "GB26SRLG04005935276395",
            "sort_code": "040059",
            "bic": "SRLGGB2L",
            "direct_credit_enabled": 1,
            "direct_debit_enabled": 1,
            "inbound_enabled": 1,
            "outbound_enabled": 1,
            "epm_method_id": 1,
            "epm_type_id": 1,
            "account_id": 1,
            "account_type": 1,
            "card_id": 123456,
            "holder_id": 1,
            "currency_ison": "826",
            "country_ison": "826",
            "assignment_state": 1
        }
    ],
    "duplicated": 0
}

Assign address to special account

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignExternalPaymentAddressForSpecialAccount",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "special_account_id": 5,
    "epm_method_id": 1,
    "currency_ison": "826",
    "country_ison": "826",
    "card_id": 103500,
    "account_name": "John Smith",
    "risk_score": 3
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed assignExternalPaymentAddressForSpecialAccount.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
special_account_id M N 1-20
epm_method_id M N 1-20
currency_ison M N 3
country_ison O N 3 If not provided country ISON will be set from the special account data.
card_id O N 1-20
account_name O AN 1-70
risk_score O N Account holder risk score
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "assignExternalPaymentAddressForSpecialAccount",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "special_account_id": 5,
    "epm_method_id": 1,
    "currency_ison": "826",
    "country_ison": "826",
    "card_id": 103500,
    "account_name": "John Smith",
    "risk_score": 3
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C LIST Response data object list. Mandatory if status = success.
data / id M N External payment address ID.
data / access_level M N
data / active M N 1 - active, 0 - not active.
data / account_number C AN Mandatory if it was provided by an external provider.
data / account_name M AN
data / iban C AN Mandatory if it was provided by an external provider.
data / sort_code C AN Mandatory if it was provided by an external provider.
data / bic C AN Mandatory if it was provided by an external provider.
data / direct_credit_enabled M N 1 - enabled, 0 - disabled.
data / direct_debit_enabled M N 1 - enabled, 0 - disabled.
data / inbound_enabled M N 1 - enabled, 0 - disabled.
data / outbound_enabled M N 1 - enabled, 0 - disabled.
data / epm_method_id M N External payment method ID.
data / epm_type_id M N External payment type ID.
data / account_id M N
data / account_type M N Account type
data / card_id O N
data / holder_id C N Mandatory if account_type = 1 (account).
data / currency_ison M N
data / country_ison M N
data / assignment_state M N External payment address assignment state
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "id": 1,
            "access_level": 0,
            "active": 1,
            "account_number": "35276395",
            "account_name": "Test Tester",
            "iban": "GB26SRLG04005935276395",
            "sort_code": "040059",
            "bic": "SRLGGB2L",
            "direct_credit_enabled": 1,
            "direct_debit_enabled": 1,
            "inbound_enabled": 1,
            "outbound_enabled": 1,
            "epm_method_id": 1,
            "epm_type_id": 1,
            "account_id": 1,
            "account_type": 1,
            "card_id": 123456,
            "holder_id": 1,
            "currency_ison": "826",
            "country_ison": "826",
            "assignment_state": 1
        }
    ],
    "duplicated": 0
}

Cancel mandate

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "cancelExternalPaymentMandate",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "epm_mandate_id": 2,
    "reason": 1
}'

Request

Field name M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed cancelExternalPaymentMandate.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
epm_mandate_id M N 1-20 External payment mandate id.
reason M N 1-20 External payment mandate cancellation reason
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "cancelExternalPaymentMandate",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "epm_mandate_id": 2,
    "reason": 1
}

Response

Field name M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Empty if status = success.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Change direct debit status

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeDDExternalPaymentStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "epm_transaction_id": 90,
    "should_pay": 1,
    "reason": 1
}'

Request

Field name M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed changeDDExternalPaymentStatus.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
epm_transaction_id M N 1-20 External payment transaction id.
should_pay M N 1 1 - should pay, 0 - shouldn't pay.
reason M N 1-6 External payment direct debit return reason
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeDDExternalPaymentStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "epm_transaction_id": 90,
    "should_pay": 1,
    "reason": 1
}

Response

Field name M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Empty if status = success.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Get address

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getExternalPaymentAddress",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "epm_address_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getExternalPaymentAddress.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
epm_address_id M N External payment address id.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getExternalPaymentAddress",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "epm_address_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
data C LIST Response data object list. Mandatory if status = success.
data / id M N External payment address ID.
data / access_level M N
data / active M N 1 - active, 0 - not active.
data / account_number C AN Mandatory if it was provided by an external provider..
data / account_name M AN
data / iban C AN Mandatory if it was provided by an external provider.
data / sort_code C AN Mandatory if it was provided by an external provider.
data / bic C AN Mandatory if it was provided by an external provider.
data / direct_credit_enabled M N 1 - enabled, 0 - disabled.
data / direct_debit_enabled M N 1 - enabled, 0 - disabled.
data / inbound_enabled M N 1 - enabled, 0 - disabled.
data / outbound_enabled M N 1 - enabled, 0 - disabled.
data / epm_method_id M N External payment method ID.
data / epm_type_id M N External payment type ID.
data / account_id M N
data / account_type M N Account type
data / card_id O N
data / holder_id C N Mandatory if account_type = 1 (account).
data / currency_ison M N
data / country_ison M N
data / assignment_state M N External payment address assignment state
data / status M A External payment address status
data / status_change_reason_code O N Status change reason code
data / status_change_note O ANS
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "id": 1,
        "access_level": 0,
        "active": 1,
        "account_number": "35276395",
        "account_name": "Test Tester",
        "iban": "GB26SRLG04005935276395",
        "sort_code": "040059",
        "bic": "SRLGGB2L",
        "direct_credit_enabled": 1,
        "direct_debit_enabled": 1,
        "inbound_enabled": 1,
        "outbound_enabled": 1,
        "epm_method_id": 1,
        "epm_type_id": 1,
        "account_id": 1,
        "account_type": 1,
        "card_id": 123456,
        "holder_id": 1,
        "currency_ison": "826",
        "country_ison": "826",
        "assignment_state": 1,
        "status": "A",
        "status_change_reason_code": null,
        "status_change_note": null
    },
    "duplicated": 0
}

Get account addresses

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getAccountExternalPaymentAddresses",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "account_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getAccountExternalPaymentAddresses.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used. Access level can impact returned list size.
account_id M N
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getAccountExternalPaymentAddresses",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "account_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
data C LIST Response data object list. Mandatory if status = success.
data / id M N External payment address ID.
data / access_level M N
data / active M N 1 - active, 0 - not active.
data / account_number C AN Mandatory if it was provided by an external provider
data / account_name M AN
data / iban C AN Mandatory if it was provided by an external provider
data / sort_code C AN Mandatory if it was provided by an external provider
data / bic C AN Mandatory if it was provided by an external provider
data / direct_credit_enabled M N 1 - enabled, 0 - disabled.
data / direct_debit_enabled M N 1 - enabled, 0 - disabled.
data / inbound_enabled M N 1 - enabled, 0 - disabled.
data / outbound_enabled M N 1 - enabled, 0 - disabled.
data / epm_method_id M N External payment method ID.
data / epm_type_id M N External payment type ID.
data / account_id M N
data / account_type M N Account type
data / card_id O N
data / holder_id C N Mandatory if account_type = 1 (account).
data / currency_ison M N
data / country_ison M N
data / assignment_state M N External payment address assignment state
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "id": 1,
            "access_level": 0,
            "active": 1,
            "account_number": "35276395",
            "account_name": "Test Tester",
            "iban": "GB26SRLG04005935276395",
            "sort_code": "040059",
            "bic": "SRLGGB2L",
            "direct_credit_enabled": 1,
            "direct_debit_enabled": 1,
            "inbound_enabled": 1,
            "outbound_enabled": 1,
            "epm_method_id": 1,
            "epm_type_id": 1,
            "account_id": 1,
            "account_type": 1,
            "card_id": 123456,
            "holder_id": 1,
            "currency_ison": "826",
            "country_ison": "826",
            "assignment_state": 1
        },
        {
            "id": 2,
            "access_level": 0, 
            "active": 1,
            "account_number": "54043626",
            "account_name": "John Smith",
            "iban": "GB82SRLG04005954043626",
            "sort_code": "040059",
            "bic": "SRLGGB2L",
            "direct_credit_enabled": 1,
            "direct_debit_enabled": 1,
            "inbound_enabled": 1,
            "outbound_enabled": 1,
            "epm_method_id": 1,
            "epm_type_id": 1,
            "account_id": 1,
            "account_type": 1,
            "card_id": 123456,
            "holder_id": 1,
            "currency_ison": "826",
            "country_ison": "826",
            "assignment_state": 1
        }
    ]
}

Change external payment address status

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeExternalPaymentAddressStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "epm_address_id": 1,
    "status": "B",
    "reason_code": 13,
    "note": "External payment address has been blocked"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed changeExternalPaymentAddressStatus.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
epm_address_id M N 20 External payment address id.
status M A 1 External payment address status .
reason_code O N 1-20 Status change reason code
note O ANS 1-255 A short description which explains why external payment address status has been changed.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "changeExternalPaymentAddressStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "epm_address_id": 1,
    "status": "B",
    "reason_code": 13,
    "note": "External payment address has been blocked"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request not duplicated. When duplicated = 1, and original request processing has been finished, original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Outbound transfer

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "transferToExternalPayment",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "epm_address_id": 1,
    "destination_account_number": "00004588",
    "destination_account_name": "John Smith",
    "destination_sort_code": "203002",
    "currency_ison": "840",
    "amount": 1255,
    "reference_number": "AB78542",
    "description": "Transfer request",
    "note": "Transfer note",
    "withdrawal_purpose": 1,
    "receiver_type": 1,
    "industry_id": 1,
    "schemes": "4,1,5"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed transferToExternalPayment.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
epm_address_id M N External payment address id.
destination_account_number C AN 1-26 Mandatory if destination_sort_code is specified.
destination_account_name M AN
destination_iban C AN Mandatory if destination_account_number and destination_sort_code are not specified.
destination_sort_code C AN 6 Mandatory if destination_account_number is specified. Only letters and numbers.
currency_ison M N
amount M N
reference_number C ANS 1-255 Depends on the external provider.
description O ANS 1-255
note O ANS 1-35
withdrawal_purpose O N 1-2 Withdrawal purpose
receiver_type O N 1 Receiver type
industry_id O N 1-2 Industry ID
schemes O EXT-LIST 1-255 Schemes list ordered by priority
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "transferToExternalPayment",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "epm_address_id": 1,
    "destination_account_number": "00004588",
    "destination_account_name": "John Smith",
    "destination_sort_code": "203002",
    "currency_ison": "840",
    "amount": 1255,
    "reference_number": "AB78542",
    "description": "Transfer request",
    "note": "Transfer note",
    "withdrawal_purpose": 1,
    "receiver_type": 1,
    "industry_id": 1,
    "schemes": "4,1,5"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C LIST Response data object list. Mandatory if status = success.
data / id C N External payment transaction ID
data / external_transaction_reference C N Provided if an external provider processed the request and returned a successful response.
data / settlement_amount M N
data / settlement_currency M N Settlement currency ison.
data / instructed_amount M N
data / instructed_currency M N Instructed currency ison.
data / transaction_id C N Provided if transaction created. Unique settlement transaction ID.
data / trans_link C AN Provided if transaction created.
data / source_bank_account_address C LIST
data / source_bank_account_address / id M N External payment address ID
data / source_bank_account_address / account_number M AN
data / source_bank_account_address / account_name M AN
data / source_bank_account_address / iban M AN
data / source_bank_account_address / sort_code M AN
data / source_bank_account_address / bic M AN
data / destination_bank_account_address C LIST
data / destination_bank_account_address / account_number C AN Provided if an external provider processed the request and returned a successful response.
data / destination_bank_account_address / account_name M AN
data / destination_bank_account_address / iban C AN Mandatory if an external provider processed the request and returned a successful response.
data / destination_bank_account_address / sort_code C AN Mandatory if an external provider processed the request and returned a successful response.
data / destination_bank_account_address / bic C AN Mandatory if an external provider processed the request and returned a successful response.
data / created_at C AN Mandatory if an external provider processed the request and returned a successful response.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "id": 15798696909332,
        "external_transaction_reference": 47,
        "settlement_amount": 1255,
        "settlement_currency": "826",
        "instructed_amount": 1255,
        "instructed_currency": "826",
        "transaction_id": 16044094764502,
        "trans_link": "580076300000109036201228103523",
        "source_bank_account_address": {
            "id": 6,
            "account_number": "26304531",
            "account_name": "John Smith",
            "iban": "GB32SRLG04005970085028",
            "sort_code": "040059",
            "bic": "SRLGGB2L"
        },
        "destination_bank_account_address": {
            "account_number": "00004588",
            "account_name": "John Smith",
            "iban": "GB85SRLG04005981391558",
            "sort_code": "203002",
            "bic": "SRLGGB2L"
        },
        "created_at": "2019-02-22T13:07:01+00:00"
    },
    "duplicated": 0
}

Inbound return transfer

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "action": "inboundReturn",
    "api_version": "1.2",
    "epm_transaction_id": 123456789,
    "reason": 5,
    "reference": null
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed inboundReturn.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
epm_transaction_id M N External payment transaction ID.
reason C N Required for specific payment schemes. External payment inbound return message code
reference O AN Depends on the external provider.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "action": "inboundReturn",
    "api_version": "1.2",
    "epm_transaction_id": 123456789,
    "reason": 5,
    "reference": null
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C LIST Response data object list. Mandatory if status = success.
data / id C N External payment transaction ID
data / external_transaction_reference C N Mandatory if an external provider processed the request and returned a successful response.
data / settlement_amount M N
data / settlement_currency M N
data / instructed_amount M N
data / instructed_currency M N
data / transaction_id C N Mandatory if transaction created. Unique settlement transaction ID.
data / trans_link C AN Mandatory if transaction created.
data / source_bank_account_address C LIST
data / source_bank_account_address / id M N External payment address ID
data / source_bank_account_address / account_number M AN
data / source_bank_account_address / account_name M AN
data / source_bank_account_address / iban M AN
data / source_bank_account_address / sort_code M AN
data / source_bank_account_address / bic M AN
data / created_at C AN Mandatory if an external provider processed the request and returned a successful response.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "id": 15798696909332,
        "external_transaction_reference": 47,
        "settlement_amount": 1255,
        "settlement_currency": "826",
        "instructed_amount": 1255,
        "instructed_currency": "826",
        "transaction_id": 16044094764502,
        "trans_link": "580076300000109036201228103523",
        "source_bank_account_address": {
            "id": 6,
            "account_number": "26304531",
            "account_name": "John Smith",
            "iban": "GB32SRLG04005970085028",
            "sort_code": "040059",
            "bic": "SRLGGB2L"
        },
        "created_at": "2019-02-22T13:07:01+00:00"
    },
    "duplicated": 0
}

Direct debit return

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "directDebitReturn",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "returned_epm_transaction_id": 1,
    "reason": 1,
    "reference": "AB78542"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed directDebitReturn.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
returned_epm_transaction_id M N 1-20 Returned external payment transaction id.
reason M AN 1-6 External payment direct debit return reason
reference O AN 1-255 Depends on the external provider.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "directDebitReturn",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "returned_epm_transaction_id": 1,
    "reason": 1,
    "reference": "AB78542"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "duplicated": 0,
    "data": []
}

Direct credit return

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "action": "directCreditReturn",
    "api_version": "1.2",
    "epm_transaction_id": 123456789,
    "return_reason_id": 5,
    "reference": "AB78542"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed directCreditReturn.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
epm_transaction_id M N 1-20 External payment transaction ID.
return_reason_id C N Required for specific payment schemes. External payment inbound return message code
reference O AN 225 Depends on the external provider.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "action": "directCreditReturn",
    "api_version": "1.2",
    "epm_transaction_id": 123456789,
    "return_reason_id": 5,
    "reference": "AB78542"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
  "status": "success",
  "duplicated": 0,
  "data": []
}

Fee

Custom fee transaction

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "createCustomFee",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_currency": "840",
    "amount": 500,
    "currency_ison": "840",
    "fee_group_id": 1,
    "fee_code": "F0000001",
    "description": "Custom fee",
    "country_ison": "840",
    "transaction_id": 15719166772813
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed createCustomFee.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id C N 1-20 Card ID. Mandatory if account ID is not provided.
account_id C N 1-20 Account ID. Mandatory if card ID is not provided.
account_currency C N 3 Account currency ison. Mandatory if transaction ID and account ID is not provided.
amount O N 1-15 Amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
currency_ison C N 3 Mandatory if amount is provided
fee_group_id M N 1-20 Fee group ID.
fee_code M AN 1-8 Fee Code.
description M AN 37 Visible in transaction view page
country_ison O N 3 3-digit country ISON code.
transaction_id O N 11 Transaction ID to which custom fee will be linked.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "createCustomFee",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_currency": "840",
    "amount": 500,
    "currency_ison": "840",
    "fee_group_id": 1,
    "fee_code": "F0000001",
    "description": "Custom fee",
    "country_ison": "840",
    "transaction_id": 15719166772813
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success.
data / transaction_id M N Transaction ID.
data / available_balance M N Available card balance.
data / settled_balance M N Settled card balance.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "transaction_id": 15719166772815,
        "available_balance": 10500,
        "settled_balance": 10500
    },
    "duplicated": 0
}

Get card fees

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardFees",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123456,
    "paginator":{
        "item_count": 1,
        "offset": 0
    }
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getCardFees.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
card_id M N 1-20
paginator M OBJ Paginator data object.
item_count M N 1-11 Items per page. Max 100.
offset M N 1-11 Index of the first item.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardFees",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123456,
    "paginator":{
        "item_count": 1,
        "offset": 0
    }
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
data / title M ANS
data / transaction_type M N Transactions type
data / entry_mode_type M N Entry mode type
data / mcc_low M N Merchant category code.
data / mcc_high M N Merchant category code.
data / fixed_price C N
data / percent_price C N
data / currency_ison M N
data / country_ison C N
data / region_id C N
data / min_amount C N
data / max_amount C N
data / date_updated M N Unix timestamp of the last fee update.
paginator M OBJ
data / total_ items_count M N
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
code M ANS
{
    "status": "success",
    "data": [
        {
            "title": "",
            "transaction_type": "1",
            "entry_mode_type": "1",
            "mcc_low": 900,
            "mcc_high": 5000,
            "fixed_price": null,
            "percent_price": 100,
            "currency_ison": "829",
            "country_ison": "829",
            "region_id": 1,
            "min_amount": 634,
            "max_amount": 119,
            "date_updated": 1552899642,
            "code": "F0000001"
        }
    ],
    "paginator": {
        "total_items_count": 20
    },
    "duplicated": 0
}

Get fee group

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getFeesGroups",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "program_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getFeesGroups.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
program_id O N [1-20]
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getFeesGroups",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "program_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
data C LIST Response data object list. Mandatory if status = success.
data / id M N Fee group id.
data / name M ANS Fee group name.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "id": 1,
            "name": "Standart fees group"
        }
    ],
    "duplicated": 0
}

Holder

Get

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getHolder",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "holder_id": 1,
    "card_id": 123456
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getHolder.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
holder_id C N 1-20 Mandatory if card_id is not specified. Both fields - holder_id and card_id - can be specified.
card_id C N 1-20 Mandatory if holder_id is not specified. Both fields - holder_id and card_id - can be specified.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getHolder",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "holder_id": 1,
    "card_id": 123456
}

Response

Parameter M Type Description
status M A Success / error.
status_code M A Possible error codes Mandatory if status = error.
data C LIST Response data object list. Mandatory if status = success.
data / id M N Holder id.
data / title O ANS
data / holder_type M ANS 0 - personal, 1 - business
data / access_level M N
data / business_name C ANS Mandatory if holder_type = 1
data / first_name M AS
data / last_name M AS
data / address_line_1 M ANS
data / address_line_2 O ANS
data / address_line_3 O ANS
data / address_line_4 O ANS
data / country_ison O N
data / zip_code M ANS
data / city M ANS
data / state O ANS
data / phone_number M N
data / email O ANS
data / date_of_birth O ANS
data / ip_address O ANS
data / industry_id O N Industry ID
data / date_of_company_incorporation O ANS Format: Y-m-d, example: 2020-06-24.
data / kyc_completion_level O N
data / kyc_document_expiration_date O ANS
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "id": 1,
        "title": null,
        "holder_type": 1,
        "access_level": 0,
        "business_name": "Company",
        "country_ison": "826",
        "first_name": "A",
        "last_name": "B",
        "address_line_1": "1520 Main",
        "address_line_2": "London",
        "address_line_3": null,
        "address_line_4": null,
        "zip_code": "63110",
        "city": "London",
        "state": "London",
        "phone_number": 12345678,
        "email": null,
        "date_of_birth": null,
        "ip_address": null,
        "kyc_completion_level": 0,
        "kyc_document_expiration_date": null,
        "industry_id": null,
        "date_of_company_incorporation": null,
        "holder_limit_group_id": 14
    },
    "duplicated": 0
}

Get holder accounts

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getHolderAccounts",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "holder_id": 206
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getHolderAccounts.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used. Access level can impact returned list size.
holder_id M N 1-20
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getHolderAccounts",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "holder_id": 206
}

Response

Parameter M Type Description
status M A Success / error.
data C LIST Response data object list. Mandatory if status = success.
data / id M N Account id.
data / holder_id M N Account owner id.
data / currency_ison M N Account currency ison.
data / available_balance M N Available card balance.
data / settled_balance M N Settled card balance.
data / reserved_balance M N Reserved balance. Funds are suspended by the processor until the dispute is resolved.
data / account_status M A Account status
data / date_updated M N Unix timestamp of the last account activity.
data / program_id M N Program id.
data / limit_group_id M N Limit group id or null if group is not set.
data / fee_group_id M N Fee group id.
data / risk_group_id M N Risk group id.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "id": 206,
            "holder_id": 206,
            "currency_ison": "826",
            "available_balance": 500,
            "settled_balance": 500,
            "reserved_balance": 0,
            "account_status": "A",
            "date_updated": 1547649491,
            "program_id": 1,
            "limit_group_id": 1,
            "fee_group_id": 1
        }
    ],
    "duplicated": 0
}

Create

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "bklMTt9cY1UuI9JSB",
    "access_api_id": "isac_admin",
    "access_api_key": "7e848b394c06d26c975b",
    "action": "createHolder",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "title": "Mr",
    "first_name": "John",
    "last_name": "Smith",
    "address_line_1": "Bridge St",
    "address_line_2": null,
    "address_line_3": null,
    "address_line_4": null,
    "zip_code": "30000",
    "city": "New York",
    "state": "New York",
    "phone_number": 3705646546565,
    "country_ison": "004",
    "holder_limit_group_id": 10,
    "email": "email@email.com",
    "date_of_birth": "1989-10-10",
    "ip_address": "192.168.1.1",
    "industry_id": null,
    "date_of_company_incorporation": null,
    "kyc_completion_level": 0,
    "kyc_document_expiration_date": "2019-05-26",
    "holder_locale": "en_US"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed createHolder.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
holder_type O N 1 0 - personal, 1 - business. Default value: 0
access_level O N 0-1000 Default value 0.
business_name C ANS 1-50 Mandatory if holder_type = 1
title O ANS 1-7
first_name M AS 1-50 Allowed symbols are combined of 2 from Default charsets and Holder additional charset field which is provided as additional_charset_id
last_name M AS 1-50 Allowed symbols are combined of 2 from Default charsets and Holder additional charset field which is provided as additional_charset_id
address_line_1 M ANS 1-100 Allowed symbols are combined of 4 from Default charsets and Address additional charset field which is provided as additional_charset_id
address_line_2 O ANS 1-100 Allowed symbols are combined of 4 from Default charsets and Address additional charset field which is provided as additional_charset_id
address_line_3 O ANS 1-100 Allowed symbols are combined of 4 from Default charsets and Address additional charset field which is provided as additional_charset_id
address_line_4 O ANS 1-100 Allowed symbols are combined of 4 from Default charsets and Address additional charset field which is provided as additional_charset_id
zip_code M ANS 1-9
city M ANS 1-50 Allowed symbols are combined of 6 from Default charsets and Address additional charset field which is provided as additional_charset_id
state O ANS 1-50 Allowed symbols are combined of 6 from Default charsets and Address additional charset field which is provided as additional_charset_id
phone_number M N 6-15
country_ison O N 3 If the program allows country change and this value is valid, then the country will be updated.
holder_limit_group_id M N 1-20 Holder limit group ID.
email O ANS 6-100 Holder e-mail address
date_of_birth O ANS 10 Holder date of birth
ip_address O ANS 7-15 Holder IP address (IPV4)
industry_id O N 4 Industry ID
date_of_company_incorporation O ANS 10 Format: Y-m-d, example: 2020-06-24.
kyc_completion_level O N 1
additional_charset_id O N 1-10 Additional charset allows to use additional symbols for specified fields
holder_locale O AS 1-15 Language code identifiers
{
    "access_key": "bklMTt9cY1UuI9JSB",
    "access_api_id": "isac_admin",
    "access_api_key": "7e848b394c06d26c975b",
    "action": "createHolder",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "title": "Mr",
    "first_name": "John",
    "last_name": "Smith",
    "address_line_1": "Bridge St",
    "address_line_2": null,
    "address_line_3": null,
    "address_line_4": null,
    "zip_code": "30000",
    "city": "New York",
    "state": "New York",
    "phone_number": 3705646546565,
    "country_ison": "004",
    "holder_limit_group_id": 10,
    "email": "email@email.com",
    "date_of_birth": "1989-10-10",
    "ip_address": "192.168.1.1",
    "industry_id": null,
    "date_of_company_incorporation": null,
    "kyc_completion_level": 0,
    "kyc_document_expiration_date": "2019-05-26",
    "additional_charset_id": null,
    "holder_locale": "en_US"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
id C N Holder id if success.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "id": 1,
    "duplicated": 0
}

Update

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "updateHolder",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "holder_id": 428,
    "title": "Mr",
    "first_name": "John",
    "last_name": "Smith",
    "address_line_1": "Bridge St",
    "address_line_2": null,
    "address_line_3": null,
    "address_line_4": null,
    "zip_code": "30000",
    "city": "New York",
    "state": "New York",
    "phone_number": 3705646546565,
    "country_ison": "004",
    "holder_limit_group_id": 10,
    "email": "email@email.com",
    "date_of_birth": "1989-10-10",
    "industry_id": null,
    "date_of_company_incorporation": null,
    "kyc_completion_level": 0,
    "kyc_document_expiration_date": "2019-10-10",
    "holder_locale": "en_US"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed updateHolder.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
holder_id M N 1-20 Holder id.
business_name C ANS 1-50 Mandatory if it is business holder (holder_type = 1)
title O ANS 1-7
first_name M AS 1-50 Allowed symbols are combined of 2 from Default charsets and Holder additional charset field which is provided as additional_charset_id
last_name M AS 1-50 Allowed symbols are combined of 2 from Default charsets and Holder additional charset field which is provided as additional_charset_id
address_line_1 M ANS 1-100 Allowed symbols are combined of 4 from Default charsets and Address additional charset field which is provided as additional_charset_id
address_line_2 O ANS 1-100 Allowed symbols are combined of 4 from Default charsets and Address additional charset field which is provided as additional_charset_id
address_line_3 O ANS 1-100 Allowed symbols are combined of 4 from Default charsets and Address additional charset field which is provided as additional_charset_id
address_line_4 O ANS 1-100 Allowed symbols are combined of 4 from Default charsets and Address additional charset field which is provided as additional_charset_id
zip_code M ANS 1-9
city M ANS 1-50 Allowed symbols are combined of 6 from Default charsets and Address additional charset field which is provided as additional_charset_id
state O ANS 1-50 Allowed symbols are combined of 6 from Default charsets and Address additional charset field which is provided as additional_charset_id
phone_number M N 6-15
country_ison O N 3 If the program allows country change and this value is valid, then the country will be updated.
holder_limit_group_id M N 1-20 Holder limit group ID.
email O ANS 6-100 Holder e-mail address
date_of_birth O ANS 10 Holder date of birth
industry_id O N 4 Industry ID
date_of_company_incorporation O ANS 10 Format: Y-m-d, example: 2020-06-01.
kyc_completion_level O N 1
kyc_document_expiration_date O ANS 10
additional_charset_id O N 1-10 Additional charset allows to use additional symbols for specified fields
holder_locale O AS 1-15 Language code identifiers
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "updateHolder",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "holder_id": 428,
    "title": "Mr",
    "first_name": "John",
    "last_name": "Smith",
    "address_line_1": "Bridge St",
    "address_line_2": null,
    "address_line_3": null,
    "address_line_4": null,
    "zip_code": "30000",
    "city": "New York",
    "state": "New York",
    "phone_number": 3705646546565,
    "country_ison": "004",
    "holder_limit_group_id": 10,
    "email": "email@email.com",
    "date_of_birth": "1989-10-10",
    "industry_id": null,
    "date_of_company_incorporation": null,
    "kyc_completion_level": 0,
    "kyc_document_expiration_date": "2019-10-10",
    "additional_charset_id": null,
    "holder_locale": "en_US"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
id C N Holder id if success.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "id": 1,
    "duplicated": 0
}

Limit

Get

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getLimits",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "record_id": 123456,
    "limit_type": 1,
    "access_level": 0,
    "paginator":{
        "item_count": 1,
        "offset": 0
    }
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getLimits.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
record_id M N 1-20 Depending on the limit type can be card ID, holder ID or account ID.
limit_type M N 1 Limit type
paginator M OBJ Paginator data object.
item_count M N 1-11 Items per page. Max 100.
offset M N 1-11 Index of the first item.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getLimits",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "record_id": 123456,
    "limit_type": 1,
    "access_level": 0,
    "paginator":{
        "item_count": 1,
        "offset": 0
    }
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
data / name C ANS
data / count C N
data / amount C N
data / amount_currency_ison M N
data / duration M N
data / transaction_type_id M N Transaction type
data / entry_mode_type_id M N Entry mode type
data / limits_tx_type_id M N Limit transaction type
data / limits_group_id M N
data / holder_country_ison M N
data / holder_region_id M N
data / transaction_region_id M N
data / region_type_id M N Region type
data / currency_ison M N
data / mcc_low M N Merchant category code.
data / mcc_high M N Merchant category code.
data / date_updated M N Unix timestamp of the last fee update.
paginator M OBJ
data / total_ items_count M N
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "name": "Max_LOAD_pr24h_EUR",
            "count": 1000,
            "amount": 450000,
            "amount_currency_ison": "840",
            "country_count": null,
            "duration": 86400,
            "transaction_type_id": 1,
            "entry_mode_type_id": 0,
            "limits_tx_type_id": 1,
            "limits_group_id": 1,
            "holder_country_ison": "000",
            "holder_region_id": 0,
            "transaction_region_id": 0,
            "region_type_id": 0,
            "currency_ison": "978",
            "mcc_low": 0,
            "mcc_high": 9999,
            "date_updated": 1551942011
        }
    ],
    "paginator": {
        "total_items_count": 20
    },
    "duplicated": 0
}

Get group

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getLimitsGroups",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "limit_type": 1,
    "program_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getLimitsGroups.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
limit_type M N 1 Limit type
program_id O N [1-20]
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getLimitsGroups",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "limit_type": 1,
    "program_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
data C LIST Response data object list. Mandatory if status = success.
data / id M N Limit group id.
data / name M ANS Limit group name.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "id": 2,
            "name": "Test Corporate Standard limits group"
        },
        {
            "id": 3,
            "name": "Test Corporate highest limit group"
        }
    ],
    "duplicated": 0
}

Get status

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getLimitsStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "record_id": 123456,
    "limit_type": 1,
    "access_level": 0, 
    "paginator":{
        "item_count": 1,
        "offset": 0
    }
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getLimitsStatus.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used.
record_id M N 1-20 Depending on limit type can be card ID, holder ID or account ID.
limit_type M N 1 Limit type
paginator M OBJ Paginator data object.
item_count M N 1-11 Items per page. Max 100.
offset M N 1-11 Index of the first item.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getLimitsStatus",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "record_id": 123456,
    "limit_type": 1,
    "access_level": 0, 
    "paginator":{
        "item_count": 1,
        "offset": 0
    }
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
data / name C ANS
data / original_count C N Count was set.
data / count M N Count left.
data / original_amount C N Amount was set.
data / amount M N Amount left.
data / amount_currency_ison M N
data / original_country_count C N Country count was set.
data / country_count M N Country count left.
data / duration M N
data / transaction_type_id M N Transaction type
data / entry_mode_type_id M N Entry mode type
data / limits_tx_type_id M N Limit transaction type
data / limits_group_id M N
data / holder_country_ison M N
data / holder_region_id M N
data / transaction_region_id M N
data / region_type_id M N Region type
data / currency_ison M N
data / mcc_low M N Merchant category code.
data / mcc_high M N Merchant category code.
data / date_updated M N Unix timestamp of the last fee update.
data / date_valid M N Unix timestamp of the limit is valid.
paginator M OBJ
data / total_ items_count M N
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "name": "Max_LOAD_pr24h_USD",
            "original_count": 1000,
            "count": 1000,
            "original_amount": 450000,
            "amount": 0,
            "amount_currency_ison": "840",
            "original_country_count": 0,
            "country_count": 0,
            "duration": 86400,
            "transaction_type_id": 1,
            "entry_mode_type_id": 0,
            "limits_tx_type_id": 1,
            "limits_group_id": 1,
            "holder_country_ison": "000",
            "holder_region_id": 0,
            "transaction_region_id": 0,
            "region_type_id": 0,
            "currency_ison": "840",
            "mcc_low": 0,
            "mcc_high": 9999,
            "date_updated": 1551942011,
            "date_valid": 1552994337
        }
    ],
    "paginator": {
        "total_items_count": 20
    },
    "duplicated": 0
}

Report

Card activity

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardsActivity",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528,
    "date_from": 1546304400,
    "date_to": 1547649027,
    "item_count": 1,
    "last_id": 15472213500540
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getCardsActivity.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used. Access level can impact the returned list size.
card_id O N 1-20 If not provided, returns all of the program manager's cards’ activity.
date_from M N 11 Unix timestamp.
date_to M N 11 Unix timestamp.
item_count M N 1-11 Item per page. Max 100.
last_id O N 20 Last transaction ID, next page transactions list is displayed after entered value.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getCardsActivity",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528,
    "date_from": 1546304400,
    "date_to": 1547649027,
    "item_count": 1,
    "last_id": 15472213500540
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
data / authorize_id M N
data / proc_code M N
data / authorize_type M N Authorization type
data / card_present M N 0 - card not present, 1 - card present.
data / card_id M N
data / trans_link M ANS
data / transmission_date M NS Example.: 2020-11-15.
data / transmission_time M N Unix timestamp.
data / billing_amount M N
data / billing_currency_ison M N
data / billing_conversion_rate M N
data / holder_amount M N
data / holder_currency_ison M N
data / stan M N System Trace Audit Number.
data / transaction_amount M N
data / transaction_currency_ison M N
data / transaction_fee_amount M N
data / auth_code C AN Authorization ID Response.
data / response_code M AN
data / transaction_local_time C AN Transaction time from scheme (format: YYMMDDHHIISS) , example: 181114181211.
data / retrieval_reference_number C AN
data / country_ison C N
data / mcc C N Merchant category code.
data / merchant_name C ANS Card acceptor's name and location.
data / merchant_id C ANS Card acceptor's identification code.
data / terminal_id C ANS Card acceptor's terminal identification.
data / acquirer_id M ANS Acquiring Institution ID.
data / forwarder_id C ANS Forwarding Institution ID.
data / pos_data C ANS Point-of-Service (POS) Data.
data / pos_entry_mode C ANS Point-of-Service (POS) Entry Mode.
data / pos_condition_code C ANS Point-of-Service (POS) Condition Code.
data / reversal M N 1 - reversal, 0 - not reversal.
data / note C ANS
data / trace_id C ANS
data / trace_number C ANS
data / actual M N 1 - actual, 0 - not actual.
data / advice_reason_code C N
data / advice_detail_code C N
data / cashback_amount C N
data / transaction_type C N Transaction type
data / entry_mode_type C N Entry mode type |
data / pad_cumulative_amount C N Calculated padding amount based on the existing padding config. It will be returned if padding is configured and was triggered with that particular transaction.
data / eci_indicator C N ECI indicator
data / settlement_amount C N Value responded from scheme, otherwise value seleted in proccessing if settlement currency selection enabled in program.
data / settlement_currency_ison C N Value responded from scheme, otherwise value seleted in proccessing if settlement currency selection enabled in program.
data / settlement_conversion_rate C N Value responded from scheme, otherwise value seleted in proccessing if settlement currency selection enabled in program.
data / suspicious M N 1 - suspicious, 0 - not suspicious.
data / risk_rule_ids O ANS
data / transaction_fee M N
data / currency_conversion_fee M N
data / risk_actions M LIST Risk rules actions
data / security_checks M LIST Security checks
has_more_records M A Y - has more records to display N - has no more records to display.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "authorize_id": 15472213500541,
            "proc_code": "000000",
            "authorize_type": "AP",
            "card_present": 0,
            "card_id": 123528,
            "trans_link": "385586000000MCCA00016000016190111123471",
            "transmission_date": "2019-01-11",
            "transmission_time": 1547221346,
            "billing_amount": -12,
            "billing_currency_ison": "840",
            "billing_conversion_rate": 1.152945,
            "stan": "000016",
            "transaction_amount": -10,
            "transaction_currency_ison": "978",
            "transaction_fee_amount": 0,
            "auth_code": "385586",
            "response_code": "01",
            "transaction_local_time": "",
            "retrieval_reference_number": "011100000016",
            "country_ison": "076",
            "mcc": "1520",
            "merchant_name": "mer11 Transaction des London BRA",
            "merchant_id": "SHP000000000014",
            "terminal_id": "pa1bra ",
            "acquirer_id": "019780",
            "forwarder_id": "200567",
            "pos_data": "1025104006000076902101234",
            "pos_entry_mode": "810",
            "pos_condition_code": null,
            "reversal": 0,
            "note": "Original billing amount: -12;",
            "trace_id": null,
            "trace_number": "MCCA000160114",
            "actual": 1,
            "advice_reason_code": null,
            "advice_detail_code": null,
            "cashback_amount": 0,
            "transaction_type": 2,
            "entry_mode_type": 3,
            "pad_cumulative_amount": 0,
            "holder_amount": -12,
            "holder_currency_ison": "840",
            "settlement_amount": -10,
            "settlement_currency_ison": "978",
            "settlement_conversion_rate": 1.16,
            "suspicious": 0,
            "risk_rule_ids": null,
            "transaction_fee": 10,
            "currency_conversion_fee": 0,
            "risk_actions": {
                "mark_transaction_as_suspicious": 0,
                "notify_cardholder_by_sending_tais_notification": 0,
                "change_card_status_to_risk": 0,
                "change_account_status_to_suspended": 0,
                "reject_transaction": 0
            },
            "eci_indicator": null,
            "security_checks": {
                "card_expiration_date_present": 0,
                "online_pin": 0,
                "offline_pin": 0,
                "3_d_secure": 0,
                "cvv_2": 0,
                "magnetic_stripe": 1,
                "chip_data": 0,
                "avs": 0,
                "phone_number": 0,
                "signature": 0
            }
        }
    ],
    "has_more_records": "N",
    "duplicated": 0
}

Financial authorizes

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getFinancialAuthorizes",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0, 
    "card_id": 123528,
    "date_from": 1546304400,
    "date_to": 1547649027,
    "item_count": 1,
    "last_id": 15472213500599
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getFinancialAuthorizes.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used. Access level can impact returned list size.
card_id M N 1-20
date_from M N 11 Unix timestamp.
date_to M N 11 Unix timestamp.
item_count M N 1-11 Items per page. Max 100.
last_id O N 20 Last transaction ID, next page transactions list is displayed after entered value.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getFinancialAuthorizes",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0, 
    "card_id": 123528,
    "date_from": 1546304400,
    "date_to": 1547649027,
    "item_count": 1,
    "last_id": 15472213500599
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
data / authorize_id M N
data / proc_code M N
data / card_id M N
data / trans_link M ANS
data / transmission_date M NS Example.: 2020-11-15.
data / transmission_time M N Unix timestamp.
data / billing_amount M N
data / billing_currency_ison M N
data / billing_conversion_rate M N
data / holder_amount M N
data / holder_currency_ison M N
data / settlement_amount C N Value responded from scheme, otherwise value seleted in proccessing if settlement currency selection enabled in program.
data / settlement_currency_ison C N Value responded from scheme, otherwise value seleted in proccessing if settlement currency selection enabled in program.
data / settlement_conversion_rate C N Value responded from scheme, otherwise value seleted in proccessing if settlement currency selection enabled in program.
data / transaction_amount M N
data / transaction_currency_ison M N
data / transaction_fee_amount M N
data / auth_code C AN Authorization ID Response.
data / transaction_local_time C AN Transaction time from scheme (format: YYMMDDHHIISS) , example: 181114181211.
data / mcc C N Merchant category code.
data / cashback_amount C N
data / transaction_type C N Transaction type
data / entry_mode_type C N Entry mode type
data / merchant_name C ANS Card acceptor's name and location.
data / merchant_id C ANS Card acceptor's identification code.
data / terminal_id C ANS Card acceptor's terminal identification.
data / acquirer_id M ANS Acquiring Institution ID.
data / base_conversion_rate M N Base FX rate that was used to convert transaction / billing currency to account currency (FX markup value is not included). Rate may be rounded to two digits after the decimal place.
data / holder_conversion_rate M N base_conversion_rate with applied FX markup (if FX fee was applied). Rate may be rounded to two digits after the decimal place.
data / is_conversion_fee_blended M N 1 - yes (blended to holder_amount), 0 - no.
data / country_ison C N
data / pos_data C ANS Point-of-Service (POS) Data. First authorize.
data / pos_entry_mode C ANS Point-of-Service (POS) Entry Mode. First authorize.
data / note C ANS
data / date_valid C NS Example: 2020-12-17.
data / response_code M AN
data / card_present C N 0 - card not present, 1 - card present.
data / currency_conversion_fee C N Currency conversion fee is added if it exists and is not merged into holder_amount.
data / transaction_fee C N Transaction fee is added, if it exists, and is not supposed to be displayed as a separate transaction.
data / eci_indicator C N ECI indicator
data / suspicious M N 1 - suspicious, 0 - not suspicious.
data / security_checks M LIST Security checks
has_more_records M A Y - has more records to display N - has no more records to display.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "authorize_id": 15472213500600,
            "proc_code": "000000",
            "card_id": 123528,
            "trans_link": "385586000000MCCA00016000016190111123471",
            "transmission_date": "2019-01-11",
            "transmission_time": 1547221346,
            "billing_amount": -12,
            "billing_currency_ison": "840",
            "billing_conversion_rate": 1.152945,
            "settlement_amount": -10,
            "settlement_currency_ison": "978",
            "settlement_conversion_rate": 1.16,
            "transaction_amount": -10,
            "transaction_currency_ison": "978",
            "transaction_fee_amount": 0,
            "auth_code": "385586",
            "transaction_local_time": "",
            "mcc": "1520",
            "cashback_amount": 0,
            "transaction_type": 2,
            "entry_mode_type": 3,
            "merchant_name": "mer11 Transaction des London BRA",
            "merchant_id": "SHP000000000014",
            "terminal_id": "pa1bra ",
            "acquirer_id": "019780",
            "base_conversion_rate": 1,
            "holder_conversion_rate": 1,
            "is_conversion_fee_blended": 0,
            "country_ison": "076",
            "pos_data": "1025104006000076902101234",
            "pos_entry_mode": "810",
            "note": null,
            "eci_indicator": null,
            "suspicious": 0,
            "date_valid": "2019-02-10",
            "card_present": 0,
            "currency_convertion_fee": -500,
            "transaction_fee": -579,
            "holder_amount": -12,
            "holder_currency_ison": "840",
            "security_checks": {
                "card_expiration_date_present": 0,
                "online_pin": 0,
                "offline_pin": 0,
                "3_d_secure": 0,
                "cvv_2": 0,
                "magnetic_stripe": 1,
                "chip_data": 0,
                "avs": 0,
                "phone_number": 0,
                "signature": 0
            }
        }
    ],
    "has_more_records": "Y",
    "duplicated": 0
}

Transactions

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getTransactions",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528,
    "account_id": 123528,
    "date_from": 1546304400,
    "date_to": 1547649027,
    "last_id": 15472143331065,
    "item_count": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getTransactions.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used. Access level can impact returned list size.
card_id C N 1-20 If account ID not provided, card ID must be provided.
account_id C N 1-20 If card ID not provided, account ID must be provided.
date_from C N 11 If transaction ID not provided, Unix timestamp must be provided.
date_to C N 11 If transaction ID not provided, Unix timestamp must be provided.
transaction_id C N 20 If date from and date to not provided, transaction ID must be provided.
item_count M N 1-11 Item per page. Max 100.
last_id O N 20 Last transaction ID, next page transactions list is displayed after entered value.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getTransactions",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "card_id": 123528,
    "account_id": 123528,
    "date_from": 1546304400,
    "date_to": 1547649027,
    "transaction_id": 15472143331066,
    "last_id": 15472143331065,
    "item_count": 1
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
data / transaction_id M N
data / mti M N Message type identifier.
data / card_id C N Can be null if an external payment transaction is performed.
data / account_id M N
data / proc_code M N
data / transaction_amount C N
data / transaction_currency_ison C N
data / reconciliation_amount C N
data / reconciliation_currency_ison C N
data / interchange_rate_designator C N
data / holder_billing_amount C N
data / holder_billing_currency_ison C N
data / transaction_original_amount C N
data / reconciliation_original_amount C N
data / transaction_local_time C AN Transaction time from scheme (format: YYMMDDHHIISS) , example: 181114181211.
data / settlement_date C N Example: 181207.
data / reconciliation_date C N Example: 181207.
data / pos_entry_mode C ANS Point-of-Service (POS) Entry Mode.
data / function_code C N
data / mcc C N Merchant category code.
data / acquirer_bin C N Acquiring Institution Bin.
data / trans_link M ANS
data / acquirer_processing_date C AN
data / acquirer_id C ANS Acquiring Institution ID.
data / forwarder_id C ANS Forwarding Institution ID.
data / merchant_terminal_id C ANS Card acceptor terminal identification.
data / merchant C ANS Card acceptor name and location.
data / merchant_name C ANS Card acceptor name.
data / merchant_address C ANS Card acceptor address.
data / merchant_city C ANS Card acceptor city.
data / merchant_postcode C ANS Card acceptor postcode.
data / merchant_id C ANS Card acceptor identification code.
data / merchant_state C ANS
data / merchant_country C ANS Alpha 3 code.
data / holder_amount C N
data / holder_currency_ison C N
data / transaction_log_id C N
data / reason_code C N
data / auth_code C AN Authorization ID Response.
data / retrieval_reference_number C AN
data / additional_data C ANS
data / transaction_fee_amount C N
data / parent_transaction_id C N
data / load_type C N Load type
data / load_source C N Load source
data / reference_number C ANS
data / description O ANS
data / transaction_type M N Transaction type
data / entry_mode_type M N Entry mode type
data / currency_convertion_fee C N Currency conversion fee is added if it exists and is not merged into the holder_amount.
data / base_conversion_rate M N Base FX rate that was used to convert transaction / billing currency to account currency (FX markup value is not included). Rate may be rounded to two digits after the decimal place.
data / holder_conversion_rate M N base_conversion_rate with applied FX markup (if FX fee was applied). Rate may be rounded to two digits after the decimal place.
data / is_conversion_fee_blended M N 1 - yes (blended to holder_amount), 0 - no.
data / transaction_fee C N Transaction fee is added, if it exists and is not supposed to be displayed as a separate transaction. Mastercard fees are in renconciliation currency, Visa and UnionPay in holder billing currency.
data / eci_indicator C N ECI indicator
data / suspicious M N Possible values: 1 - is suspicious , 0 - is not suspicious.
data / risk_rule_ids O ANS
data / risk_actions M LIST Risk rules actions
data / security_checks M LIST Security checks
has_more_records M A Y - has more records to display N - has no more records to display.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "transaction_id": 15472143331066,
            "mti": "LOCL",
            "card_id": 123528,
            "account_id": 123528,
            "proc_code": "CU0000",
            "transaction_amount": -10000,
            "transaction_currency_ison": "840",
            "reconciliation_amount": null,
            "reconciliation_currency_ison": null,
            "interchange_rate_designator": "75",
            "holder_billing_amount": -10000,
            "holder_billing_currency_ison": "840",
            "transaction_original_amount": 0,
            "reconciliation_original_amount": 0,
            "transaction_local_time": null,
            "settlement_date": "190111",
            "reconciliation_date": null,
            "pos_entry_mode": "021",
            "function_code": 200,
            "mcc": 6011,
            "acquirer_bin": null,
            "trans_link": "1547214333123471CU0000TRANS5C389DFD1636C",
            "acquirer_processing_date": null,
            "acquirer_id": null,
            "forwarder_id": null,
            "merchant_terminal_id": null,
            "merchant": "UNLOAD",
            "merchant_name": "UNLOAD",
            "merchant_address": null,
            "merchant_city": null,
            "merchant_postcode": null,
            "merchant_id": null,
            "merchant_state": null,
            "merchant_country": null,
            "transaction_log_id": null,
            "reason_code": null,
            "auth_code": null,
            "retrieval_reference_number": null,
            "additional_data": null,
            "transaction_fee_amount": 0,
            "parent_transaction_id": null,
            "load_type": null,
            "load_source": null,
            "reference_number": "8b07f30537944896",
            "description": "Money Unload",
            "entry_mode_type": 0,
            "transaction_type": 1,
            "currency_convertion_fee": -500,
            "base_conversion_rate": 1,
            "holder_conversion_rate": 1,
            "is_conversion_fee_blended": 0,
            "suspicious": 0,
            "transaction_fee": -579,
            "eci_indicator": null,
            "holder_amount": -10000,
            "holder_currency_ison": "840",
            "risk_rule_ids": "1,2",
            "risk_actions": {
                "mark_transaction_as_suspicious": 1,
                "notify_cardholder_by_sending_tais_notification": 1,
                "change_card_status_to_risk": 0,
                "change_account_status_to_suspended": 0,
                "reject_transaction": 0
            },
            "security_checks": {
                "card_expiration_date_present": 0,
                "online_pin": 0,
                "offline_pin": 0,
                "3_d_secure": 0,
                "cvv_2": 0,
                "magnetic_stripe": 1,
                "chip_data": 0,
                "avs": 0,
                "phone_number": 0,
                "signature": 0
            }
        }
    ],
    "has_more_records": "Y",
    "duplicated": 0
}

Financial detail addendum

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getFinancialDetailAddendums",
    "api_version": "1.2",
    "date_imported_from": 1546304400,
    "date_imported_to": 1547649027,
    "transaction_id": 15719798993953,
    "item_count": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getFinancialDetailAddendums.
api_version M NS Fixed 1.2.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used. Access level can impact the returned list size.
date_imported_from M N 11 Unix timestamp.
date_imported_to M N 11 Unix timestamp.
transaction_id O N 11
item_count M N 1-11 Item per page. Max 100.
last_id O N 20 Last financial detail addendum ID, next page financial detail addendums list is displayed after entered value.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getFinancialDetailAddendums",
    "api_version": "1.2",
    "date_imported_from": 1546304400,
    "date_imported_to": 1547649027,
    "transaction_id": 15719798993953,
    "item_count": 1
}

Response

Parameter M Type Description
status M A Success / error.
status_code M A Possible error codes Mandatory if status = error.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
data / finnancial_detail_addendum_id M N
data / mti M N Message type identifier.
data / function_code M N
data / acquirer_id M N
data / forwarder_id C N
data / additional_data M OBJ
data / additional_data / originatingMessageFormat M N
data / additional_data / transactionDescription M OBJ
data / additional_data / transactionDescription / usageCode M N
data / additional_data / transactionDescription / industryRecordNumber M N
data / additional_data / transactionDescription / occurrenceIndicator M N
data / additional_data / transactionDescription / associatedFirstPresentmentNumber M N
data / additional_data / customIdentifier M OBJ Applicable for Lodging Summary, Travel Agency Details, Lodged Account Details
data / additional_data / customIdentifier / type M ANS
data / additional_data / customIdentifier / detail M ANS
data / additional_data / travelAgencySequenceNumber M ANS Applicable for Travel Agency Detail
data / additional_data / travelAgencyFee M OBJ Applicable for Travel Agency Detail
data / additional_data / travelAgencyFee / amount M N
data / additional_data / travelAgencyFee / amountExponent M N
data / additional_data / travelAgencyFee / amountSign M A
data / additional_data / travelAgencyFee / amountRate M N
data / additional_data / travelAgencyFee / description M ANS
data / additional_data / passengerName C ANS Applicable for Passenger Transport Detail—General Ticket Information, Passenger Transport Detail—Rail Data
data / additional_data / ticketNumber C ANS Applicable for Passenger Transport Detail—General Ticket Information, Passenger Transport Detail—Rail Data
data / additional_data / issuingCarrier C ANS Not applicable for Passenger Transport Detail—Rail Data
data / additional_data / customerCode C ANS Not applicable for Passenger Transport Detail—Rail Data
data / additional_data / issueDate C N Not applicable for Passenger Transport Detail—Rail Data
data / additional_data / travelAgencyCode C ANS Applicable for Passenger Transport Detail—General Ticket Information, Passenger Transport Detail—Rail Data
data / additional_data / travelAgencyName C ANS Applicable for Passenger Transport Detail—General Ticket Information, Passenger Transport Detail—Rail Data
data / additional_data / totalFare C N Not applicable for Passenger Transport Detail—Rail Data
data / additional_data / totalFees C N Not applicable for Passenger Transport Detail—Rail Data
data / additional_data / totalTaxes C N Not applicable for Passenger Transport Detail—Rail Data
data / additional_data / additionalCardAcceptorInformation C ANS Applicable for Private Label Common Data, Corporate Card Common Data Requirements
data / additional_data / austinTetraNumber C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / naicsCode C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / lineItemDate C N Applicable for Corporate Line Item Detail
data / additional_data / additionalFuelLocationInformation C OBJ Applicable for Corporate Fleet Transaction Information
data / additional_data / additionalFuelLocationInformation / hoursOfOperational24HoursAvailable C A
data / additional_data / additionalFuelLocationInformation / 18WheelerAccessAvailable C A
data / additional_data / additionalFuelLocationInformation / dieselSitesAvailable C A
data / additional_data / additionalFuelLocationInformation / interstateAccessExitNumberWithDirectionsAvailable C A
data / additional_data / additionalFuelLocationInformation / convenienceStoreAvailable C A
data / additional_data / additionalFuelLocationInformation / truckStopRestaurantAvailable C A
data / additional_data / additionalFuelLocationInformation / truckStopHotelAvailable C A
data / additional_data / additionalFuelLocationInformation / truckStopWithShowersAvailable C A
data / additional_data / additionalFuelLocationInformation / vehicleMaintenanceRepairBaysAvailable C A
data / additional_data / additionalFuelLocationInformation / carWashAvailable C A
data / additional_data / additionalFuelLocationInformation / aviationLocationsAvailable C A
data / additional_data / additionalFuelLocationInformation / marinaLocationsAvailable C A
data / additional_data / additionalFuelLocationInformation / alternativeFuelLocationsAvailable C A
data / additional_data / additionalFuelLocationInformation / payAtPumpAvailable C A
data / additional_data / travelDate C N Applicable for Passenger Transport Detail—Rail Data, Passenger Transport Detail—Trip Leg Data
data / additional_data / carrierCode C ANS Applicable for Passenger Transport Detail—Trip Leg Data, Lodging Summary
data / additional_data / serviceClassCode C ANS Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / cityOfOriginAirportCode C ANS Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / cityOfDestinationAirportCode C ANS Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / stopOverCode C ANS Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / conjuctionTicket C ANS Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / exchangeTicket C ANS Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / couponNumber C ANS Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / fareBasisCode C ANS Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / flightNumber C ANS Applicable for Passenger Transport Detail—Trip Leg Data, Lodging Summary
data / additional_data / departureTime C OBJ Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / departureTime / departureTime C N
data / additional_data / departureTime / departureTimeSegment C ANS
data / additional_data / totalCharges C OBJ Applicable for Lodging Summary
data / additional_data / totalCharges / amount C N
data / additional_data / totalCharges / exponent C N
data / additional_data / totalCharges / sign C A
data / additional_data / arrivalTime C OBJ Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / arrivalTime / arrivalTime C N
data / additional_data / arrivalTime / arrivalTimeSegment C ANS
data / additional_data / totalRoomCharges C OBJ Applicable for Lodging Summary
data / additional_data / totalRoomCharges / amount C N
data / additional_data / totalRoomCharges / exponent C N
data / additional_data / totalRoomCharges / sign C A
data / additional_data / Fare C N Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / Fee C N Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / Taxes C N Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / endorsementsRestrictions C ANS Applicable for Passenger Transport Detail—Trip Leg Data
data / additional_data / totalAmountChargedonCreditCard C OBJ Applicable for Lodging Summary
data / additional_data / totalAmountChargedonCreditCard / amount C N
data / additional_data / totalAmountChargedonCreditCard / exponent C N
data / additional_data / totalAmountChargedonCreditCard / sign C A
data / additional_data / roomServiceCharges C OBJ Applicable for Lodging Summary
data / additional_data / roomServiceCharges / amount C N
data / additional_data / roomServiceCharges / exponent C N
data / additional_data / roomServiceCharges / sign C A
data / additional_data / loungeBarCharges C OBJ Applicable for Lodging Summary
data / additional_data / loungeBarCharges / amount C N
data / additional_data / loungeBarCharges / exponent C N
data / additional_data / loungeBarCharges / sign C A
data / additional_data / transportationCharges C OBJ Applicable for Lodging Summary
data / additional_data / transportationCharges / amount C N
data / additional_data / transportationCharges / exponent C N
data / additional_data / transportationCharges / sign C A
data / additional_data / gratuityCharges C OBJ Applicable for Lodging Summary
data / additional_data / gratuityCharges / amount C N
data / additional_data / gratuityCharges / exponent C N
data / additional_data / gratuityCharges / sign C A
data / additional_data / rentalAgreementNumber C ANS Applicable for Vehicle Rental Detail
data / additional_data / renterName C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalReturnCity C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalReturnStateProvince C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalReturnCountry C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalReturnLocationId C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalReturnDate C N Applicable for Vehicle Rental Detail
data / additional_data / rentalReturnCheckoutDate C N Applicable for Vehicle Rental Detail
data / additional_data / customerServiceTollFreeNumber C ANS Applicable for Vehicle Rental Detail, Lodging Summary
data / additional_data / rentalRate C OBJ Applicable for Vehicle Rental Detail
data / additional_data / rentalRate / rentalRateIndicator C ANS
data / additional_data / rentalRate / rentalRate C N
data / additional_data / conferenceRoomCharges C OBJ Applicable for Lodging Summary
data / additional_data / conferenceRoomCharges / amount C N
data / additional_data / conferenceRoomCharges / exponent C N
data / additional_data / conferenceRoomCharges / sign C A
data / additional_data / ratePerMileOrKilometer C N Applicable for Vehicle Rental Detail
data / additional_data / totalMilesOrKilometers C N Applicable for Vehicle Rental Detail
data / additional_data / maximumFreeMilesOrKilometers C N Applicable for Vehicle Rental Detail
data / additional_data / milesKilometersIndicator C ANS Applicable for Vehicle Rental Detail
data / additional_data / vehicleInsurance C OBJ Applicable for Vehicle Rental Detail
data / additional_data / audioVisualCharges C OBJ Applicable for Lodging Summary
data / additional_data / audioVisualCharges / amount C N
data / additional_data / audioVisualCharges / exponent C N
data / additional_data / audioVisualCharges / sign C A
data / additional_data / adjustedAmount C OBJ Applicable for Vehicle Rental Detail
data / additional_data / adjustedAmount / adjustedAmountIndicator C ANS
data / additional_data / adjustedAmount / adjustedAmount C N
data / additional_data / banquetCharges C OBJ Applicable for Lodging Summary
data / additional_data / banquetCharges / amount C N
data / additional_data / banquetCharges / exponent C N
data / additional_data / banquetCharges / sign C A
data / additional_data / programCode C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalLocationCity C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalLocationStateProvince C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalLocationCountry C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalLocationId C ANS Applicable for Vehicle Rental Detail
data / additional_data / rentalClassId C ANS Applicable for Vehicle Rental Detail
data / additional_data / internetAccessCharges C OBJ Applicable for Lodging Summary
data / additional_data / internetAccessCharges / amount C N
data / additional_data / internetAccessCharges / exponent C N
data / additional_data / internetAccessCharges / sign C A
data / additional_data / earlyDepartureCharges C OBJ Applicable for Lodging Summary
data / additional_data / earlyDepartureCharges / amount C N
data / additional_data / earlyDepartureCharges / exponent C N
data / additional_data / earlyDepartureCharges / sign C A
data / additional_data / guestName C ANS Applicable for Lodging Summary
data / additional_data / guestNumber C ANS Applicable for Lodging Summary
data / additional_data / invoiceNumber C ANS Applicable for Electronic Invoice—Transaction Data
data / additional_data / arrivalDate C N Applicable for Lodging Summary
data / additional_data / departureDate C N Applicable for Lodging Summary
data / additional_data / folioNumber C ANS Applicable for Lodging Summary
data / additional_data / propertyPhoneNumber C ANS Applicable for Lodging Summary
data / additional_data / billingAdjustment C OBJ Applicable for Lodging Summary
data / additional_data / billingAdjustment / indicator C ABS
data / additional_data / billingAdjustment / amount C N
data / additional_data / billingAdjustment / exponent C N
data / additional_data / billingAdjustment / sign C A
data / additional_data / invoiceDate C N Applicable for Electronic Invoice—Transaction Data
data / additional_data / roomRate C OBJ Applicable for Lodging Summary
data / additional_data / roomRate / amount C N
data / additional_data / roomRate / exponent C N
data / additional_data / totalRoomTax C OBJ Applicable for Lodging Summary
data / additional_data / totalRoomTax / amount C N
data / additional_data / totalRoomTax / exponent C N
data / additional_data / totalRoomTax / sign C A
data / additional_data / programCode C ANS Applicable for Lodging Summary
data / additional_data / phoneCharges C OBJ Applicable for Lodging Summary
data / additional_data / phoneCharges / amount C N
data / additional_data / phoneCharges / exponent C N
data / additional_data / phoneCharges / sign C A
data / additional_data / restaurantCharges C OBJ Applicable for Lodging Summary
data / additional_data / restaurantCharges / amount C N
data / additional_data / restaurantCharges / exponent C N
data / additional_data / restaurantCharges / sign C A
data / additional_data / miniBarCharges C OBJ Applicable for Lodging Summary
data / additional_data / miniBarCharges / amount C N
data / additional_data / miniBarCharges / exponent C N
data / additional_data / miniBarCharges / sign C A
data / additional_data / giftShopCharges C OBJ Applicable for Lodging Summary
data / additional_data / giftShopCharges / amount C N
data / additional_data / giftShopCharges / exponent C N
data / additional_data / giftShopCharges / sign C A
data / additional_data / laundryAndDryCleaningCharges C OBJ Applicable for Lodging Summary
data / additional_data / laundryAndDryCleaningCharges / amount C N
data / additional_data / laundryAndDryCleaningCharges / exponent C N
data / additional_data / laundryAndDryCleaningCharges / sign C A
data / additional_data / otherServices C OBJ Applicable for Lodging Summary
data / additional_data / otherServices / code C ANS
data / additional_data / otherServices / amount C N
data / additional_data / otherServices / exponent C N
data / additional_data / otherServices / sign C A
data / additional_data / invoiceCreationDateAndTime C OBJ Applicable for Electronic Invoice—Transaction Data
data / additional_data / invoiceCreationDateAndTime / date C N YYMMDD
data / additional_data / invoiceCreationDateAndTime / time C N HHMMSS
data / additional_data / partyIdentification C AN Applicable for Electronic Invoice—Party Information
data / additional_data / partyName C OBJ Applicable for Electronic Invoice—Party Information
data / additional_data / partyName / partyName C ANS
data / additional_data / partyName / partyName2 C ANS
data / additional_data / partyName / partyName3 C ANS
data / additional_data / partyAddress C OBJ Applicable for Electronic Invoice—Party Information
data / additional_data / partyAddress / partyAddressLine C ANS
data / additional_data / partyAddress / partyAddressLine2 C ANS
data / additional_data / partyAddress / partyAddressLine3 C ANS
data / additional_data / partyAddress / partyAddressLine4 C ANS
data / additional_data / partyAddress / partyAddressLine5 C ANS
data / additional_data / partyAddress / partyAddressLine6 C ANS
data / additional_data / partyPostalInformation C OBJ Applicable for Electronic Invoice—Party Information
data / additional_data / partyPostalInformation / city C ANS
data / additional_data / partyPostalInformation / stateProvinceCode C ANS
data / additional_data / partyPostalInformation / countryCode C ANS
data / additional_data / partyPostalInformation / postalCode C ANS
data / additional_data / partyContact C OBJ Applicable for Electronic Invoice—Party Information
data / additional_data / partyContact / partyContactDescriptor C N
data / additional_data / partyContact / partyContactInformation C ANS
data / additional_data / partyContact / partyContactDescriptor2 C N
data / additional_data / partyContact / partyContactInformation2 C ANS
data / additional_data / partyContact / partyContactDescriptor3 C N
data / additional_data / partyContact / partyContactInformation3 C ANS
data / additional_data / partyContact / partyContactDescriptor4 C N
data / additional_data / partyContact / partyContactInformation4 C ANS
data / additional_data / partyContact / partyContactDescriptor5 C N
data / additional_data / partyContact / partyContactInformation5 C ANS
data / additional_data / cardAcceptorType C OBJ Applicable for Corporate Card Common Data Requirements
data / additional_data / cardAcceptorType / businessType C ANS
data / additional_data / cardAcceptorType / businessOwnerType C ANS
data / additional_data / cardAcceptorType / businessCertificationType C ANS
data / additional_data / cardAcceptorType / businessRacialEthnicType C ANS
data / additional_data / cardAcceptorType / businessTypeProvidedCode C ANS
data / additional_data / cardAcceptorType / businessOwnerTypeProvidedCode C ANS
data / additional_data / cardAcceptorType / businessCertificationTypeProvidedCode C ANS
data / additional_data / cardAcceptorType / businessRacialEthnicTypeProvidedCode C ANS
data / additional_data / cardAcceptorTaxId C OBJ Applicable for Corporate Card Common Data Requirements
data / additional_data / cardAcceptorTaxId / taxId C ANS
data / additional_data / cardAcceptorTaxId / taxIdProvidedCode C ANS
data / additional_data / totalTaxAmount C OBJ Not applicable -forPassenger Transport Detail—Rail Data
data / additional_data / totalTaxAmount / amount C N
data / additional_data / totalTaxAmount / exponent C N
data / additional_data / totalTaxAmount / sign C A
data / additional_data / totalTaxCollectedIndicator C ANS Not applicable for Passenger Transport Detail—Rail Data
data / additional_data / corporateVatNumber C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / cardAcceptorReferenceNumber C ANS Applicable for Private Label Common Data, Corporate Card Common Data Requirements
data / additional_data / partyNatureOfFilling C A Applicable for Electronic Invoice—Party Information
data / additional_data / partySuplementalData1 C OBJ Applicable for Electronic Invoice—Party Information
data / additional_data / partySuplementalData1 / partySupplementalDataDescription C ANS
data / additional_data / partySuplementalData1 / partySupplementalData C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataCode C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataDescription2 C ANS
data / additional_data / partySuplementalData1 / partySupplementalData2 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataCode2 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataDescription3 C ANS
data / additional_data / partySuplementalData1 / partySupplementalData3 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataCode3 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataDescription4 C ANS
data / additional_data / partySuplementalData1 / partySupplementalData4 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataCode4 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataDescription5 C ANS
data / additional_data / partySuplementalData1 / partySupplementalData5 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataCode5 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataDescription6 C ANS
data / additional_data / partySuplementalData1 / partySupplementalData6 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataCode6 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataDescription7 C ANS
data / additional_data / partySuplementalData1 / partySupplementalData7 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataCode7 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataDescription8 C ANS
data / additional_data / partySuplementalData1 / partySupplementalData8 C ANS
data / additional_data / partySuplementalData1 / partySupplementalDataCode8 C ANS
data / additional_data / partySuplementalData2 C OBJ Applicable for Electronic Invoice—Party Information
data / additional_data / partySuplementalData2 / partySupplementalDataDescription C ANS
data / additional_data / partySuplementalData2 / partySupplementalData C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataCode C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataDescription2 C ANS
data / additional_data / partySuplementalData2 / partySupplementalData2 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataCode2 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataDescription3 C ANS
data / additional_data / partySuplementalData2 / partySupplementalData3 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataCode3 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataDescription4 C ANS
data / additional_data / partySuplementalData2 / partySupplementalData4 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataCode4 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataDescription5 C ANS
data / additional_data / partySuplementalData2 / partySupplementalData5 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataCode5 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataDescription6 C ANS
data / additional_data / partySuplementalData2 / partySupplementalData6 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataCode6 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataDescription7 C ANS
data / additional_data / partySuplementalData2 / partySupplementalData7 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataCode7 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataDescription8 C ANS
data / additional_data / partySuplementalData2 / partySupplementalData8 C ANS
data / additional_data / partySuplementalData2 / partySupplementalDataCode8 C ANS
data / additional_data / transactionSuplementalData1 C OBJ Applicable for Electronic Invoice—Transaction Data
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataDescription C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalData C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataCode C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataDescription2 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalData2 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataCode2 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataDescription3 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalData3 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataCode3 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataDescription4 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalData4 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataCode4 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataDescription5 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalData5 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataCode5 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataDescription6 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalData6 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataCode6 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataDescription7 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalData7 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataCode7 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataDescription8 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalData8 C ANS
data / additional_data / transactionSuplementalData1 / transactionSupplementalDataCode8 C ANS
data / additional_data / transactionSuplementalData2 C OBJ Applicable for Electronic Invoice—Transaction Data
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataDescription C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalData C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataCode C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataDescription2 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalData2 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataCode2 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataDescription3 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalData3 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataCode3 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataDescription4 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalData4 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataCode4 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataDescription5 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalData5 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataCode5 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataDescription6 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalData6 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataCode6 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataDescription7 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalData7 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataCode7 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataDescription8 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalData8 C ANS
data / additional_data / transactionSuplementalData2 / transactionSupplementalDataCode8 C ANS
data / additional_data / freightAmount C OBJ Applicable for Corporate Card Common Data Requirements
data / additional_data / freightAmount / amount C N
data / additional_data / freightAmount / exponent C N
data / additional_data / freightAmount / sign C A
data / additional_data / dutyAmount C OBJ Applicable for Corporate Card Common Data Requirements
data / additional_data / dutyAmount / amount C N
data / additional_data / dutyAmount / exponent C N
data / additional_data / dutyAmount / sign C A
data / additional_data / destinationPostalCode C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / destinationStateProvinceCode C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / destinationCountryCode C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / sequenceNumber C ANS Applicable for Passenger Transport Detail—Rail Data
data / additional_data / shipDate C N Applicable for Private Label Line Item Detail, Corporate Line Item Detail, format: YYMMDD
data / additional_data / shipFromPostalCode C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / orderDate C N Applicable for Private Label Common Data, Private Label Line Item Detail, Corporate Card Common Data Requirements, Corporate Line Item Detail, format: YYMMDD
data / additional_data / medicalServicesShipToHealthIndustry C ANS Applicable for Corporate Line Item Detail
data / additional_data / contractNumber C ANS Applicable for Corporate Line Item Detail
data / additional_data / medicalServicesPriceAdjustment C A Applicable for Corporate Line Item Detail
data / additional_data / medicalServicesProductNumberQualifier C AN Applicable for Corporate Line Item Detail
data / additional_data / userName C ANS Applicable for Telephony Billing—Summary
data / additional_data / oilCompanyBrandName C N Applicable for Corporate Fleet Transaction Information
data / additional_data / purchaseTime C N Applicable for Corporate Fleet Transaction Information, format: HHMM
data / additional_data / motorFuelServiceType C ANS Applicable for Corporate Fleet Transaction Information
data / additional_data / motorFuelInformation C OBJ Applicable for Private Label Common Data, Corporate Fleet Transaction Information
data / additional_data / motorFuelInformation / productCode C N
data / additional_data / motorFuelInformation / unitPrice C N
data / additional_data / motorFuelInformation / unitOfMeasure C NS
data / additional_data / motorFuelInformation / quantity C N
data / additional_data / motorFuelInformation / quantityExponent C N
data / additional_data / motorFuelInformation / saleAmount C N
data / additional_data / userAccountNumber C ANS Applicable for Telephony Billing—Summary
data / additional_data / userTelephoneNumber C ANS Applicable for Telephony Billing—Summary
data / additional_data / billingStatementPeriod C OBJ Applicable for Telephony Billing—Summary
data / additional_data / billingStatementPeriod / statementStartDate C N Format: YYMMDD
data / additional_data / billingStatementPeriod / statementEndDate C N Format: YYMMDD
data / additional_data / billingEvent1 C OBJ Applicable for Telephony Billing—Summary
data / additional_data / billingEvent1 / amount C N
data / additional_data / billingEvent1 / exponent C N
data / additional_data / billingEvent1 / sign C A
data / additional_data / billingEvent1 / description C ANS
data / additional_data / billingEvent1 / amount2 C N
data / additional_data / billingEvent1 / exponent2 C N
data / additional_data / billingEvent1 / sign2 C A
data / additional_data / billingEvent1 / description2 C ANS
data / additional_data / billingEvent1 / amount3 C N
data / additional_data / billingEvent1 / exponent3 C N
data / additional_data / billingEvent1 / sign3 C A
data / additional_data / billingEvent1 / description3 C ANS
data / additional_data / billingEvent1 / amount4 C N
data / additional_data / billingEvent1 / exponent4 C N
data / additional_data / billingEvent1 / sign4 C A
data / additional_data / billingEvent1 / description4 C ANS
data / additional_data / billingEvent1 / amount5 C N
data / additional_data / billingEvent1 / exponent5 C N
data / additional_data / billingEvent1 / sign5 C A
data / additional_data / billingEvent1 / description5 C ANS
data / additional_data / billingEvent1 / amount6 C N
data / additional_data / billingEvent1 / exponent6 C N
data / additional_data / billingEvent1 / sign6 C A
data / additional_data / billingEvent1 / description6 C ANS
data / additional_data / billingEvent1 / amount7 C N
data / additional_data / billingEvent1 / exponent7 C N
data / additional_data / billingEvent1 / sign7 C A
data / additional_data / billingEvent1 / description7 C ANS
data / additional_data / billingEvent1 / amount8 C N
data / additional_data / billingEvent1 / exponent8 C N
data / additional_data / billingEvent1 / sign8 C A
data / additional_data / billingEvent1 / description8 C ANS
data / additional_data / billingEvent1 / amount9 C N
data / additional_data / billingEvent1 / exponent9 C N
data / additional_data / billingEvent1 / sign9 C A
data / additional_data / billingEvent1 / description9 C ANS
data / additional_data / billingEvent1 / amount10 C N
data / additional_data / billingEvent1 / exponent10 C N
data / additional_data / billingEvent1 / sign10 C A
data / additional_data / billingEvent1 / description10 C ANS
data / additional_data / billingEvent2 C OBJ Applicable for Telephony Billing—Summary
data / additional_data / billingEvent2 / amount C N
data / additional_data / billingEvent2 / exponent C N
data / additional_data / billingEvent2 / sign C A
data / additional_data / billingEvent2 / description C ANS
data / additional_data / billingEvent2 / amount2 C N
data / additional_data / billingEvent2 / exponent2 C N
data / additional_data / billingEvent2 / sign2 C A
data / additional_data / billingEvent2 / description2 C ANS
data / additional_data / billingEvent2 / amount3 C N
data / additional_data / billingEvent2 / exponent3 C N
data / additional_data / billingEvent2 / sign3 C A
data / additional_data / billingEvent2 / description3 C ANS
data / additional_data / billingEvent2 / amount4 C N
data / additional_data / billingEvent2 / exponent4 C N
data / additional_data / billingEvent2 / sign4 C A
data / additional_data / billingEvent2 / description4 C ANS
data / additional_data / billingEvent2 / amount5 C N
data / additional_data / billingEvent2 / exponent5 C N
data / additional_data / billingEvent2 / sign5 C A
data / additional_data / billingEvent2 / description5 C ANS
data / additional_data / billingEvent2 / amount6 C N
data / additional_data / billingEvent2 / exponent6 C N
data / additional_data / billingEvent2 / sign6 C A
data / additional_data / billingEvent2 / description6 C ANS
data / additional_data / billingEvent2 / amount7 C N
data / additional_data / billingEvent2 / exponent7 C N
data / additional_data / billingEvent2 / sign7 C A
data / additional_data / billingEvent2 / description7 C ANS
data / additional_data / billingEvent2 / amount8 C N
data / additional_data / billingEvent2 / exponent8 C N
data / additional_data / billingEvent2 / sign8 C A
data / additional_data / billingEvent2 / description8 C ANS
data / additional_data / billingEvent2 / amount9 C N
data / additional_data / billingEvent2 / exponent9 C N
data / additional_data / billingEvent2 / sign9 C A
data / additional_data / billingEvent2 / description9 C ANS
data / additional_data / billingEvent2 / amount10 C N
data / additional_data / billingEvent2 / exponent10 C N
data / additional_data / billingEvent2 / sign10 C A
data / additional_data / billingEvent2 / description10 C ANS
data / additional_data / odometerReading C ANS Applicable for Private Label Common Data, Corporate Fleet Transaction Information
data / additional_data / vehicleNumber C ANS Applicable for Corporate Fleet Transaction Information
data / additional_data / driverNumberIdNumber C ANS Applicable for Private Label Common Data, Corporate Fleet Transaction Information
data / additional_data / productTypeCode C N Applicable for Corporate Fleet Transaction Information
data / additional_data / couponDiscountAmount C N Applicable for Corporate Fleet Transaction Information
data / additional_data / taxAmount1 C N Applicable for Private Label Common Data, Corporate Fleet Transaction Information
data / additional_data / taxAmount2 C N Applicable for Private Label Common Data, Corporate Fleet Transaction Information
data / additional_data / callDate C N Applicable for Telephony Billing—Detail, format YYMMDD
data / additional_data / callTime C N Applicable for Telephony Billing—Detail, format HHMMSS
data / additional_data / callToInformation C OBJ Applicable for Telephony Billing—Detail
data / additional_data / callToInformation / callToCity C ANS
data / additional_data / callToInformation / callToState C ANS
data / additional_data / callToInformation / callToCountry C ANS
data / additional_data / callToInformation / callToNumber C ANS
data / additional_data / callToInformation / callToType C AN
data / additional_data / callDuration C N Applicable for Telephony Billing—Detail, format: HHMMSS
data / additional_data / callTimePeriod C AN Applicable for Telephony Billing—Detail
data / additional_data / productCode C ANS Applicable for Private Label Line Item Detail, Corporate Line Item Detail
data / additional_data / itemDescription C ANS Applicable for Private Label Line Item Detail, Healthcare, Corporate Line Item Detail
data / additional_data / itemQuantity C OBJ Applicable for Private Label Line Item Detail, Healthcare, Corporate Line Item Detail
data / additional_data / itemQuantity / itemQuantity C N
data / additional_data / itemQuantity / itemQuantityExponent C N
data / additional_data / callFromInformation C OBJ Applicable for Telephony Billing—Detail
data / additional_data / callToInformation / callFromCity C ANS
data / additional_data / callToInformation / callFromState C ANS
data / additional_data / callToInformation / callFromCountry C ANS
data / additional_data / callToInformation / callFromNumber C ANS
data / additional_data / itemUnitOfMeasure C ANS Applicable for Private Label Line Item Detail, Corporate Line Item Detail
data / additional_data / unitPrice C OBJ Applicable for Private Label Line Item Detail, Healthcare, Corporate Line Item Detail
data / additional_data / unitPrice /unitPrice C N
data / additional_data / unitPrice /unitPriceExponent C N
data / additional_data / extendedItemAmount C OBJ Applicable for Private Label Line Item Detail, Corporate Line Item Detail
data / additional_data / extendedItemAmount / amount C N
data / additional_data / extendedItemAmount / exponent C N
data / additional_data / extendedItemAmount / sign C A
data / additional_data / itemDiscount C OBJ Applicable for Corporate Line Item Detail
data / additional_data / itemDiscount / discountIndicator C ANS
data / additional_data / itemDiscount / discountAmount C ANS
data / additional_data / itemDiscount / itemDiscountRate C N
data / additional_data / itemDiscount / itemDiscountRateExponent C N
data / additional_data / itemDiscount / itemDiscountAmountSign C A
data / additional_data / callUsageAmount C OBJ Applicable for Telephony Billing—Detail
data / additional_data / callUsageAmount / amount C N
data / additional_data / callUsageAmount / exponent C N
data / additional_data / callUsageAmount / sign C A
data / additional_data / zeroCostToCustomerIndicator C A Applicable for Corporate Line Item Detail
data / additional_data / procedureId C ANS Applicable for Passenger Transport Detail—Rail Data
data / additional_data / serviceType C OBJ Applicable for Passenger Transport Detail—Rail Data
data / additional_data / serviceType / serviceType C ANS
data / additional_data / serviceType / serviceNature C ANS
data / additional_data / serviceAmount C OBJ Applicable for Passenger Transport Detail—Rail Data
data / additional_data / serviceAmount / amount C N
data / additional_data / serviceAmount / exponent C N
data / additional_data / serviceAmount / sign C A
data / additional_data / debitOrCreditIndicator C AN Applicable for Corporate Line Item Detail
data / additional_data / callLongDistanceAmount C OBJ Applicable for Telephony Billing—Detail
data / additional_data / callLongDistanceAmount / amount C N
data / additional_data / callLongDistanceAmount / exponent C N
data / additional_data / callLongDistanceAmount / sign C A
data / additional_data / fullVatAmounts C OBJ Applicable for Passenger Transport Detail—Rail Data
data / additional_data / fullVatAmounts / grossAmount C N
data / additional_data / fullVatAmounts / grossExponent C N
data / additional_data / fullVatAmounts / grossSign C A
data / additional_data / fullVatAmounts / taxAmount C N
data / additional_data / fullVatAmounts / taxExponent C N
data / additional_data / fullVatAmounts / taxSign C A
data / additional_data / halfVatAmounts C OBJ Applicable for Passenger Transport Detail—Rail Data
data / additional_data / halfVatAmounts / grossAmount C N
data / additional_data / halfVatAmounts / grossExponent C N
data / additional_data / halfVatAmounts / grossSign C A
data / additional_data / halfVatAmounts / taxAmount C N
data / additional_data / halfVatAmounts / taxExponent C N
data / additional_data / halfVatAmounts / taxSign C A
data / additional_data / callConnectAmount C OBJ Applicable for Telephony Billing—Detail
data / additional_data / callConnectAmount / amount C N
data / additional_data / callConnectAmount / exponent C N
data / additional_data / callConnectAmount / sign C A
data / additional_data / otherDescription C ANS Applicable for Telephony Billing—Detail
data / additional_data / customerReference C OBJ Applicable for Lodged Account Detail
data / additional_data / customerReference / valueId C N
data / additional_data / customerReference / valueDetail C ANS
data / additional_data / trafficCode C N Applicable for Passenger Transport Detail—Rail Data
data / additional_data / sampleNumber C N Applicable for Passenger Transport Detail—Rail Data
data / additional_data / freeFormDescription C ANS Applicable for Generic Detail
data / additional_data / startStation C ANS Applicable for Passenger Transport Detail—Rail Data
data / additional_data / destinationStation C ANS Applicable for Passenger Transport Detail—Rail Data
data / additional_data / genericData C OBJ Applicable for Passenger Transport Detail—Rail Data
data / additional_data / genericData / code C N
data / additional_data / genericData / number C ANS
data / additional_data / genericData / otherCode C N
data / additional_data / genericData / otherNumber C ANS
data / additional_data / reductionData C OBJ Applicable for Passenger Transport Detail—Rail Data
data / additional_data / reductionData / code C N
data / additional_data / reductionData / number C ANS
data / additional_data / reductionData / otherCode C N
data / additional_data / reductionData / otherNumber C ANS
data / additional_data / transportationOtherCode C N Applicable for Passenger Transport Detail—Rail Data
data / additional_data / payerNameOrUserId C OBJ Applicable for Payment Transaction Detail
data / additional_data / payerNameOrUserId / payerNameUserId C ANS
data / additional_data / payerNameOrUserId / payerAddress C ANS
data / additional_data / payerNameOrUserId / payerCity C ANS
data / additional_data / payerNameOrUserId / payerStateCode C ANS
data / additional_data / payerNameOrUserId / payerCountryCode C ANS
data / additional_data / payerNameOrUserId / payerPostalCode C ANS
data / additional_data / payerNameOrUserId / payerDateOfBirth C N format: MMDDYYYY
data / additional_data / dateOfFundsRequested C N Applicable for Payment Transaction Detail, format: YYMMDD
data / additional_data / dateOfAnticipatedReceiptOfFunds C ANS Applicable for Payment Transaction Detail
data / additional_data / additionalTraceReferenceNumberUsedByCardAcceptor C ANS Applicable for Payment Transaction Detail, Private Label Common Data
data / additional_data / additionalTransactionDescriptionData C ANS Applicable for Payment Transaction Detail
data / additional_data / cardAcceptorVatNumber C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / customerVatNumber C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / uniqueInvoiceNumber C ANS Applicable for Private Label Common Data, Corporate Card Common Data Requirements
data / additional_data / CommodityCode C ANS
data / additional_data / authorizedContactName C ANS Applicable for Private Label Common Data, Corporate Card Common Data Requirements
data / additional_data / authorizedContactPhone C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / detailTaxAmount1 C OBJ
data / additional_data / detailTaxAmount1 / detailTaxAmountIndicator C ANS
data / additional_data / detailTaxAmount1 / detailTaxAmount C ANS
data / additional_data / detailTaxAmount1 / detailTaxRate C ANS
data / additional_data / detailTaxAmount1 / detailTaxRateExponent C ANS
data / additional_data / detailTaxAmount1 / detailTaxTypeApplied C ANS
data / additional_data / detailTaxAmount1 / detailTaxTypeIdentifier C ANS
data / additional_data / detailTaxAmount1 / cardAcceptorTaxId C ANS
data / additional_data / detailTaxAmount1 / detailTaxAmountSign C ANS
data / additional_data / detailTaxAmount2 C OBJ
data / additional_data / detailTaxAmount2 / detailTaxAmountIndicator C ANS
data / additional_data / detailTaxAmount2 / detailTaxAmount C ANS
data / additional_data / detailTaxAmount2 / detailTaxRate C ANS
data / additional_data / detailTaxAmount2 / detailTaxRateExponent C ANS
data / additional_data / detailTaxAmount2 / detailTaxTypeApplied C ANS
data / additional_data / detailTaxAmount2 / detailTaxTypeIdentifier C ANS
data / additional_data / detailTaxAmount2 / cardAcceptorTaxId C ANS
data / additional_data / detailTaxAmount2 / detailTaxAmountSign C ANS
data / additional_data / detailTaxAmount3 C OBJ
data / additional_data / detailTaxAmount3 / detailTaxAmountIndicator C ANS
data / additional_data / detailTaxAmount3 / detailTaxAmount C ANS
data / additional_data / detailTaxAmount3 / detailTaxRate C ANS
data / additional_data / detailTaxAmount3 / detailTaxRateExponent C ANS
data / additional_data / detailTaxAmount3 / detailTaxTypeApplied C ANS
data / additional_data / detailTaxAmount3 / detailTaxTypeIdentifier C ANS
data / additional_data / detailTaxAmount3 / cardAcceptorTaxId C ANS
data / additional_data / detailTaxAmount3 / detailTaxAmountSign C ANS
data / additional_data / typeOfSupply C AN Applicable for Corporate Line Item Detail
data / additional_data / taxExemptIndicator C AN
data / additional_data / uniqueVatInvoiceRefenreceNumber C ANS Applicable for Corporate Line Item Detail
data / additional_data / cardAcceptorContactEmailAddress C ANS Applicable for Corporate Card Common Data Requirements
data / additional_data / corporateIdentifier C ANS Applicable for Vehicle Rental Detail
data / additional_data / noShowIndicator C AN Applicable for Vehicle Rental Detail, Lodging Summary
data / additional_data / daysRented C N Applicable for Vehicle Rental Detail
data / additional_data / weeklyRentalAmount C N Applicable for Vehicle Rental Detail
data / additional_data / totalAuthorizedAmount C OBJ Applicable for Vehicle Rental Detail, Lodging Summary
data / additional_data / totalAuthorizedAmount / amount C N
data / additional_data / totalAuthorizedAmount / exponent C N
data / additional_data / totalAuthorizedAmount / sign C A
data / additional_data / oneWayDropOffCharge C N Applicable for Vehicle Rental Detail
data / additional_data / regularMileageCharge C N Applicable for Vehicle Rental Detail
data / additional_data / extraMileageCharge C N Applicable for Vehicle Rental Detail
data / additional_data / lateCharge C N Applicable for Vehicle Rental Detail
data / additional_data / fuelCharge C N Applicable for Vehicle Rental Detail
data / additional_data / totalTaxAmount C OBJ Applicable for Lodging Summary
data / additional_data / totalTaxAmount / amount C N
data / additional_data / totalTaxAmount / exponent C N
data / additional_data / totalTaxAmount / sign C A
data / additional_data / towingCharges C N Applicable for Vehicle Rental Detail
data / additional_data / extraCharges C N Applicable for Vehicle Rental Detail
data / additional_data / otherCharges C N Applicable for Vehicle Rental Detail
data / additional_data / totalRoomNights C N Applicable for Lodging Summary
data / additional_data / prepaidExpenses C OBJ Applicable for Lodging Summary
data / additional_data / prepaidExpenses / amount C N
data / additional_data / prepaidExpenses / exponent C N
data / additional_data / prepaidExpenses / sign C A
data / additional_data / totalNonRoomTaxAmount C OBJ Applicable for Lodging Summary
data / additional_data / totalNonRoomTaxAmount / amount C N
data / additional_data / totalNonRoomTaxAmount / exponent C N
data / additional_data / totalNonRoomTaxAmount / sign C A
data / additional_data / cashAdvances C OBJ Applicable for Lodging Summary
data / additional_data / cashAdvances / amount C N
data / additional_data / cashAdvances / exponent C N
data / additional_data / cashAdvances / sign C A
data / additional_data / cashAdvances C OBJ Applicable for Lodging Summary
data / additional_data / cashAdvances / amount C N
data / additional_data / cashAdvances / exponent C N
data / additional_data / cashAdvances / sign C A
data / additional_data / valetCharges C OBJ Applicable for Lodging Summary
data / additional_data / valetCharges / amount C N
data / additional_data / valetCharges / exponent C N
data / additional_data / valetCharges / sign C A
data / additional_data / movieCharges C OBJ Applicable for Lodging Summary
data / additional_data / movieCharges / amount C N
data / additional_data / movieCharges / exponent C N
data / additional_data / movieCharges / sign C A
data / additional_data / businessCenterCharges C OBJ Applicable for Lodging Summary
data / additional_data / businessCenterCharges / amount C N
data / additional_data / businessCenterCharges / exponent C N
data / additional_data / businessCenterCharges / sign C A
data / additional_data / healthClubCharges C OBJ Applicable for Lodging Summary
data / additional_data / healthClubCharges / amount C N
data / additional_data / healthClubCharges / exponent C N
data / additional_data / healthClubCharges / sign C A
data / additional_data / fireSafetyActIndicator C AN Applicable for Lodging Summary
data / additional_data / netFuelPrice C OBJ Applicable for Corporate Fleet Transaction Information
data / additional_data / netFuelPrice / price C N
data / additional_data / netFuelPrice / exponent C N
data / additional_data / restrictedTicketIndicator C AN
data / additional_data / exchangeTickedAmount C N
data / additional_data / ancillaryServiceCharges C OBJ
data / additional_data / ancillaryServiceCharges / ancillaryFeeCode C A
data / additional_data / ancillaryServiceCharges / ancillaryFeeAmount C N
data / additional_data / travelAuthorizationCode C ANS
data / additional_data / iataClientCode C ANS
data / additional_data / employeeTempNameId C ANS Applicable for Temporary Services
data / additional_data / employeeSocialSecurityNumberOrId C ANS Applicable for Temporary Services
data / additional_data / jobDescription C ANS Applicable for Temporary Services, Private Label Common Data
data / additional_data / jobCode C ANS Applicable for Temporary Services
data / additional_data / flatRateIndicator C AN Applicable for Temporary Services
data / additional_data / regularHoursWorked C OBJ Applicable for Temporary Services
data / additional_data / regularHoursWorked / regularHoursWorked C N
data / additional_data / regularHoursWorked / regularHoursWorkedExponent C N
data / additional_data / regularHoursRate C OBJ Applicable for Temporary Services
data / additional_data / regularHoursRate / regularHoursRate C N
data / additional_data / regularHoursRate / regularHoursRateExponent C N
data / additional_data / overtimeHoursWorked C OBJ Applicable for Temporary Services
data / additional_data / overtimeHoursWorked / overtimeHoursWorked C N
data / additional_data / overtimeHoursWorked / overtimeHoursWorkedExponent C N
data / additional_data / overtimeHoursRate C OBJ Applicable for Temporary Services
data / additional_data / overtimeHoursRate / overtimeHoursRate C N
data / additional_data / overtimeHoursRate / overtimeHoursRateExponent C N
data / additional_data / tempStartDate C N Applicable for Temporary Services, format: YYMMDD
data / additional_data / tempWeekEnding C N Applicable for Temporary Services, format: YYMMDD
data / additional_data / requestorNameOrId C ANS Applicable for Temporary Services
data / additional_data / supervisorReportsTo C ANS Applicable for Temporary Services
data / additional_data / timeSheetNumber C ANS Applicable for Temporary Services
data / additional_data / discountAmount C OBJ Applicable for Temporary Services
data / additional_data / discountAmount / amount C N
data / additional_data / discountAmount / exponent C N
data / additional_data / discountAmount / sign C A
data / additional_data / discountAmount / type C A
data / additional_data / subtotalAmount C OBJ Applicable for Temporary Services
data / additional_data / subtotalAmount / amount C N
data / additional_data / subtotalAmount / exponent C N
data / additional_data / subtotalAmount / sign C A
data / additional_data / miscellaneousExpenses C OBJ Applicable for Temporary Services, Shipping/Courier Services, Telephony Billing—Detail
data / additional_data / miscellaneousExpenses / description C ANS
data / additional_data / miscellaneousExpenses / amount C N
data / additional_data / miscellaneousExpenses / exponent C N
data / additional_data / miscellaneousExpenses / sign C A
data / additional_data / serviceDescriptorCode C ANS Applicable for Shipping/Courier Services
data / additional_data / trackingNumberOrPickupNumber C ANS Applicable for Shipping/Courier Services
data / additional_data / shippingNetAmount C OBJ Applicable for Shipping/Courier Services, Private Label Line Item Detail
data / additional_data / shippingNetAmount / amount C N
data / additional_data / shippingNetAmount / exponent C N
data / additional_data / shippingNetAmount / sign C A
data / additional_data / incentiveAmount C OBJ Applicable for Shipping/Courier Services
data / additional_data / incentiveAmount / amount C N
data / additional_data / incentiveAmount / exponent C N
data / additional_data / incentiveAmount / sign C A
data / additional_data / pickupDate C N Applicable for Shipping/Courier Services, format: YYMMDD
data / additional_data / deliveryDate C N Applicable for Shipping/Courier Services, YYMMDD
data / additional_data / numberOfPackages C N Applicable for Shipping/Courier Services, Private Label Line Item Detail
data / additional_data / packageWeight C N Applicable for Shipping/Courier Services, Private Label Line Item Detail
data / additional_data / unitOfMeasure C ANS Applicable for Shipping/Courier Services, Private Label Line Item Detail
data / additional_data / shippingPartyInformation C OBJ Applicable for Shipping/Courier Services
data / additional_data / shippingPartyInformation / name C ANS
data / additional_data / shippingPartyInformation / name2 C ANS
data / additional_data / shippingPartyInformation / name3 C ANS
data / additional_data / shippingPartyAddress C OBJ Applicable for Shipping/Courier Services, Private Label Line Item Detail
data / additional_data / shippingPartyAddress / address C ANS
data / additional_data / shippingPartyAddress / address2 C ANS
data / additional_data / shippingPartyAddress / address3 C ANS
data / additional_data / shippingPartyAddress / address4 C ANS
data / additional_data / shippingPartyAddress / address5 C ANS
data / additional_data / shippingPartyAddress / address6 C ANS
data / additional_data / shippingPartyPostalInformation C OBJ Applicable for Shipping/Courier Services
data / additional_data / shippingPartyPostalInformation / city C ANS
data / additional_data / shippingPartyPostalInformation / stateCode C ANS
data / additional_data / shippingPartyPostalInformation / countryCode C ANS
data / additional_data / shippingPartyPostalInformation / postalCode C ANS
data / additional_data / shippingPartyContact C OBJ Applicable for Shipping/Courier Services, Private Label Line Item Detail
data / additional_data / shippingPartyContact / shippingPartyDescriptor C ANS
data / additional_data / shippingPartyContact / shippingPartyContactInformation C ANS
data / additional_data / deliveryPartyInformation C OBJ Applicable for Shipping/Courier Services, Private Label Line Item Detail
data / additional_data / deliveryPartyInformation / name C ANS
data / additional_data / deliveryPartyInformation / name2 C ANS
data / additional_data / deliveryPartyInformation / name3 C ANS
data / additional_data / deliveryPartyAddressInformation C OBJ Applicable for Shipping/Courier Services, Private Label Line Item Detail
data / additional_data / deliveryPartyAddressInformation / address C ANS
data / additional_data / deliveryPartyAddressInformation / address2 C ANS
data / additional_data / deliveryPartyAddressInformation / address3 C ANS
data / additional_data / deliveryPartyAddressInformation / address4 C ANS
data / additional_data / deliveryPartyAddressInformation / address5 C ANS
data / additional_data / deliveryPartyAddressInformation / address6 C ANS
data / additional_data / deliveryPartyPostalInformation C OBJ Applicable for Shipping/Courier Services, Private Label Line Item Detail
data / additional_data / deliveryPartyPostalInformation / city C ANS
data / additional_data / deliveryPartyPostalInformation / stateCode C ANS
data / additional_data / deliveryPartyPostalInformation / countryCode C ANS
data / additional_data / deliveryPartyPostalInformation / postalCode C ANS
data / additional_data / detailTaxAmount4 C OBJ
data / additional_data / detailTaxAmount4 / detailTaxAmountIndicator C ANS
data / additional_data / detailTaxAmount4 / detailTaxAmount C ANS
data / additional_data / detailTaxAmount4 / detailTaxRate C ANS
data / additional_data / detailTaxAmount4 / detailTaxRateExponent C ANS
data / additional_data / detailTaxAmount4 / detailTaxTypeApplied C ANS
data / additional_data / detailTaxAmount4 / detailTaxTypeIdentifier C ANS
data / additional_data / detailTaxAmount4 / cardAcceptorTaxId C ANS
data / additional_data / detailTaxAmount4 / detailTaxAmountSign C ANS
data / additional_data / detailTaxAmount5 C OBJ
data / additional_data / detailTaxAmount5 / detailTaxAmountIndicator C ANS
data / additional_data / detailTaxAmount5 / detailTaxAmount C ANS
data / additional_data / detailTaxAmount5 / detailTaxRate C ANS
data / additional_data / detailTaxAmount5 / detailTaxRateExponent C ANS
data / additional_data / detailTaxAmount5 / detailTaxTypeApplied C ANS
data / additional_data / detailTaxAmount5 / detailTaxTypeIdentifier C ANS
data / additional_data / detailTaxAmount5 / cardAcceptorTaxId C ANS
data / additional_data / detailTaxAmount5 / detailTaxAmountSign C ANS
data / additional_data / detailTaxAmount6 C OBJ
data / additional_data / detailTaxAmount6 / detailTaxAmountIndicator C ANS
data / additional_data / detailTaxAmount6 / detailTaxAmount C ANS
data / additional_data / detailTaxAmount6 / detailTaxRate C ANS
data / additional_data / detailTaxAmount6 / detailTaxRateExponent C ANS
data / additional_data / detailTaxAmount6 / detailTaxTypeApplied C ANS
data / additional_data / detailTaxAmount6 / detailTaxTypeIdentifier C ANS
data / additional_data / detailTaxAmount6 / cardAcceptorTaxId C ANS
data / additional_data / detailTaxAmount6 / detailTaxAmountSign C ANS
data / additional_data / deliveryPartyContact C OBJ Applicable for Shipping/Courier Services
data / additional_data / deliveryPartyContact / deliveryPartyDescriptor C ANS
data / additional_data / deliveryPartyContact / deliveryPartyContactInformation C ANS
data / additional_data / lineItemTotalAmount C OBJ Applicable for Telephony Billing—Summary, Telephony Billing—Detail, C- Corporate Line Item Detail
data / additional_data / lineItemTotalAmount / amount C N
data / additional_data / lineItemTotalAmount / exponent C N
data / additional_data / lineItemTotalAmount / sign C A
data / additional_data / passengerDescription C OBJ Applicable for Passenger Transport Detail—Rail Data
data / additional_data / passengerDescription / numberOfAdults C N
data / additional_data / passengerDescription / numberOfChildren C N
data / additional_data / passengerDescription / class C ANS
data / additional_data / transportationServiceProvider C ANS Applicable for Passenger Transport Detail—Rail Data
data / additional_data / transportationServicesOffered C ANS Applicable for Passenger Transport Detail—Rail Data
data / additional_data / deliveryOrderNumber C ANS Applicable for Lodged Account Detail
data / additional_data / creditCardSlipNumber C ANS Applicable for Lodged Account Detail
data / additional_data / travelAgencyId C ANS Applicable for Lodged Account Detail
data / additional_data / dataSource C N Applicable for Lodged Account Detail
data / additional_data / vatSuppressionIndicator C ANS Applicable for Lodged Account Detail
data / additional_data / healtcareEligibleStatusIndicator C N Applicable for Healthcare
data / additional_data / moneySendReceiverData C OBJ Applicable for Payment Transaction Detail
data / additional_data / moneySendReceiverData / payeeFirstName C ANS
data / additional_data / moneySendReceiverData / payeeLastName C ANS
data / additional_data / moneySendReceiverData / payeeAddress C ANS
data / additional_data / moneySendReceiverData / payeeCity C ANS
data / additional_data / moneySendReceiverData / payeeStateCode C ANS
data / additional_data / moneySendReceiverData / payeeCountryCode C ANS
data / additional_data / moneySendReceiverData / payeePostalCode C ANS
data / additional_data / moneySendReceiverData / payeeDateOfBirth C N Format MMDDYYYY
data / additional_data / moneySendReceiverData / payeePhoneNumber C ANS
data / additional_data / additionalCardAcceptorInquiryInformation C OBJ Applicable for Private Label Common Data
data / additional_data / additionalCardAcceptorInquiryInformation / salesRepName C ANS
data / additional_data / additionalCardAcceptorInquiryInformation / salesRepPhoneNumber C ANS
data / additional_data / additionalCardAcceptorInquiryInformation / salesRepFaxNumber C ANS
data / additional_data / additionalCardAcceptorInquiryInformation / technicalSupportPhoneNumber C ANS
data / additional_data / costCenterInformation C OBJ Applicable for Private Label Common Data, Private Label Line Item Detail
data / additional_data / costCenterInformation / number C ANS
data / additional_data / costCenterInformation / description C ANS
data / additional_data / driverLicenseStateIssuedIdInformation C OBJ Applicable for Private Label Common Data
data / additional_data / driverLicenseStateIssuedIdInformation / number C ANS
data / additional_data / driverLicenseStateIssuedIdInformation / stateIdProvinceOrRegion C ANS
data / additional_data / paymentMethodInformation C OBJ Applicable for Private Label Common Data
data / additional_data / paymentMethodInformation / paymentMethod C AN
data / additional_data / paymentMethodInformation / amount C N
data / additional_data / stockKeepingUnitDescription C ANS Applicable for Private Label Line Item Detail
data / additional_data / departmentCode C ANS Applicable for Private Label Common Data, Private Label Line Item Detail
data / additional_data / alternateCustomIndetifier C OBJ Applicable for Private Label Common Data, Private Label Line Item Detail
data / additional_data / alternateCustomIndetifier / type C ANS
data / additional_data / alternateCustomIndetifier / detail C ANS
data / additional_data / alternateCustomIndetifier / type2 C ANS
data / additional_data / alternateCustomIndetifier / detail2 C ANS
data / additional_data / alternateCustomIndetifier / type3 C ANS
data / additional_data / alternateCustomIndetifier / detail3 C ANS
data / additional_data / alternateCustomIndetifier / type4 C ANS
data / additional_data / alternateCustomIndetifier / detail4 C ANS
data / additional_data / alternateCustomIndetifier / type5 C ANS
data / additional_data / alternateCustomIndetifier / detail5 C ANS
data / additional_data / promationCode C ANS Applicable for Private Label Line Item Detail
data / trace_id M ANS
data / message_number M N
data / transaction_destination_institution_id_code M N
data / transaction_originator_institution_id_code M N
data / receiving_institution_id_code M N
data / transaction_id M N
{
    "status": "success",
    "data": [
        {
            "finnancial_detail_addendum_id": 15705146864454,
            "mti": "1240",
            "function_code": "200",
            "acquirer_id": "00000999901",
            "forwarder_id": "999901",
            "additional_data": {
                "originalMessageFormat": "2",
                "transactionDescription": {
                    "usageCode": "01",
                    "industryRecordNumber": "000",
                    "occuranceIndicator": "001",
                    "associatedFirstPresentmentNumber": "00000053"
                },
                "passenderName": "Name Surname",
                "ticketNumber": "1234567890     ",
                "issuingCarrier": "1234",
                "issueDate": "190522",
                "travelAgencyCode": "12345678",
                "travelAgencyName": "Travel Agency Name",
                "travelDate": "190522"
            },
            "trace_id": "DMCAB12340101  ",
            "message_number": "00000050",
            "transaction_destination_institution_id_code": "019780",
            "transaction_originator_institution_id_code": "999901",
            "receiving_institution_id_code": "019780",
            "transaction_id": 15717220745695
        }
    ],
    "has_more_records": "Y",
    "duplicated": 0
}

External payment transactions

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getExternalPaymentTransactions",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "date_from": 1546304400,
    "date_to": 1547649027,
    "epm_address_id": 1, 
    "item_count": 1,
    "last_id": 15472143331065
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getExternalPaymentTransactions.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used. Access level can impact the returned list size.
date_from M N 11 Unix timestamp.
date_to M N 11 Unix timestamp.
epm_address_id O N External payment address ID.
item_count O N 1-11 Item per page. Max 100. Default 10.
last_id O N 20 Last transaction ID, next page transactions list is displayed after entered value.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getExternalPaymentTransactions",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "date_from": 1546304400,
    "date_to": 1547649027,
    "epm_address_id": 1, 
    "item_count": 1,
    "last_id": 15472143331065
}

Response

Parameter M Type Description
status M A Success / error.
data C LIST Response data object list. Mandatory if status = success.
data / id M N External payment transaction ID.
data / tx_type M N External payment transaction type
data / status M N External payment transaction status
data / status_code M N External payment transaction status code
data / settlement_amount M N
data / settlement_currency M N
data / instructed_amount M N
data / instructed_currency M N
data / country_ison M N
data / epm_address_id M N External payment address ID.
data / epm_type_id M N External payment type ID.
data / epm_method_id M N External payment method ID.
data / epm_schemes_id M N External payment schemes
data / epm_mandate_id C N External payment mandate ID. Mandatory if tx_type = 5 (direct debit).
data / account_id M N
data / account_type M N Account type
data / holder_id C N Mandatory if account_type = 1 (account).
data / transaction_id M N Transaction ID.
data / returned_transaction_id C N Returned transaction ID. Mandatory if tx_type = 1 (unload) and was rejected, if tx_type = 2 (load) and was reversed.
data / date_created M N Unix timestamp.
data / due_at C N Unix timestamp. Mandatory if tx_type = 5 (direct debit).
data / reference_number O ANS
data / request_reference_id O ANS
data / description O ANS
data / reason_description O ANS
data / note O ANS
data / direct_payment_details O ANS
data / should_pay C N 1 - should pay, 0 - shouldn't pay. Mandatory if tx_type = 5 (direct debit).
data / transaction_identifier O ANS ID generated by external payment bank provider.
data / end_to_end_identifier O ANS ID generated by Bank Connect.
has_more_records M A Y - has more records to display N - has no more records to display.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "id": 15788972444337,
            "tx_type": 1,
            "status": 1,
            "status_code": 0,
            "settlement_amount": 2000,
            "settlement_currency": "826",
            "instructed_amount": 2000,
            "instructed_currency": "826",
            "country_ison": "826",
            "epm_address_id": 1,
            "epm_type_id": 1,
            "epm_method_id": 1,
            "epm_schemes_id": 2,
            "epm_mandate_id": null,
            "account_id": 1,
            "account_type": 1,
            "holder_id": 1,
            "transaction_id": 15788972444118,
            "returned_transaction_id": null,
            "date_created": 1578897244,
            "due_at": null,
            "reference_number": "8b07f30537944896",
            "request_reference_id": "a54sdfdsFSDf87cvzxcv323",
            "description": "ID:27,account number:81391558,account name:bbbb,iban:GB85SRLG04005981391558,sort code:040059",
            "reason_description": "Timeout",
            "note": "Intern Company note",
            "direct_payment_details": "sender_iban:GB06SRLG04005908483609,sender_account_name:Test Tester,sender_account_number:08483609,sender_sort_code:040059",
            "should_pay": null,
            "transaction_identifier": null,
            "end_to_end_identifier": null
        },
        {
            "id": 15788972610858,
            "access_level": 0,
            "tx_type": 5,
            "status": 3,
            "status_code": 0,
            "settlement_amount": 2000,
            "settlement_currency": "826",
            "instructed_amount": 2000,
            "instructed_currency": "826",
            "country_ison": "826",
            "epm_address_id": 1,
            "epm_type_id": 1,
            "epm_method_id": 1,
            "epm_mandate_id": 1,
            "account_id": 1,
            "account_type": 1,
            "holder_id": 1,
            "transaction_id": 15796148925061,
            "returned_transaction_id": null,
            "date_created": 1579614892,
            "due_at": 1553644800,
            "reference_number": null,
            "request_reference_id": null,
            "description": null,
            "reason_description": null,
            "note": null,
            "direct_payment_details": null,
            "should_pay": 1,
            "transaction_identifier": "123456",
            "end_to_end_identifier": "987654"
        }
    ],
    "has_more_records": "N",
    "duplicated": 0
}

Transaction counters

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getTransactionCounters",
    "api_version": "1.1",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "holder_id": 30
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getTransactionCounters.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
access_level O N 0-1000 If not provided, the value from the client's credentials will be used. Access level can impact returned list size.
card_id C N 1-20 If account ID and card holder ID not provided, card ID must be provided.
account_id C N 1-20 If card ID and card holder ID not provided, account ID must be provided.
holder_id C N 11 If card ID and account ID not provided, holder ID must be provided.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getTransactionCounters",
    "api_version": "1.1",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "access_level": 0,
    "holder_id": 30
}

Response

Parameter M Type Description
status M A Success / error.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
data / id M N
data / holder_id M N
data / currency_ison M N
data / transaction_amount M N Amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
data / transaction_count M N
data / transaction_counter_config_id M N
data / valid_from M N Unix timestamp
data / valid_until M N Unix timestamp
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [
        {
            "id": 1,
            "holder_id": 30,
            "currency_ison": "978",
            "transaction_amount": 328992,
            "transaction_count": 45,
            "transaction_counter_config_id": 3,
            "valid_from": 1601499600,
            "valid_until": 1604181599
        },
        {
            "id": 2,
            "holder_id": 30,
            "currency_ison": "978",
            "transaction_amount": 5291,
            "transaction_count": 1,
            "transaction_counter_config_id": 1,
            "valid_from": 1601499600,
            "valid_until": 1604181599
        }
    ],
    "duplicated": 0
}

TAI notifications

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getTaiNotifications",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "date_from": 1546304400,
    "date_to": 1547649027,
    "id": 15844381176966,
    "transaction_id": 15844381177508,
    "is_sent": 1,
    "item_count": 1,
    "last_id": 15472143331065
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getTaiNotifications.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
date_from M N 11 Unix timestamp.
date_to M N 11 Unix timestamp.
id O N TAI notifications ID.
transaction_id O N
authorize_id O N
actual_authorize_id O N
is_sent O N 1 - sent, 0 - not sent.
item_count O N 1-11 Item per page. Max 100. Default 10.
last_id O N 20 Last transaction ID, next page transactions list is displayed after entered value.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getTaiNotifications",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "date_from": 1546304400,
    "date_to": 1547649027,
    "id": 15844381176966,
    "transaction_id": 15844381177508,
    "is_sent": 1,
    "item_count": 1,
    "last_id": 15472143331065
}

Response

Parameter M Type Description
status M A Success / error.
data C LIST Response data object list. Mandatory if status = success.
data / id M N TAI notifications ID.
data / transaction_id O N
data / authorize_id O N
data / actual_authorize_id O N
data / attempt_count M N
data / is_sent M N 1 - sent, 0 - not sent.
data / duration O N
data / response O ANS
data / status_code O N
data / date_created M N Unix timestamp.
data / date_updated O N Unix timestamp.
has_more_records M A Y - has more records to display N - has no more records to display.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
     "data": [
        {
            "id": 15845294337782,
            "transaction_id": null,
            "authorize_id": 15845294338357,
            "actual_authorize_id": 15845294339522,
            "attempt_count": 1,
            "is_sent": 1,
            "duration": 0.4914529920,
            "response": "{\"status\":\"success\",\"data\":{\"responseCode\":\"00\"}",
            "status_code": 200,
            "date_created": 1584529433,
            "date_updated": 1584529433
        },
        {
            "id": 15845293111270,
            "transaction_id": null,
            "authorize_id": 15845293111867,
            "actual_authorize_id": 15845293113073,
            "attempt_count": 1,
            "is_sent": 1,
            "duration": 0.5006240010,
            "response": "{\"status\":\"success\",\"data\":{\"responseCode\":\"00\"}",
            "status_code": 200,
            "date_created": 1584529311,
            "date_updated": 1584529311
        }
    ],
    "has_more_records": "N",
    "duplicated": 0
}

TAI

Get failed notifications count

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getFailedNotificationsCount",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getFailedNotificationsCount.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getFailedNotificationsCount",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321"
}

Response

Parameter M Type Description
status M A Success / error.
data C LIST Response data object list. Mandatory if status = success.
data / count M N Failed notifications count.
data / first_failed_notification_date C N Unix timestamp. Mandatory if count > 0.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "count": 10,
        "first_failed_notification_date": 1581984000
    },
    "duplicated": 0
}

Resend failed notifications

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "resendFailedNotifications",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "date_from": 1581984000,
    "date_to": 1582095354
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed resendFailedNotifications.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
date_from M N 11 Unix timestamp. Date range is limited to 48 hours
date_to M N 11 Unix timestamp. Date range is limited to 48 hours
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "resendFailedNotifications",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "date_from": 1581984000,
    "date_to": 1582095354
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C LIST Response data object list. Mandatory if status = success.
data / notifications_enqueued M N Number of TAI messages added to the resending queue
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "notifications_enqueued": 66
    },
    "duplicated": 0
}

Send custom notification

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "sendCustomNotification",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "source": 1,
    "invoked_event": "dublicatedSession",
    "payload": {
        "reference": "1aff56ef"
    }
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed sendCustomNotification.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id C N 1-20 Mandatory if account_id is not specified. Both fields: card_id and account_id can be specified.
account_id C N 1-20 Mandatory if card_id is not specified. Both Fields: card_id and account_id can be specified.
source M N 1-11 Custom notification source
invoked_event M AN 1-50
payload O OBJ
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "sendCustomNotification",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "source": 1,
    "invoked_event": "dublicatedSession",
    "payload": {
        "reference": "1aff56ef"
    }
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C LIST Response data object list. Mandatory if status = success.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Transfer

Credit adjustment

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "creditAdjustment",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "amount": 500,
    "currency_ison": "840",
    "reference_number": "123528",
    "description": "Credit Adjustment"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed creditAdjustment.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id C N 1-20 Mandatory if account_id is not specified. Both fields: card_id and account_id can be specified.
Required card statuses: any
account_id C N 1-20 Mandatory if card_id is not specified. Both fields: card_id and account_id can be specified.
amount M N 1-15 Amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
currency_ison M N 3
description O AN 37
reference_number O AN 1-255
balance_adjustment_type O N 1-2 Balance adjustment type
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "creditAdjustment",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "amount": 500,
    "currency_ison": "840",
    "description": "Credit Adjustment",
    "reference_number": "123528",
    "balance_adjustment_type": 1
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success.
data / transaction_id M N Transaction ID.
data / available_balance M N Available card balance.
data / settled_balance M N Settled card balance.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "transaction_id": 15719168303904,
        "available_balance": 10500,
        "settled_balance": 10500
    },
    "duplicated": 0
}

Debit adjustment

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "debitAdjustment",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "amount": 500,
    "currency_ison": "840",
    "reference_number": "123528",
    "description": "Debit Adjustment"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed debitAdjustment.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id C N 1-20 Mandatory if account_id is not specified. Both fields: card_id and account_id can be specified.
Required card statuses: any
account_id C N 1-20 Mandatory if card_id is not specified. Both fields: card_id and account_id can be specified.
amount M N 1-15 Amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
currency_ison M N 3
description O AN 37
reference_number O AN 1-255
balance_adjustment_type O N 1-2 Balance adjustment type
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "debitAdjustment",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "amount": 500,
    "currency_ison": "840",
    "description": "Debit Adjustment",
    "reference_number": "123528",
    "balance_adjustment_type": 3
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success.
data / transaction_id M N Transaction ID.
data / available_balance M N Available card balance.
data / settled_balance M N Settled card balance.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "transaction_id": 15719167613334,
        "available_balance": 9500,
        "settled_balance": 9500
    },
    "duplicated": 0
}

Load

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "load",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "source_card_id": 123457,
    "source_account_id": 2,
    "amount": 500,
    "currency_ison": "840",
    "reference_number": "123528",
    "description": "Money Load",
    "load_type": 0,
    "load_source": 0,
    "country_ison": "840"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed load.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id C N 1-20 Mandatory if account_id is not specified. Both fields: card_id and account_id can be specified.
Required card statuses: Activated, Suspended, Expired
account_id C N 1-20 Mandatory if card_id is not specified. Both fields: card_id and account_id can be specified.
source_card_id O N 1-20
source_account_id O N 1-20
amount M N 1-15 Amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
currency_ison M N 3
reference_number O AN 1-255
description O AN 37
load_type O N 1-11 Load type
load_source O N 1-11 Load source
country_ison O AN 3 3-digit country ISON code.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "load",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "source_card_id": 123457,
    "source_account_id": 2,
    "amount": 500,
    "currency_ison": "840",
    "reference_number": "123528",
    "description": "Money Load",
    "load_type": 0,
    "load_source": 0,
    "country_ison": "840"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success.
data / transaction_id M N Transaction ID.
data / available_balance M N Available card balance.
data / settled_balance M N Settled card balance.
data / source_transaction_id C N Mandatory if source_card_id or source_account_id was provided in the request.
data / source_available_balance C N Mandatory if source_card_id or source_account_id was provided in the request.
data / source_settled_balance C N Mandatory if source_card_id or source_account_id was provided in the request.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "transaction_id": 15719166264756,
        "available_balance": 10500,
        "settled_balance": 10500,
        "source_transaction_id": 15719166259506,
        "source_available_balance": 9500,
        "source_settled_balance": 9500
    },
    "duplicated": 0
}

Unload

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "unload",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "destination_card_id": 123457,
    "destination_account_id": 2,
    "amount": 500,
    "currency_ison": "840",
    "reference_number": "123528",
    "description": "Money Unload",
    "load_type": 0,
    "load_source": 0,
    "country_ison": "840"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed unload.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id C N 1-20 Mandatory if account_id is not specified. Both fields: card_id and account_id can be specified.
Required card statuses: Activated, Suspended, Expired, Stolen, Lost
account_id C N 1-20 Mandatory if card_id is not specified. Both fields: card_id and account_id can be specified.
destination_card_id O N 1-20
destination_account_id O N 1-20
amount M N 1-15 Amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
currency_ison M N 3
description O AN 37
reference_number O AN 1-255
load_type O N 1-11 Load type
load_source O N 1-11 Load source
country_ison O AN 3 3-digit country ISON code.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "unload",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "account_id": 1,
    "destination_card_id": 123457,
    "destination_account_id": 2,
    "amount": 500,
    "currency_ison": "840",
    "reference_number": "123528",
    "description": "Money Unload",
    "load_type": 0,
    "load_source": 0,
    "country_ison": "840"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success.
data / transaction_id M N Transaction ID.
data / available_balance M N Available card balance.
data / settled_balance M N Settled card balance.
data / destination_transaction_id C N Mandatory if destination_card_id or destination_account_id was provided in the request.
data / destination_available_balance C N Mandatory if destination_card_id or destination_account_id was provided in the request.
data / destination_settled_balance C N Mandatory if destination_card_id or destination_account_id was provided in the request.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "transaction_id": 15719166772813,
        "available_balance": 9500,
        "settled_balance": 9500,
        "destination_transaction_id": 15719166777893,
        "destination_available_balance": 10500,
        "destination_settled_balance": 10500
    },
    "duplicated": 0
}

Card frame

Create session

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "createCardFrameSession",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "localization": "en_GB",
    "design_code": "CF123456",
    "page": "setPin"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed createCardFrameSession.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M ANS 1-20 Card ID.
localization O AS 1-20 Language code identifiers if not provided, the default localization will be applied. This parameter is case insensitive and - character can be used instead of _, e.g. en_US, en_us, en-US, en-us.
design_code O ANS 1-15 If not provided, the default design will be applied.
page O AN 100 Pages if not provided, then any page can be applied.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "createCardFrameSession",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "localization": "en_GB",
    "design_code": "CF123456",
    "page": "setPin"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success.
data / url M ANS Page URL. If in request parameter page not provided URL returned with placeholder {page} which should be replaced with valid page
data / base_url M ANS Base URL
data / session_id M ANS Session ID
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": {
        "url": "http://cardframe.local/sid/99a52735-5f8b-11ea-9b70-309c238f6e75/{page}",
        "base_url": "http://cardframe.local/sid/99a52735-5f8b-11ea-9b70-309c238f6e75",
        "session_id": "99a52735-5f8b-11ea-9b70-309c238f6e75"
    },
    "duplicated": 0
}

Close session

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "closeCardFrameSession",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "session_id": "99a52735-5f8b-11ea-9b70-309c238f6e75"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed closeCardFrameSession.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
card_id M ANS 1-20 Card ID.
session_id M ANS 1-36 Session ID to be closed
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "closeCardFrameSession",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "card_id": 123456,
    "session_id": "99a52735-5f8b-11ea-9b70-309c238f6e75"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C OBJ Response data object. Mandatory if status = success. Empty for this call.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "data": [],
    "duplicated": 0
}

Services

PEP Check

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "pepCheck",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "threshold": 70,
    "pep": 1,
    "previous_sanctions": 0,
    "current_sanctions": 0,
    "law_enforcement": 0,
    "financial_regulator": 0,
    "insolvency": 0,
    "disqualified_director": 0,
    "adverse_media": 0,
    "forename": "Vladimir",
    "middle_name": null,
    "surname": "Putin",
    "date_of_birth": "1952-10-23",
    "year_of_birth": 1952,
    "address": "23 ilinkina street",
    "city": "Moscow",
    "county": null,
    "postcode": "103132",
    "country": "643" 
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed pepCheck.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
threshold M N 1-10 Minimum score to filter matched profiles.
pep O N 1 0 or 1. If the value is 1, returns PEP profiles.
previous_sanctions O N 1 0 or 1. If the value is 1, returns previously sanctioned profiles.
current_sanctions O N 1 0 or 1. If the value is 1, returns currently sanctioned profiles.
law_enforcement O N 1 0 or 1. If the value is 1, returns profiles from the 'Law Enforcement' dataset.
financial_regulator O N 1 0 or 1. If the value is 1, returns profiles from the 'Financial regulator' dataset.
insolvency O N 1 0 or 1. If the value is 1, returns profiles from the 'Insolvency' dataset.
disqualified_director O N 1 0 or 1. If the value is 1, returns profiles from the 'Disqualified Director' dataset.
adverse_media O N 1 0 or 1. If the value is 1, returns profiles from the 'Adverse Media' dataset.
forename M ANS 1-20 Person's forename.
middle_name O ANS 1-20 Person's middle name.
surname M ANS 1-20 Person's surname.
date_of_birth O AN 10 Date of birth. YYYY-mm-dd format.
year_of_birth O AN 4 Year of birth. YYYY format.
address O ANS 1-40 Address.
city O ANS 1-20 City.
county O ANS 1-20 County.
postcode O ANS 1-20 Post code.
country O N 3 Country in ISON format (ISO 3166 by the RIPE Network Coordination Centre).
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "pepCheck",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "threshold": 70,
    "pep": 1,
    "previous_sanctions": 0,
    "current_sanctions": 0,
    "law_enforcement": 0,
    "financial_regulator": 0,
    "insolvency": 0,
    "disqualified_director": 0,
    "adverse_media": 0,
    "forename": "Vladimir",
    "middle_name": null,
    "surname": "Putin",
    "date_of_birth": "1952-10-23",
    "year_of_birth": 1952,
    "address": "23 ilinkina street",
    "city": "Moscow",
    "county": null,
    "postcode": "103132",
    "country": "643" 
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
status_code C N Possible error codes Mandatory if status = error.
data C OBJ Response data object. Mandatory if status = success.
data / records_found M N Count of records found.
data / matches M OBJ List of matches.
data / matches / score O ANS Match score. Value [0, 100]
data / matches / person O OBJ Person data.
data / matches / person / id O N Person ID.
data / matches / person / title O OBJ
data / matches / person / title / description O N Title description.
data / matches / person / alternativeTitle O N Alternative title.
data / matches / person / forename O N Person forename.
data / matches / person / middlename O N Person middlename.
data / matches / person / dateOfBirth O N Date of birth. YYYY-mm-dd format.
data / matches / person / yearOfBirth O N Year of birth. YYYY format.
data / matches / person / dateOfDeath O ANS Date of death. YYYY-mm-dd format.
data / matches / person / isDeceased O N Is deceased.
data / matches / person / gender O N Gender.
data / matches / person / nationality O OBJ
data / matches / person / nationality / nationality O N Nationality.
data / matches / person / imageURL O N Image URL.
data / matches / person / telephoneNumber O N Telephone Number.
data / matches / person / faxNumber O N Fax number.
data / matches / person / mobileNumber O N Mobile number.
data / matches / person / email O N Email.
data / matches / person / pepLevel O N PEP level.
data / matches / person / isPEP O N Is PEP.
data / matches / person / isSanctionsCurrent O N Current sanctions is included.
data / matches / person / isSanctionsPrevious O N Previous sanctions is included.
data / matches / person / isLawEnforcement O N Law enforcement is included.
data / matches / person / isFinancialregulator O N Financial regulator is included.
data / matches / person / isDisqualifiedDirector O N Disqualified director is included.
data / matches / person / isInsolvent O N Insolvent is included.
data / matches / person / isAdverseMedia O N Adverse media is included.
data / matches / person / addresses O OBJ Address list.
data / matches / person / addresses / address1 O N Address #1.
data / matches / person / addresses / address2 O N Address #2.
data / matches / person / addresses / address3 O N Address #3.
data / matches / person / addresses / address4 O N Address #4.
data / matches / person / addresses / city O N City.
data / matches / person / addresses / county O N County.
data / matches / person / addresses / postcode O N Post code.
data / matches / person / addresses / country O OBJ -
data / matches / person / addresses / country /name O N Country name.
{
  "status": "success",
  "duplicated": 0,
  "data": {
    "recordsFound": 1,
    "matches": [
      {
        "score": 100,
        "person": {
          "id": 116301,
          "title": {
            "description": "Mr"
          },
          "alternativeTitle": "",
          "forename": "Vladimir",
          "middlename": "Vladimirovich",
          "surname": "Putin",
          "dateOfBirth": "1952-10-07",
          "yearOfBirth": 1952,
          "dateOfDeath": null,
          "yearOfDeath": null,
          "isDeceased": false,
          "gender": "Male",
          "nationality": {
            "nationality": "Russian"
          },
          "imageURL": "https://secure.c6-intelligence.com/c6images/0020715000/0020712831.jpg",
          "telephoneNumber": "",
          "faxNumber": "",
          "mobileNumber": "",
          "email": "",
          "pepLevel": 1,
          "isPEP": true,
          "isSanctionsCurrent": false,
          "isSanctionsPrevious": false,
          "isLawEnforcement": false,
          "isFinancialregulator": false,
          "isDisqualifiedDirector": false,
          "isInsolvent": false,
          "isAdverseMedia": true,
          "addresses": [
            {
              "address1": "",
              "address2": "",
              "address3": "",
              "address4": "",
              "city": "Saint Petersburg",
              "county": "",
              "postcode": "",
              "country": {
                "name": "Russia"
              }
            },
            {
              "address1": "23 Ilinkina Street",
              "address2": "",
              "address3": "",
              "address4": "",
              "city": "Moscow",
              "county": "",
              "postcode": "103132",
              "country": {
                "name": "Russia"
              }
            }
          ],
          "aliases": [
            {
              "title": null,
              "alternativeTitle": null,
              "forename": "Владимир",
              "middlename": "Владимирович",
              "surname": "Путин"
            },
            {
              "title": null,
              "alternativeTitle": "",
              "forename": "Volodymyr",
              "middlename": "Volodymyrovych",
              "surname": "Putin"
            }
          ],
          "articles": [
            {
              "originalURL": "http://www.russianlaw.org/newsweek090301.htm",
              "dateCollected": "2016-05-17",
              "c6URL": "https://secure.c6-intelligence.com/c6images/0000105000/0000101477.pdf",
              "categories": [
                {
                  "name": "PEP"
                }
              ],
              "snippet": null
            },
            {
              "originalURL": "https://www.occrp.org/personoftheyear/2017/",
              "dateCollected": "2018-01-12",
              "c6URL": "https://secure.c6-intelligence.com/c6images/0023905000/0023902400.pdf",
              "categories": [
                {
                  "name": "PEP"
                }
              ],
              "snippet": null
            }
          ],
          "sanctions": [],
          "notes": [
            {
              "dataSource": null,
              "text": "PEP Tier 1"
            },
            {
              "dataSource": null,
              "text": "Rep. Risk: Financial Crime and Fraud - Financial and Non-Financial Fraud"
            }
          ],
          "linkedBusinesses": [
            {
              "businessId": 41263,
              "businessName": "Gazprom PAO",
              "position": "Shareholder (4,5%)"
            },
            {
              "businessId": 671849,
              "businessName": "Surgutneftegas PAO",
              "position": "Shareholder (37%)"
            }
          ],
          "linkedPersons": [
            {
              "personId": 5553781,
              "name": "Alexey Krapivin",
              "association": "Alexey Krapivin is an associate of Vladimir Vladimirovich Putin."
            },
            {
              "personId": 5452938,
              "name": "Sergey Yevgenyevich Korepanov",
              "association": "Gazprom PAO"
            }
          ],
          "politicalPositions": [
            {
              "description": "Former President of the Federation (2 Terms)",
              "from": "31 December 1999",
              "to": "7 May 2008",
              "country": {
                "name": "Russia"
              }
            },
            {
              "description": "Former Prime Minister of the Federation (1st Term)",
              "from": "16 August 1999",
              "to": "7 May 2000",
              "country": {
                "name": "Russia"
              }
            }
          ]
        }
      }
    ]
  }
}

OpenBanking

Register token

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "registerOpenBankingToken",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "token": "njciuyqnsakhjgasdokml",
    "expiration_date": "2021-09-01",
    "consents": [
        1,
        2,
        3
    ],
    "ibans": [
        "GB06SRLG04005908483609",
        "GB06SRLG04005908483610"
    ],
    "epm_addresses": [
        1,
        2
    ]
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed registerOpenBankingToken.
api_version M NS Fixed 1.1.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
token M AN 128 Open banking config token.
expiration_date M N Date of token expiration YYYY-mm-dd format.
consents M LIST Consent.
ibans O LIST Mandatory if epm_addresses not provided.
epm_addresses O LIST Mandatory if ibans not provided.
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "registerOpenBankingToken",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "token": "njciuyqnsakhjgasdokml",
    "expiration_date": "2021-09-01",
    "consents": [
        1,
        2,
        3
    ],
    "ibans": [
        "GB06SRLG04005908483609",
        "GB06SRLG04005908483610"
    ],
    "epm_addresses": [
        1,
        2
    ]
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C LIST Response data object list. Mandatory if status = success.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
  "status": "success",
  "data": [],
  "duplicated": 0
}

Get payment

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getOpenBankingPaymentById",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "payment_id": 1
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed getOpenBankingPaymentById.
api_version M NS Fixed 1.2.
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
payment_id M N 1-20 Open banking payment ID
{
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "getOpenBankingPaymentById",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321",
    "payment_id": 1
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C LIST Response data object list. Mandatory if status = success.
data / payment_id M N
data / client_id M N
data / sender_iban M AN The max length of the field is 34 characters.
data / amount M N Amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
data / currency M N Currency ison.
data / receiver_name M N The max length of the field is 40 characters.
data / receiver_iban M N The max length of the field is 34 characters.
data / receiver_account_number M AN The max length of the field is 34 characters.
data / receiver_sort_code M AN The max length of the field is 6 characters.
data / message_for_receiver M ANS The max length of the field is 35 characters.
data / callback_url M N Callback URL to the TPP.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
  "status": "success",
  "data": {
    "payment_id": 1,
    "client_id": 1,
    "sender_iban": "GB06SRLG04005908483609",
    "amount": 1500,
    "currency": "978",
    "receiver_name": "John Smith",
    "receiver_iban": null,
    "receiver_account_number": "00000014",
    "receiver_sort_code": "040472",
    "message_for_receiver": "Payment for goods",
    "callback_url": "https://tpp.example.com/"
  },
  "duplicated": 0
}

Process payment

URL Method Header Body
/api POST empty {request data}
curl --location --request POST 'https://pmapi.isaac-demo.tribepayments.com/api' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payment_id": 1,
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "processOpenBankingPayment",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321"
}'

Request

Parameter M Type Length Description
access_key M AN 20
access_api_id M AN
access_api_key M AN
action M AN Fixed processOpenBankingPayment.
api_version M NS Fixed 1.2.
payment_id M N 1-20 Open banking payment ID |
request_reference_id O ANS 10-255 Unique request identifier. Can contain only letters, numbers and hyphens.
{
    "payment_id": 1,
    "access_key": "%YOUR_ACCESS_KEY%",
    "access_api_id": "%YOUR_API_ID%",
    "access_api_key": "%YOUR_ACCESS_API_KEY%",
    "action": "processOpenBankingPayment",
    "api_version": "1.2",
    "request_reference_id": "a54sdfdsFSDf87cvzxcv321"
}

Response

Parameter M Type Description
status M A Success / error.
duplicated M N 1 - request is duplicated, 0 - request is not duplicated. When duplicated = 1, and the original request processing has finished, the original request response will be returned.
data C LIST Response data object list. Mandatory if status = success.
data / id C N External payment transaction ID.
data / external_transaction_reference C N Provided if an external provider processed the request and returned a successful response.
data / settlement_amount M N Settlement amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
data / settlement_currency M N Settlement currency ison.
data / instructed_amount M N Instructed amount in minor currency units. (i.e. 500 for 5.00USD; 215 for 2.15 EUR).
data / instructed_currency M N Instructed currency ison.
data / transaction_id C N Provided if transaction created. Unique settlement transaction ID.
data / trans_link C AN Provided if transaction created.
data / source_bank_account_address C LIST
data / source_bank_account_address / id M N External payment address ID.
data / source_bank_account_address / account_number M AN
data / source_bank_account_address / account_name M AN
data / source_bank_account_address / iban M AN
data / source_bank_account_address / sort_code M AN
data / source_bank_account_address / bic M AN
data / destination_bank_account_address C LIST
data / destination_bank_account_address / account_number C AN Provided if an external provider processed the request and returned a successful response.
data / destination_bank_account_address / account_name M AN
data / destination_bank_account_address / iban C AN Provided if an external provider processed the request and returned a successful response.
data / destination_bank_account_address / sort_code C AN Provided if an external provider processed the request and returned a successful response.
data / destination_bank_account_address / bic C AN Provided if an external provider processed the request and returned a successful response.
data / created_at C AN Provided if an external provider processed the request and returned a successful response.
status_code C N Possible error codes Mandatory if status = error.
message C ANS Error message. Mandatory if status = error.
{
    "status": "success",
    "duplicated": 0,
    "data": [
        {
            "id": 15798696909332,
            "external_transaction_reference": 47,
            "settlement_amount": 1255,
            "settlement_currency": "826",
            "instructed_amount": 1255,
            "instructed_currency": "826",
            "transaction_id": 16044094764502,
            "trans_link": "580076300000109036201228103523",
            "source_bank_account_address": {
                "id": 6,
                "account_number": "26304531",
                "account_name": "John Smith",
                "iban": "GB32SRLG04005970085028",
                "sort_code": "040059",
                "bic": "SRLGGB2L"
            },
            "destination_bank_account_address": {
                "account_number": "00004588",
                "account_name": "John Smith",
                "iban": "GB85SRLG04005981391558",
                "sort_code": "203002",
                "bic": "SRLGGB2L"
            },
            "created_at": "2019-02-22T13:07:01+00:00"
        }
    ]
}

Appendix

Version guide

Update type Notation Compatibility Description
Major version X.1.1 Breaking API changes A major update that will most likely affect the client's integration and therefore must be reviewed. Resets the minor and patch versions to zero.
Minor version 1.X.1 Non-backwards compatible Minor changes that might affect the client's integration and therefore must be reviewed.
Patch 1.1.X Backwards compatible Minor changes that will not affect the client's integration - reviewing is not necessary.

Changelog

Version Date
1.2.61 August 20, 2021 Added ‘Try it Now’ functionality to each API action (an ability to send API request to Demo environment directly from web browser).
1.2.60 August 03, 2021 Added additional_charset_id in createHolder and updateHolder. Added description with charsets used through out the system.
1.2.59 July 27, 2021 Added new action changeAccountProgramId.
1.2.58 July 31, 2021 Added a new request parameter balance_adjustment_type and a new error code 2015 to creditAdjustment and debitAdjustment methods.
1.2.57 July 26, 2021 Added new method directCreditReturn.
1.2.56 June 28, 2021 Added new external payment transaction status codes: "Rejected by risk processor" and "Hold by risk processor". Added new external payment transaction statuses: "Pending in risk" and "Hold in risk".
1.2.55 June 22, 2021 Added new error code (141) to assignExternalPaymentAddress, assignExternalPaymentAddressForSpecialAccount, getExternalPaymentAddress, changeExternalPaymentAddressStatus, cancelExternalPaymentMandate, transferToExternalPayment, directDebitReturn and changeDDExternalPaymentStatus, methods.
1.2.54 June 16, 2021 Added request parameter epm_addresses to registerOpenBankingToken method.
1.2.53 June 14, 2021 Updated External payment inbound return message code list. Removed 0, updated 5 and 6, added 7, 8, 9 and 10 ID's.
1.2.52 June 14, 2021 Updated card status change. Can be changed from Not activated (N) to Stolen (S).
1.2.51 June 14, 2021 Added a new error code 1922 to "inboundReturn" method.
1.2.49 June 11, 2021 Updated method "getTransactions". Added new response parameters "interchange_rate_designator", |
1.2.48 May 26, 2021 Added new error codes to "Assign address to account" and "Assign address to special account"
1.2.47 April 30, 2021 Added request parameters reason_code and note to changeCardStatus, changeAccountStatus, changeExternalPaymentAddressStatus methods. Added response parameters reason_code and note to getCardStatus method. Added response parameters status_change_reason_code and status_change_note to getCardDetails, getAccounts, getExternalPaymentAddress, getAccountExternalPaymentAddresses methods. Added response parameter status to getExternalPaymentAddress, getAccountExternalPaymentAddresses methods.
1.2.46 May 17, 2021 Updated Transaction type list. Added new records: 74, 75 and 76.
1.2.45 May 17, 2021 Updated description of field transaction_fee in getTransactions method.
1.2.44 May 7, 2021 Added new error code to "load" and "unload" method.
1.2.43 May 5, 2021 Added new error code to "createAccount" method.
1.2.42 April 29, 2021 Renamed method scaConfirm to authenticationConfirm. Added new request parameter oob_auth_method to authenticationConfirm method.
1.2.41 April 20, 2021 Added new methods getOpenBankingPaymentById and processOpenBankingPayment.
1.2.40 April 20, 2021 Added new error code to "transferToExternalPayment" method.
1.2.39 April 15, 2021 Added a new transaction types "P2P credit cash deposit", "P2P debit cash deposit", "P2P credit merchant payment" and "P2P debit merchant payment".
1.2.38 April 2, 2021 Added Signature to security check bitmap.
1.2.37 March 24, 2021 Added new method scaConfirm.
1.2.36 March 8, 2021 Added new methods assignAccountToRiskRuleGroup, assignAccountToLimitRuleGroup, assignAccountToFeeRuleGroup. Added new response parameter risk_group_id to methods: getAccounts, getCardDetails, getHolderAccounts.
1.2.35 February 20, 2021 Added new load sources "Balance adjustment load from GUI", "Balance adjustment load from PM API" and "Balance adjustment load by system"
1.2.34 February 17, 2021 Added new external payment transaction status codes: "External payment mandate status validation failed" and "Risk check failed".
1.2.33 February 3, 2021 Added new method registerOpenBankingToken.
1.2.32 January 27, 2021 Updated destination_account_number length in transferToExternalPayment method.
1.2.31 January 12, 2021 Updated methods "getCardsActivity", "getFinancialAuthorizes". Added new response parameters "settlement_amount", "settlement_currency_ison", "settlement_conversion_rate".
Updated method "getTransactions". Added new response parameter "reconciliation_conversion_rate".
1.2.30 January 8, 2021 Updated method "getTransactions". Added new response parameters "base_conversion_rate", "holder_conversion_rate" and "is_conversion_fee_blended".
Updated method "getFinancialAuthorizes" by adding new response parameters "base_conversion_rate", "holder_conversion_rate" and "is_conversion_fee_blended".
1.2.29 January 7, 2021 Added new method "getTransactionCounters"
1.2.28 December 29, 2020 Updated method "inboundReturn" and "transferToExternalPayment". Added new response parameter "trans_link".
1.2.27 December 14, 2020 Updated method "getExternalPaymentTransactions". Added new response parameters "transaction_identifier" and "end_to_end_identifier".
1.2.26 December 7, 2020 Updated External payment transaction type list. Updated ID 3.
1.2.25 November 20, 2020 Updated method "transferToExternalPayment". Added a new parameter "schemes".
1.2.24 November 24, 2020 Updated External payment transaction type list. Added new records: 8, 9 and 10.
1.2.23 November 24, 2020 Updated Transaction type list. Updated ID 65, added new records: 66, 67, 68 and 69.
1.2.22 November 24, 2020 Added new method createCustomFee.
1.2.21 November 24, 2020 Added new method directDebitReturn.
1.2.20 November 24, 2020 Updated method getFailedNotificationsCount. Added a new conditional response parameter first_failed_notification_date.
1.2.19 November 24, 2020 Updated methods transferToExternalPayment. Added a new validation error code 1771.
1.2.18 November 24, 2020 Updated methods transferToExternalPayment and inboundReturn. Added a new conditional response parameter transaction_id.
1.2.17 November 24, 2020 Updated method changeExternalPaymentAddressStatus. Added a new validation error code 1772.
1.2.16 November 24, 2020 Updated method changeDDExternalPaymentStatus. Added a new mandatory request parameter reason and added a new validation error codes: 1785, 1786 and 1787.
1.2.15 November 24, 2020 Updated method cancelExternalPaymentMandate. Added a new mandatory request parameter reason and added a new validation error codes: 1773 and 1774.
1.2.14 November 24, 2020 Updated methods createAccount, createHolder, updateHolder and createCard. Added a new optional request parameter holder_locale and added a new validation error code 1815.
1.2.13 November 18, 2020 Updated method transferToExternalPayment. Added a new validation error code: 1820.
1.2.12 September 25, 2020 Updated method getExternalPaymentTransactions response parameters: tx_type, status, status_code, settlement_amount, instructed_amount and account_type cast types (from string to integer).
1.2.11 September 25, 2020 Updated method getTransactions response parameters: transaction_amount, reconciliation_amount, holder_billing_amount, transaction_original_amount, reconciliation_original_amount, transaction_log_id, reason_code, transaction_fee_amount, parent_transaction_id, load_type, load_source, entry_mode_type_id, transaction_type, suspicious, transaction_fee, holder_amount and holder_currency_ison cast types (from string to integer).
1.2.10 September 25, 2020 Updated method getFinancialAuthorizes response parameters: transmission_time, billing_amount, billing_conversion_rate, transaction_amount, transaction_fee_amount, cashback_amount, transaction_type, entry_mode_type, suspicious, card_present, currency_convertion_fee, transaction_fee and holder_amount cast types (from string to integer).
1.2.09 September 25, 2020 Updated method getCardsActivity response parameters: card_present, transmission_time, billing_amount, billing_conversion_rate, holder_amount, transaction_amount, transaction_fee_amount, reversal, actual, cashback_amount, transaction_type, entry_mode_type, pad_cumulative_amount, suspicious, transaction_fee and currency_conversion_fee cast types (from string to integer).
1.2.08 September 25, 2020 Updated method getLimitsStatus response parameters: original_count, count, original_amount, amount, original_country_count, country_count, duration, transaction_type_id, entry_mode_type_id, mcc_low and mcc_high cast types (from string to integer).
1.2.07 September 25, 2020 Updated method getLimits response parameters: count, amount, country_count, duration, transaction_type_id, entry_mode_type_id, mcc_low and mcc_high cast types (from string to integer).
1.2.06 September 25, 2020 Updated method getHolder response parameters: holder_type, phone_number, kyc_completion_level and industry_id cast types (from string to integer).
1.2.05 September 25, 2020 Updated method getCardFees response parameters: mcc_low, mcc_high, fixed_price, percent_price, min_amount and max_amount cast types (from string to integer).
1.2.04 September 25, 2020 Updated methods assignExternalPaymentAddress, assignExternalPaymentAddressForSpecialAccount, getExternalPaymentAddress and getAccountExternalPaymentAddresses responses parameters active, direct_credit_enabled, direct_debit_enabled, inbound_enabled and outbound_enabled cast types (from boolean to integer).
1.2.03 September 25, 2020 Updated method getDesign response parameters card_design_id cast types (from string to integer).
1.2.02 September 25, 2020 Updated method reissueCard response parameters: card_holder_id renamed to holder_id and card_account_id renamed to account_id.
1.2.01 September 25, 2020 Updated method getCardDetails response parameters reference_number cast types (from integer to string).
1.2.00 September 25, 2020 Updated methods getAccounts and getHolderAccounts responses parameters available_balance, settled_balance and reserved_balance cast types (from string to integer).

Enum

Account status

ID Type Description
A Active
R Receive only
P Spend only
S Suspended
B Blocked Final status for closed account.

Authorization type

Type Description
AN Normal authorize
AP Pre authorize
AF Final authorize
AI Incremental
AIM Instalment
APC Preferred customer
AR Recurring
ADC Delayed charges
ANS No show
AD Authorize advice
ARF Refund
R0 Reversal 400
R2 Reversal 420
AFT Account Funding

Card status

ID Type Description
A Activated Can be changed to: B, T, R, S, L, F, E.
B Blocked Can`t be changed.
T Suspended Can be changed to: A, B, R, S, L, F.
R Risk Can be changed to: A, B, T, S, L, F.
S Stolen Can be changed to: B.
L Lost Can be changed to: A, B, T, R, S, F.
E Expired Can be changed to: A, B.
N Not activated Can be changed to: A, B, S.
F Fraud Can be changed to: A, B, T, R, S, L.

ECI indicator

Mastercard

Position 1-2
Value Description
21 Channel encryption; cardholder certificate not used (this is the preferred value for Mastercard ® SecureCode TM)
22 Masterpass-generated transaction
24 Digital Secure Remote Payment transaction
91 No security protocol; cardholder certificate not used
Position 3
Value Description
0 UCAF data collection is not supported by the merchant or a SecureCode merchant has chosen not to undertake SecureCode on this transaction
1 UCAF data collection is supported by the merchant, and UCAF data must be present (DE 48, subelement 43 must be present and contain an attempt AAV for Mastercard SecureCode)
2 UCAF data collection is supported by the merchant, and UCAF data must be present (DE 48, subelement 43 must contain a fully authenticated AAV)
3 UCAF data collection is supported by the merchant, and UCAF (Mastercard assigned Static Accountholder Authentication Value) data must be present.
4 Merchant has chosen to share authentication data within authorization; UCAF data collection not supported
5 Issuer Risk Based Decisioning
6 Merchant Risk Based Decisioning
7 Partial shipment or recurring payment (DE 48, subelement 43 not required). Liability will depend on the original UCAF values provided and matching with the initial transaction.
8 Reserved for future use
9 Reserved for future use

UnionPay

value Description
00 Not applicable
01 Conduct UnionPay safe entry mode authentication, and check if cardholder security information was input successfully.
03 Conduct the certification of Issuer SAA direct authentication authorization, and the SAA authentication authorization is successful.
05 Conduct the authentication of Issuer SA direct status verification, and the cardholder status verification is successful.
06 Tried to conduct the Issuer direct status verification.
07 Failed CUPSecure safe authentication, but adopted the security technology of channel.
08 Failed CUPSecure safe authentication, and did not adopt the security technology of encryption.
09 Issuer Authentication Mode in card-no-present CAT transactions.
10 Issuer Non-Authentication Mode in card-no-present CAT transactions.

Visa

Value Description
00 Not applicable
01 Mail/Phone Order (MOTO)
02 Recurring transaction
03 Installment payment
04 Unknown classification/other mail order
05 Secure electronic commerce transaction
06 Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure
07 Non-authenticated Security Transaction
08 Non-secure transaction
09 Reserved

Entry mode type

Type Name Description
0 Irrelevant This covers all entry mode types
1 Magstripe Card data was read from a magnetic stripe.
2 Contactless Card data was read via a contactless interface.
3 Ecomm Card data was sent via e-commerce/internet website.
4 Reserved Reserved for future use.
5 Optical code Card data was read via an optical interface.
6 Icc Card data was read via a chip.
7 Credential on file Card data was loaded from the merchant's storage (recurring).
8 Moto Card data was entered manually by an operator via a phone.
9 Manual Card data was entered manually.
10 Card present
11 Card not present
12 Unknown Can’t determine entry mode type.

Error code

Code Description
9999 Unknown error
001 Incorrect card provided
002 Incorrect amount provided
003 Incorrect currency provided
004 Insufficient funds
005 Incorrect program provided
006 Incorrect API key provided
007 Date not provided
008 Provider Id must be provided
009 Incorrect method provided
010 Card already exists
011 Card number not provided
012 Nameline not provided
013 Expiry month not provided
014 Expiry year not provided
016 CVV not provided
017 PIN not provided
018 First name not provided
019 Last name not provided
020 Address line 1 not provided
021 ZIP code not provided
022 City not provided
023 Country not provided
024 Default program currency is not set
025 Currencies rates is not provided
026 Status not provided
027 Duplicate unique value (trans_code, program_id, mcc_low and mcc_high)
028 Fee save failed
029 Can not delete fee
030 Selected invalid fee group
031 Selected invalid trans code
032 Can not delete limitation group
033 Selected invalid limitation group
034 Selected invalid period
035 Selected invalid opt type
036 Selected invalid type
037 Can not delete limitation
038 That limitation already exists
039 There are active limitations
040 Limit exceeded
041 Can not delete program
042 Transaction with the same reference already exists
043 Trans code is not provided
044 MCC low is not provided
045 Can not delete pad(s)
046 Card type not provided
047 Program configuration error
048 Card virtual status not provided
049 State not provided
050 Incorrect shipping method
051 Product configuration error
052 Card processor error
053 Delivery address line not provided
055 Delivery city not provided
057 Delivery country not provided
056 Delivery state not provided
054 Delivery ZIP code not provided
058 Limit group external Id must be provided
059 Limit group ID must be provided
060 Limit group not found
061 Limit name must be provided
062 Limit count must be provided
063 Limit duration must be provided
064 Limit type must be provided
065 Country id must be numeric
066 Incorrect mcc provided
067 Limit not found
068 mmc high must be bigger than mmc low
069 Parameter fee group Id is missing
070 Unknown error please refresh the page and try again
071 Scheme not provided
072 Invalid card PIN provided
073 Group with assigned data cannot be deleted
074 Program name not provided
075 Default currency not provided
076 Default limit group not provided
077 Default fee group not provided
078 Scheme not provided
079 Card design not provided
080 Cards provider not provided
081 Cards purpose not provided
082 Cards issuer not provided
083 Program not found
084 Can’t delete program with cards
085 Program contact type required
086 Fee group not found
087 Limit tx type not found
088 Program card type not provided
089 Program must be marked as virtual or not virtual
090 Cards product is required
091 Cards product not found
098 Cards sub product not found
092 Cards product name is required
093 Cards product ID is required
094 Card sub product ID is required
095 Card sub product countries ID is required
096 GPS product ID is required
097 Card sub product is required
106 Is virtual attribute is required
099 GPS sub product must be unique
105 Card sub product must be unique
100 Processing error
101 Parameter name is missing
102 Parameter name is missing
103 Card purpose not found
104 Scheme not found
107 Cards printer not provided
108 Incorrect card program provided
109 Incorrect card product bin range
110 Incorrect card sub product bin range
111 Title is too long
112 Can’t create card with this bin range
113 Cards printer name is required
114 CVV service code is required
115 Invalid printer code
116 Invalid printer id
117 Invalid shipping method id
118 Missing parameters
119 Delivery address change is restricted
120 Title not provided
121 Card id not provided
122 Shipping name not provided
123 Clients not provided
124 Name not provided
125 Tag not provided
126 Incorrect card issuer provided
127 Design code not provided
128 Default usages group not provided
129 Usage group not found
130 Parameter name is missing
131 Parameter system usages is missing
132 Parameter usages is missing
133 Parameter group id is missing
134 Card usage not found
135 Unknown usage id
136 Parameter name is missing
137 Parameter bitmap type is missing
138 Bitmap type is unknown
139 Parameter client id is missing
140 Parameter methods is missing
141 Do not have permission to access requested API method
142 Provided client ID does not exist
143 Bin range is already in use
144 Parameter name is missing
145 Parameter API id is missing
146 Parameter API key is missing
147 Client already exists
148 Client not found
149 Unknown country provided
150 Parameter region is missing
151 Parameter country is missing
152 Parameter system is missing
153 Parameter region id is missing
166 HSM keys type is not provided
167 HSM keys type id is not provided
168 HSM keys type is not found
169 HSM keys type is in use with keys. Cannot delete
154 HSM keys type is in use with keys sets. Cannot delete
155 HSM keys name is not provided
156 HSM keys key is not provided
157 HSM key is not found
158 HSM key ID is not provided
159 HSM key cannot be removed, because it is used in key set
162 HSM key set cannot be saved
163 HSM key set ID is not provided
160 HSM key set name is not provided
161 HSM key set type is not provided
164 HSM key set is in use and cannot be deleted
165 Parameter name is missing
170 This Key Type already exists
171 Cards product country ISON is required
172 Limit region type is not provided
173 Parameter bin from is missing
174 Parameter bin to is missing
175 Sub product bin range is already in use
176 Card or product key set is not provided
177 Default sub product currency is not set
178 Sub product is not found by selected card country
179 HSM Key or HSM Type is not provided
180 More than one key found. Cannot determine correct key without using index
181 Action failed. No keys has been found in card keyset
182 PIN change/unblock failed. PVKI is not found on the card until first transaction
183 Phone number not provided
184 Cards not found
185 No data set
186 Can not prepare file save location
187 Incorrect card design provided
188 Card design configuration error
189 Phone number is not valid
190 Transaction date imported from is not set
191 Transaction date imported to is not set
192 Transaction ID is not provided
193 Transaction is not found
194 Dispute reason is not provided
195 Dispute function code is not provided
196 Dispute amount type is not provided
197 Dispute amount is not provided
198 Dispute currency is not provided
199 Dispute amount or amount type is incorrect
200 Dispute currency is incorrect
201 Dispute amount is higher than transaction amount
202 Dispute reason code is not provided
203 Can not create dispute for dispute transaction
204 Parameter card number hash is missing
205 Parameter acquirer bin is missing
206 Parameter trace id is missing
207 Billing amount is not provided
208 Billing currency ison is not provided
209 Trace number is not provided
210 Card has not been found
211 Operations limit has been reached. Transaction cancelled
212 Load amount limit has been reached. Transaction cancelled
213 Load transaction failed
214 Unload amount limit has been reached. Transaction cancelled
215 Unload transaction failed
216 Insufficient funds
217 Card is not active
218 Dispute status is not provided
219 Dispute stage id is not provided
220 Dispute masked pan is not provided
221 Dispute card number hash is not provided
222 Dispute trace id is not provided
223 Dispute acquirer bin is not provided
224 Dispute main transaction id is not provided
225 Dispute event id is not provided
226 Dispute MTI is not provided
227 Transaction already has dispute case
228 Dispute id is not provided
229 Incorrect dispute status
230 Incorrect dispute stage
231 Dispute not found
232 Client ID is not provided
233 Product ID is not provided
234 API ID is not provided
235 Stand in is not provided
236 External decision is not provided
237 Authorization notification is not provided
238 Transaction notification is not provided
239 Active is not provided
240 Callback URL is not provided
241 Product reference is not provided
242 Delivery code too long
243 Fulfil 1 value too long
244 Fulfil 2 value too long
245 Product reference is not provided or is too long
246 Carrier logo ID is not provided or is too long
247 Image ID is not provided or is too long
248 Logo front ID is not provided or is too long
249 Logo back ID is not provided or is too long
250 Parameter client credentials id is missing
251 Provided client credentials ID does not exist
252 Client credential already exists
253 Parameter is system is missing
254 Client credentials not found
255 Dispute system due date is not provided
256 Dispute scheme id is not provided
257 Unknown dispute scheme id is provided
258 Can not update card balance
259 Personalization file date from is not set
260 Personalization file date to is not set
261 Personalization file id is not provided
262 Personalization file not found
263 TAI endpoint not found
264 TAI endpoint ID is not provided
265 Minimum allowed value for timeout after milliseconds is 1
266 Maximum allowed value for timeout after milliseconds is 60000
267 ACS file date from is not set
268 ACS file date to is not set
269 ACS file id is not provided
270 ACS file not found
271 Card product is not provided
272 MCC high is not provided
273 Amount is not provided
274 Percent is not provided
275 Pad amount currency is not provided
276 Pad not found
277 Pad id is not provided
278 Actual authorize date from is not set
279 Actual authorize date to is not set
280 MCC low only integer value allowed
281 MCC high only integer value allowed
282 Pad amount only integer value allowed
283 Pad percent only integer value allowed
284 TAI endpoint has TAI notifications
285 Authorize date from is not set
286 Authorize date to is not set
287 Transaction id only integer value allowed
288 Transaction proc code only string value allowed
289 Transaction amount transaction only integer value allowed
290 Transaction amount reconciliation only integer value allowed
291 Transaction amount holder billing only integer value allowed
292 Transaction currency transaction ison only string value allowed
293 Transaction currency reconciliation ison only string value allowed
294 Transaction currency holder billing ison only string value allowed
295 Transaction function code only integer value allowed
296 Transaction mti only string value allowed
297 Transaction mcc only integer value allowed
298 Transaction trace id only string value allowed
299 Transaction ipm files id only integer value allowed
300 Transaction schemes id only integer value allowed
301 Transaction cards id only integer value allowed
302 Transaction holder amount only integer value allowed
303 Transaction holder currency ison only string value allowed
304 Transaction proc code incorrect value length
305 Transaction currency transaction ison incorrect value length
306 Transaction currency reconciliation ison incorrect value length
307 Transaction currency holder billing ison incorrect value length
308 Transaction holder currency ison incorrect value length
309 Transaction function code incorrect value length
310 Transaction mti incorrect value length
311 Transaction mcc incorrect value length
312 Transaction trace id incorrect value length
313 Timeout after milliseconds not provided
314 Raw message send not provided
315 Dispute status only string value allowed
316 Dispute status value is too long
317 Dispute stage id only integer value allowed
318 Dispute main transaction id only integer value allowed
319 Dispute amount type only integer value allowed
320 Dispute event id only integer value allowed
321 Dispute reason code only integer value allowed
322 Dispute mti only string value allowed
323 Dispute mti value is too long
324 Dispute function code only integer value allowed
325 Dispute scheme id only integer value allowed
326 Dispute amount only numeric value allowed
327 Currency ison only numeric value allowed
328 Currency ison must be three characters long
329 Dispute amount must be greater than nil
330 Dispute dispute id only integer value allowed
331 Can not revert this transaction
332 Can not find main transaction
333 Transaction card number hash only string value allowed
334 Transaction card number hash incorrect value length
335 Transaction acquirer bin only integer value allowed
336 Transaction acquirer bin incorrect value length
337 De proc code is not provided
338 Mcc low incorrect value, minimum value 1
339 Can not create another reversal for this transaction
340 Transaction is not processed
341 Parent transaction not found
342 Card printer personalization file format is invalid
343 Mcc low incorrect value, maximum value 9999
344 Mcc high incorrect value, minimum value 1
345 Mcc high incorrect value, maximum value 9999
346 Pad amount incorrect value length
347 Pad percent incorrect value length
348 Transaction type not found
349 Currency not found
350 Dispute retrieval document code is not provided
351 Dispute retrieval document code only integer value allowed
352 Limit configuration for this group already exists
353 When region type is All Regions then Holder Region, Transaction Region and Transaction Country values should be 0
354 When region type is Domestic then Holder Region, Transaction Region and Transaction Country values should be 0 or more
355 When region type is International then Holder Region and Transaction Region is 0, but Transaction Country values should be 0 or more
356 When region type is International Within Region then Holder Region and Transaction Region values should be 0 or more, but Transaction Country is 0
357 When region type is International Outside Region then Holder Region and Transaction Region values should be 0 or more, but Transaction Country is 0
358 Invalid transaction country Ison
359 Invalid holder country Ison
360 Invalid holder currency Ison
361 Holder region is not valid
362 Transaction region is not valid
363 Fees merge not provided
364 Blend in FX not provided
365 Can not create dispute by fee transaction
366 Account to card not found
367 Account not found
368 Invalid title provided
369 Invalid first name provided
370 Invalid last name provided
371 Invalid address line 1 provided
372 Invalid address line 2 provided
373 Invalid address line 3 provided
374 Invalid address line 4 provided
375 Invalid zip code provided
376 Invalid city provided
377 Invalid state provided
378 Invalid phone number provided
379 First name is too long
380 Last name is too long
381 Address line 1 is too long
382 Address line 2 is too long
383 Address line 3 is too long
384 Address line 4 is too long
385 Zip code is too long
386 City is too long
387 State is too long
388 Phone number is too long
389 Address line 2 is not provided
390 Address line 3 is not provided
391 Address line 4 is not provided
392 country_ison must be three characters long
393 Country not found
394 Delivery title is too long
395 Invalid delivery title provided
396 Delivery first name is not provided
397 Delivery first name is too long
398 Invalid delivery first name provided
399 Delivery last name is not provided
400 Delivery last name is too long
401 Invalid delivery last name provided
402 Delivery address line 1 is not provided
403 Delivery address line 1 is too long
404 Invalid delivery address line 1 provided
405 Delivery address line 2 is too long
406 Invalid delivery address line 2 provided
407 Delivery address line 3 is too long
408 Invalid delivery address line 3 provided
409 Delivery address line 4 is too long
410 Invalid delivery address line 4 provided
411 Delivery zip code is not provided
412 Delivery zip code is too long
413 Invalid delivery zip code provided
414 Delivery city is too long
415 Invalid delivery city provided
416 Delivery state is too long
417 Invalid delivery state provided
418 Invalid delivery shipping method provided
419 Delivery shipping method not found
420 Original transaction amount is not provided
421 Original transaction amount only integer value allowed
422 Reserved for future
423 Issuer not found
424 Issuer business id not provided
425 Issuer invalid business id provided
426 Issuer business name not provided
427 Issuer not provided
428 Provided Issuer name to long
429 Invalid Issuer name provided
430 Effective from is not provided
431 Effective to is not provided
432 Effective from only integer value allowed
433 Effective to only integer value allowed
434 Effective from can not be greater than effective to
435 Card reference id is too long
436 Invalid card reference id provided
437 Holder country not found
438 Bulk address line 1 not provided
439 Bulk address line 1 too long
440 Invalid bulk address line 1 provided
441 Bulk address line 2 too long
442 Invalid bulk address line 2 provided
443 Bulk address line 3 too long
444 Invalid bulk address line 3 provided
445 Bulk address line 4 too long
446 Invalid bulk address line 3 provided
447 Bulk address country ison not provided
448 Bulk address country ison too long
449 Invalid bulk address country ison provided
450 Bulk address country not found
451 Bulk zip code not provided
452 Bulk zip code too long
453 Invalid bulk zip code provided
454 Bulk city not provided
455 Bulk city is too long
456 Invalid bulk city provided
457 Bulk state not provided
458 Bulk state is too long
459 Invalid bulk state provided
460 Holder not found
461 Holder id not provided
462 Holder id only integer value allowed
463 Card ID only integer value allowed
464 Card name line 3 too short
465 Card name line 3 is too long
466 Invalid card name line 3 provided
467 Card name line 4 is too short
468 Card name line 4 is too long
469 Invalid card name line 4 provided
470 Invalid order delivery code provided
471 Invalid order fulfil 1 provided
472 Invalid order fulfil 2 provided
473 Holder country not provided
474 Provided program do not have option provided in card virtual
475 API version is invalid
476 Account id not provided
477 Account id only integer value allowed
478 Account status not provided
479 Account status only string value allowed
480 Account status is too long
481 Incorrect account status
482 Card ID is not provided
483 Incorrect value provided for card virtual
484 Card nameline 3 not provided
485 Card product id too long
486 Card product id must be numeric
487 Card fee group id must be numeric
488 Card fee group id too long
489 Card limit group id must be numeric
490 Card limit group id too long
491 Card usage group id must be numeric
492 Card usage group id too long
493 Card usage group id must be numeric
494 Card design id too long
495 Card design not found
496 Account ID must be numeric
497 Account id too long
498 Account owner id must be numeric
499 Account owner id too long
500 Account owner not found
501 Account owner id not provided
502 Holder id too long
503 Holder title is too long
504 Invalid holder title provided
505 Holder first name not provided
506 Holder first name is too long
507 Invalid holder first name provided
508 Holder last name not provided
509 Holder last name is too long
510 Invalid holder last name provided
511 Holder address line 1 not provided
512 Holder address line 1 is too long
513 Invalid holder address line 1 provided
514 Holder address line 2 is too long
515 Invalid holder address line 2 provided
516 Holder address line 3 is too long
517 Invalid holder address line 3 provided
518 Holder address line 4 is too long
519 Invalid holder address line 4 provided
520 Holder zip code not provided
521 Holder zip code is too long
522 Invalid holder zip code provided
523 Holder city not provided
524 Holder city is too long
525 Invalid holder city provided
526 Holder state not provided
527 Holder state is too long
528 Invalid holder state provided
529 Holder phone number not provided
530 Invalid holder phone number provided
531 Delivery country ison must be three characters long
532 Delivery country not found
533 Order language only alphabetic characters
534 Order language must be three characters long
535 Invalid card pan provided
536 Invalid card cvc2 provided
537 Invalid card expiration year provided
538 Invalid card expiration month provided
539 Account blocked
540 Billing amount only integer value allowed
541 Billing amount incorrect value length
542 Load type is not provided
543 Load source is not provided
544 Load type only integer value allowed
545 Load source only integer value allowed
546 Load type incorrect value length
547 Load source incorrect value length
548 Incorrect Country Count value provided
549 Amount Currency is mandatory when Amount higher than 0
550 Invalid Amount Currency provided
551 Card is already activated
552 Reserved for future
553 Reserved for future
554 Card status cannot be changed to the current status.
555 Billing amount cannot be less than 1
556 Schemes id not provided or invalid
557 Duplicate unique value (type, scheme id)
558 Provided number of accounts ids and account owners ids do not match
559 Only one account allowed per currency
560 Card currency must be empty then account provided
561 Program and account currency do not match
562 Duplicate card currency ison value provided
563 Load type is incorrect
564 Load source is incorrect
565 Balance amount overflow
566 Client ID only integer value allowed
567 Client ID too long
568 API ID too long
569 Pan return type not provided
570 Invalid pan return type provided
571 PIN return type not provided
572 Invalid PIN return type provided
573 Cvc2 return type not provided
574 Invalid cvc2 return type provided
575 Card expiration date return type provided
576 Invalid card expiration date return type provided
577 HSM key set keys contains invalid values. Only integers allowed
578 Reference number is too long
579 Invalid reference number provided
580 Paginator data not provided
581 Paginator limit not provided
582 Paginator limit must be numeric
583 Paginator offset not provided
584 Paginator offset must be numeric
584 Paginator limit cannot be bigger than 100
586 Paginator limit must be at least 1
587 Date from must be numeric unix timestamp
588 Date to must be numeric unix timestamp
589 Paginator must contain limit(items count) and offset
590 Data encryption key is not provided
591 Invalid data encryption key provided
592 Data encryption key should be 32 symbols
593 Invalid data return type provided
594 Bypass instant notification option is not provided
595 Limit group name is too short
596 Limit group name is too long
597 Invalid limit group name provided
598 Region not found
599 Region cannot be removed, because it is used in fee
600 Region cannot be removed, because it is used in limit
601 Region cannot be removed, because it is used in card fee
602 Region cannot be removed, because it is used in card limit
603 Fee group cannot be removed, because it is used in cards
604 Fee group cannot be removed, because it is used in fee
605 Fee group cannot be removed, because it is used in programs
606 Auto conversion parameter is required
607 Cannot edit program with cards
608 Program id must be numeric
609 Program id too long
610 Cannot edit card product with cards
611 Cannot delete card product with cards
612 Card sub product id must be numeric
613 Card sub product id too long
614 Cannot edit card sub product with cards
615 Cannot delete card sub product with cards
616 Bin range id must be numeric
617 Bin range id too long
618 Bin range not found
619 Cannot edit bin range with cards
620 Card id too long
621 Limit type option is not provided
622 Limit type must be numeric
623 Limit type is too long
624 Invalid limit type provided
625 Fee title only string value allowed
626 Fee title is too long
627 Transaction type not provided
628 Entry mode not provided
629 Mcc low is not provided
630 Mcc high is not provided
631 Fee fixed price only numeric value allowed
632 Fee percent price only numeric value allowed
633 Currency ison is not provided
634 Country ison is not provided
635 Region id only integer value allowed
636 Fee min amount only integer value allowed
637 Fee max amount only integer value allowed
638 Blacklist source type id is not provided
639 Blacklist source type id only integer value allowed
640 Blacklist source type id not found
641 Blacklist by source, source value is not provided
642 Blacklist by source, source value only string value allowed
643 Blacklist by source, is report fraud is not provided
644 Blacklist by source, is report fraud only bool value allowed
645 Blacklist by source, is report fraud not found
646 Blacklist by source, date created only integer value allowed
647 Blacklist by source, date updated only integer value allowed
648 Blacklist by source, id not found
649 Blacklist by source, record not found
650 Blacklist by source, record already exists
651 Mcc high should be higher value than mcc low
652 Only one country id or region id should be provided
653 Invalid fee title provided
654 Description is too long
655 Invalid description provided
656 Log history id not provided
657 Log history not found
658 Date from not provided
659 Date to not provided
660 Cannot delete card product, it has assigned card sub product
661 Incorrect user bit map provided
662 Bin range already exists with this id
663 Bin range id not provided
664 Card product already exists with this id
665 Duplicate unique value transaction type, program, mcc low, mcc high and currency ison
666 Pad already exists with this id
667 Issuer id not provided
668 Pad id too long
669 Pad id must be numeric
670 Program id not provided
671 Limit group and Card Id cannot have limit. You must choose one or the other
672 Card design printer info not provided
673 Card design printer info tag is too long
674 Invalid card design printer info tag provided
675 Card printer not found
676 Card design printer info product reference is too long
677 Card design printer info is default not provided
678 Invalid card design printer info is default provided
679 Card design id not provided
680 Default card printer info not provided
681 Only one default card printer info can be provided
682 Cannot delete bin range with card products
683 Card design name is already taken
684 Card printer name is already taken
685 Printer and Scheme to the card design can be assigned only once
686 Blacklist by source, response code only string value allowed
687 Blacklist by source, response code incorrect value length
688 Authorize processing code only string value allowed
689 Authorize processing code incorrect value length
690 Authorize MTI only string value allowed
691 Authorize MTI incorrect value length
692 Authorize type only string value allowed
693 Authorize type incorrect value length
694 Authorize cards id only integer value allowed
695 Authorize transaction date and time only integer value allowed
696 Authorize transaction amount only integer value allowed
697 Authorize transaction currency ison only string value allowed
698 Authorize transaction currency ison incorrect value length
699 Authorize status code only string value allowed
700 Authorize status code incorrect value length
701 Authorize country ison only string value allowed
702 Authorize country ison incorrect value length
703 Authorize MCC code only integer value allowed
704 Authorize transaction type id only integer value allowed
705 Authorize entry mode type id only integer value allowed
706 Authorize date created only integer value allowed
707 Authorize id is not provided
708 Authorize id only integer value allowed
709 Authorize not found
710 Company client is not provided
711 Cannot assign same scheme and business ID per country multiple times
712 Card printer sftp enabled invalid
713 Card printer sftp username invalid
714 Card printer sftp port invalid
715 Card printer sftp path invalid
716 Card printer sftp host invalid
717 Card number hash only string value allowed
718 Card number hash incorrect value length
719 Personalization file id only integer value allowed
720 Provided account holder id and cards id: %s, holders id does not match
721 Skip holder validation value not provided
722 Can not unset cards id: %s, because it is card primary account id
723 Entity for limit has not been detected
724 Limit group and Account Id cannot have limit. You must choose one or the other
725 External payment method id not provided
726 External payment method invalid id provided
727 Reserved for future
728 External payment method name not provided
729 External payment method name too long
730 External payment method API id not provided
731 External payment method API id too long
732 Reserved for future
733 External payment method API password too long
734 External payment method API url not provided
735 External payment method url too long
736 External payment not found
737 External payment type id not provided
738 External payment method not found
739 Reserved for future
740 Cannot assign same currency per external payment method multiple times
741 Fee group name too long
742 External payment address id not provided
743 External payment address id only integer value allowed
744 External payment address not found
745 Invalid holder id provided
746 Reserved for future
747 Shipping method not found
748 Card printer shipping method not found
749 Duplicate unique value card printer and shipping method
750 Card printer shipping method id not provided
751 Duplicate unique value card printer and printer code
752 External payment method API url invalid
753 External payment method name invalid
754 External payments server not exist by provided method API URL
755 Reserved for future
756 External payment method not implemented
757 External payment address inbound enabled not provided
758 External payment address inbound enabled only boolean value allowed
759 External payment address inbound enabled only 0 and 1 values allowed
760 External payment address outbound enabled not provided
761 External payment address outbound enabled only integer value allowed
762 External payment address outbound enabled only 0 and 1 values allowed
763 Provide client name is too long
764 Provided client name already exists
765 Invalid client name provided
766 Invalid allow country change provided
767 Reserved for future
768 External payment address account number not provided
769 External payment address account number too long
770 External payment address account number invalid
771 External payment address account name not provided
772 External payment address account name too long
773 External payment address account name invalid
774 External payment address sort code not provided
775 External payment address sort code too long
776 External payment address sort code invalid
777 Sequence limit reset data cannot be empty
778 Sequence limit reset data must be type of array
779 External payment transaction failed
780 External payment type notification action not provided
781 External payment type notification action too long
782 External payment type API secret not provided
783 External payment type API secret too long
784 Duplicate unique value external payment type notification action
785 Cannot assign same country multiple times with overlapping effective dates
786 Limit account group not found
787 Default limits accounts group not provided
788 External payment transaction id not provided
789 External payment transaction id only integer value allowed
790 Reserved for future
791 Reserved for future
792 Reserved for future
793 Reserved for future
794 Reserved for future
795 Reserved for future
796 Reserved for future
797 Reserved for future
798 Reserved for future
799 Reserved for future
800 Reserved for future
801 Reserved for future
802 Sequence limit reset data entry mode is invalid
803 Reserved for future
804 Reserved for future
805 External payment transaction not found
806 Card number already exists
807 Account limit group id must be numeric
808 Account limit group id too long
809 Card number not found
810 Selected currency not supported by card product
811 Invalid program name provided
812 A list has to be provided for the card designs
813 A list has to be provided for the fees groups
814 A list has to be provided for the limits groups
815 A list has to be provided for the usage groups
816 Card has been expired
817 Reserved for future
818 Fee transaction failed
819 Transaction failed
820 Invalid card request id
821 More than one card number found
822 Card limit has been reached
823 External payment address iban not provided
824 External payment address iban too long
825 External payment address iban invalid
826 Reserved for future
827 External payment address bic too long
828 External payment address bic invalid
829 Reserved for future
830 Reserved for future
831 Reserved for future
832 Reserved for future
833 Records limit must be a numeric value
834 Last ID must be a numeric value
835 Reserved for future
836 Reserved for future
837 Reserved for future
838 Reserved for future
839 Item count parameter cannot be less than 1
840 Item count parameter cannot be more than 100
841 A list has to be provided for the account limits groups
842 Limit group and Holder ID cannot have limit. You must choose one or the other
843 Reason code not provided
844 Function code not provided
845 Reson code only integer value allowed
846 Function code only integer value allowed
847 Transaction amount not provided
848 Transaction amount only integer value allowed
849 Cards ID not provided
850 Cards ID only integer value allowed
851 Mcc not provided
852 Mcc only integer value allowed
853 Acquirer ID not provided
854 Acquirer ID only string value allowed
855 Forwarder ID not provided
856 Forwarder ID only string value allowed
857 Card acceptor terminal ID not provided
858 Card acceptor terminal ID only string value allowed
859 Fee collection control number not provided
860 Fee collection control number only integer value allowed
861 Original transaction currency code not provided
862 Original transaction currency code only integer value allowed
863 Transaction currency not provided
864 Transaction currency only integer value allowed
865 Trace ID not provided
866 Trace ID only string value allowed
867 Transaction destination ID code not provided
868 Transaction destination ID code only integer value allowed
869 Transaction originator ID code not provided
870 Transaction originator ID code only integer value allowed
871 Invalid card ID
872 Sequence reset entry modes list cannot contain same value as the main entry mode
873 Card number stock is empty
874 Record ID only integer value allowed
875 Incorrect Record ID provided
876 Limit group and Record ID cannot have limit. You must choose one or the other.
877 Limit tx type is not provided
878 Limit tx type must be numeric
879 Limit tx type is too long
880 Limit tx type provided is invalid
881 Limit Count must be numeric value if provided
882 Sequence limit reset data entry modes must be integer values
883 Failed to recalculate card account
884 Holder contains invalid information. %s
885 External payment address direct credit enabled not provided
886 External payment address direct credit enabled only boolean value allowed
887 External payment address direct credit enabled only 0 and 1 values allowed
888 External payment address direct debit enabled not provided
889 External payment address direct debit enabled only integer value allowed
890 External payment address direct debit enabled only 0 and 1 values allowed
891 Reserved for future
892 Primary not provided
893 Invalid value provided for primary
894 Only one primary TAI endpoint can be created
895 Invalid value provided for stand in
896 Invalid value provided for internal balance check
897 Invalid value provided for authorization notification
898 Invalid value provided for transaction notification
899 Invalid value provided for active
900 Invalid value provided for raw message send
901 Invalid value provided for fees merge
902 Invalid value provided for blend in FX
903 Invalid value provided for bypass instant notification
904 Reserved for future
905 Reserved for future
906 Program id already exists
907 Minimum allowed value for port is 0
908 Maximum allowed value for port is 65535
909 Provided card printer id already exists
910 Integer should be provided for the card printer id
911 Provided card printer id too long
912 Card printer id not provided
913 Fee group id only integer value allowed
914 Special account id is not provided
915 Special account id only integer value allowed
916 Special account not found
917 Special account name is not provided
918 Special account name is too long
919 Special account type is not provided
920 Special account type only integer value allowed
921 Incorrect special account type
922 Can not delete special account with special account transactions
923 Special account date created only integer value allowed
924 Special account date updated only integer value allowed
925 Special account transaction id is not provided
926 Special account transaction id only integer value allowed
927 Special account transaction not found
928 Special account transaction operation only integer value allowed
929 Incorrect special account transaction operation
930 Special account transaction origin date from only integer value allowed
931 Special account transaction origin date to only integer value allowed
932 Special account transaction date created only integer value allowed
933 External payments server error. %s
934 Special account balance only integer value allowed
935 Special account transaction amount only integer value allowed
936 Reserved for future
937 Limit duration type unknown
938 Limit holder group not found
939 Default holder limits group not provided
940 Holder limit group id must be numeric
941 Holder limit group id too long
942 Invalid card design printer info provided
943 Reserved for future
944 Reserved for future
945 Reserved for future
946 Reserved for future
947 Special account invalid name provided
948 Card ID or account ID must be specified
949 Account limits group not provided
950 Holder limits group not provided
951 Reserved for future
952 Internal host transaction failed
953 Region type not provided
954 Invalid region type provided
955 Reserved for future
956 Reserved for future
957 Reserved for future
958 Reserved for future
959 Reserved for future
960 Reserved for future
961 Reserved for future
962 Reserved for future
963 Mandate id not provided
964 Mandate id only integer value allowed
965 Reserved for future
966 Reserved for future
967 API version must be provided
968 Mandate not found
969 Reserved for future
970 Reserved for future
971 Reserved for future
972 Blacklist by sources ID only integer value allowed
973 Personalization file name only string value allowed
974 Personalization file is sent only bool value allowed
975 Printer ID only integer value allowed
976 Transaction type ID only integer value allowed
977 Invalid TAI endpoint ID provided
978 Callback URL must be string
979 API ID must be string
980 Card reference ID must be string
981 Card number must be string
982 Should pay not provided
983 Should pay only integer value allowed
984 Should pay only 0 and 1 values allowed
985 Wrong due date
986 ZPK key id not provided
987 Invalid ZPK key id provided
988 Reserved for future
989 Reserved for future
990 Reserved for future
991 Reserved for future
992 Reserved for future
993 Reserved for future
994 Authorize type is not provided
995 Authorize type only integer value allowed
996 Incorrect authorize type
997 Transaction type is not provided
998 Transaction type only integer value allowed
1000 Incorrect transaction type
1001 Entry mode type is not provided
1002 Entry mode type only integer value allowed
1003 Incorrect entry mode type
1004 Scheme ID is not provided
1005 Scheme ID only integer value allowed
1006 Incorrect scheme ID
1007 Expiration date is not provided
1008 Expiration date only string value allowed
1009 Incorrect expiration date format
1010 Transaction amount is not provided
1011 Transaction amount only integer value allowed
1012 Transaction currency only numeric value allowed
1013 Transaction currency must be three characters long
1014 Transaction currency is not provided
1015 Incorrect transaction currency
1016 Billing amount is not provided
1017 Billing amount only integer value allowed
1018 Billing currency only numeric value allowed
1019 Billing currency must be three characters long
1020 Incorrect billing currency
1021 Billing currency is not provided
1022 Mcc is not provided
1023 Mcc only numeric value allowed
1024 Incorrect mcc value
1025 Transaction amount and billing amount must be the same value, because amounts are the same currency
1026 Direct debit disabled
1027 Personalization file cards count only integer allowed
1028 Personalization file products count only integer allowed
1029 Authorize simulation is off
1030 External payment direct debit is disabled
1031 Invalid authorize log type provided
1032 Account attribute not provided
1033 Reserved for future
1034 Bin not provided
1035 Bin should be between 1 and 12 digits length
1036 Key set id not provided
1037 Key set id must be of type integer
1038 Key set does not exist
1039 Bin sponsor must be of type integer
1040 Bin sponsor not provided
1041 Issuer id must be of type integer
1042 Bin does not exist
1043 Bin id should be of type integer
1044 Log transaction error ID not provided
1045 Log transaction error ID only integer value allowed
1046 Log transaction error not found
1047 Log transaction error status not provided
1048 Log transaction error invalid status provided
1049 Transaction already processed
1050 Log transaction not found
1051 Transaction reimport failed
1052 IPM file not found
1053 Cannot reimport transaction, because not processed transaction status is completed
1054 Transaction reimport not implemented for provided scheme
1055 Cannot reprocess transaction, because not processed transaction status is completed
1056 Assignee not provided
1057 Assignee only integer value allowed
1058 Schemes ID only integer value allowed
1059 Status only integer value allowed
1060 Error type only integer value allowed
1061 A list has to be provided for the API methods
1062 Internal host load transaction card amount limit has been reached
1063 Internal host load transaction account amount limit has been reached
1064 Internal host load transaction holder amount limit has been reached
1065 De proc code is not provided
1066 Card acceptor ID is not provided
1067 Transaction receiving ID code is not provided
1068 Transaction receiving ID code string allowed
1069 Card acceptor ID length is incorrect
1070 Acquirer ID length is incorrect
1071 Forwarder ID length is incorrect
1072 Card acceptor terminal ID length is incorrect
1073 Transaction destination ID code length is incorrect
1074 Transaction originator ID code length is incorrect
1075 Transaction receiving institution ID code length is incorrect
1076 Card acceptor name, address, city, post code length is incorrect
1077 Card acceptor name, address, city, post code is not provided
1078 Card acceptor name, address, city, post code must be a string
1079 Printer key and Issuer is duplicated, but must be unique
1080 Card type name is not provided
1081 Card type ID is not provided
1082 Card type not found
1083 Fixed price currency must be provided if fixed price is entered
1084 External payment type name not provided
1085 External payment type name too long
1086 External payment type name invalid
1087 External payment method invalid ID provided
1088 External payment type notification action invalid value provided
1089 Holder email address is invalid
1090 Holder IP address is invalid
1091 Holder date of birth is not a valid date
1092 Holder KYC document expiration date is not a valid date
1093 Holder KYC completion level must be numeric
1094 Could not resolve host by provided method API URL
1095 Holder email length is invalid
1096 Holder IP length is invalid
1097 Holder birth of date length is invalid
1098 KYC expiration date length is invalid
1099 KYC completion level length is invalid
1100 Parameter name is missing
1101 Scheme not provided
1102 MCC group not found
1103 Parameter MCC group ID is missing
1104 Is default attribute is required
1105 Is default only bool value allowed
1106 Only one default special account can be set
1107 MCC group name too long
1108 Card validity period value must be numeric
1109 Card validity period value is not in valid range
1110 Cards cannot be the same
1111 Accounts cannot be the same
1112 Shipping method ID is not provided
1113 Shipping method name is not provided
1114 Risk merchant configuration name is not provided
1115 Risk merchant configuration name must be less than 255 symbols
1116 Risk merchant configuration does not exists
1117 Risk merchant configuration client id is not provided
1118 Risk merchant configuration merchant id is not provided
1119 Risk merchant configuration merchant id must be less than 20 symbols
1120 Risk merchant configuration acquirer id is not provided
1121 Risk merchant configuration acquirer id must be less than 20 symbols
1122 Risk merchant configuration terminal id must be less than 50 symbols
1123 Only one special account with same currency can be selected
1124 Only one special account could be set as default
1125 KYC completion level must be possitive
1126 Risk Merchant Configuration already exist.
1127 Risk merchant configuration name can contain letters, numbers and dash.
1128 External ID only integer value allowed
1129 Due date only integer value allowed
1132 Account limit has been reached
1133 Holder limit has been reached
1134 External payment address is not active
1135 External payment mandate is not active
1136 Pad name string allowed
1137 Pad name incorrect value length
1138 Pad name is not provided
1139 Source card ID only integer value allowed
1140 Source card has not been found
1141 Destination card ID only integer value allowed
1142 Destination card has not been found
1143 Source account ID must be numeric
1144 Source account not found
1145 Destination account ID must be numeric
1146 Destination account not found
1147 Duplicated MCC range
1148 Card delivery data not found
1149 Clients IDs not provided
1150 Entity keys not provided
1151 Entity does not exist
1152 External payment transaction tx type invalid value provided
1152 External payment transaction tx type invalid value provided
1153 External payment transaction status invalid value provided
1154 External payment transaction status code invalid value provided
1155 External payment type ID only integer value allowed
1156 Date created from only integer value allowed
1157 Date created to only integer value allowed
1158 Card purpose name is not provided
1159 Card purpose ID is not provided
1160 Card purpose not found
1161 Risk rule group name is not provided
1162 Risk rule group name is too short
1163 Risk rule group name is too long
1164 Invalid risk rule group name provided
1165 Risk rule group ID not provided
1166 Risk rule group not found
1167 Group with assigned risk rules cannot be deleted
1168 Cannot deleted risk rules group which is assigned to program
1169 Risk rule ID not provided
1170 Risk rule is assigned as counter
1171 Risk rule not found
1172 Risk rule name is not provided
1173 Risk rule name is too short
1174 Risk rule name is too long
1175 Invalid risk rule name provided
1176 Risk rule type not provided
1177 Risk rule type must be numeric
1178 Risk rule type is too long
1179 Invalid risk rule type provided
1180 Risk rule action not provided
1181 Risk rule action must be numeric
1182 Risk rule action is too long
1183 Invalid risk rule action provided
1184 Risk rule transaction amount must be numeric
1185 Risk rule transaction amount currency ison must be numeric
1186 Risk rule transaction amount currency not found
1187 Risk rule transaction amount currency is mandatory if transaction amount provided
1188 Risk rule duration amount currency ison must be numeric
1189 Risk rule duration amount currency ison must be numeric
1190 Risk rule duration amount currency not found
1191 Risk rule duration amount currency is mandatory if duration amount provided
1192 Risk rule count must be numeric
1193 Risk rule duration must be numeric
1194 Unknown risk rule duration type provided
1195 Entry mode not found
1196 Both MCC low and high required
1197 MCC high must be higher or equal than MCC low
1198 Transaction country not found
1199 Transaction region not found
1200 Invalid risk rule transaction status provided
1201 Risk rule transaction status only numeric value allowed
1202 Risk rule additional counter not found
1203 Risk rule additional counter type is too long
1204 Risk rule unknown additional counter type
1205 Risk rule additional counter effected by must be numeric
1206 Risk rule additional counter effected by is too long
1207 Client credential ID is not provided
1208 Risk rule transaction amount not provided
1209 Risk rule duration amount not provided
1210 Risk rule duration not provided
1211 Risk rule additional counter ID not provided
1212 Risk rule additional counter type not provided
1213 Risk rule additional counter effected by not provided
1214 API ID already exist. API secret should be the same
1215 Reserved for future
1216 Unknown entity does not exist
1217 Unknown field is empty
1219 Provided transaction amount is too low
1220 Provided duration amount is too low
1221 Provided count is too low
1222 Provided duration is too low
1223 Risk rule duration or duration amount is required
1224 Risk rule count not provided
1225 Bin is already in use
1226 Program availability not provided
1227 Program acs not provided
1228 Invalid value provided for the risk rule action
1229 Cannot assign risk rule action
1230 Risk rule is counter only not provided
1231 Risk rule is counter only boolean value allowed
1232 FX fee transaction failed
1233 Risk rule code is not provided
1234 Risk rule code is too long
1235 Invalid risk rule code provided
1240 Replacement amount can not be greater or equal than transaction amount
1241 API ID is already used
1242 Can not create partial reversal
1243 Can not create full reversal
1244 Can not revert reversal
1245 TAI config name is not provided
1246 TAI config name is too long
1247 TAI config name invalid
1248 TAI type is not provided
1249 Invalid TAI type value provided
1250 TAI config ID is not provided
1251 Invalid TAI config ID provided
1252 TAI config not found
1253 TAI config has TAI endpoints
1254 TAI config has programs
1255 TAI config has TAI notifications
1256 Paginator offset must be positive number
1258 Can not create settlement
1259 Can not revert settlement
1260 Can not settlement reversal
1261 Can not settle settlement
1262 Actual authorize not found
1263 Failed to create settlement
1264 Can not change PIN for virtual cards
1265 Can not unblock PIN for virtual cards
1269 Carrier type is not provided
1270 Carrier type is too long
1271 Duplicated request
1274 Authorization type must be numeric
1275 Invalid authorization type provided
1278 Incorrect card status
1279 Reference ID should be between 10 and 255 alphanumeric length
1280 Reference ID can contain only letters, numbers and dashes
1282 Risk rule duration type not provided
1283 Risk rule duration value too high
1284 Limit duration value too high
1285 Generate new pan attribute is required
1286 Generate new pan only boolean value is allowed
1287 Is virtual attribute is required
1288 Is virtual only boolean value is allowed
1289 New program is not compatible with card. Please choose another program or generate new PAN
1290 Risk rule reversed tx included is not provided
1291 Risk rule reversed tx included only boolean value allowed
1292 Card status cannot be changed from %s (%s) to %s (%s)
1304 Risk rule amount must be numeric
1305 Risk rule amount ison must be numeric
1306 Risk rule amount currency not found
1307 Risk rule amount currency is mandatory if amount provided
1308 Risk rule amount is not provided
1309 Risk rule condition type must be numeric
1310 Risk rule condition type mandatory if amount provided
1311 Risk rule condition type is not provided
1312 Card country ison must be same as holder country ison
1313 Risk rule reversed tx included is not provided
1314 Risk rule amount ison is not provided
1318 Card PAN length is incorrect
1319 A list has to be provided for the authorization risk rule ids
1320 A list has to be provided for the transaction risk rule ids
1321 Account suspended
1322 Account status is receive only
1323 Account status is spend only
1324 External payment inbound is disabled
1325 External payment outbound is disabled
1326 Reserved for future
1327 Risk rule response code is not provided
1328 Invalid response code provided
1329 File name prefix is not provided
1330 File name prefix is too long
1331 Risk rule value not provided
1332 Load transaction rejected by risk rule
1334 Incorrect account type
1335 External payment address already assigned for special account
1336 Invalid risk rule description provided
1340 Risk rule foreign currency tx only is not provided
1341 Risk rule foreign currency tx only boolean value allowed
1342 ACS empty encryption command
1343 ACS encryption failed
1359 Authorize programs ID only integer value allowed
1360 Settlements programs ID only integer value allowed
1361 Authorize is fraud only bool value allowed
1362 Transaction is fraud only bool value allowed
1364 Bypass instant notification should be false if stand in is false
1365 Internal balance check should be false if stand in is false
1366 Personalization file delivery config name is not provided
1367 Personalization file delivery config name is too short
1368 Personalization file delivery config name is too long
1369 Personalization file delivery config name is invalid
1370 Personalization file delivery config day is not provided
1371 Personalization file delivery config hour is not provided
1372 Personalization file delivery config min cards count must be numeric
1373 Personalization file delivery config min cards count value is too big
1374 Personalization file delivery config max term days must be numeric
1375 Personalization file delivery config max term days value is too big
1376 Personalization file delivery config ID is not provided
1377 Personalization file delivery config ID must be numeric
1378 Personalization file delivery config ID value is too big
1379 Personalization file delivery config is not found
1380 Can not delete personalization file delivery config. It is already in use
1381 Day is not found
1382 Hour is not found
1383 Invalid transaction amount direction provided
1384 Transaction amount direction mandatory then transaction amount provided
1387 Threshold data cannot be empty
1388 Threshold only integer value allowed
1389 Threshold parameter cannot be more than 100
1390 PEP parameter only numeric value allowed
1391 Previous sanctions parameter only numeric value allowed
1392 Current sanctions parameter only numeric value allowed
1393 Law enforcement parameter only numeric value allowed
1394 Financial regulator parameter only numeric value allowed
1395 Insolvency parameter only numeric value allowed
1396 Disqualified director parameter only numeric value allowed
1397 Adverse media parameter only numeric value allowed
1398 Forename data cannot be empty
1399 Forename must be string
1400 Middle name must be string
1401 Middle name parameter length is invalid
1402 Surname data cannot be empty
1403 Surname must be string
1404 Surname length cannot be more than 100
1405 Date of birth parameter is invalid
1406 Year of birth must be numeric
1407 Address length cannot be more than 150
1408 Address must be string
1409 City length cannot be more than 150
1410 City must be string
1411 County length cannot be more than 100
1412 County must be string
1413 Postcode length cannot be more than 20
1414 Postcode must be string
1415 Country must be numeric
1416 Country length cannot be more than 100
1417 Forename length cannot be more than 100
1418 Risk merchant configuration setting already exists
1419 Risk merchant configuration setting ID not provided
1420 Risk merchant configuration setting not found
1423 Invalid risk alert originator provided
1425 Cannot delete risk merchant configuration because it is in use
1427 Holders not found
1428 Card not found
1429 Holder not found
1430 Client issuers is not provided
1431 Client issuers only array value allowed
1432 Program type is not privided
1433 Program type must be numeric
1434 Invalid program type provided
1436 Program validity period is not provided
1437 Program validity value must be numeric
1438 Request must be encrypted
1439 Client keys configuration error
1440 Request decryption failed
1443 ACS password must be numeric
1444 ACS password is too long
1445 Invalid ACS password provided
1446 ACS password return type not provided
1447 Invalid ACS password return type provided
1448 ACS password is too short
1449 Incorrect request format
1453 Card printer SFTP password is too long
1454 At least SFTP password or SFTP ssh key must be provided
1455 Dispute external dispute ID is not provided
1456 Dispute external dispute ID only numeric value is allowed
1457 Dispute external dispute ID is too long
1458 SFTP config name not provided
1459 Invalid value provided for SFTP config type
1460 SFTP config name invalid
1461 SFTP config host not provided
1462 Invalid value provided for SFTP config host
1463 Only integer value allowed for SFTP config port
1464 Invalid value provided for SFTP config ID
1465 SFTP config id not provided
1466 SFTP config not found
1467 SFTP configuration name too long
1468 SFTP configuration type not provided
1469 SFTP username invalid
1470 SFTP password too long
1471 At least SFTP password or SFTP ssh key must be provided
1472 Minimum allowed value for port is 0
1473 Maximum allowed value for port is 65535
1474 SFTP port not provided
1475 SFTP username not provided
1476 Virtual Card does not have PIN
1477 External payment method invalid external ID provided
1478 External payment method ID too long
1479 External payment method external ID too long
1480 SFTP config path not provided
1481 Invalid value provided for SFTP config host
1482 EPM address assign completed notification is not provided
1483 Invalid value provided for EPM address assign completed notification
1484 EPM address assign failed notification is not provided
1485 Invalid value provided for EPM address assign failed notification
1486 SFTP config is in use. Cannot delete
1487 Is settled must be numeric
1488 Is settled only 0 and 1 values allowed
1489 Something went wrong. Please try again later
1490 Failed to encrypt CSV file
1491 Date created from only integer value allowed
1492 Date created to only integer value allowed
1493 Item count parameter should be between 1 and 100
1494 Date range is limited to 48 hours
1499 Personalization file delivery config name is already taken
1500 Unload transaction rejected by risk rule
1501 Internal host unload transaction card amount limit has been reached
1502 Internal host unload transaction account amount limit has been reached
1503 Internal host unload transaction holder amount limit has been reached
1504 Load FX fee transaction failed
1505 Unload FX fee transaction failed
1506 Request reference not provided
1507 Request reference only integer value allowed
1508 Auto conversion must be numeric
1509 Auto conversion only 0 and 1 values allowed
1510 Auto conversion is not supported by program
1511 Risk rule can be created only as counter
1512 Risk rules group assigned to the card cannot be deleted
1513 Risk rules group assigned to the account cannot be deleted
1514 All the same digits in PIN are not allowed.
1515 All sequential digits in PIN are not allowed.
1516 Fee group cannot be removed, because it is used in accounts
1517 Holder type not provided
1518 Holder type is invalid
1519 Holder business name not provided
1520 Holder business name is invalid
1521 Holder business name is too long
1522 Duplicate account ID value provided
1523 MAPI client validation failed. %s
1524 Account ID should be provided when owner ID is provided
1525 Offset must be numeric
1526 Can not find card design by scheme assigned to product
1527 Column not found
1528 A list has to be provided for the columns
1529 Risk merchant config setting reason is too long
1530 Risk merchant config invalid reason provided
1531 Use activate card method to change card status from not activated to activated
1532 Client integration not found
1533 Client integration type integer allowed
1534 Client integration type incorrect value length
1535 Client integration type is not provided
1536 Client integration URL string allowed
1537 Client integration URL incorrect value length
1538 Client integration URL is not provided
1539 Client integration external ID integer allowed
1540 Client integration external ID incorrect value length
1541 Client integration external ID is not provided
1542 Client integration config string allowed
1543 Client integration config is not provided
1544 Client integration config integer allowed
1545 Client integration URL invalid
1546 Client integration ID is not provided
1547 Client integration invalid type provided
1549 Encryption mode is not provided
1550 Encryption mode is invalid
1551 Provided card does not belong to provided account
1552 A list has to be provided for the payment methods
1553 Client for the integration is not provided
1554 Client for the integration is not found
1555 Connection problem
1556 Design code only string allowed
1557 Session ID not provided
1558 Card ID should not be blank
1559 Invalid localization provided
1560 Invalid page provided
1561 Invalid design provided
1562 Default design not found
1563 Default localization translation not found
1564 Card frame integration not configurated
1565 Custom notifications source not provided
1566 Custom notifications source only integer value allowed
1567 Custom notifications source incorrect value length
1568 Custom notifications source is incorrect
1569 Custom notifications invoked event not provided
1570 Custom notifications invoked event is too long
1571 Invalid custom notifications invoked event provided
1572 Custom notifications payload only array value allowed
1573 Design code incorrect value length
1574 Generate new card PIN only boolean value is allowed
1575 TAI notification ID not provided
1576 TAI notification not found
1577 TAI notification ID only integer value allowed
1578 Actual authorize ID only integer value allowed
1579 TAI notification is sent only defined values allowed
1580 Note too long
1581 Keep directory structure not provided
1582 Invalid keep directory structure provided
1583 Unable to lock resource%s. Please retry later
1584 Specified transaction type are not allowed for provided limit type
1585 Logs external aggregated record ID is not provided
1586 Log external aggregated entity not provided
1587 Account ID %s belongs to another company
1588 Custom fee transaction failed
1589 Account currency or transaction ID must be specified
1590 Original transaction ID must be numeric
1591 SFTP endpoint must be unique
1592 Fee collection ID not provided
1593 Fee collection ID only integer value allowed
1594 Fee collection ID too long
1595 Fee collection has not been found
1596 Date imported from not set
1597 Date imported from only integer value allowed
1598 Date imported from too long
1599 Date imported to not set
1600 Date imported to only integer value allowed
1601 Date imported to too long
1602 Card ID only integer value allowed
1603 Card ID too long
1604 Card has not been found
1605 Processing code only string value allowed
1606 Processing code too long
1607 Transaction amount only integer value allowed
1608 Transaction amount too long
1609 Transaction currency ISON only numeric value allowed
1610 Transaction currency ISON too short
1611 Transaction currency ISON too long
1612 Reconciliation amount only integer value allowed
1613 Reconciliation amount too long
1614 Reconciliation currency ISON only numeric value allowed
1615 Reconciliation currency ISON too short
1616 Reconciliation currency ISON too long
1617 Function code only integer value allowed
1618 Function code too long
1619 Trace ID only string value allowed
1620 Trace ID too long
1621 Scheme ID only integer value allowed
1622 Scheme ID too long
1623 Invalid scheme ID provided
1624 Issuer ID only integer value allowed
1625 Issuer ID too long
1626 Issuer has not been found
1627 Invalid clearing file ID provided
1628 Clearing file ID too long
1629 Transaction ID only integer value allowed
1630 Transaction ID too long
1631 Authorize ID only integer value allowed
1632 Authorize ID too long
1633 Do not have permission to access requested fee collection record
1634 Invalid record ID
1635 Invalid log ID
1636 Not supported entity or action
1637 Invalid date provided
1639 Fee group must be from account program
1640 Fee not found
1641 Amount currency must be specified
1642 Fee currency must by same as transaction currency or amount currency
1644 Access level is not provided
1645 Access level only integer value allowed
1646 Access level should be between 0 and 1000
1647 Holder access level is not provided
1648 Holder access level only integer value allowed
1649 Holder access level should be between 0 and 1000
1650 Fee group must be same as account fee group
1651 Description should not be blank
1652 Fixed fee not found
1653 External payment transaction ID too long
1654 Reason only numeric value allowed
1655 Reason too long
1656 Incorrect reason value provided
1657 Reference only string value allowed
1658 Reference too long
1659 Request reference only string value allowed
1660 Request reference too long
1661 Incorrect external payment transaction status
1662 This action cannot be completed at the moment
1663 Access level too low to get data
1664 Risk score only numeric value allow
1665 Risk score too long
1666 Incorrect risk score value provided
1671 Encrypted request content is not valid JSON
1672 Client design not found
1673 Client translation not found
1674 Default card enroll status required
1675 Invalid date of company incorporation provided
1676 Date of company incorporation too short
1677 Date of company incorporation too long
1678 CVV service code must be three characters long
1679 Industry ID only numeric value allowed
1680 Incorrect industry ID value provided
1681 Invalid Generate New PIN flag provided, when switching card from virtual to physical
1683 Card thermal line one too long
1684 Invalid card thermal line one provided
1685 Card thermal line two only string value allowed
1686 Card thermal line two too long
1687 Invalid card thermal line two provided
1688 Authorize expires after must be numeric
1689 Authorize expires after value is incorrect
1690 Card thermal line one only string value allowed
1691 Limit group does not belong to the selected program
1692 Fee group ID too long
1693 Fee group does not belong to the selected program
1694 Usage group does not belong to the selected program
1695 Risk group does not belong to the selected program
1714 Date of company incorporation length is invalid
1715 Receiver type only numeric value allowed
1716 Incorrect receiver type value provided
1717 Withdrawal purpose only numeric value allowed
1718 Incorrect withdrawal purpose value provided
1727 External payment address status not provided
1728 External payment address status only string value allowed
1729 Incorrect external payment address status provided
1730 External payment address old status and new status cannot be the same
1731 External payment address status change is in progress
1734 Permission denied. Check whitelisted IP configuration
1735 Invalid IP list
1755 FX fee applying strategy cannot be null
1736 FX fee applying strategy must be numeric
1757 FX fee applying strategy must be from the list
1759 Working hours cannot be null
1760 Working hours must be numeric
1761 Working hours must be from the list
1770 Incorrect EPM address status
1771 External payment direct credit is disabled
1772 Failed to change external payment address status
1773 Mandate cancel reason not provided
1774 Incorrect mandate cancel reason provided
1775 Holder currency must be numeric
1776 Holder currency must be three chars
1777 Holder currency is not provided
1778 Holder currency is not found
1779 Billing currency must be numeric
1780 Billing currency must be three chars
1781 Billing currency is not found
1782 Transaction currency must be numeric
1783 Transaction currency must be three chars
1784 Transaction currency is not found
1785 Direct debit return reason not provided
1786 Incorrect direct debit return reason provided
1787 Direct debit payment status already changed
1802 Incorrect external payment transaction type
1803 External payment transaction already returned
1804 External payment transaction is older then allowed
1817 Invalid external payment scheme id provided
1770 Incorrect EPM address status
1810 account_id, card_id or holder_id must be provided
1811 Card not found
1820 Incorrect sort code length
1821 Endpoint ID must be numeric
1822 Endpoint ID is too long
1823 Client integration ping URL only string value allowed
1824 Client integration ping URL is too long
1825 Invalid client integration ping URL
1838 Open banking consents not provided
1839 Open banking consents array value allowed
1841 Token is missing
1842 Consents is missing
1843 Consents only array value allowed
1844 Accounts is missing
1845 Accounts only array value allowed
1846 Account config not found
1847 Invalid consent value
1869 Invalid open banking consent
1870 Open banking token is not provided
1871 Open banking consents is not provided
1872 Open banking consents only array value allowed
1873 Open banking ibans is not provided
1874 Open banking ibans only array value allowed
1875 Authentication endpoint name must be unique
1876 Authentication endpoint API ID must be unique
1877 Open banking token already exists
1878 Open banking expiration date invalid format
1879 Open banking expiration date not found
1881 Open banking token is too long
1882 Open banking ibans must be unique
1888 Authentication request ID not provided
1890 Confirmation status not provided
1891 Invalid confirmation status provided
1892 Authentication request not found
1893 Card account risk rule group id must be numeric
1894 Fee group id only integer value allowed
1895 Open banking payment is already completed
1895 Limit group id only integer value allowed
1896 Holder authentication notification is not provided
1897 Invalid value provided for holder authentication notification
1900 Risk rule group id only integer value allowed
1902 Authentication endpoint API key not provided
1903 Authentication endpoint API key too long
1904 Authentication endpoint API key invalid
1908 Load amount is lower than fee
1912 Risk processor is down
1913 Transaction rejected by risk processor. Risk code: %s
1914 Authentication request ID integer allowed
1916 OOB authentication method not provided
1917 Invalid OOB authentication method provided
1918 Provided currency is different from the currency assigned to %s account
1919 Card ID %s already have an assigned account with the same currency
1920 Incorrect reason code provided
1922 Sender external payment address data is not provided
1930 Account and EPM address currencies do not match
1931 Special account and EPM address currencies do not match
1953 Open banking EPM addresses only array allowed
1954 Open banking EPM addresses must be unique
1955 Transaction ID or transaction date imported from and transaction date imported to must be provided
1956 Open banking EPM addresses or ibans must be provided
1959 Open banking EPM address must be numeric
1977 Invalid card track data first name provided
1978 Invalid card track data last name provided
1979 Card track data name and last name combined exceeds allowed length
1987 Card track data name exceeds allowed length
1988 Card track last name exceeds allowed length
1996 Card track data name and last name combined length too short
2016 Return reason ID must be numeric
2030 Invalid program ID value
2031 Invalid card account ID value

Notes: - %s - message placeholder to provide more information about an error.

Limit transaction type

Type Name Description
1 Accumulated per period Transaction count or all transactions amount limit per period.
2 Minimum per transaction Minimum amount allowed per transaction.
3 Maximum per transaction Maximum amount allowed per transaction.
4 Maximum balance Maximum amount allowed in balance.
5 Transactions sequence counter Maximum amount/count allowed transactions in a row.

Limit type

Type Name Description
0 General limit This limit type only applicable for limit groups
1 Card limit
2 Account limit
3 Holder limit

Load source

ID Source Description
0 Unknown Partner system does not know the source of the funds
1 Internal Account Funds are transferred from Tribe held account
2 Internal Card Funds are transferred from Tribe held card
3 Debit Card External Debit Card Load via partners Gateway
4 Credit Card External Credit Card Load via partners Gateway
5 Bank Transfer External Bank Transfer to partners Bank Account
6 Cash External load of cash to the account
7 Unload to repatriate Used to unload funds and return them to external customer account
8 Unload to partner account Used to unload funds to cover costs not covered by fees held eslewhere
9 PayPal External PayPal load via parterns Gateway
10 Poli External Poli load via parterns Gateway
11 Payeer External Payer load via parterns Gateway
12 EPG Ideal External EPG Ideal load via parterns Gateway
13 OKPay External OKPay load via parterns Gateway
14 Qiwi External Qiwi load via parterns Gateway
15 Sofort External Sofort load via parterns Gateway
16 Astropay External Astropay load via parterns Gateway
17 Skrill External Skrill load via parterns Gateway
18 Neteller External Neteller load via parterns Gateway
19 EcoPayz External EcoPayz load via parterns Gateway
20 Bitcoin Crypto Load via Bitcoin
21 BitcoinCash Crypto Load via BitcoinCash
22 Etherium Crypto Load via Etherium
23 Litecoin Crypto Load via Litecoin
24 Ripple Crypto Load via Ripple
25 Customer Account Internal load from Customer account to another account held at Tribe
26 Payouts Account Internal load from Payouts account to another account held at Tribe
27 Cashback Account Internal load from Cashback account to another account held at Tribe
28 Office Account Internal load from Office account to another account held at Tribe
29 Fees and Chargeback Account Internal load from Fees and Chargeback account to another account held at Tribe
30 External client Wallet External load via client Wallet
31 Balance adjustment load from GUI Balance adjustment created via admin panel
32 Balance adjustment load from PM API Balance adjustment created via PM API
33 Balance adjustment load by system Balance adjustment created by system

Load type

ID Type Description
0 Unknown
1 e-Wallet
2 Internal

Balance adjustment type

ID Type
1 Compensation credit
2 Debit authority
3 Beyond 7 days debit
4 Indemnity debit
5 Indemnity credit
6 Goodwill credit
7 Return to source debit
8 System failure debit
9 System failure credit
10 Chargeback debits
11 Chargeback credits

Region type

Type Name Description
0 All regions
1 Domestic Transaction country same as holder country.
2 International International - In specified country.
3 International within region International within region - Holder region not equal to Transaction region.
4 International outside region International outside region - Holder region equal to Transaction region.

Transaction type

Type Name Operation sign Description
0 Unknown - Can’t determine transaction type.
1 Load Credit Card load via API.
2 Pos Debit Purchase by card.
3 Atm Debit ATM withdrawal.
4 Unload Debit Card unload/withdrawal via API.
5 Credit cheque Credit Credit cheque.
6 Balance inquiry - Balance inquiry at ATM/POS.
7 Cashback Debit Cashback at sale point.
8 Cash Debit Cash withdrawal.
9 Quasi cash Debit Quasi cash operation.
10 Credit Credit Original credit operation.
11 Credit adjustment Credit Credit adjustment via API.
12 Refund Credit Refund.
13 Debit adjustment Debit Debit adjustment via API.
14 Pin unblock - PIN unblock via ATM.
15 Pin change - PIN Change at ATM.
16 Reserved
17 Pos verification only - Pos verification only.
18 Reserved
19 Reserved
20 Money transfer Debit Money transfer operation (UnionPay).
21 P2p debit Debit P2P transfer debit part.
22 P2p credit Credit P2P transfer credit part.
23 Debit cheque Debit Original debit operation.
24 Card activate - Card activate.
25 Pin change API - PIN change via API.
26 P2p Debit account to account Debit Account funding debit account to account.
27 P2p Credit account to account Credit Account funding credit account to account.
28 P2p Debit person to person Debit Account funding debit person to person.
29 P2p Credit person to person Credit Account funding credit person to person.
30 P2p debit financial institution Debit Account funding debit financial institution.
31 P2p credit financial institution Credit Account funding credit financial institution.
32 P2p debit prepaid card load and top up Debit Account funding debit prepaid card load and top up.
33 P2p credit prepaid card load and top up Credit Account funding credit prepaid card load and top up.
34 P2p debit wallet transfer Debit Account funding debit wallet transfer.
35 P2p credit wallet transfer Credit Account funding credit wallet transfer.
36 P2p debit card bill pay Debit Account funding debit card bill.
37 P2p credit card bill pay Credit Account funding credit card bill.
38 P2p debit non card bill pay Debit Account funding debit non card bill.
39 P2p credit non card bill pay Credit Account funding credit non card bill.
40 P2p debit non online gambling/gaming Debit Account funding debit non online gambling/gaming.
41 P2p credit non online gambling/gaming Credit Account funding credit non online gambling/gaming.
42 P2p debit online gambling/gaming Debit Account funding debit online gambling/gaming.
43 P2p credit online gambling/gaming Credit Account funding credit online gambling/gaming.
44 P2p debit government disbursement and tax refund Debit Account funding debit government disbursement and tax refund.
45 P2p credit government disbursement and tax refund Credit Account funding credit government disbursement and tax refund.
46 P2p debit loyalty payments Debit Account funding debit loyalty payments.
47 P2p credit loyalty payments Credit Account funding credit loyalty payments.
48 P2p debit merchant settlement Debit Account funding debit merchant settlement.
49 P2p credit merchant settlement Credit Account funding credit merchant settlement.
50 P2p debit payroll and pensions Debit Account funding debit.
51 P2p credit payroll and pensions Credit Account funding credit.
52 P2p debit b2b supplier payments Debit Account funding debit b2b supplier payments.
53 P2p credit b2b supplier payments Credit Account funding credit b2b supplier payments.
54 P2p debit other disbursements Debit Account funding debit other disbursements.
55 P2p credit other disbursements Credit Account funding credit other disbursements.
56 Outbound from external payment address Debit Outbound from external payment address via API.
57 Inbound from external payment address Credit Inbound from external payment address via API.
58 Direct debit from external payment address Debit Direct debit from external payment address via API.
59 Direct credit from external payment address Credit Direct credit from external payment address via API.
60 P2p credit agent cash out Credit Account funding credit agent cash out.
61 P2p debit agent cash out Debit Account funding debit agent cash out.
62 P2p credit merchant presented qr Credit Account funding credit merchant presented qr.
63 P2p debit merchant presented qr Debit Account funding debit merchant presented qr.
64 Pin unblock API - PIN unblock via API.
65 Inbound return from external payment Debit Inbound return from external payment.
66 Outbound return from external payment Credit Outbound return from external payment.
67 Direct credit return Debit Direct credit return.
68 Direct debit return Credit Direct debit return.
69 Custom fee Debit Custom fee.
70 P2P credit cash deposit Credit Account funding credit cash deposit.
71 P2P debit cash deposit Debit Account funding debit cash deposit.
72 P2P debit merchant payment Debit Account funding debit merchant payment.
73 P2P credit merchant payment Credit Account funding credit merchant payment.
74 First chargeback - First chargeback.
75 Second chargeback - Second chargeback.
76 Retrieval request - Retrieval request.

Account type

ID Type
1 Account
2 Special account

External payment address assignment state

ID Description
1 Pending
2 Success
3 Error

External payment address status

Type Description
A Active
B Blocked
S Suspended
P Spend only
R Receive only

External payment transaction type

ID Type
1 Outbound
2 Inbound
3 Outbound return
4 Reverse
5 Direct debit
6 Direct credit
7 Inbound debit
8 Inbound return
9 Direct debit return
10 Direct credit return

External payment transaction status

ID Status
1 Accepted
2 Rejected
3 Pending
4 Error
5 On hold
6 Operator approval required
7 Pending in risk
8 Hold in risk

External payment transaction status code

ID Status code
0 Success
1 Unknown
2 Balance validation failed
3 Card limit validation failed
4 Account limit validation failed
5 Holder limit validation failed
6 External server validation failed
7 Unable to deliver transaction to external service
8 External payment address status validation failed
9 Account status validation failed
10 External payment mandate status validation failed
11 Risk check failed
12 Rejected by risk processor
13 Hold by risk processor

External payment scheme

ID Scheme Description
0 UNKNOWN Unknown scheme
1 TRANSFER Transfer
2 FPS Faster payments
3 CHAPS Chaps scheme
4 BACS Bacs scheme
5 SCT SEPA transfer
6 SCTI SEPA instant transfer
7 SDD SEPA direct debit

External payment inbound return message code

ID Description
1 Incorrect account number
2 Account closed
3 Account blocked
4 Account holder deceased
5 Missing creditor's address
6 Missing debtor's account or identification
7 Missing debtor's name or address
8 Missing creditor's name or address
9 Account name mismatch
10 Account transferred

External payment mandate cancellation reason

ID Description
1 Institution cancelled - refer to payer. Paying bank has cancelled instruction.
2 Instruction cancelled by payer. Payer has instructed the paying bank to cancel the DirectDebit Instruction (Mandate).
3 Payer deceased.
4 Account closed. Payer has closed their account for an unknown reason.

External payment direct debit return reason

ID Description
1 Incorrect account number.
2 Account closed.
3 Account blocked.
4 Account holder deceased.
5 Not specified reason by customer.
6 Following cancellation request.
11 Missing creditor`s address.
12 Missing debtor`s account or identification.
13 Missing debtor`s name or address.
14 Missing creditor`s name or address.
16 Other reason.
18 Account name mismatch.
20 Account transferred.

Withdrawal purpose

ID Description
1 Other
2 Mobile wallet cash in
3 Mobile wallet cash out
4 Mobile wallet payments
5 Stored value card cash-in
6 Stored value card cash-out
7 Stored value card payments
8 Equity other than investment fund shares in the related companies abroad
9 Agency Commission
10 Receipts or payments from personal residents bank account or deposits abroad
11 Allowances
12 Air transport
13 Corporate Card Payment
14 Equity for the establishment of new company from residents abroad equity of merger or acquisition of companies abroad from residents and participation to capital increase of related company abroad
15 Equity for the establishment of new company in the UAE from residents equity of merger or acquisition of companies in the UAE from n-residents participation to capital increase of related companies
16 Charitable Contributions
17 Commission
18 Compensation
19 Credit Card Payments
20 Pre-Paid Reloadable and Personalized Debit Card Payments
21 Dividend Payouts
22 Dividends on equity not intra group
23 Educational Support
24 Equated Monthly Instalments
25 End of Service
26 Family Support
27 Financial services
28 Equity other than investment fund shares in related companies in the UAE
29 Goods Bought or Sold
30 Processing repair and maintenance services on goods
31 Government goods and services embassies etc
32 Government related income taxes tariffs capital transfers etc
33 Information services
34 Intra group dividends
35 Inter group transfer
36 Insurance services
37 Charges for the use of intellectual property royalties
38 Computer services
39 Leave Salary
40 Monetary Claim Reimbursements Medical Insurance or Auto Insurance etc
41 Own account transfer
42 Other modes of transport
43 Overtime
44 Pension
45 Professional and management consulting services
46 POS Merchant Settlement
47 Personal cultural audio visual and recreational services
48 Research and development services
49 Rent Payments
50 Salary
51 Construction
52 Travel
53 Sea transport
54 Salary Advance
55 Telecommunication services
56 Tickets
57 Transfer of funds between persons Normal and Juridical
58 Utility Bill Payments

Receiver type

ID Description
1 Individual
2 Business

Industry ID

ID Description
1 Other
2 Travel services
3 Financial services
4 Computer services
5 Insurance services
6 Rental services
7 Charities
8 Accountants
9 Trusts
10 Pharmaceutical services
11 Gambling/Betting
12 Adult services
13 Telemarketing services
14 Crypto activity
15 Foreign exchange
16 Retail
17 Healthcare & Social services
18 Public catering

Key

Keys are unique identifiers that are used to authenticate and authorize requests, encrypt or decrypt messages.

Parameter Description
Access key A key which allows access to the API service.
API ID User identification (ID) (equivalent to a username).
API key A key for user authentification (equivalent to a password).
Data encryption key A key for encrypting or decrypting a single field (parameter), for example: if PAN is returned as encrypted (configurable).

Account holder risk score

ID Description
1 Low risk
2 Medium risk
3 High risk

Risk rules actions

Value Description
mark_transaction_as_suspicious Mark transaction as suspicious
notify_cardholder_by_sending_tais_notification Notify cardholder by sending TAIs notification
change_card_status_to_risk Change card status to risk
change_account_status_to_suspended Change account status to suspended
reject_transaction Reject transaction

Security checks

Value Description
card_expiration_date_present Card expiration date present and validation performed
online_pin Online PIN validation performed
offline_pin Offline PIN validation performed
3_d_secure Accountholder authentication value validation performed (3DSecure)
cvv_2 Card verification value validation performed
magnetic_stripe Magnetic stripe validation performed
chip_data Chip data validation performed
avs Holder address validation performed
phone_number Phone number validation performed (Only for UnionPay)
signature Signature validation performed

Authentication confirmation status

ID Meaning
Y Verified
N Not verified
E Expired
L Limit reached
C Canceled

OOB (Out-of-Band) authentication method

It is completed outside of the 3-D Secure flow.

ID Meaning
1 Static password
2 OTP via SMS
3 OTP via app
4 OTP via email
5 OTP other
6 Push confirmation
7 Biometrics
8 Login
9 Hand-held token generators/fobs
99 Other

Status change reason code

ID Meaning
1 Positive review
2 Negative review
3 Customer request
4 Death of an account holder
5 Risk check – suspected fraud
6 Risk check – compromised account
7 Risk check – compromised card
8 Risk check – investigation
9 Indemnity received
10 Third party notification
11 Police request
12 Internal block request
13 Suspected identity theft
14 Charge back fraud
15 Internal investigations
16 Lost or stolen cards
17 Suspicious payments
18 Suspected money laundering concerns
19 Unknown source of funds

Custom notification source

ID Source
1 Card frame

Card frame pages

Value Description
showCardData Page for the displaying card details
activateCard Card activation page
showPin Page for the displaying card PIN
setPin Page for the card PIN change

Language code

Value Description
af_NA Afrikaans (Namibia)
af_ZA Afrikaans (South Africa)
af Afrikaans
ak_GH Akan (Ghana)
ak Akan
sq_AL Albanian (Albania)
sq Albanian
am_ET Amharic (Ethiopia)
am Amharic
ar_DZ Arabic (Algeria)
ar_BH Arabic (Bahrain)
ar_EG Arabic (Egypt)
ar_IQ Arabic (Iraq)
ar_JO Arabic (Jordan)
ar_KW Arabic (Kuwait)
ar_LB Arabic (Lebanon)
ar_LY Arabic (Libya)
ar_MA Arabic (Morocco)
ar_OM Arabic (Oman)
ar_QA Arabic (Qatar)
ar_SA Arabic (Saudi Arabia)
ar_SD Arabic (Sudan)
ar_SY Arabic (Syria)
ar_TN Arabic (Tunisia)
ar_AE Arabic (United Arab Emirates)
ar_YE Arabic (Yemen)
ar Arabic
hy_AM Armenian (Armenia)
hy Armenian
as_IN Assamese (India)
as Assamese
asa_TZ Asu (Tanzania)
asa Asu
az_Cyrl Azerbaijani (Cyrillic)
az_Cyrl_AZ Azerbaijani (Cyrillic, Azerbaijan)
az_Latn Azerbaijani (Latin)
az_Latn_AZ Azerbaijani (Latin, Azerbaijan)
az Azerbaijani
bm_ML Bambara (Mali)
bm Bambara
eu_ES Basque (Spain)
eu Basque
be_BY Belarusian (Belarus)
be Belarusian
bem_ZM Bemba (Zambia)
bem Bemba
bez_TZ Bena (Tanzania)
bez Bena
bn_BD Bengali (Bangladesh)
bn_IN Bengali (India)
bn Bengali
bs_BA Bosnian (Bosnia and Herzegovina)
bs Bosnian
bg_BG Bulgarian (Bulgaria)
bg Bulgarian
my_MM Burmese (Myanmar [Burma])
my Burmese
yue_Hant_HK Cantonese (Traditional, Hong Kong SAR China)
ca_ES Catalan (Spain)
ca Catalan
tzm_Latn Central Morocco Tamazight (Latin)
tzm_Latn_MA Central Morocco Tamazight (Latin, Morocco)
tzm Central Morocco Tamazight
chr_US Cherokee (United States)
chr Cherokee
cgg_UG Chiga (Uganda)
cgg Chiga
zh_Hans Chinese (Simplified Han)
zh_Hans_CN Chinese (Simplified Han, China)
zh_Hans_HK Chinese (Simplified Han, Hong Kong SAR China)
zh_Hans_MO Chinese (Simplified Han, Macau SAR China)
zh_Hans_SG Chinese (Simplified Han, Singapore)
zh_CN Chinese (Simplified, PRC)
zh_Hant Chinese (Traditional Han)
zh_Hant_HK Chinese (Traditional Han, Hong Kong SAR China)
zh_Hant_MO Chinese (Traditional Han, Macau SAR China)
zh_Hant_TW Chinese (Traditional Han, Taiwan)
zh_TW Chinese (Traditional, Taiwan)
zh Chinese
kw_GB Cornish (United Kingdom)
kw Cornish
hr_HR Croatian (Croatia)
hr Croatian
cs_CZ Czech (Czech Republic)
cs Czech
da_DK Danish (Denmark)
da Danish
nl_BE Dutch (Belgium)
nl_NL Dutch (Netherlands)
nl Dutch
ebu_KE Embu (Kenya)
ebu Embu
en_AS English (American Samoa)
en_AU English (Australia)
en_BE English (Belgium)
en_BZ English (Belize)
en_BW English (Botswana)
en_CA English (Canada)
en_GU English (Guam)
en_HK English (Hong Kong SAR China)
en_IN English (India)
en_IE English (Ireland)
en_IL English (Israel)
en_JM English (Jamaica)
en_MT English (Malta)
en_MH English (Marshall Islands)
en_MU English (Mauritius)
en_NA English (Namibia)
en_NZ English (New Zealand)
en_MP English (Northern Mariana Islands)
en_PK English (Pakistan)
en_PH English (Philippines)
en_SG English (Singapore)
en_ZA English (South Africa)
en_TT English (Trinidad and Tobago)
en_UM English (U.S. Minor Outlying Islands)
en_VI English (U.S. Virgin Islands)
en_GB English (United Kingdom)
en_US English (United States)
en_ZW English (Zimbabwe)
en English
eo Esperanto
et_EE Estonian (Estonia)
et Estonian
ee_GH Ewe (Ghana)
ee_TG Ewe (Togo)
ee Ewe
fo_FO Faroese (Faroe Islands)
fo Faroese
fil_PH Filipino (Philippines)
fil Filipino
fi_FI Finnish (Finland)
fi Finnish
fr_BE French (Belgium)
fr_BJ French (Benin)
fr_BF French (Burkina Faso)
fr_BI French (Burundi)
fr_CM French (Cameroon)
fr_CA French (Canada)
fr_CF French (Central African Republic)
fr_TD French (Chad)
fr_KM French (Comoros)
fr_CG French (Congo - Brazzaville)
fr_CD French (Congo - Kinshasa)
fr_CI French (Côte d’Ivoire)
fr_DJ French (Djibouti)
fr_GQ French (Equatorial Guinea)
fr_FR French (France)
fr_GA French (Gabon)
fr_GP French (Guadeloupe)
fr_GN French (Guinea)
fr_LU French (Luxembourg)
fr_MG French (Madagascar)
fr_ML French (Mali)
fr_MQ French (Martinique)
fr_MC French (Monaco)
fr_NE French (Niger)
fr_RW French (Rwanda)
fr_RE French (Réunion)
fr_BL French (Saint Barthélemy)
fr_MF French (Saint Martin)
fr_SN French (Senegal)
fr_CH French (Switzerland)
fr_TG French (Togo)
fr French
ff_SN Fulah (Senegal)
ff Fulah
gl_ES Galician (Spain)
gl Galician
lg_UG Ganda (Uganda)
lg Ganda
ka_GE Georgian (Georgia)
ka Georgian
de_AT German (Austria)
de_BE German (Belgium)
de_DE German (Germany)
de_LI German (Liechtenstein)
de_LU German (Luxembourg)
de_CH German (Switzerland)
de German
el_CY Greek (Cyprus)
el_GR Greek (Greece)
el Greek
gu_IN Gujarati (India)
gu Gujarati
guz_KE Gusii (Kenya)
guz Gusii
ha_Latn Hausa (Latin)
ha_Latn_GH Hausa (Latin, Ghana)
ha_Latn_NE Hausa (Latin, Niger)
ha_Latn_NG Hausa (Latin, Nigeria)
ha Hausa
haw_US Hawaiian (United States)
haw Hawaiian
he_IL Hebrew (Israel)
he Hebrew
hi_IN Hindi (India)
hi Hindi
hu_HU Hungarian (Hungary)
hu Hungarian
is_IS Icelandic (Iceland)
is Icelandic
ig_NG Igbo (Nigeria)
ig Igbo
id_ID Indonesian (Indonesia)
id Indonesian
ga_IE Irish (Ireland)
ga Irish
it_IT Italian (Italy)
it_CH Italian (Switzerland)
it Italian
ja_JP Japanese (Japan)
ja Japanese
kea_CV Kabuverdianu (Cape Verde)
kea Kabuverdianu
kab_DZ Kabyle (Algeria)
kab Kabyle
kl_GL Kalaallisut (Greenland)
kl Kalaallisut
kln_KE Kalenjin (Kenya)
kln Kalenjin
kam_KE Kamba (Kenya)
kam Kamba
kn_IN Kannada (India)
kn Kannada
kk_Cyrl Kazakh (Cyrillic)
kk_Cyrl_KZ Kazakh (Cyrillic, Kazakhstan)
kk Kazakh
km_KH Khmer (Cambodia)
km Khmer
ki_KE Kikuyu (Kenya)
ki Kikuyu
rw_RW Kinyarwanda (Rwanda)
rw Kinyarwanda
kok_IN Konkani (India)
kok Konkani
ko_KR Korean (South Korea)
ko Korean
khq_ML Koyra Chiini (Mali)
khq Koyra Chiini
ses_ML Koyraboro Senni (Mali)
ses Koyraboro Senni
lag_TZ Langi (Tanzania)
lag Langi
lv_LV Latvian (Latvia)
lv Latvian
lt_LT Lithuanian (Lithuania)
lt Lithuanian
luo_KE Luo (Kenya)
luo Luo
luy_KE Luyia (Kenya)
luy Luyia
mk_MK Macedonian (Macedonia)
mk Macedonian
jmc_TZ Machame (Tanzania)
jmc Machame
kde_TZ Makonde (Tanzania)
kde Makonde
mg_MG Malagasy (Madagascar)
mg Malagasy
ms_BN Malay (Brunei)
ms_MY Malay (Malaysia)
ms Malay
ml_IN Malayalam (India)
ml Malayalam
mt_MT Maltese (Malta)
mt Maltese
gv_GB Manx (United Kingdom)
gv Manx
mr_IN Marathi (India)
mr Marathi
mas_KE Masai (Kenya)
mas_TZ Masai (Tanzania)
mas Masai
mer_KE Meru (Kenya)
mer Meru
mfe_MU Morisyen (Mauritius)
mfe Morisyen
naq_NA Nama (Namibia)
naq Nama
ne_IN Nepali (India)
ne_NP Nepali (Nepal)
ne Nepali
nd_ZW North Ndebele (Zimbabwe)
nd North Ndebele
nb_NO Norwegian Bokmål (Norway)
nb Norwegian Bokmål
nn_NO Norwegian Nynorsk (Norway)
nn Norwegian Nynorsk
nyn_UG Nyankole (Uganda)
nyn Nyankole
or_IN Oriya (India)
or Oriya
om_ET Oromo (Ethiopia)
om_KE Oromo (Kenya)
om Oromo
ps_AF Pashto (Afghanistan)
ps Pashto
fa_AF Persian (Afghanistan)
fa_IR Persian (Iran)
fa Persian
pl_PL Polish (Poland)
pl Polish
pt_BR Portuguese (Brazil)
pt_GW Portuguese (Guinea-Bissau)
pt_MZ Portuguese (Mozambique)
pt_PT Portuguese (Portugal)
pt Portuguese
pa_Arab Punjabi (Arabic)
pa_Arab_PK Punjabi (Arabic, Pakistan)
pa_Guru Punjabi (Gurmukhi)
pa_Guru_IN Punjabi (Gurmukhi, India)
pa Punjabi
ro_MD Romanian (Moldova)
ro_RO Romanian (Romania)
ro Romanian
rm_CH Romansh (Switzerland)
rm Romansh
rof_TZ Rombo (Tanzania)
rof Rombo
ru_MD Russian (Moldova)
ru_RU Russian (Russia)
ru_UA Russian (Ukraine)
ru Russian
rwk_TZ Rwa (Tanzania)
rwk Rwa
saq_KE Samburu (Kenya)
saq Samburu
sg_CF Sango (Central African Republic)
sg Sango
seh_MZ Sena (Mozambique)
seh Sena
sr_Cyrl Serbian (Cyrillic)
sr_Cyrl_BA Serbian (Cyrillic, Bosnia and Herzegovina)
sr_Cyrl_ME Serbian (Cyrillic, Montenegro)
sr_Cyrl_RS Serbian (Cyrillic, Serbia)
sr_Latn Serbian (Latin)
sr_Latn_BA Serbian (Latin, Bosnia and Herzegovina)
sr_Latn_ME Serbian (Latin, Montenegro)
sr_Latn_RS Serbian (Latin, Serbia)
sr Serbian
sn_ZW Shona (Zimbabwe)
sn Shona
ii_CN Sichuan Yi (China)
ii Sichuan Yi
si_LK Sinhala (Sri Lanka)
si Sinhala
sk_SK Slovak (Slovakia)
sk Slovak
sl_SI Slovenian (Slovenia)
sl Slovenian
xog_UG Soga (Uganda)
xog Soga
so_DJ Somali (Djibouti)
so_ET Somali (Ethiopia)
so_KE Somali (Kenya)
so_SO Somali (Somalia)
so Somali
es_AR Spanish (Argentina)
es_BO Spanish (Bolivia)
es_CL Spanish (Chile)
es_CO Spanish (Colombia)
es_CR Spanish (Costa Rica)
es_DO Spanish (Dominican Republic)
es_EC Spanish (Ecuador)
es_SV Spanish (El Salvador)
es_GQ Spanish (Equatorial Guinea)
es_GT Spanish (Guatemala)
es_HN Spanish (Honduras)
es_419 Spanish (Latin America)
es_MX Spanish (Mexico)
es_NI Spanish (Nicaragua)
es_PA Spanish (Panama)
es_PY Spanish (Paraguay)
es_PE Spanish (Peru)
es_PR Spanish (Puerto Rico)
es_ES Spanish (Spain)
es_US Spanish (United States)
es_UY Spanish (Uruguay)
es_VE Spanish (Venezuela)
es Spanish
sw_KE Swahili (Kenya)
sw_TZ Swahili (Tanzania)
sw Swahili
sv_FI Swedish (Finland)
sv_SE Swedish (Sweden)
sv Swedish
gsw_CH Swiss German (Switzerland)
gsw Swiss German
shi_Latn Tachelhit (Latin)
shi_Latn_MA Tachelhit (Latin, Morocco)
shi_Tfng Tachelhit (Tifinagh)
shi_Tfng_MA Tachelhit (Tifinagh, Morocco)
shi Tachelhit
dav_KE Taita (Kenya)
dav Taita
ta_IN Tamil (India)
ta_LK Tamil (Sri Lanka)
ta Tamil
te_IN Telugu (India)
te Telugu
teo_KE Teso (Kenya)
teo_UG Teso (Uganda)
teo Teso
th_TH Thai (Thailand)
th Thai
bo_CN Tibetan (China)
bo_IN Tibetan (India)
bo Tibetan
ti_ER Tigrinya (Eritrea)
ti_ET Tigrinya (Ethiopia)
ti Tigrinya
to_TO Tonga (Tonga)
to Tonga
tr_TR Turkish (Turkey)
tr Turkish
uk_UA Ukrainian (Ukraine)
uk Ukrainian
ur_IN Urdu (India)
ur_PK Urdu (Pakistan)
ur Urdu
uz_Arab Uzbek (Arabic)
uz_Arab_AF Uzbek (Arabic, Afghanistan)
uz_Cyrl Uzbek (Cyrillic)
uz_Cyrl_UZ Uzbek (Cyrillic, Uzbekistan)
uz_Latn Uzbek (Latin)
uz_Latn_UZ Uzbek (Latin, Uzbekistan)
uz Uzbek
vi_VN Vietnamese (Vietnam)
vi Vietnamese
vun_TZ Vunjo (Tanzania)
vun Vunjo
cy_GB Welsh (United Kingdom)
cy Welsh
yo_NG Yoruba (Nigeria)
yo Yoruba
zu_ZA Zulu (South Africa)
zu Zulu
Value Description
1 Allows to review accounts list.
2 Allows to check account balance.
3 Allow to review accounts payments.
4 Allow to review payments list.
5 Allow to check payment details.
6 Allow to initiate payment.

Security

Authentication

In order to encrypt request and response you should set these parameters to the header.

Request header

Parameter M Type Length Description
x-access-key C AN 50 mandatory if x-encryption = 1
x-access-api-id C AN 50 mandatory if x-encryption = 1
x-access-api-key C AN 50 mandatory if x-encryption = 1
x-api-version C AN 1-3 fixed 1.2, mandatory if x-encryption = 1
x-sign C AN 1-65,535 "secret" encrypted with client's private key, mandatory if x-encryption = 1
x-encryption C N 1 1 - encrypted, 0 - not encrypted. Mandatory in production

If MODE 2 (encrypt with RSA public key) is configured, Tribe public key should be used for encryption

Response header

Parameter M Type Length Description
x-sign C AN 1-65,535 "secret" encrypted with Tribe private key, mandatory if request was encrypted

If MODE 2 (encrypt with RSA public key) mode configured, client's public key is used for encryption

Cryptography

When x-encryption is set to 1, request and response will be encrypted.

Some clients do not have a possibility to encrypt by using private keys. For these cases MODE 2 (encrypt with RSA public key) configuration is implemented.

Request message should be encrypted by using a random secret (x-sign in header) which is then encrypted with client's private key (or Tribe public key if MODE 2 is configured).

Response message will be encrypted with a newly generated secret (x-sign in header), which is then encrypted with Tribe private key (or client's public key if MODE 2 is configured).

Encrypted request/response body should be plain text.

RSA key generation example:

  • Key type: RSA
  • Key length: 4096
  • Algorithm: sha512
    // Generate Private Key
    $ openssl req -nodes -newkey rsa:4096 -keyout private.key -out private.csr -sha512

    // Extract Public Key from previously generated Private Key
    $ openssl rsa -in private.key -pubout > public.key

Encryption scheme

Encryption algorithm in PHP (MODE 1 - encrypt with RSA private key):

    function encrypt(string $privateKey, array $requestData): array
    {
        $secret = 'RandomString32CharactersLength12'; // 32 characters
        openssl_private_encrypt($secret, $temp, $privateKey);
        $sign = base64_encode($temp);

        $rb = bin2hex(random_bytes(8));
        $encryptedRequest = $rb.base64_encode(openssl_encrypt(json_encode($requestData), 'aes-256-cbc', $secret, OPENSSL_RAW_DATA, $rb));

        return [
            'sign' => $sign,
            'encryptedRequest' => $encryptedRequest
        ];
    }

    // usage  
    $encrypted = encrypt($privateKey, $requestData);
    // add $encrypted['sign'] to the request header as 'x-sign'
    // set $encrypted['encryptedRequest'] to the request body.

Decryption algorithm in PHP (MODE 1 - encrypt with RSA private key):

    function decryptSecret(string $sign, string $publicKey): string
    {
        openssl_public_decrypt(base64_decode($sign), $secret, $publicKey);

        return $secret;
    }

    function decryptContent(string $secret, string $content): string
    {
        $iv = substr($content, 0, 16);
        $originalData = base64_decode(substr($content, 16));

        return openssl_decrypt($originalData, 'aes-256-cbc', $secret, OPENSSL_RAW_DATA, $iv);
    }

    //usage
    $secret = decryptSecret($sign, $publicKey);
    $decryptedResponse = decryptContent($secret, $encryptedResponse);

Encryption algorithm in PHP (MODE 2 - encrypt with RSA public key):

    function encrypt(string $publicKey, array $requestData): array
    {
        $secret = 'RandomString32CharactersLength12'; // 32 characters
        openssl_public_encrypt($secret, $temp, $publicKey);
        $sign = base64_encode($temp);

        $rb = bin2hex(random_bytes(8));
        $encryptedRequest = $rb.base64_encode(openssl_encrypt(json_encode($requestData), 'aes-256-cbc', $secret, OPENSSL_RAW_DATA, $rb));

        return [
            'sign' => $sign,
            'encryptedRequest' => $encryptedRequest
        ];
    }

    // usage  
    $encrypted = encrypt($publicKey, $requestData);
    // add $encrypted['sign'] to the request header as 'x-sign'
    // set $encrypted['encryptedRequest'] to the request body.

Decryption algorithm in PHP (MODE 2 - encrypt with RSA public key):

    function decryptSecret(string $sign, string $privateKey): string
    {
        openssl_private_decrypt(base64_decode($sign), $secret, $privateKey);

        return $secret;
    }

    function decryptContent(string $secret, string $content): string
    {
        $iv = substr($content, 0, 16);
        $originalData = base64_decode(substr($content, 16));

        return openssl_decrypt($originalData, 'aes-256-cbc', $secret, OPENSSL_RAW_DATA, $iv);
    }

    //usage
    $secret = decryptSecret($sign, $privateKey);
    $decryptedResponse = decryptContent($secret, $encryptedResponse);

Notation

Parameter requirement

Notation Meaning
M Mandatory
O Optional
C Conditional
- Not applicable

Value type

Notation Meaning
Not blank Not empty, not null, isset.
A Alphabetic chars only.
N Only numbers.
NS Numeric with symbols value.
AN Alphanumeric value.
AS Alphabetic with symbols value.
ANS Alphanumeric with symbols value.
[1,2,3] Possible values: 1 or 2 or 3.
[1-3] Range from 1 to 3.
LIST List of values.
EXT-LIST List of values. Possible formats: 1. ['840', '978'] 2. '840,878', 3. '840'
OBJ Object with properties.
- Not applicable.

Default charsets

ID Charset regex
1 ^[0-9a-zA-Z .\,\&-\/\'#$()[]\]+$
2 ^[a-zA-Z-,.\/ ]+$
3 ^[0-9a-zA-Z]+$
4 ^[0-9a-zA-Z-,.\/ ]+$
5 ^[0-9a-zA-Z-,.\/\&!?;:*+ @()[]{}#%\']+$
6 ^[0-9a-zA-Z- ]+$