Dictionaries
Request statuses
| Code | Description |
|---|---|
success | Successfully processed. |
process | In processing. |
error | Processing error. |
Client product
| Code | Description |
|---|---|
1000 | Freedom Wallet Card. |
2000 | Instant Card. |
3000 | Electron Card. |
Parameters for the Method: Creating a Client Card with product_id = 1000
| Parameter Name | Parameter Name | Parameter Name | Description | Type |
|---|---|---|---|---|
request_id (required) | Unique request number in the partner's system (UUID). | string/uuid | ||
product_id (required) | Identifier for the product within which the client is created. | integer | ||
client (required) | phone (required) | Client's phone number. | integer | |
type | Client type: 1 - Individual 2 - Legal Entity 3 - Individual Entrepreneur | integer | ||
resident | Residency status: 1 - Resident 2 - Non-resident | integer | ||
first_name (required) | Client's first name (Latin characters). | string | ||
last_name (required) | Client's last name (Latin characters). | string | ||
middle_name | Client's middle name (Latin characters). | string | ||
birthdate | Date of birth of the cardholder (Format: YYYY-MM-DD). | date | ||
email | Client's email address. | string | ||
country (required) | Country of client's residency (alpha-3 format). | string | ||
person_id (required) | Client's identifier in the country of residency (e.g., Tax ID for Kazakhstan, Personal ID for Russia). | string | ||
language | Client's communication language (alpha-2 format). | string | ||
document (required) | A scanned copy of an identity document: - File format: PDF - Base64 encoding - Max size: 2 MB | string | ||
address1 (required) | country (required) | Registration country (alpha-3 format). | string | |
postal_code (required) | Postal code. | string | ||
address_line1 (required) | Registration city. | string | ||
address_line2 (required) | Registration street. | string | ||
address_line3 (required) | Registration building and premises. | string | ||
address2 (required) | country (required) | Residential country (alpha-3 format). | string | |
postal_code (required) | Postal code. | string | ||
address_line1 (required) | Residential city. | string | ||
address_line2 (required) | Residential street. | string | ||
address_line3 (required) | Residential building and premises. | string | ||
external_user_id | Identifier of the client in the partner's system. | string | ||
identification_info (required) | idn_date (required) | Date of identification in RFC 3339 format (YYYY-MM-DDThh:mm:ss±hh:mm). | string | |
identified_by (required) | Identifier of the user who conducted the client's identification. | string |
Parameters for the Method: Creating a Client Card with product_id = 2000
| Parameter Name | Child Parameter Name | Sub-Child Parameter Name | Description | Type |
|---|---|---|---|---|
request_id (required) | Unique request number in the partner's system (UUID). | string/uuid | ||
product_id (required) | Identifier for the product within which the client is created. | integer | ||
client (required) | phone (required) | Client's phone number. | integer | |
type (required) | Client type: 1 - Individual 2 - Legal Entity 3 - Individual Entrepreneur | integer | ||
resident (required) | Residency status: 1 - Resident 2 - Non-resident | integer | ||
first_name (required) | Client's first name (Latin characters). | string | ||
last_name (required) | Client's last name (Latin characters). | string |
Card product
| Code | Description |
|---|---|
| 1000 | Freedom Wallet Card |
| 2000 | Instant Card Visa Signature |
| 2100 | Instant Card Visa Gold |
| 2200 | Instant Card Visa Signature 3 Curr |
| 2300 | Instant Card Visa Gold 3 Curr |
| 3000 | Electron Card |
| 3010 | Electron Card Visa Resident 12 Month |
| 3020 | Electron Card Visa Resident 60 Month |
| 3030 | Electron Card Visa Non-resident 12 Month |
| 3040 | Electron Card Visa Non-resident 60 Month |
| 4010 | Electron Card Mastercard Resident 12 Month |
| 4020 | Electron Card Mastercard Resident 60 Month |
| 4030 | Electron Card Mastercard Non-resident 12 Month |
| 4040 | Electron Card Mastercard Non-resident 60 Month |
Card status
| Code | Description |
|---|---|
| 00 | Card is active. |
| 10 | Temporarily blocked by the client. |
| 20 | Temporarily blocked by the partner. |
| 30 | Card validity period has expired. |
| 40 | Card blocked due to loss. |
| 50 | Card not activated. |
| 60 | In the process of production. |
| 70 | Card is closed. |
| 99 | Unknown card status. |
Card block
| Code | Description |
|---|---|
| 10 | Temporary block by the client. |
| 20 | Temporary block by the partner. |
| 30 | Card validity period has expired. |
| 40 | Card blocked due to loss. |
| 50 | Card not activated. |
Transaction
| Code | Description |
|---|---|
| 1000 | Balance Inquiry. Clearing. |
| 1001 | Balance Inquiry. Authorization. |
| 1002 | Cancellation of Balance Inquiry. Clearing. |
| 1003 | Cancellation of Balance Inquiry. Authorization. |
| 1004 | ATM Fee. |
| 1005 | Cancellation of ATM Fee. |
| 1006 | Online Statement. |
| 1007 | Cancellation of Online Statement. |
| 1008 | Card Issuance. |
| 1009 | Cancellation of Card Issuance. |
| 1010 | Card Reissue. |
| 1011 | Cancellation of Card Reissue. |
| 1012 | Annual Service Fee. |
| 1013 | Cancellation of Annual Service Fee. |
| 1014 | Balance Inquiry Fee. |
| 1015 | Cancellation of Balance Inquiry Fee. |
| 1016 | Card Reissue (Due to Expiration). |
| 1017 | Cancellation of Card Reissue (Due to Expiration). |
| 1018 | Debit Card Issuance. |
| 1019 | Cancellation of Debit Card Issuance. |
| 1020 | Card Reissue Fee. |
| 1021 | Cancellation of Card Reissue Fee. |
| 1022 | Card Reissue (Due to Loss). |
| 1023 | Cancellation of Card Reissue (Due to Loss). |
| 1024 | Reissue Fee. |
| 1025 | Cancellation of Reissue Fee. |
| 1026 | Mini Statement. Clearing. |
| 1027 | Mini Statement. Authorization. |
| 1028 | Cancellation of Mini Statement. Clearing. |
| 1029 | Cancellation of Mini Statement. Authorization. |
| 1030 | Adjustments Between Multi-Currency Accounts. |
| 1031 | Cancellation of Adjustments Between Multi-Currency Accounts. |
| 1032 | Transfer Between Accounts. |
| 1033 | Cancellation of Transfer Between Accounts. |
| 1034 | Purchase with Cashback. Clearing. |
| 1035 | Purchase with Cashback. Authorization. |
| 1036 | Cancellation of Purchase with Cashback. Clearing. |
| 1037 | Cancellation of Purchase with Cashback. Authorization. |
| 1038 | Cash Withdrawal at the POS Terminal. Clearing. |
| 1039 | Cash Withdrawal at the POS Terminal. Authorization. |
| 1040 | Cancellation of Cash Withdrawal at the POS Terminal. Clearing. |
| 1041 | Cancellation of Cash Withdrawal at the POS Terminal. Authorization. |
| 1042 | Funds Debited from the Card (AFT). Clearing. |
| 1043 | Funds Debited from the Card (AFT). Authorization. |
| 1044 | Cancellation of Funds Debited from the Card (AFT). Clearing. |
| 1045 | Cancellation of Funds Debited from the Card (AFT). Authorization. |
| 1046 | Purchase (Quasi-Cash). Clearing. |
| 1047 | Purchase (Quasi-Cash). Authorization. |
| 1048 | Cancellation/Refund of Purchase (Quasi-Cash). Clearing. |
| 1049 | Cancellation/Refund of Purchase (Quasi-Cash). Authorization. |
| 1050 | Funds Credited to the Card (Typically for Returns at POS Terminal). Clearing. |
| 1051 | Funds Credited to the Card (Typically for Returns at POS Terminal). Authorization. |
| 1052 | Cancellation of Funds Credited to the Card (Typically for Returns at POS Terminal). Clearing. |
| 1053 | Cancellation of Funds Credited to the Card (Typically for Returns at POS Terminal). Authorization. |
| 1054 | ATM Cash Withdrawal. Clearing. |
| 1055 | ATM Cash Withdrawal. Authorization. |
| 1056 | Cancellation of ATM Cash Withdrawal. Clearing. |
| 1057 | Cancellation of ATM Cash Withdrawal. Authorization. |
| 1058 | Purchase. Clearing. |
| 1059 | Purchase. Authorization. |
| 1060 | Cancellation/Refund of Purchase. Clearing. |
| 1061 | Cancellation/Refund of Purchase. Authorization. |
| 1062 | Funds Credited to the Card (OCT). Clearing. |
| 1063 | Funds Credited to the Card (OCT). Authorization. |
| 1064 | Cancellation of Funds Credited to the Card (OCT). Clearing. |
| 1065 | Cancellation of Funds Credited to the Card (OCT). Authorization. |
| 1066 | Account Debit. |
| 1067 | Cancellation of Account Debit. |
| 1068 | ATM Cash Deposit. Clearing. |
| 1069 | ATM Cash Deposit. Authorization. |
| 1070 | Cancellation of ATM Cash Deposit. Clearing. |
| 1071 | Cancellation of ATM Cash Deposit. Authorization. |
| 1072 | Card Top-Up from Device. Clearing. |
| 1073 | Card Top-Up from Device. Authorization. |
| 1074 | Cancellation of Card Top-Up. Clearing. |
| 1075 | Cancellation of Card Top-Up. Authorization. |
| 1076 | Account Top-Up. |
| 1077 | Cancellation of Account Top-Up. |
| 1078 | ATM Cash Withdrawal via Code (No Card). Clearing. |
| 1079 | ATM Cash Withdrawal via Code (No Card). Authorization. |
| 1080 | Cancellation of ATM Cash Withdrawal via Code (No Card). Clearing. |
| 1081 | Cancellation of ATM Cash Withdrawal via Code (No Card). Authorization. |
Error codes
| Code | Description |
|---|---|
| 12001 | Incorrect input parameters. |
| 12002 | Non-unique request identifier. |
| 12003 | Product code not found. |
| 12004 | Request with the specified request identifier not found. |
| 12006 | Card with the specified identifier not found. |
| 12007 | Client with the specified identifier not found. |
| 12008 | Failed to issue a physical card. |
| 12009 | Failed to open the card. |
| 12010 | Failed to close the card. |
| 12011 | Card is already closed. |
| 12012 | Failed to block the card. |
| 12013 | Card is already blocked. |
| 12014 | Failed to set the PIN code. |
| 9999 | System error, please retry the request later. |
| 1000 | Service unavailable. |