Description: This merchant id will be provided by the TipMe Admin and will be used in each API. Without a merchant ID, you cannot access any of TipMe’s API.

Access Key Name: authorizekey

Description: This key will be provided by TipMe Admin and will be used in each API.

Authorize key is sent in headers.

API URLs:

Description: This link will be provided by TipMe Admin. The staging and the live URLs will be different. All testing is done in the staging environment and upon a successful test, your account will be, migrated to the Live system, and new credentials provided by TipMe Admin.

Listing of APIs

1. Get Profile (Post Method)

Description: This API is used for getting the agent’s profile details linked with a merchant id.

URL: {base_url}/Merchant_api/get_profile

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
500	Internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Data Found.",

"details": {

"agent_id": "AID1000001",

"company_name": "XYZ",

"email": "xyz@email.com",

"fullname": "ABC",

"mobile": "1234567890",

"country": "Liberia",

"profile_pic": ""

}

2. Check Balance (Post Method)

Description: This API is used for fetching the agent balance details linked with this merchant id.

URL: {base_url}/Merchant_api/check_balance

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Data Found.",

"wallet": [

{

"amount": "100.00",

"currency_code": "LRD",

"is_primary": "1",

"currency": "L$"

{

"amount": "0.00",

"currency_code": "USD",

"is_primary": "0",

"currency": "$"

}

]

}

3. Withdrawal History (Post Method)

Description: This API is used for listing all withdrawal requests and the requests can be filtered out through multiple parameters.

URL: {base_url}/Merchant_api/withdraw_history

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. Page (integer) (Mandatory) (It is a page no.)

3. Limit (integer) (Optional) (limit of 10 per page as default)

4. Keyword (string) (Optional) – In keyword parameter you can filter by customer id or transaction id

5. Status (string) (Optional) – Pending, Accepted, Declined,

Cancelled, Success

6. from_date (Optional) – Format: YYYY-MM-DD

7. to_date (Optional) – Format: YYYY-MM-DD

8. ref_no (string) (Optional)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Data Found",

"list": [

{

"customer_id": "CID1000000",

"sub_agent_id": "0",

"sub_agent": "",

"amount_request": "L$ 100.00",

"transaction_commission": "L$ 15.000000",

"agent_commission": "L$ 15.00",

"total_paid": "L$ 60.00",

"description": "",

"transaction_id": "TR1234567890",

"ref_no": "123467980",

"status": "Success",

"customer_full_name": "Username",

"customer_profile_pic": "image.png",

"request_date": "22/06/2020 09:28 AM",

"transaction_date": "22/06/2020 09:31 AM"

]

}

4. Withdrawal Request List (Post Method)

Description: This API is used for listing all pending requests and the requests can be filtered out through multiple parameters.

URL: {base_url}/Merchant_api/withdraw_request

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. Page (integer) (Mandatory) (It is a page no.)

3. Limit (integer) (Optional) (limit of 10 per page as default)

4. Keyword (string) (Optional) – In keyword parameter you can filter by customer id or transaction id

5. from_date (Optional) – Format: YYYY-MM-DD

6. to_date (Optional) – Format: YYYY-MM-DD

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Data Found",

"list": [

{

"withdrawal_id": "1",

"customer_id": "CID100000",

"amount_request": "L$ 100.00",

"description": "",

"transaction_id": "TR1234567890",

"customer_full_name": "Username",

"customer_profile_pic": "image.png",

"request_date": "22/06/2020 09:10 AM"

]

}

5 . Withdrawal Request Detail (Post Method)

Description: This API is used for get details.

URL: {base_url}/Merchant_api/withdrawal_detail

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. withdraw_id (integer) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Withdrawal request detail.",

"details": {

"withdrawal_id": "62",

"customer_id": "CID100000",

"agent_id": "AID1000001",

"sub_agent_id": "0",

"sub_agent_name": "",

"amount_request": "$ 93.00",

"amount": "93.00",

"currency_code": "USD",

"currency": "$",

"description": "",

"ref_no": "1234567890",

"status": "Pending",

"transaction_id": "TR1234567890",

"customer_name": "xyz",

"customer_profile_pic": "image.png",

"customer_mobile": "0123456789",

"request_date": "31/10/2020 10:11 AM"

}

6. Decline Withdrawal Request (Post Method)

Description: This API is used to decline withdrawal requests sent by customers.

