API ReferencePayouts API

Get payout by ID

View as Markdown
Retrieves detailed information about a specific payout by its unique identifier. This endpoint returns the complete payout object including current status and payout-metadata. **Path Parameters** | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payout_id` | UUID | Yes | Unique identifier of the payout to retrieve | **Success Responses** | Status Code | Description | |-------------|-------------| | 200 | OK - The payout was successfully retrieved | **Error Responses** | Status Code | Error Code | Description | |-------------|------------|-------------| | 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or missing | | 403 | AUTHORIZATION_ERROR | You do not have permission to perform this action | | 404 | NOT_FOUND | The specified payout was not found |

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

payout_idstringRequiredformat: "uuid"

Response

Payout retrieved successfully
dataobject
warningstring or null

Errors

400
Bad Request Error
404
Not Found Error