Skip to main content
POST
/
payments
/
payout
Create Payout Transaction
curl --request POST \
  --url https://staging.payzio.org/payments/payout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "money": {
    "amount": 13000,
    "currency": "INR"
  },
  "merchant_order_no": "<string>",
  "receiver": {
    "name": "<string>",
    "account_no": "<string>",
    "ifsc_code": "<string>"
  },
  "callback_url": "<string>",
  "user_details": {
    "phone_number": "<string>",
    "user_name": "<string>",
    "email": "<string>"
  }
}
'
{
  "success": true,
  "payment_id": "<string>",
  "amount": 123,
  "currency": "<string>",
  "status": "<string>",
  "message": "<string>"
}
Ensure you save the payment_id for future use. This identifier is crucial for tracking and managing your transactions effectively.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request schema for creating a payout transaction.

money
PayoutMoneyRequest · object
required

Payment amount and currency

merchant_order_no
string
required

Unique order identifier

Required string length: 1 - 32
receiver
PayoutReceiverRequest · object
required

Receiver information

callback_url
string | null

HTTPS callback URL for payout notifications

Maximum string length: 512
user_details
UserDetails · object

User details (phone, name, email)

Response

Successful Response

Response schema for payout transaction creation.

success
boolean
required

Whether the transaction was created successfully

payment_id
string
required

Payment id generated by payzio

amount
number
required

Payout amount

currency
string
required

Currency code

status
string
required

Transaction status

message
string
required

Response message