URL: {base_url}/Merchant_api/decline_withdraw_request

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. withdrawal_id (integer) (Mandatory) – Get this withdrawal_id from the withdrawal request api

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Withdrawal request declined successfully."

}

7. Accept Withdrawal Request (Post Method)

Description: This API is used to accept withdrawal requests sent by a customer as well as a one-time password (OTP) that is sent to the customer.

URL : {base_url}/Merchant_api/accept_withdraw_request

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. withdrawal_id (integer) (Mandatory)

Response :

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "You have accepted a withdrawal request of amount L$ 100.00, Please get the one-time password from Username."

}

8. Resend OTP (Post Method)

Description: This API is used for Resending a validation OTP to a customer

URL: {base_url}/Merchant_api/resend_otp

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. withdrawal_id (integer) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "You have resent an OTP for the requested amount of L$ 100.00, Please get the one-time password from Username."

}

9 . Check Resend OTP Notifications (Post Method)

Description: This API is used for getting resending OTP messages if a customer resends for withdrawal requests after accepting by agent or any subagent will accept withdrawal request. You can use it for checking resend otp notifications by calling it in 15-20 seconds.

URL: {base_url}/Merchant_api/get_withdrawal_resend_notification

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"list": [

{

"message": "Withdrawal request TR11234567890 OTP is resend by ABC XYZ for amount of L$ 62.00",

"transaction_id": "TR11234567890"

}

]

}

10. Search Customer (Post Method)

Description: This API is used for searching customers by Customer ID which is registered in the TipMe system. It is helpful to non-smart users for making transactions.

URL : {base_url}/Merchant_api/search_customer

Content-Type: application/x-www-form-urlencoded

Parameters :

1. merchant_id (string) (Mandatory)

2. customer_id (string) (Mandatory)

Response :

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Record found.",

"user_data": {

"mobile": "1234567890",

"user_name": "Username",

"customer_id": "CID1000000",

"profile_pic": "image.png",

"country_name": "Liberia",

"currency": "L$",

"wallets": [

{

"currency_code": "USD",

"is_primary": "1",

"currency": "$"

{

"currency_code": "LRD",

"is_primary": "0",

"currency": "L$"

}

]

}

11. Estimate Charges (Post Method)

Description: This API is used to estimate the charges for non-smart users. It is used for calculating transaction charges and Agent commission and must be called before creating a withdrawal request API.

URL : {base_url}/Merchant_api/estimate_charges

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. customer_id (string) (Mandatory)

3. amount (float) (Mandatory) – Withdrawal Amount

4. currency_code (string) (Mandatory) - Customer wallet currency code, fetched by the search customer API.

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response

{

"status": "1",

"msg": "Data Found",

"details": {

"amount": "100",

"currency": "L$",

"currency_code": "LRD",

"transaction_charge": "40.00",

"estimated_charge": "60.00"

}

12. Create Withdrawal Request (Post Method)

Description: This API is used to create withdrawal requests for the non-smart users.

URL : {base_url}/Merchant_api/create_withdrawal_request

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. customer_id (string) (Mandatory)

3. amount (float) (Mandatory) – Withdrawal Amount

4. currency_code (string) (Mandatory) - Customer wallet currency code, fetched by the search customer API.

5. ref_no (string) (optional)

Response :

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"withdraw_id": "10",

"ref_no": "1234567890",

"transaction_id_id": "TR100000000",

"msg": "Cash withdrawal request for customer (Username) in the amount of L$ 100.00 has been created."

}

13. Confirm Withdrawal OTP (Post Method)

Description: This API is used to confirm withdrawal OTP for requests of non-smart users. Before this API is called, one needs to accept the withdrawal request first by the API accept_withdraw_request

URL : {base_url}/Merchant_api/confirm_withdrawal_otp

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. withdrawal_id (integer) (Mandatory)

3. otp (integer) (Mandatory) – Get otp from the customer

4. ref_no (string) (Mandatory)

Response :

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Withdrawal process completed, please provide cash to customer."

}

14. Create Sub Agent (Post Method)

Description: This API is used for the creation of sub-agent.

URL : {base_url}/Merchant_api/create_sub_agent

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. fullname (string) (Mandatory)

3. email (string) (Mandatory) – Unique email id

4. username (string) (Mandatory) – Unique username

5. mobile (integer) (Mandatory) – Unique mobile number

6. password (string) (Mandatory) – (6-12 chars)

7. confirm_password (string) (Mandatory) – (6-12 chars)

