Skip to navigation
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

ParameterTypeRequiredDescription
payout_idUUIDYesUnique identifier of the payout to retrieve

Success Responses

Status CodeDescription
200OK - The payout was successfully retrieved

Error Responses

Status CodeError CodeDescription
401AUTHENTICATION_ERRORAuthentication credentials are invalid or missing
403AUTHORIZATION_ERRORYou do not have permission to perform this action
404NOT_FOUNDThe 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 nullOptional

Errors

400
Bad Request Error
404
Not Found Error