Retrieve Payout

Retrieve the details of an existing payout.

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

Retrieves a payout by its ID. Returns the payout object with current status, attempts history, and all associated details.

Path Parameters

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

Request Example

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

Response

200OK

{
  "payout_id": "po_1234567890abcdef",
  "merchant_id": "mer_xyz789",
  "customer_id": "cus_abc123",
  "status": "success",
  "amount": 10000,
  "currency": "USD",
  "payout_type": "bank",
  "priority": "regular",
  "email": "recipient@example.com",
  "name": "John Doe",
  "phone": "+1234567890",
  "error_message": null,
  "error_code": null,
  "attempts": [
    {
      "attempt_id": "att_001",
      "status": "success",
      "created": "2024-01-15T10:00:00Z"
    }
  ],
  "billing": {
    "address": {
      "line1": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94102",
      "country": "US"
    }
  },
  "metadata": {},
  "created": "2024-01-15T10:00:00Z"
}