Get payee by ID | Root API

Retrieves a specific payee by their unique identifier.

Path Parameters

Parameter	Type	Required	Description
`payee_id`	UUID	Yes	Unique identifier of the payee to retrieve

Success Responses

Status Code	Description
200	OK - The payee 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	PAYEE_NOT_FOUND	The specified payee was not found

Retrieves a specific payee by their unique identifier. **Path Parameters** | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `payee_id` | UUID | Yes | Unique identifier of the payee to retrieve | **Success Responses** | Status Code | Description | |-------------|-------------| | 200 | OK - The payee 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 | PAYEE_NOT_FOUND | The 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 null

1	{
2	"data": {
3	"created_at": "2024-03-20T12:00:00Z",
4	"updated_at": "2024-03-20T12:00:00Z",
5	"id": "123e4567-e89b-12d3-a456-426614174000",
6	"name": "John Doe",
7	"email": "john.doe@example.com",
8	"country_code": "US",
9	"country_sub_division": "NY",
10	"city": "New York",
11	"address_line": "123 Main Street, Apt 4B",
12	"postal_code": "10001"
13	}
14	}