Skip to content

Create payout

POST api/v2/paygate/payout/ifsc/
 Create a payout by bank details

Request Body schema

application/json

Field Type Required Description Example
endpoint string Yes Api key "1dc4441f-38d5-42b5-a705-81958f928462"
amount integer Yes Amount in minor units 1000
currency integer Yes Number code 356
buyer object Yes Buyer at the endpoint in JSON format {"remote_id": "string", "ip": "string"}
account_number string Yes Beneficiary account number "12312312312"
ifsc string Yes IFSC / bank branch code "HDFC0001234"
email string Yes Beneficiary email "user@example.com"
phone string Yes Beneficiary phone number. Sent as mobile "911123456789"
name string No Beneficiary name. Falls back to description if empty "Savings Account"
description string No Payout description. Used as fallback for name "payout"

Request sample

{
    "endpoint": "1dc4441f-38d5-42b5-a705-81958f928462",
    "amount": 1000,
    "currency": 356,
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "account_number": "12312312312",
    "ifsc": "HDFC0001234",
    "name": "Savings Account",
    "email": "user@example.com",
    "phone": "911123456789",
    "description": "payout"
}