8. access_pin (integer) (Mandatory)– (4 digits only)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Sub Agent added successfully. ",

"details": {

"fullname": "Xyz",

"email": "xyz@example.com",

"username": "username",

"mobile": "0123456789",

"status": "Active",

"profile":image.png",

"agent_id":AID1000000"

}

15. Sub Agent Listing (Post Method)

Description: This API is to be used for the listing of Sub agent with details and it can also filter the records by the given parameters.

URL : {base_url}/Merchant_api/sub_agent_list

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. page (integer) (Mandatory) (It is a page no.)

3. limit (integer) (Optional) (Page limit 10 default records displayed)

4. fullname (string) (Optional)

5. email (string) (Optional)

6. username (string) (Optional)

7. mobile (integer) (Optional)

8. status (string) (Optional) – (Active/Inactive)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Data Found",

"details": [

{

"id": "1",

"email": "xyz@example.com",

"mobile": "0123456789",

"username": "username",

"fullname": "Xyz Name",

"profile_pic": "profile.png",

"status": "Active"

}

]

}

16. Change Sub Agent Status (Post Method)

Description: This API will be used for the listing of Sub agent with details

URL : {base_url}/Merchant_api/change_sub_agent_status

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2. sub_agent_id (string) (Mandatory)

3. status (string) (Mandatory) – (Active/Inactive)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Sub agent status Active successfully."

}

17. Edit Sub Agent (Post Method)

Description: This API is used for the updation of sub-agent.

URL : {base_url}/Merchant_api/edit_sub_agent

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.subagent_id (string) (Mandatory)

3. fullname (string) (Mandatory)

4. email (string) (Mandatory) – Unique email id

5. mobile (integer) (Mandatory) – Unique mobile number

6. password (string) (Optional) – (6-12 chars)

7. confirm_password (string) (Optional) – (6-12 chars)

8. access_pin (integer) (Optional)– (4 digits only)

9.commission (float) (Optional)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Sub agent updated successfully. ",

"details": {

"subagent_id": "SAID1000016",

"fullname": "Rashique Khan",

"email": "rkhan@hitaishin.com",

"username": "rashiquekhan",

"mobile": "8871071112",

"profile": "",

"commission": "1.50",

"qr_code": "https://xyz/qr_code.png",

"agent_id": "AID1000022"

}

18. Refill Wallet (Post Method)

Description: This API is used for the updation of sub-agent.

URL : {base_url}/Merchant_api/refill_wallet

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.customer_id (string) (Mandatory)

3. refill_code (string) (Mandatory)

4. subagent_id (string) (Optional)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "TopUp Code 71866228G06PV, added $ 100.00 in XYZ User wallet."

}

19. Refill History (Post Method)

Description: This API is used for the updation of sub-agent.

URL : {base_url}/Merchant_api/refill_history

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.customer_id (string) (Mandatory)

3.page (integer) (Mandatory)

4.limit (integer) (Optional) (Limit of 10 per page by default)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Refill history.",

"list": [

{

"refill_code": "LU16037B62214",

"amount": "1000.00",

"currency": "$",

"customer_id": "CID1001070",

"customer_name": "Neeraj Sub user"

}

]

}

20. Country List (Post Method)

Description: This API is used for get country list and get id for country and this use in add customer api.

URL : {base_url}/Merchant_api/countries

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Country list",

"list": [

{

"country_id": "1",

"country_name": "Algeria",

"country_code": "+213",

"currency_codes": [

{

"currency": "د.ج",

"currency_code": "DZD"

}

]

}

]

}

21. Add Customer (Post Method)

Description: This API is used for add non smart customer.

URL : {base_url}/Merchant_api/add_customer

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.first_name (string) (Mandatory) Max Length 30 Chars.

3.last_name (string) (Mandatory) Max Length 30 Chars.

4.username (string) (Mandatory) Between 6-30 Chars.

5.country_id (integer) (Mandatory) Get from country_list

6.country_code (string) (Mandatory) Get from country_list

7.email (string) (Mandatory)

8.mobile (integer) (Mandatory)

9.gender (string) (Mandatory) Male/Female

10.dob (string) (Mandatory) YYYY-MM-DD

11.access_pin (integer) (Mandatory) – 4 Digits Only

12. profile_pic (file) (Optional)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Congratulations! Activate your account using OTP codes you received. It could take up to 5mins before you get a code. Exercise some patience…",

