Create Payout

Auto Payout must be enabled in your API key settings before using this endpoint.

Endpoint

POST https://melomoney.com/api/v1/payouts

Authentication

Use your API credentials in the request headers:

Header	Description	Required
`Client-Id`	Your API Client ID	Yes
`Client-Secret`	Your API Client Secret	Yes

Request Parameters

Parameter	Type	Description	Required
`payouts`	Array	Array of payout objects	Yes
`payouts[].amount`	Number	Payout amount (must be greater than 0)	Yes
`payouts[].currency`	String	Currency code (e.g., USD, EUR)	Yes
`payouts[].recipient`	String	Recipient identifier (email, phone, or custom ID)	Yes
`payouts[].reference_id`	String	Unique reference ID for the payout	Yes
`payouts[].description`	String	Payout description (max 255 characters)	No
`webhook_url`	String	Override default webhook URL for this request	No
`batch_reference`	String	Batch reference for multiple payouts	No

Example Request

{
  "payouts": [
    {
      "amount": 100.50,
      "currency": "USD",
      "recipient": "user@example.com",
      "reference_id": "PAYOUT_001",
      "description": "Salary payment"
    },
    {
      "amount": 200.75,
      "currency": "USD", 
      "recipient": "+1234567890",
      "reference_id": "PAYOUT_002",
      "description": "Bonus payment"
    }
  ],
  "webhook_url": "https://your-app.com/webhook/payouts",
  "batch_reference": "BATCH_2023_12_001"
}

Example Response

{
  "success": true,
  "message": [
    "Payouts processed successfully"
  ],
  "data": {
    "success_count": 2,
    "failed_count": 0,
    "batch_reference": "BATCH_2023_12_001",
    "results": [
      {
        "reference_id": "PAYOUT_001",
        "status": "success",
        "transaction_id": "TXN_001",
        "amount": 100.50,
        "currency": "USD",
        "charges": 1.50
      },
      {
        "reference_id": "PAYOUT_002", 
        "status": "success",
        "transaction_id": "TXN_002",
        "amount": 200.75,
        "currency": "USD",
        "charges": 3.00
      }
    ]
  }
}

IP Whitelisting

For security, configure allowed IP addresses in your API key settings:

Use comma-separated IP addresses
Set to 0.0.0.0 to allow all IPs (not recommended for production)
IP validation occurs on every API request

Security Notice: Always restrict API access to specific IP addresses in production environments.