Uprails
DocumentationAPI ReferenceSettings
Payouts/Update

Update Payout

Update metadata on an existing payout.

POSThttps://api.uprails.com/payouts/:payout_id

Updates the specified payout by setting the values of the parameters passed. Currently, only metadata can be updated.

Limited Updates
You cannot update the amount, destination, or other core properties after a payout is created. To change these, cancel and create a new payout.

Path Parameters

ParameterTypeDescription
payout_idstringRequired. The ID of the payout.

Request Example

cURLbash
curl -X POST https://api.uprails.com/payouts/po_1234567890abcdef \
  -H "Content-Type: application/json" \
  -H "api-key: snd_YOUR_API_KEY" \
  -d '{
    "metadata": {
      "order_id": "12345",
      "note": "Vendor payment"
    }
  }'

Request Body

metadataobject

Set of key-value pairs for storing additional information

Response

200OK
{
  "payout_id": "po_1234567890abcdef",
  "merchant_id": "mer_xyz789",
  "status": "pending",
  "amount": 10000,
  "currency": "USD",
  "metadata": {
    "order_id": "12345",
    "note": "Vendor payment"
  },
  "created": "2024-01-15T10:00:00Z"
}