"details": {

"customer_id": "CID1000001",

"email": "xyz@example.com",

"country_code": "+231",

"mobile": "1234567890",

"first_name": "First",

"last_name": "Last",

"username": "xyz123",

"country_id": "56",

"profile_pic": "",

"gender": "Male",

"dob": "1994-01-01",

"wallet_balance": "0.00",

"qr_code": "https://xyz/qr_code.png",

"country_name": "Liberia"

}

22. Account Verification (Post Method)

Description: This API is used for verify account by verification code.

URL : {base_url}/Merchant_api/account_verification

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.customer_id (string) (Mandatory) Get from add customer

3.mobile (integer) (Mandatory)

4.verification_code (integer) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Mobile verification completed successfully.",

"details": {

"customer_id": "CID1000001",

"email": "xyz@example.com",

"country_code": "+231",

"mobile": "1234567890",

"first_name": "First",

"last_name": "Last",

"username": "xyz123",

"country_id": "56",

"profile_pic": "",

"gender": "Male",

"dob": "1994-01-01",

"wallet_balance": "0.00",

"qr_code": "https://xyz/qr_code.png",

"country_name": "Liberia"

}

23. Resend Verification Code (Post Method)

Description: This API is used for resend verification code.

URL : {base_url}/Merchant_api/resend_verification_code

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.customer_id (string) (Mandatory) Get from add customer

3.mobile (integer) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Mobile verification OTP resent to your registered mobile number XXXXXX7811"

}

24. Deposit Estimate Payment (Post Method)

Description: This API is used for estimate of deposit payment .

URL : {base_url}/Merchant_api/deposit_estimate_payment

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.receiver_id (string) (Mandatory) (Customer/Business Id)

3.amount (float) (Mandatory)

4.currency_code (integer) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "You are about to transfer L$ 200.00 to XYZ.",

"details": {

"deposit_fee": "L$ 8.16",

"agent_commission": "L$ 3.26",

"conversion_charge": "L$ 0.00",

"sender_paid": "L$ 208.16",

"receiver_get": "L$ 200.00",

"amount": "L$ 200"

}

25. Verify Access Pin for Deposit Payment (Post Method)

Description: This API is used for verify access pin for deposit payment .

URL : {base_url}/Merchant_api/deposit_verify_access_pin

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.receiver_id (string) (Mandatory) (Customer/Business Id)

3.amount (float) (Mandatory)

4.currency_code (string) (Mandatory)

5.access_pin (integer) (Mandatory)

6.description (string) (Optional) Max Length 150 Chars.

7.subagent_id (string) (Optional) If deposit through Sub agent then access pin should be sub agent access pin

8.ref_no (string) (Optional)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Payment done successfully.",

"transaction_id": "TR16093108898859"

}

26. Deposit History (Post Method)

Description: This API is used for get deposit payment history.

URL : {base_url}/Merchant_api/deposit_history

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.page (integer) (Mandatory)

3.limit (integer) (Optional) (Limit of 10 per page by default)

4.subagent_id (string) (Optional) for filter by sub agent

5. Keyword (string) (Optional) – In keyword parameter you can filter by customer id or transaction id

6.ref_no (string) (Optional)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Deposit History",

"List": [

{

"sender_id": "CID100001",

"receiver_id": "CID1000002",

"sender_country": "56",

"receiver_country": "56",

"description": "Description",

"charges_by": "Receiver",

"agent_currency": "$",

"agent_currency_code": "USD",

"agent_commission": "2.00",

"transaction_id": "TR16092324809967",

"ref_no": "1234567890",

"created": "2020-12-29 09:01:20",

"type": "receiver",

"currency": "$",

"total_amount": "100.00",

"admin_comission": 4,

"conversion_comission": "0.000000",

"total_paid": "96.00",

"full_name": "User",

"profile_pic": "img.jpg"

]

}

27. Estimate Transaction Charge (Post Method)

Description: This API is used for estimate of transaction charge.

URL : {base_url}/Merchant_api/estimate_transaction

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.sender_id (string) (Mandatory) (Customer/Business Id)

3.receiver_id (string) (Mandatory) (Customer/Business Id)

4.amount (float) (Mandatory)

5.currency_code (integer) (Mandatory)

6.charges_by (string) (Mandatory) (Sender/Receiver)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "You are about to transfer $ 100.00 to ABC on behalf of XYZ User.",

