• UPI Virtual Address validation

• UPI Send (Single virtual address)

• UPI Send Async (Single virtual address)

• UPI Transaction Status

• Check credit balance

• IMPS Add Beneficiary

• IMPS Verify Beneficiary

• IMPS Send (Single Bank Account)

• IMPS Send Async (Single Bank Account)

• IMPS Transaction Status

• Check credit balance

https://sdk.mypoolin.com/merchants_upi

https://sdk.mypoolin.com/merchants_imps

API Key will be shared by Mypoolin Admin

• Endpoint - /validate_vpa
• Request Type - POST
• Parameters -
  1. beneficiary_virtual_address (UPI Virtual Address of beneficiary to be validated)

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_upi/validate_vpa -d "beneficiary_virtual_address=8800149537@upi" -H "apikey:API_KEY"

• Endpoint - /request_upi_single
• Request Type - POST
• Parameters -
  1. beneficiary_virtual_address (UPI Virtual Address of beneficiary to be validated)
  2. beneficiary_amount (Amount to be credited to the beneficiary)
  3. comment (Message you want to send to user (only alphanumeric, max 15 characters)) - optional
  4. merchant_txn_id (Unique Merchant transaction id (only alphanumeric, max 30 characters)) - optional

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_upi/request_upi_single -d "beneficiary_virtual_address=wibmomerchant@yesbank" -d "beneficiary_amount=1" -d "comment=Wibmo" -d "merchant_txn_id=ABC123" -H "apikey:API_KEY"

Sample Response

Success (status code - 200)

{
    "message": "Transaction Successful",
    "mypoolin_commission": 3,
    "order_id": "UPII447I1541153265190IU",
    "other_commission": 0,
    "sent_amount": 1,
    "status": "success"
}

Failed (status code - 200)

{
    "message": "Virtual Address Not Valid",
    "mypoolin_commission": 0,
    "order_id": "UPII447I1541154557275IU",
    "other_commission": 0,
    "sent_amount": 1,
    "status": "failed"
}

Pending (status code - 200)

{
    "message": "Transaction Pending",
    "mypoolin_commission": 0,
    "order_id": "UPII1157I1542261163412IU",
    "other_commission": 0,
    "sent_amount": 1,
    "status": "pending"
}

• Endpoint - /request_upi_single_async
• Request Type - POST
• Parameters -
  1. beneficiary_virtual_address (UPI Virtual Address of beneficiary to be validated)
  2. beneficiary_amount (Amount to be credited to the beneficiary)
  3. comment (Message you want to send to user (only alphanumeric, max 15 characters)) - optional
  4. merchant_txn_id (Unique Merchant transaction id (only alphanumeric, max 30 characters)) - optional

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_upi/request_upi_single_async -d "beneficiary_virtual_address=wibmomerchant@yesbank" -d "beneficiary_amount=1" -d "comment=Wibmo" -d "merchant_txn_id=ABC123" -H "apikey:API_KEY"

• Endpoint - /check_transaction_status
• Request Type - POST
• Parameters -
  1. order_id (Order id obtained from /request_upi_single request)

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_upi/check_transaction_status -H 'apikey: API_KEY' -d order_id=None1510559700IU

Sample Response
Success (status code - 200)

{
    "response": {
        "mypoolin_commission": 3,
        "order_id": "UPII447I1541153265190IU",
        "transfer_amount": 1,
        "transfer_bank_ref_no": "830615315861",
        "transfer_txn_status": "COMPLETED",
        "transfer_type": "UPI"
    },
    "status": "success"
}

Failed (status code - 200)

{
    "response": {
        "mypoolin_commission": 0,
        "order_id": "UPII447I1541153752903IU",
        "transfer_amount": 1,
        "transfer_bank_ref_no": "",
        "transfer_txn_status": "Virtual Address Not Valid",
        "transfer_type": "UPI"
    },
    "status": "failed"
}

Pending (status code - 200)

{
    "response": {
        "mypoolin_commission": 0,
        "order_id": "UPII447I1541153752903IU",
        "transfer_amount": 1,
        "transfer_bank_ref_no": "",
        "transfer_txn_status": "Transaction in pending state",
        "transfer_type": "UPI"
    },
    "status": "pending"
}

Failed (status code - 400)

{
    "response": {
        "mypoolin_commission": 0,
        "order_id": "UPII447I1541153265190I",
        "transfer_amount": "",
        "transfer_bank_ref_no": "",
        "transfer_txn_status": "Order Id Not Found",
        "transfer_type": "UPI"
    },
    "status": "failed"
}

• Endpoint - /get_balance
• Request Type - GET

Sample Request

curl -X GET https://sdk.mypoolin.com/merchants_upi/get_balance -H 'apikey: API_KEY'

Add beneficiary before imps transfer to reduce transaction failure rate and response time of imps request APIs.

• Endpoint - /add_beneficiary
• Request Type - POST
• Parameters -
  1. account_number (Account number of the beneficiary)
  2. ifsc_code (IFSC Code of the bank branch associated with the account)
  3. merchant_username (Your merchant username)

