Insert Transaction
POST https://dev.korimoneytransfer.com/api/transaction/InsertTransaction
Request¶
Creates a Remitter.
Use this endpoint a new create a new kyced remitter into our system.
Authorization¶
Authorization
Payouts API is HTTPS (TLS V 1.2) based with basic HTTP authorization headers.
Each integrated partner should receive API key & Secret that should be added to every request. Authorization header should be generated as follows:
Base64(API USERNAME + ":" + API PASSWORD ":" + API PIN).getBytes
And the header should look like this: "Authorization": "Basic " + authorization.
Parameters:¶
Body¶
object | application/json
Common remitter creation object properties.
| Name | Type | Notes | |
|---|---|---|---|
agent_trans_ref |
Integer | required | Transaction reference from the sending system. |
trans_type |
Integer | required | Account / Cash Collection / Card Transfer / Home Delivery / Mobile Transfer |
purpose |
String | optional | See 'Description' on Appendix G |
source_of_income |
String | optional | See 'Description' on Appendix F |
member_id |
Integer | optional | Optional, remitter’s member id |
occupation |
String | optional | |
remitt_name |
String | optional | |
remitt_fname |
String | optional | |
remitt_mname |
String | optional | |
remitt_lname |
String | optional | |
remitt_addr |
String | optional | |
remitter_address2 |
String | optional | |
remitt_city |
String | optional | |
remitt_state |
String | optional | |
remitt_postcode |
String | optional | |
remitt_tel |
String | optional | |
remitt_id_type |
String | optional | |
remitt_id_details |
String | optional | |
id1_issued_by |
String | optional | |
id1_issue_place |
String | optional | |
remitt_nationality |
String | optional | 2 letter country ISO code. Please refer to Appendix A. |
remitt_dob |
Date | optional | YYYY-MM-DD |
remitt_mobile |
String | optional | |
remitt_orgtype |
String | optional | Individual or Corporate |
remitt_company_name |
String | optional | Optional if Individual |
remitt_company_type |
String | optional | Optional if Individual |
remitt_company_reg_no |
String | optional | Optional if Individual |
remitt_business_type |
String | optional | Optional if Individual |
benef_id |
Integer | optional | Optional, beneficiary’s member id |
benef_name |
String | optional | |
benef_address |
String | optional | |
benef_address2 |
String | optional | |
benef_address3 |
String | optional | |
benef_city |
String | optional | |
benef_state |
String | optional | |
benef_postcode |
String | optional | |
benef_tel |
String | optional | |
benef_mobile |
String | optional | |
benef_id_type |
String | optional | |
benef_id_details |
String | optional | |
benef_ac |
String | optional | |
benef_bank |
String | optional | |
benef_bank_swift_code |
String | optional | |
benef_branch |
String | optional | |
benef_branch_code |
String | optional | |
benef_branch_address |
String | optional | |
benef_branch_tel |
String | optional | |
benef_branch_city |
String | optional | |
benef_branch_state |
String | optional | |
benef_card_number |
String | optional | |
collection_point |
String | optional | |
collection_point_code |
String | optional | |
collection_point_bank |
String | optional | |
collection_point_addres |
String | optional | |
collection_point_city |
String | optional | |
collection_pin |
String | optional | |
benef_utilitybillcompany |
String | optional | Name of the Utility Company where money will be paid. Required if transaction is of type Utility Bill. |
benef_utilitybillcompanycode |
String | optional | The Utility Company Code. It is used for routing the money. |
benef_utilitybillaccountno |
String | optional | Customer Account No. Required if transaction is of type Utility Bill. |
benef_utilitybillinvoice |
String | optional | Invoice No. |
benef_utilitybillbank |
String | optional | Bank Name |
benef_utilitybillbankcode |
String | optional | Bank IBAN/SWIFT Code. |
benef_utilitybillbankbic |
String | optional | |
benef_utilitybilldescription |
String | optional | Bill Description. |
benef_utilitybill_address1 |
String | optional | |
benef_utilitybill_address2 |
String | optional | |
benef_utilitybill_address3 |
String | optional | |
benef_utilitybill_city |
String | optional | |
benef_utilitybill_state |
String | optional | |
benef_utilitybill_postcode |
String | optional | |
benef_mobiletransfer_number |
String | optional | |
benef_mobiletransfer_network |
String | optional | |
payment_method |
Code | required | See Appendix D for codes. |
source_currency |
String | required | |
source_amount |
Integer | required | |
dest_currency |
String | required | |
dest_amount |
Integer | required | |
rate |
Integer | required | |
commission |
Integer | required | |
source_tax |
Integer | optional | |
originating_country |
String | required | 2 letter country ISO code. Please refer to Appendix A. |
destination_country |
String | required | 2 letter country ISO code. Please refer to Appendix A. |
service_level |
Code | optional | See Appendix E for codes. |
sms_notification |
Boolean | required | t/f |
sms_confirmation |
Boolean | required | t/f |
sms_benef_confirmation |
Boolean | required | t/f |
agent_fee |
Integer | optional | |
agent_comments |
String | optional | Remitter/Agent Comments |
sms_remitter_mobile |
String | optional | |
sms_benef_mobile |
String | optional | |
agent_settlement_exchange_rate |
Integer | optional | |
agent_comments |
Test | optional |
PAYLOAD JSON
{
"agent_trans_ref": "",
"trans_type": "",
"purpose": "",
"source_of_income": "",
"member_id": "",
"occupation": "",
"remitt_name": "",
"remitt_fname": "",
"remitt_mname": "",
"remitt_lname": "",
"remitt_addr": "",
"remitter_address2": "",
"remitt_city": "",
"remitt_state": "",
"remitt_postcode": "",
"remitt_tel ": "",
"remitt_id_type": "",
"remitt_id_details": "",
"id1_issued_by": "",
"id1_issue_place": "",
"remitt_nationality": "",
"remitt_dob": "",
"remitt_mobile": "",
"remitt_orgtype": "",
"remitt_company_name": "",
"remitt_company_type": "",
"remitt_company_reg_no": "",
"remitt_business_type": "",
"benef_id": "",
"benef_name": "",
"benef_address": "",
"benef_address2": "",
"benef_address3": "",
"benef_city": "",
"benef_state": "",
"benef_postcode": "",
"benef_tel": "",
"benef_mobile": "",
"benef_id_type": "",
"benef_id_details": "",
"benef_ac": "",
"benef_bank": "",
"benef_bank_swift_code": "",
"benef_branch": "",
"benef_branch_code": "",
"benef_branch_address": "",
"benef_branch_tel": "",
"benef_branch_city": "",
"benef_branch_state": "",
"benef_card_number": "",
"collection_point": "",
"collection_point_code": "",
"collection_point_bank": "",
"collection_point_addres": "",
"collection_point_city": "",
"collection_pin": "",
"benef_utilitybillcompany": "",
"benef_utilitybillcompanycode": "",
"benef_utilitybillaccountno": "",
"benef_utilitybillinvoice": "",
"benef_utilitybillbank": "",
"benef_utilitybillbankcode": "",
"benef_utilitybillbankbic": "",
"benef_utilitybilldescription": "",
"benef_utilitybill_address1": "",
"benef_utilitybill_address2": "",
"benef_utilitybill_address3": "",
"benef_utilitybill_city": "",
"benef_utilitybill_state": "",
"benef_utilitybill_postcode": "",
"benef_mobiletransfer_number": "",
"benef_mobiletransfer_network": "",
"payment_method": "",
"source_currency": "",
"source_amount": "",
"dest_currency": "",
"dest_amount": "",
"rate": "",
"commission": "",
"source_tax": "",
"originating_country": "",
"destination_country": "",
"service_level": "",
"sms_notification": "",
"sms_confirmation": "",
"sms_benef_confirmation": "",
"agent_fee": "",
"agent_comments": "",
"sms_remitter_mobile": "",
"sms_benef_mobile": "",
"agent_settlement_exchange_rate": "",
"agent_comments": "",
"trans_type": "",
"purpose": "",
"source_of_income": "",
"member_id": "",
"occupation": "",
"remitt_name": "",
"remitt_fname": "",
"remitt_mname": "",
"remitt_lname": "",
"remitt_addr": "",
"remitter_address2": "",
"remitt_city": "",
"remitt_state": "",
"remitt_postcode": "",
"remitt_tel ": "",
"remitt_id_type": "",
"remitt_id_details": "",
"id1_issued_by": "",
"id1_issue_place": "",
"remitt_nationality": "",
"remitt_dob": "",
"remitt_mobile": "",
"remitt_orgtype": "",
"remitt_company_name": "",
"remitt_company_type": "",
"remitt_company_reg_no": "",
"remitt_business_type": "",
"benef_id": "",
"benef_name": "",
"benef_address": "",
"benef_address2": "",
"benef_address3": "",
"benef_city": "",
"benef_state": "",
"benef_postcode": "",
"benef_tel": "",
"benef_mobile": "",
"benef_id_type": "",
"benef_id_details": "",
"benef_ac": "",
"benef_bank": "",
"benef_bank_swift_code": "",
"benef_branch": "",
"benef_branch_code": "",
"benef_branch_address": "",
"benef_branch_tel": "",
"benef_branch_city": "",
"benef_branch_state": "",
"benef_card_number": "",
"collection_point": "",
"collection_point_code": "",
"collection_point_bank": "",
"collection_point_addres": "",
"collection_point_city": "",
"collection_pin": "",
"benef_utilitybillcompany": "",
"benef_utilitybillcompanycode": "",
"benef_utilitybillaccountno": "",
"benef_utilitybillinvoice": "",
"benef_utilitybillbank": "",
"benef_utilitybillbankcode": "",
"benef_utilitybillbankbic": "",
"benef_utilitybilldescription": "",
"benef_utilitybill_address1": "",
"benef_utilitybill_address2": "",
"benef_utilitybill_address3": "",
"benef_utilitybill_city": "",
"benef_utilitybill_state": "",
"benef_utilitybill_postcode": "",
"benef_mobiletransfer_number": "",
"benef_mobiletransfer_network": "",
"payment_method": "",
"source_currency": "",
"source_amount": "",
"dest_currency": "",
"dest_amount": "",
"rate": "",
"commission": "",
"source_tax": "",
"originating_country": "",
"destination_country": "",
"service_level": "",
"sms_notification": "",
"sms_confirmation": "",
"sms_benef_confirmation": "",
"agent_fee": "",
"agent_comments": "",
"sms_remitter_mobile": "",
"sms_benef_mobile": "",
"agent_settlement_exchange_rate": "",
"agent_comments": "",
}