Sign in

Get details of a single payout by payoutId

get/balance/payouts/{payoutId}

Path parameters

payoutIdstring required

Unique identifier of the payout

Response

Successful response with payout details

payoutIdstring required

Unique identifier of the payout

payoutStatementUrlstring required

A special link you can use to download the payout statement file as a CSV. This link is valid for 10 minutes.

amountinteger required

Amount in cents (USD)

status'INITIATED' | 'SUCCESS' | 'FAILED' required

Current status of the payout

createdAtinteger required

Epoch timestamp in milliseconds of when the payout was created

Example response

{
  "payoutId": "po_g8jKF4kdSdxlYcX2",
  "amount": 30000,
  "status": "SUCCESS",
  "createdAt": 1727340330123
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.