Program Namespace
The program namespace contains the resource to manage programs.with the following Methods Method Endpoint Scope Description.
| Operation | Method | Endpoint | Scope | Sample | Description |
| Program Currency Conversion | Post | program/currency_conversion/program_id | Program | Sample | Program Currency Conversion |
| Get Program Data | Get | program/program_id | Program Credential | Sample | Get Program Data |
| Get Program Info | Get | program/info/program_id | Program | Sample | Get Program Info |
| Get Program Bin(s) | Get | program/bin/program_id | Program Credential | Sample | Get Program Bin(s) |
| Get Program Content | Get | program/content/program_id | Program | Sample | Get Program Content |
| Get Program Mobile Options | Get | program/mobile_options/program_id | Program Credential | Sample | Get Program Mobile Options |
| Get Program Security | Get | program/security/program_id | Program | Sample | Get Program Security |
| Get Program Sign Up | Get | program/sign_up/program_id | Program Credential | Sample | Get Program Sign Up |
| Program System Features | Get | program/system_features/program_id | Program | Sample | Get Program System Features |
| Get Program History | Get | program/history/program_id | Program Credential | Sample | Get Program History |
| Get Program Latest History | Get | program/history/latest/program_id | Program | Sample | Get Program Latest History |
| Get Program POS Config | Get | program/pos/config/program_id | Program Credential | Sample | Get Program POS Config |
| Program Inquiry | Get | program/inquiry/program_id | Program | Sample | Program Inquiry |
| Currency Rates Inquiry | Get | program/currency_rates_inquiry | Program Credential | Sample | Currency Rates Inquiry |
| Biller Inquiry | Get | program/biller_inquiry | Program | Sample | Biller Inquiry |
Data Object
| Field Name | Field Type | Regular Expression | Sample | Field Status | |||
| POST | PUT | GET | DELETE | ||||
| program_data | |||||||
| result Security Type: None |
Object | NA | NA | NA | NA | ||
| info Security Type: None |
Object | None | NA | NA | NA | NA | |
| bin Security Type: None |
Object | None | NA | NA | NA | NA | |
| mobile_options Security Type: None |
Object | None | NA | NA | NA | NA | |
| security Security Type: None |
Object | None | NA | NA | NA | NA | |
| content Security Type: None |
Object | None | NA | NA | NA | NA | |
| system_features Security Type: None |
Object | None | NA | NA | NA | NA | |
| ecommerce_settings 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 | NA | NA | NA | NA |
| result | |||||||
| code Security Type: None |
String | ^[0-9]{1,4}$ | 9000 | NA | NA | NA | NA |
| message Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| friendly_message Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| info | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| parent_id Security Type: None |
String | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| status Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| company_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| title Security Type: None |
String | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| first_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| last_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| address_line1 Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| address_line2 Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| postal_zip_code Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{1,20}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| state_region Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| city_town Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| country_code Security Type: None |
String | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| email_address Security Type: None |
String | ^(?!.*--)([\w-+\.]{1,80})@([\w-+\.]{1,80})\.([a-zA-Z]{1,20})$ | John.Smith@example.com | NA | NA | NA | NA |
| phone_number Security Type: None |
String | ^[+]([1-9])\d{7,14}$ | +15180000000 | NA | NA | NA | NA |
| fax_number Security Type: None |
String | None | NA | NA | NA | NA | |
| update_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 |
| 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 |
| terms_conditions | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | NA | NA | NA |
| is_active Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| country_code Security Type: None |
String | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| server_date Security Type: None |
String | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
| enforced Security Type: None |
Integer | None | NA | NA | NA | NA | |
| inform Security Type: None |
Integer | None | NA | NA | NA | NA | |
| localization Security Type: None |
Object | None | NA | NA | NA | NA | |
| mobile_options | |||||||
| terminal_application Security Type: None |
Object | None | NA | NA | NA | NA | |
| user_application Security Type: None |
Object | None | NA | NA | NA | NA | |
| pos_application Security Type: None |
Object | None | O | O | O | O | |
| social_media | |||||||
| facebook Security Type: None |
String | ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:\/~\+#]*[\w\-\@?^=%&\/~\+#]){1,2038}$ | https://www.google.com | NA | NA | NA | NA |
| twitter Security Type: None |
String | ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:\/~\+#]*[\w\-\@?^=%&\/~\+#]){1,2038}$ | https://www.google.com | NA | NA | NA | NA |
| youtube Security Type: None |
String | ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:\/~\+#]*[\w\-\@?^=%&\/~\+#]){1,2038}$ | https://www.google.com | NA | NA | NA | NA |
| google_plus Security Type: None |
String | ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:\/~\+#]*[\w\-\@?^=%&\/~\+#]){1,2038}$ | https://www.google.com | NA | NA | NA | NA |
| user_mobile_features | |||||||
| enable_catalog Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| ping_timer_sec Security Type: None |
String | None | NA | NA | NA | NA | |
| enable_promotions Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| wap_links_a Security Type: None |
Object | None | NA | NA | NA | NA | |
| enable_payments Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| wap_links_b Security Type: None |
Object | None | NA | NA | NA | NA | |
| enable_near_by Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| wap_links_c Security Type: None |
Object | None | NA | NA | NA | NA | |
| enable_facebook_account Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| wap_links_d Security Type: None |
Object | None | NA | NA | NA | NA | |
| enable_share Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| wap_links_e Security Type: None |
Object | None | NA | NA | NA | NA | |
| wap_links_f Security Type: None |
Object | None | NA | NA | NA | NA | |
| wap_dock_items_a Security Type: None |
Object | None | NA | NA | NA | NA | |
| wap_dock_items_b Security Type: None |
Object | None | NA | NA | NA | NA | |
| wap_dock_items_c Security Type: None |
Object | None | NA | NA | NA | NA | |
| wap_dock_items_d Security Type: None |
Object | None | NA | NA | NA | NA | |
| password_settings | |||||||
| enable_password_edit_setting Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| enable_password_max_length Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| enable_password_min_length Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| enable_min_number_of_upper Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| enable_min_number_of_lower Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| enable_min_number_of_numbers Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| enable_min_number_of_special_characters Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| password_max_length_value Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| password_min_length_value Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| min_number_of_upper_value Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| min_number_of_lower_value Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| min_num_of_numbers_value Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| min_number_of_special_characters_value Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| verification_requirements | |||||||
| personal_details Security Type: None |
Object | None | NA | NA | NA | NA | |
| contact_details Security Type: None |
Object | None | NA | NA | NA | NA | |
| email_address Security Type: None |
Object | None | NA | NA | NA | NA | |
| telephone Security Type: None |
Object | None | NA | NA | NA | NA | |
| identification Security Type: None |
Object | None | NA | NA | NA | NA | |
| banking_information Security Type: None |
Object | None | NA | NA | NA | NA | |
| general_requirements Security Type: None |
Object | None | NA | NA | NA | NA | |
| status | |||||||
| limited Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| confirmed Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| trusted Security Type: None |
Boolean | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| content | |||||||
| social_media Security Type: None |
Object | None | NA | NA | NA | NA | |
| terms_conditions Security Type: None |
Object | None | NA | NA | NA | NA | |
| localization Security Type: None |
Object | None | NA | NA | NA | NA | |
| account_tabs | |||||||
| e_wallet Security Type: None |
String | None | NA | NA | NA | NA | |
| debit_card Security Type: None |
String | None | NA | NA | NA | NA | |
| points Security Type: None |
String | None | NA | NA | NA | NA | |
Query Parameters
| Field Name | Field Type | Regular Expression | Sample | Field Status | |||
| POST | PUT | GET | DELETE | ||||
| program_inquiry | |||||||
| program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| bin_id Security Type: None |
String | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| country_code Security Type: None |
String | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| currency_code Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | NA | NA | NA | NA |
| bin_currency Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | NA | NA | NA | NA |
| bin_type Security Type: None |
String | ^[0-9]{1,1}$ | 0-9 | NA | NA | NA | NA |
| type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
| 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 | O | O |
Program Currency Conversion
Program Currency Conversion
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program Data
Get Program Data
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program Info
Get Program Info
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program Bin(s)
Get Program Bin(s)
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program Content
Get Program Content
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program Mobile Options
Get Program Mobile Options
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program Security
Get Program Security
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program Sign Up
Get Program Sign Up
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Program System Features
Get Program System Features
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program History
Get Program History
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program Latest History
Get Program Latest History
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Program POS Config
Get Program POS Config
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Program Inquiry
Program Inquiry
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Currency Rates Inquiry
Currency Rates Inquiry
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Biller Inquiry
Biller Inquiry
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|