Account Namespace
The account namespace contains the resource to manage accounts of users with the following Methods Method Endpoint Scope Description.
Operation | Method | Endpoint | Scope | Sample | Description |
Create Account | Post | account | Account | Sample | Create Account |
Create Account With Fulfilment | Post | account | Account | Sample | Create Account With Fulfilment |
Create DebitCard Auto Obtain Account | Post | account | Account | Sample | Create DebitCard Auto Obtain Account |
Create DebitCard Supplied Account | Post | account | Account | Sample | Create DebitCard Supplied Account |
Create Ewallet Account | Post | account | Account | Sample | Create Ewallet Account |
Create Multi Currency | Post | account/multi_currency/account_id | Account | Sample | Create Multi Currency |
Create Security Access | Post | account/security/rule/account_id | Account | Sample | Create Security Access |
Create Custom Field | Post | account/custom_field/account_id | Account | Sample | Create Custom Field |
Account Activation | Post | account/activate/account_id | Account | Sample | Account Activation |
Account Create & Activate | Post | account/activate/account_id | Account | Sample | Account Create & Activate |
Create Credit Limit | Post | account/credit_limit/account_id | Account | Sample | Create Credit Limit |
Update Account | Put | account/account_id | Account | Sample | Update Account |
Account Update Options | Put | account/options/account_id | Account | Sample | Account Update Options |
Account Update Options Renewal | Put | account/options/account_id | Account | Sample | Account Update Options Renewal |
Account Update Options Replacment | Put | account/options/account_id | Account | Sample | Account Update Options Replacment |
Account Update Options Physical Issuance | Put | account/options/account_id | Account | Sample | Account Update Options Physical Issuance |
Account Update Options Multi PAN | Put | account/options/account_id | Account | Sample | Account Update Options Multi PAN |
Account Update External Balance | Put | account/external_balance/0 | Account | Sample | Account Update External Balance |
Update Account Security Access | Put | account/security/rule/account_id | Account | Sample | Update Account Security Access |
Get Account | Get | account/account_id | Account | Sample | Get Account |
Get Account Multi PAN | Get | account/account_id | Account | Sample | Get Account Multi PAN |
Get Account Info | Get | account/info/account_id | Account | Sample | Get Account Info |
Get Account Limits | Get | account/limits/account_id | Account | Sample | Get Account Limits |
Get Account Security Access | Get | account/security/rule/account_id | Account | Sample | Get Account Security Access |
Get Account History | Get | account/history/account_id | Account | Sample | Get Account History |
Get Account Latest History | Get | account/history/latest/account_id | Account | Sample | Get Account Latest History |
Inquiry Account(s) | Get | account/inquiry | Account | Sample | Inquiry Account(s) |
Card Image Account | Get | account/card_image/inquiry | Account | Sample | Card Image Account |
Get Credit Limit | Get | account/credit_limit/account_id | Account | Sample | Get Credit Limit |
Delete Account Security Access | Delete | account/security/rule/account_id | Account | Sample | Delete Account Security Access |
Data Object
Field Name | Field Type | Regular Expression | Sample | Field Status | |||
POST | PUT | GET | DELETE | ||||
account_data | |||||||
info Security Type: None |
Object | None | R | O | NA | NA | |
limits Security Type: None |
Object | None | NA | NA | NA | NA | |
archive Security Type: None |
Object | None | NA | NA | NA | NA | |
custom_field Security Type: None |
Object | None | O | NA | NA | NA | |
geo_coordinates Security Type: None |
Object | None | O | O | NA | NA | |
options Security Type: None |
Object | None | NA | NA | NA | NA | |
bank_account Security Type: None |
Object | None | O | O | O | O | |
history Security Type: None |
Object | None | NA | NA | NA | NA | |
notes Security Type: None |
Object | None | O | O | O | O | |
last_activity Security Type: None |
Object | None | NA | O | NA | NA | |
authentication Security Type: None |
Object | None | O | O | O | O | |
validate Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
info | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | C | R | NA | NA |
supplied_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | C | NA | NA | NA |
program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | R | R | NA | NA |
bin_id Security Type: None |
String | ^[0-9]{1,10}$ | 5000000 | R | NA | NA | NA |
user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | R | R | NA | NA |
name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
nick_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | O | O | NA | NA |
type Security Type: None |
String | ^[0-9]{1,3}$ | 900 | R | NA | NA | NA |
number Security Type: Masked |
String | ^[0-9]{11,19}$ | 5389820000000000, 3333330000000000000 | C | NA | NA | NA |
currency Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | O | NA | NA | NA |
status Security Type: None |
String | ^(-1|[0-9]{1,2})$ | 10,3,-1 | OP | C | NA | NA |
balance Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
available_balance Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
activation_date_time Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
replace_account Security Type: None |
String | ^[0-9]{11,19}$ | 5389820000000000, 3333330000000000000 | NA | NA | NA | NA |
original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | NA | NA | NA | NA |
server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
source_time_zone Security Type: None |
String | ^((?:UTC [+|-](?:2[0-3]|[01][0-9]):[0-5][0-9])){1,10}$ | UTC -06:00, UTC +02:30 | NA | NA | NA | NA |
security Security Type: None |
Object | None | C | NA | NA | NA | |
security | |||||||
security_code Security Type: Wiped |
String | ^[0-9]{1,6}$ | 900000 | C | NA | O | O |
activation_code Security Type: Wiped |
String | ^[a-zA-Z0-9-]{1,20}$ | Abc00000 | C | NA | O | O |
expiry_date Security Type: Wiped |
String | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
pin_code Security Type: Wiped |
String | ^[0-9]{1,4}$ | 9000 | NA | NA | NA | NA |
limits | |||||||
deposit Security Type: None |
Object | None | NA | NA | NA | NA | |
withdraw Security Type: None |
Object | None | NA | NA | NA | NA | |
transfer_sending Security Type: None |
Object | None | NA | NA | NA | NA | |
transfer_recieving Security Type: None |
Object | None | NA | NA | NA | NA | |
deposit | |||||||
monthly Security Type: None |
Object | None | NA | NA | NA | NA | |
yearly Security Type: None |
Object | None | NA | NA | NA | NA | |
manual Security Type: None |
Object | None | NA | NA | NA | NA | |
general Security Type: None |
Object | None | NA | NA | NA | NA | |
bank_transfer Security Type: None |
Object | None | NA | NA | NA | NA | |
check Security Type: None |
Object | None | O | O | O | O | |
deposit_monthly | |||||||
maximum_allowed_credit_balance Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
maximum_transactions_amount_per_month Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
remaining_transactions_amount_per_month Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
maximum_transactions_count_per_month Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_month Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_yearly | |||||||
maximum_allowed_credit_balance Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
maximum_transactions_count_per_year Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
maximum_transactions_amount_per_year Security Type: None |
Float | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
remaining_transactions_amount_per_year Security Type: None |
Float | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
remaining_transactions_count_per_year Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_manual | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_general | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_bank_transfer | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_check_load | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_a_c_h | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_vouchers | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | None | NA | NA | NA | NA | |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_fana_pay_load | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_cash_u_load | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_u_kash_load | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
deposit_one_card_load | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
withdraw | |||||||
monthly Security Type: None |
Object | None | O | O | O | O | |
yearly Security Type: None |
Object | None | O | O | O | O | |
manual Security Type: None |
Object | None | O | O | O | O | |
general Security Type: None |
Object | None | O | O | O | O | |
reseller_purchase Security Type: None |
Object | None | O | O | O | O | |
user_purchase Security Type: None |
Object | None | O | O | O | O | |
bank_transfer Security Type: None |
Object | None | O | O | O | O | |
check Security Type: None |
Object | None | O | O | O | O | |
purchase Security Type: None |
Object | None | O | O | O | O | |
withdrawal Security Type: None |
Object | None | O | O | O | O | |
withdraw_monthly | |||||||
maximum_allowed_debit_balance Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
maximum_transactions_amount_per_month Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
remaining_transactions_amount_per_month Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
maximum_transactions_count_per_month Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_month Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
withdraw_yearly | |||||||
maximum_transactions_amount_per_year Security Type: None |
Float | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
maximum_transactions_count_per_year Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_amount_per_year Security Type: None |
Integer | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
remaining_transactions_count_per_year Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
withdraw_manual | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
withdraw_general | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
reseller_purchase | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
user_purchase | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
withdraw_bank_transfer | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
withdraw_checks | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
withdraw_a_c_h | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
transfer_sending | |||||||
monthly Security Type: None |
Object | None | O | O | O | O | |
yearly Security Type: None |
Object | None | O | O | O | O | |
generic_transfer_send Security Type: None |
Object | None | O | O | O | O | |
general_transfer_send Security Type: None |
Object | None | O | O | O | O | |
transfer_sending_monthly | |||||||
maximum_transactions_amount_per_month Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_month Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_month Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_month Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
ewallet_send_internal | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
ewallet_send_external | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
points_send_internal | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
points_send_external | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
debit_card_send_internal | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
debit_card_send_external | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
program_payout | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
transfer_receiving | |||||||
monthly Security Type: None |
Object | None | O | O | O | O | |
yearly Security Type: None |
Object | None | O | O | O | O | |
generic_transfer_receive Security Type: None |
Object | None | O | O | O | O | |
general_transfer_receive Security Type: None |
Object | None | O | O | O | O | |
ewallet_receive_internal | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
ewallet_receive_external | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
points_receive_internal | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
points_receive_external | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
transfer_receiving_monthly | |||||||
maximum_transactions_amount_per_month Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_month Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_month Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_month Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
transfer_receiving_yearly | |||||||
maximum_transactions_amount_per_year Security Type: None |
Float | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
maximum_transactions_count_per_year Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_amount_per_year Security Type: None |
Integer | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
remaining_transactions_count_per_year Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
debit_card_receive_internal | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
debit_card_receive_external | |||||||
minimum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transaction_amount Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
remaining_transactions_amount_per_day Security Type: None |
Decimal | None | NA | NA | NA | NA | |
maximum_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
remaining_transactions_count_per_day Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
archive | |||||||
server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
input Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | NA | NA | NA | NA |
output Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | NA | NA | NA | NA |
geo_coordinates | |||||||
latitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | 37.42242 | R | R | NA | NA |
longitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | 37.42242 | R | R | NA | NA |
position_description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,255}$ | Abc00, fʁɑ̃s123 | O | O | NA | NA |
Query Parameters
Field Name | Field Type | Regular Expression | Sample | Field Status | |||
POST | PUT | GET | DELETE | ||||
account_inquiry | |||||||
start_index Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
page_size Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
sort_by Security Type: None |
String | ^[a-zA-Z0-9_]{1,22}$ | create_time | NA | NA | O | NA |
sort_flag Security Type: None |
String | ^(asc|desc)$ | asc, desc | NA | NA | O | NA |
program_id Security Type: None |
String | ^[0-9]{1,10}$ | 5000000 | NA | NA | R | NA |
user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
status Security Type: None |
String | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | O | NA |
account_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
currency Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | NA | NA | O | NA |
from_date Security Type: None |
String | ^([0-9]{4})[\/|-]((0[1-9])|(1[0-2]))[\/|-]((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))$ | 2006-06-12, 2006/06/12 (yyyy-mm-dd or yyyy/mm/dd) | NA | NA | O | NA |
to_date Security Type: None |
String | ^([0-9]{4})[\/|-]((0[1-9])|(1[0-2]))[\/|-]((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))$ | 2006-06-12, 2006/06/12 (yyyy-mm-dd or yyyy/mm/dd) | NA | NA | O | NA |
archive Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | NA | NA | O | NA |
notes Security Type: None |
Object | None | O | O | O | O | |
last_activity Security Type: None |
Object | None | NA | O | NA | NA | |
authentication Security Type: None |
Object | None | O | O | O | O | |
validate Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
Create Account
Create Account
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create Account With Fulfilment
Create Account With Fulfilment
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create DebitCard Auto Obtain Account
Create DebitCard Auto Obtain Account
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create DebitCard Supplied Account
Create DebitCard Supplied Account
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create Ewallet Account
Create Ewallet Account
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create Multi Currency
Create Multi Currency
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create Security Access
Create Security Access
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create Custom Field
Create Custom Field
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Account Activation
Account Activation
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Account Create & Activate
Account Create & Activate
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create Credit Limit
Create Credit Limit
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Update Account
Update Account
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Account Update Options
Account Update Options
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Account Update Options Renewal
Account Update Options Renewal
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Account Update Options Replacment
Account Update Options Replacment
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Account Update Options Physical Issuance
Account Update Options Physical Issuance
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Account Update Options Multi PAN
Account Update Options Multi PAN
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Account Update External Balance
Account Update External Balance
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Update Account Security Access
Update Account Security Access
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get Account
Get Account
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get Account Multi PAN
Get Account Multi PAN
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get Account Info
Get Account Info
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get Account Limits
Get Account Limits
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get Account Security Access
Get Account Security Access
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get Account History
Get Account History
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get Account Latest History
Get Account Latest History
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Inquiry Account(s)
Inquiry Account(s)
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Card Image Account
Card Image Account
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get Credit Limit
Get Credit Limit
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Delete Account Security Access
Delete Account Security Access
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|