Create a payout

POST/api/v6/external/payout

Authorization

apikey

apikey<token>

Your merchant API key, provided by your admin.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

account*string

Beneficiary Account

Length1 <= length

amount*number

Float data type. Decimals are ignored: 100.99 is paid out as 100. Accepted as a number or a numeric string, e.g. 500 or "500".

currency*string

Alphabetic currency code, e.g. INR

Length3 <= length <= 3

callbackUrl*string

Url where payment callback will be sent

Formaturi

country*string

ISO 3166-1-alpha-2

Length2 <= length <= 2

email*string

Customer’s email

Length6 <= length <= 120

data*

For additional parameters for payout

hash?string

Payout payload signature. Contact your account manager to enable this parameter. When enabled, a payout without it is rejected. Required if enabled.

Length64 <= length <= 64

method*string

Methods supported.

orderId*string

Merchant Order ID

Length1 <= length <= 50

ip*string

Customer’s IP

Response Body

`application/json`

curl -X POST "https://example.com/api/v6/external/payout" \  -H "apikey: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "account": "abc123",    "amount": 50000,    "currency": "PKR",    "callbackUrl": "https://example.com/callback",    "country": "PK",    "email": "name@email.com",    "data": {},    "method": "BANK_TRANSFER",    "orderId": "abc123456",    "ip": "192.0.2.1"  }'

{  "id": "string",  "message": "string",  "status": "string",  "orderId": "string"}

Create a payout

Authorization

Request Body

Response Body

200application/json

`application/json`