Skip to main content
GET
/
v1
/
platform
/
payees
/
{payee_id}
Get One Payee
curl --request GET \
  --url https://api-sandbox.finogates.com/v1/platform/payees/{payee_id} \
  --header 'Authorization: Bearer <token>'
{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
payee_id
string<uuid>
required

Query Parameters

​
user_id
string<uuid>
required

The unique ID of the user who owns this payee.

​
includeDestinations
boolean
default:false

Set to true to also include the payee's payout destinations in the response.

​
includeMethods
boolean
default:false

Set to true to also include the payee's payout destinations in the response.

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

​
status_code
integer
required

HTTP status code for the response.

​
data
any
required

Payload or error details.

​
query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.