"details": {

"admin_commission": "$ 2.000000",

"conversion_charge": "0.00",

"sender_currency": "$",

"sender_paid": "96.00",

"agent_commission": "$ 2.00",

"charges_by": "Receiver",

"total_paid": "$ 96.00"

}

28. Verify Access for Transaction (Post Method)

Description: This API is used for verify access pin for transaction.

URL : {base_url}/Merchant_api/verify_transaction

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.sender_id (string) (Mandatory) (Customer/Business Id)

3.access_pin (integer) (Mandatory)

4.amount (float) (Mandatory)

5.currency_code (integer) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Access pin verified successfully."

}

29. Resend Transaction OTP (Post Method)

Description: This API is used for resend transaction OTP.

URL : {base_url}/Merchant_api/resend_transaction_otp

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.sender_id (string) (Mandatory) (Customer/Business Id)

3.amount (float) (Mandatory)

4.currency_code (integer) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "OTP resent to your registered mobile number XXXXXX0000"

}

30. Confirm Transaction OTP (Post Method)

Description: This API is used for confirm transaction OTP.

URL : {base_url}/Merchant_api/confirm_transaction

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.sender_id (string) (Mandatory) (Customer/Business Id)

3.receiver_id (string) (Mandatory) (Customer/Business Id)

4.otp (integer) (Mandatory)

5.amount (float) (Mandatory)

6.currency_code (integer) (Mandatory)

7.charges_by (string) (Mandatory) (Sender/Receiver)

8.description (string) (Optional) Max Length 150 Chars.

9.subagent_id (string) (Optional) for transaction through sub agent

10.ref_no (string) (Optional)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Payment done successfully",

"transaction_id": "TR16000000000000"

}

31. Transaction History (Post Method)

Description: This API is used for transaction history.

URL : {base_url}/Merchant_api/transaction_history

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.page (integer) (Mandatory)

3.limit (integer) (Optional) (Limit of 10 per page by default)

4.subagent_id (string) (Optional) for filter by sub agent

5.ref_no (string) (Optional)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Transactions",

"List": [

{

"sender_id": "AID1000001",

"receiver_id": "BID1000002",

"sender_country": "56",

"sender_currency": "L$",

"sender_currency_code": "LRD",

"sender_total_amount": "200.00",

"sender_admin_comission": "8.156252",

"admin_commission_usd": "0.050000",

"sender_conversion_comission": "0.000000",

"conversion_comission_usd": "0.000000",

"sender_total_paid": "208.16",

"receiver_country": "56",

"receiver_currency": "L$",

"receiver_currency_code": "LRD",

"receiver_total_amount": "200.00",

"receiver_admin_comission": "0.000000",

"receiver_conversion_comission": "0.000000",

"receiver_total_paid": "200.00",

"description": "Test Payment",

"charges_by": "",

"agent_currency": "L$",

"agent_currency_code": "LRD",

"agent_commission": "3.26",

"transaction_id": "TR16000000000000",

"ref_no": "1234567890",

"status": "Success",

"created": "2020-12-30 06:48:09"

}

]

}

32. Support Enquiry List (Post Method)

Description: This API is used for get enquiry list for super agent.

URL : {base_url}/Merchant_api/enquiry_list

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.page (integer) (Mandatory)

3.limit (integer) (Optional) (Limit of 10 per page by default)

4.status (string) (Optional) (Pending/Replied)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Support Enquiries",

"List": [

{

"contact_id": "1",

"name": "Test Name",

"email": "test123@example.com",

"contact_no": "1234567890",

"subject": "Test",

"message": "Test message",

"status": "Pending",

"created": "2020-03-02 11:26:29"

}

]

}

33. Support Enquiry Detail (Post Method)

Description: This API is used for get support enquiry detail.

URL : {base_url}/Merchant_api/enquiry_detail

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.contact_id (integer) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Enquiry Detail",

"Detail": [

{

"contact_id": "2",

"name": "Admin",

"subject": "TipMe Global - sdfsdf",

"message": "ttest",

"created": "2020-05-07 19:03:20"

]

}

34. Support Enquiry Reply (Post Method)

Description: This API is used for reply on support enquiry.

URL : {base_url}/Merchant_api/enquiry_reply

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.contact_id (integer) (Mandatory)

3.reply (string) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Message sent successfully"

}

35. Check Transaction Status (Post Method)

Description: This API is used for check transaction status/detail using ref_no.

URL : {base_url}/Merchant_api/check_transaction_status

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.ref_no (string) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Transaction detail",

