IppoPay
  • Introduction
  • Client Side Integration
  • Javascript Integration
  • React JS
  • Angular JS
  • PHP Integration
  • Server Side Integrations
    • REST API
    • PHP Client
    • Node JS SDK
  • eCommerce Integrations
    • WooCommerce
    • Opencart
    • PrestaShop
    • Magento
  • Mobile SDK Integrations
  • Android SDK
  • iOS SDK
  • Flutter
  • UPI Intent (Self Hosted)
  • Payouts
    • Account
    • Beneficiary
    • Transfers
Powered by GitBook
On this page
  • Transfer Request
  • Transfer Details

Was this helpful?

  1. Payouts

Transfers

Transfer Request

POST https://public_key:secret_key@api.ippopay.com/v1/payout/transfer/request

Use this api to initiate a transfer to your added beneficiary. You can get your keys from the payout api dashboard.

Request Body

Name
Type
Description

amount

number

10.00

trans_ref

string

Unique Transfer Reference id for the Transfer. Accepts only alpha numeric.

beneficiary_ref

string

Reference id of the created beneficiary.

remarks

string

Transaction remarks.

pay_mode

string

Payment modes to be used for this transaction, Defaults to NEFT. Available modes: "NEFT", "IMPS", "RTGS" IMPS: Transactions value up to INR 200000 RTGS: Transaction value above INR 200000

{
    "success": true,
    "message": "Payout Accepted",
    "data": {
        "transfer": {
            "commission": {
                "value": 4,
                "total": 4
            },
            "status": "accepted",
            "merchant_id": "TaodSgGa",
            "trans_id": "trans_VRm7frCeE",
            "trans_ref": "test24",
            "beneficiary": {
                "account": {
                    "number": "50100035304529",
                    "ifsc": "HDFC0000674"
                }
                "beneficiary_id": "bene_0sWxgFdY@",
                "beneficiary_ref": "jaikumarr"
            },
            "pay_mode": "IMPS",
            "amount": 1,
            "total_deduction": 5,
            "product_type": "payout",
            "trans_type": "DEBIT",
            "init_source": "api",
            "remarks": "Testing",
            "updatedAt": "2021-05-11T14:59:07.594Z",
            "createdAt": "2021-05-11T14:59:07.594Z"
            
        }
    }
}
 {
	"amount":10.00,
	"trans_ref":"xxxxx",
	"pay_mode":"NEFT",
	"remarks":"Testing",
	"beneficiary_ref":"xxxxx"
}

Transfer Details

GET https://public_key:secret_key@api.ippopay.com/v1/payout/transfer/detail?trans_ref=xxxx

Use this api to get the status of a transfer. You can get your keys from the payout api dashboard.

Query Parameters

Name
Type
Description

trans_ref

string

Unique transfer id used to initiate the transaction.

{
    "success": true,
    "message": "Payout Accepted",
    "data": {
        "transfer": {
            "commission": {
                "value": 4,
                "total": 4
            },
            "status": "accepted",
            "merchant_id": "TaodSgGa",
            "trans_id": "trans_VRm7frCeE",
            "trans_ref": "test24",
            "beneficiary": {
                "account": {
                    "number": "50100035304529",
                    "ifsc": "HDFC0000674"
                }
                "beneficiary_id": "bene_0sWxgFdY@",
                "beneficiary_ref": "jaikumarr"
            },
            "pay_mode": "IMPS",
            "amount": 1,
            "total_deduction": 5,
            "product_type": "payout",
            "trans_type": "DEBIT",
            "init_source": "api",
            "remarks": "Testing",
            "updatedAt": "2021-05-11T14:59:07.594Z",
            "createdAt": "2021-05-11T14:59:07.594Z"
            
        }
    }
}
PreviousBeneficiary

Last updated 3 years ago

Was this helpful?