Check Payout Status

Endpoint

GET https://melomoney.com/api/v1/payouts/{reference_id}

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

URL Parameters

Parameter	Description	Required
`reference_id`	The unique reference ID of the payout	Yes

Example Request

curl -X GET \
  "https://melomoney.com/pay/api/v1/payouts/PAYOUT_001" \
  -H "Client-Id: your_client_id" \
  -H "Client-Secret: your_client_secret"

Example Response

{
  "success": true,
  "message": [
    "Payout status retrieved successfully"
  ],
  "data": {
    "reference_id": "PAYOUT_001",
    "status": "success",
    "amount": 100.50,
    "currency": "USD",
    "created_at": "2023-12-01T10:30:00Z",
    "updated_at": "2023-12-01T10:30:05Z",
    "transaction_id": "TXN_001",
    "recipient": "user@example.com",
    "description": "Salary payment"
  }
}

Status Codes

Status	Description
success	Payout completed successfully
pending	Payout is being processed
failed	Payout failed
canceled	Payout was canceled

Error Responses

// Payout not found
{
  "success": false,
  "message": [
    "Payout not found"
  ],
  "data": []
}

// Invalid credentials
{
  "success": false, 
  "message": [
    "Invalid API credentials"
  ],
  "data": []
}