Skip to main content
PUT
/
payouts
/
{id}
Update payout status
curl --request PUT \
  --url https://api.affonso.io/v1/payouts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "pending",
  "paymentMethod": "<string>",
  "paymentReference": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "affiliate_id": "<string>",
    "affiliate_name": "<string>",
    "affiliate_email": "<string>",
    "amount": 123,
    "currency": "<string>",
    "status": "pending",
    "payment_method": "<string>",
    "payment_reference": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "processed_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Prefix with 'sk_live_' for production or 'sk_dev_' for development.

Path Parameters

id
string
required

Body

application/json
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
cancelled
paymentMethod
string
paymentReference
string

Response

Payout updated

success
boolean
data
object