Transaction Namespace
The transaction namespace contains the resource to manage transactions. with the following Methods Method Endpoint Scope Description.
| Operation | Method | Endpoint | Scope | Sample | Description |
| Internal Transfer Transaction | Post | transaction | Transaction | Sample | Internal Transfer Transaction |
| External Transfer Transaction | Post | transaction | Transaction | Sample | External Transfer Transaction |
| Manual Withdrawal | Post | transaction | Transaction | Sample | Manual Withdrawal |
| Validate Manual Load | Post | transaction | Transaction | Sample | Validate Manual Load |
| Manual Load | Post | transaction | Transaction | Sample | Manual Load |
| Voucher Payment by PIN Code | Post | transaction | Transaction | Sample | Voucher Payment by PIN Code |
| Voucher Payment by Auth Code | Post | transaction | Transaction | Sample | Voucher Payment by Auth Code |
| Get Transaction | Get | transaction/transaction_id | Transaction | Sample | Get Transaction |
| Inquiry Transaction | Get | transaction/inquiry | Transaction | Sample | Inquiry Transaction |
| Transfer Inquiry | Get | transfer/inquiry | Transaction | Sample | Transfer Inquiry |
| Reverse Transaction | Get | reverse/original_source_id | Transaction | Sample | Reverse Transaction |
| Get Transaction History | Get | history/transaction_id | Transaction | Sample | Get Transaction History |
| Get Transaction Latest History | Get | history/latest/transaction_id | Transaction | Sample | Get Transaction Latest History |
Data Object
| Field Name | Field Type | Regular Expression | Sample | Field Status | |||
| POST | PUT | GET | DELETE | ||||
| transaction_data | |||||||
| info Security Type: None |
Object | None | R | NA | NA | NA | |
| account Security Type: None |
Object | None | R | NA | NA | NA | |
| fee Security Type: None |
Object | None | NA | NA | NA | NA | |
| tax Security Type: None |
Object | None | NA | NA | NA | NA | |
| conversion Security Type: None |
Object | None | NA | NA | NA | NA | |
| transfer Security Type: None |
Object | None | O | NA | NA | NA | |
| credit_card Security Type: Masked |
Object | None | O | NA | NA | NA | |
| bank_account Security Type: None |
Object | None | O | 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 | |
| history Security Type: None |
Object | None | NA | O | 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 | C | NA | NA | NA | |
| validate Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | O | NA | NA | NA |
| info | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| parent_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| account_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | NA | NA | NA |
| user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | R | NA | NA | NA |
| type Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | R | NA | NA | NA |
| classification Security Type: None |
String | ^[a-zA-Z_\/*\s]{1,50}$ | TransferSend, Debit, Credit | NA | NA | NA | NA |
| operation Security Type: None |
String | ^[a-zA-Z_\/*\s]{1,50}$ | TransferSend, Debit, Credit | NA | NA | NA | NA |
| amount Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | R | NA | NA | NA |
| currency Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | R | NA | 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 |
| notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | O | 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 |
| 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 |
| fee | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| amount Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
| type Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| operation Security Type: None |
String | ^[a-zA-Z_\/*\s]{1,50}$ | TransferSend, Debit, Credit | NA | NA | NA | NA |
| notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | O | NA | NA | NA |
| tax | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| amount Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
| type Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| operation Security Type: None |
String | ^[a-zA-Z_\/*\s]{1,50}$ | TransferSend, Debit, Credit | NA | NA | NA | NA |
| notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | NA | NA | NA | NA |
| balance Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
| conversion | |||||||
| from_currency Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | O | O | O | O |
| from_currency Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | O | O | O | O |
| to_currency Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | O | O | O | O |
| to_currency Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | O | O | O | O |
| original_amount Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
| converted_amount Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
| converted_amount_without_margin Security Type: -1 |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
| converted_amount_without_margin Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
| converted_amount_without_margin Security Type: -1 |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
| converted_amount_without_margin Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
| conversion_type Security Type: None |
Integer | None | O | O | O | O | |
| conversion_type Security Type: None |
Integer | None | O | O | O | O | |
| ws_setup_id Security Type: None |
Integer | None | O | O | O | O | |
| ws_setup_id Security Type: None |
Integer | None | O | O | O | O | |
| currency_rate Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
| currency_rate Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
| second_currency_rate Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
| second_currency_rate Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
| margin_percent Security Type: None |
Decimal | None | O | O | O | O | |
| margin_percent Security Type: None |
Decimal | None | O | O | O | O | |
| margin_percent_from_base Security Type: None |
Decimal | None | O | O | O | O | |
| margin_percent_from_base Security Type: None |
Decimal | None | O | O | O | O | |
| transfer | |||||||
| account_info Security Type: None |
Object | None | R | NA | NA | NA | |
| receiver_info Security Type: None |
Object | None | C | O | NA | NA | |
| fee Security Type: None |
Object | None | O | O | O | O | |
| tax Security Type: None |
Object | None | O | O | O | O | |
| conversion Security Type: None |
Object | None | O | O | O | O | |
| notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | O | NA | 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 | |
| credit_card | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | R | NA | NA | NA |
| type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| holder_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| number Security Type: Encrypted |
String | ^[0-9]{1,16}$ | 5389820000000000 | NA | NA | NA | NA |
| expiry_year Security Type: Encrypted |
String | ^(20|21)\d{2}$ | 2000 | NA | NA | NA | NA |
| expiry_month Security Type: Encrypted |
String | ^(0[1-9]|1[0-2])$ | 01,06,12 | NA | NA | NA | NA |
| security_code Security Type: Encrypted |
String | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| is_primary Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| status Security Type: None |
String | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| verification_status Security Type: None |
String | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| billing_address Security Type: None |
Object | None | NA | NA | NA | NA | |
| save_creditcard Security Type: None |
Boolean | None | O | O | O | O | |
| billing_address | |||||||
| 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 |
| verification_status Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | 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 | ||||
| transaction_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 |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
| operation Security Type: None |
String | ^[a-zA-Z_\/*\s]{1,50}$ | TransferSend, Debit, Credit | NA | NA | O | NA |
| user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | R | NA |
| status Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | NA | NA | O | NA |
| account_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
| transaction_type Security Type: None |
String | ^[0-9]{1,3}$ | 900 | 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 | O | NA |
| transaction_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
| original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | NA | NA | O | NA |
| statement_month Security Type: None |
String | ^([0-9]{4})[\/|-]((0[1-9])|(1[0-2]))$ | 2011-05, 2011/05 (yyyy-mm or yyyy/mm) | NA | NA | O | NA |
| latest Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
Internal Transfer Transaction
Internal Transfer Transaction
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
External Transfer Transaction
External Transfer Transaction
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Manual Withdrawal
Manual Withdrawal
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Validate Manual Load
Validate Manual Load
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Manual Load
Manual Load
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Voucher Payment by PIN Code
Voucher Payment by PIN Code
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Voucher Payment by Auth Code
Voucher Payment by Auth Code
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Transaction
Get Transaction
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Inquiry Transaction
Inquiry Transaction
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Transfer Inquiry
Transfer Inquiry
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Reverse Transaction
Reverse Transaction
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Transaction History
Get Transaction History
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Transaction Latest History
Get Transaction Latest History
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|