"details":

{

"sender_id": "AID1000001",

"receiver_id": "BID1000002",

"sender_country": "56",

"sender_currency": "L$",

"sender_currency_code": "LRD",

"sender_total_amount": "200.00",

"sender_admin_comission": "8.156252",

"admin_commission_usd": "0.050000",

"sender_conversion_comission": "0.000000",

"conversion_comission_usd": "0.000000",

"sender_total_paid": "208.16",

"receiver_country": "56",

"receiver_currency": "L$",

"receiver_currency_code": "LRD",

"receiver_total_amount": "200.00",

"receiver_admin_comission": "0.000000",

"receiver_conversion_comission": "0.000000",

"receiver_total_paid": "200.00",

"description": "Test Payment",

"charges_by": "",

"agent_currency": "L$",

"agent_currency_code": "LRD",

"agent_commission": "3.26",

"transaction_id": "TR16000000000000",

"ref_no": "1234567890",

"status": "Success",

"created": "2020-12-30 06:48:09"

}

36. Check Commission Wallet (Post Method)

Description: This API is used for fetching the agent commission balance details linked with this merchant id.

URL: {base_url}/Merchant_api/check_commission_balance

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Data Found.",

"commission wallet": [

{

"currency_code": "LRD",

"agent_commission_balance": "17.95",

"currency": "L$"

{

"currency_code": "USD",

"agent_commission_balance": "210.52",

"currency": "$"

}

]

}

37. Commission Wallet History (Post Method)

Description: This API is used for view agent commission wallet history when money is transferred from Agent Commission wallet to Main wallet.

URL : {base_url}/Merchant_api/commission_wallet_history

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.page (integer) (Mandatory)

3.limit (integer) (Optional) (Limit of 10 per page by default)

4.currency_code (string) (Optional) for filtering by currency code

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "History",

"list": [

{

"transaction_id": "TR0000000001",

"currency_code": "USD",

"total_amount": "$ 5.00",

"opening_balance": "$ 215.52",

"closing_balance": "$ 210.52",

"date": "15/12/2022 08:42 AM"

}

...

]

}

38. Agent Commission History (Post Method)

Description: This API is used for view agent commission history that get from various transactions like withdrawal,deposit etc.

URL : {base_url}/Merchant_api/commission_history

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.page (integer) (Mandatory)

3.limit (integer) (Optional) (Limit of 10 per page by default)

4.currency_code (string) (Optional) for filter by currency code

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "History",

"list": [

{

"transaction_id": "TR100000001",

"total_amount": "L$ 100.00",

"subagent": "",

"agent_commission": "L$ 5.00",

"type": "Deposit",

"transaction_date": "16/11/2022 01:44 PM",

"description": "Description : Deposit Commission"

}

...

]

}

39. Commission wallet to main wallet transfer (Post Method)

Description: This API is used for to transfer commission wallet balance to main wallet.

URL : {base_url}/Merchant_api/commission_to_wallet

Content-Type: application/x-www-form-urlencoded

Parameters:

1. merchant_id (string) (Mandatory)

2.amount (integer) (Mandatory)

3.currency_code (integer) (Mandatory)

4.access_pin (integer) (Mandatory)– (4 digits only)

Response:

Content-Type: application/json

HTTP Response Code:	Meaning
401	Unauthorized access
200	Success
500	internal server error
Status: 0	Fail
Status: 1	Success

Sample Response:

{

"status": "1",

"msg": "Commission added $ 5.00 in your wallet. Your current wallet bal. Is $ 105.00.",

"transaction_id": "TR100000002"

}

Sample Request for Php Curl Example:

$curl = curl_init();

curl_setopt_array($curl, array(

CURLOPT_URL => {base_url}/Merchant_api/get_profile",

CURLOPT_RETURNTRANSFER => true,

CURLOPT_TIMEOUT => 30,

CURLOPT_CUSTOMREQUEST => "POST",

CURLOPT_POSTFIELDS => "merchant_id=MAID1000001",

CURLOPT_HTTPHEADER => array(

"Content-Type: application/x-www-form-urlencoded",

"authorizekey:ae4cfec7ad73b0397b61c5c201a3e160",

"cache-control: no-cache"

));

$response = curl_exec($curl);

$err = curl_error($curl);

curl_close($curl);

if ($err) {

echo "cURL Error #:" . $err;

} else {

echo $response;

}