Skip to navigation

Get payee by ID

View as Markdown

Retrieves a specific payee by their unique identifier.

Path Parameters

ParameterTypeRequiredDescription
payee_idUUIDYesUnique identifier of the payee to retrieve

Success Responses

Status CodeDescription
200OK - The payee 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
404PAYEE_NOT_FOUNDThe specified payee 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

payee_idstringRequiredformat: "uuid"

Response

Payee retrieved successfully
dataobject
warningstring or nullOptional