Fulfill Payout

Confirm fulfillment of a payout that requires manual confirmation.

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

Some payouts require manual fulfillment confirmation before they are processed. Call this endpoint to confirm that the payout should proceed.

When Fulfillment is Required

Fulfillment is typically required for payouts with confirm: falseor when additional verification is needed by the processor.

Path Parameters

Parameter	Type	Description
`payout_id`	string	Required. The ID of the payout to fulfill.

Request Example

curl -X POST https://api.uprails.com/payouts/po_1234567890abcdef/fulfill \
  -H "api-key: snd_YOUR_API_KEY"

Response

200OK

{
  "payout_id": "po_1234567890abcdef",
  "merchant_id": "mer_xyz789",
  "status": "pending",
  "amount": 10000,
  "currency": "USD",
  "created": "2024-01-15T10:00:00Z"
}

Manual Fulfillment Workflow

Create Payout

Create a payout with confirm: false to hold for review.

Review

Payout enters requires_fulfillment state for manual review.

Fulfill

Call the fulfill endpoint to confirm and process the payout.