mypoolin-server

For UPI / IMPS / NEFT money distribution / settlement to anyone via APIs


Keywords
beneficiary, ifsc, imps-transaction-status, upi, upi-transaction-status
License
CC-BY-NC-SA-2.5
Install
pip install mypoolin-server==0.4dev

Documentation

wibmopay-server

UPI Related calls

IMPS Related Calls

General Information

Base URL for UPI calls:

https://sdk.mypoolin.com/merchants_upi

Base URL for IMPS calls:

https://sdk.mypoolin.com/merchants_imps

API Key will be shared by Mypoolin Admin

UPI Related calls

UPI Virtual Address validation

  • 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"

UPI Send (Single virtual address)

  • 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)

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_upi/request_upi_single -d "beneficiary_virtual_address=8800149537@upi" -d “beneficiary_amount=1” -H "apikey:API_KEY"

UPI Send Async (Single virtual address)

  • 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)

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_upi/request_upi_single_async -d "beneficiary_virtual_address=8800149537@upi" -d “beneficiary_amount=1” -H "apikey:API_KEY"

UPI Transaction Status

  • 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

Check credit balance

  • Endpoint - /get_balance
  • Request Type - GET

Sample Request

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

IMPS Related calls

IMPS Send (Single Bank Account)

  • 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)

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_imps/request_imps_single -H 'apikey: API_KEY' -F 'beneficiary_name=Shobhit Verma' -F 'beneficiary_account_number=8411566856' -F 'beneficiary_ifsc_code=KKBK0005029' -F 'beneficiary_amount=1'

IMPS Send Async (Single Bank Account)

  • 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)

Sample Request

curl -X POST https://sdk.mypoolin.com/merchants_imps/request_imps_single -H 'apikey: API_KEY' -F 'beneficiary_name=Shobhit Verma' -F 'beneficiary_account_number=8411566856' -F 'beneficiary_ifsc_code=KKBK0005029' -F 'beneficiary_amount=1'

IMPS Transaction Status

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

Sample Request

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

Check credit balance

  • 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