Verify beneficiary before initiating transfer request.

• Endpoint - /verify_beneficiary
• Request Type - POST
• Parameters -
  1. account_number (Account number of the beneficiary)
  2. ifsc_code (IFSC Code of the bank branch associated with the account)
  3. merchant_username (Your merchant username)

• Endpoint - /request_imps_single
• Request Type - POST
• Parameters -
  1. beneficiary_account_number (Account number of the beneficiary)
  2. beneficiary_ifsc_code (IFSC Code of the bank branch associated with the account)
  3. beneficiary_amount (Amount to be credited to the beneficiary)
  4. comment (Message you want to send to user (only alphanumeric, max 15 characters)) - optional
  5. merchant_txn_id (Unique Merchant transaction id (only alphanumeric, max 30 characters)) - optional

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_imps/request_imps_single -H 'apikey: API_KEY' -F 'beneficiary_name=Wibmo Pay' -F 'beneficiary_account_number=001661100000033' -F 'beneficiary_ifsc_code=YESB0000016' -F 'beneficiary_amount=1' -F 'comment=Wibmo' -F 'merchant_txn_id=ABC123'

Sample Response

Success (status code - 200)

{
    "message": "Transaction Successful",
    "mypoolin_commission": 5,
    "other_commission": 0,
    "requestNo": "IMPSI447I1540982809312IU",
    "sent_amount": 1,
    "status": "success"
}

Failed (status code - 200)

{
    "message": "Account Details Not Matching",
    "mypoolin_commission": 0,
    "other_commission": 0,
    "requestNo": "IMPSI447I1540982781373IU",
    "sent_amount": 1,
    "status": "failed"
}

• Endpoint - /request_imps_single_async

• Request Type - POST

• Note - This call makes a non blocking call to the IMPS switch. The requester only gets the order ID back and is expected to hit transaction status for the status

• Parameters -

  1. beneficiary_account_number (Account number of the beneficiary)
  2. beneficiary_ifsc_code (IFSC Code of the bank branch associated with the account)
  3. beneficiary_amount (Amount to be credited to the beneficiary)
  4. comment (Message you want to send to user (only alphanumeric, max 15 characters))
  5. merchant_txn_id (Unique Merchant transaction id (only alphanumeric, max 30 characters)) - optional

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_imps/request_imps_single_async -H 'apikey: API_KEY' -F 'beneficiary_name=Wibmo Pay' -F 'beneficiary_account_number=001661100000033' -F 'beneficiary_ifsc_code=YESB0000016' -F 'beneficiary_amount=1' -F 'comment=Wibmo' -F 'merchant_txn_id=ABC123'

• Endpoint - /check_transaction_status
• Request Type - POST
• Parameters -
  1. order_id (Order id obtained from /request_imps_single request) OR
  2. merchant_txn_id (Your unique transaction id)

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_imps/check_transaction_status -H 'apikey: API_KEY' -F order_id=IMPSIMERI28I1510723520IU

Sample Response
Success (status code - 200)

{
    "response": {
        "mypoolin_commission": 5,
        "order_id": "IMPSI447I1540974899279IU",
        "transfer_amount": 1,
        "transfer_bank_ref_no": "830414452718",
        "transfer_txn_status": "COMPLETED",
        "transfer_type": "IMPS"
    },
    "status": "success"
}

Failed (status code - 200)

{
    "response": {
        "mypoolin_commission": 0,
        "order_id": "IMPSI447I1540979902502IU",
        "transfer_amount": 1,
        "transfer_bank_ref_no": "",
        "transfer_txn_status": "Account Details Not Matching",
        "transfer_type": "IMPS"
    },
    "status": "failed"
}

Pending (status code - 200)

{
   "response": {
       "mypoolin_commission": 0,
       "order_id": "IMPSI447I1548920283487IU",
       "transfer_amount": 1,
       "transfer_bank_ref_no": "",
       "transfer_txn_status": "Transaction in pending state",
       "transfer_type": "IMPS"
   },
   "status": "pending"
}

Failed (status code - 400)

{
    "response": {
        "mypoolin_commission": 0,
        "order_id": "IMPSI447I1541152208766I",
        "transfer_amount": "",
        "transfer_bank_ref_no": "",
        "transfer_txn_status": "Order Id Not Found",
        "transfer_type": "IMPS"
    },
    "status": "failed"
}

• Endpoint - /get_balance
• Request Type - POST
• Parameters -
  1. order_id (Order id obtained from /request_imps_single request)

Sample Request

curl -X GET https://sdk.mypoolin.com/merchants_imps/get_balance -H 'apikey: API_KEY'

For any queries, feel free to reach out to the developers on backend@wibmopay.com

Please refer to this link - https://documenter.getpostman.com/view/4111011/S17kyArh

Documentation Last Updated - 22nd April 2019

All possible error & status codes list added