Skip to main content
GET
/
v1
/
platform
/
payees
List Payees
curl --request GET \
  --url https://api-sandbox.finogates.com/v1/platform/payees \
  --header 'Authorization: Bearer <token>'
{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123,
  "row_count": 1,
  "limit": 2,
  "current_page": 2,
  "total_page_number": 1,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
user_id
string<uuid>
required

The unique ID of the user who owns these payees.

​
status
string | null

Show only payees in this state.

​
limit
integer
default:50

How many payees to return per page (1 to 200).

Required range: 1 <= x <= 200
​
offset
integer
default:0

How many payees to skip before this page starts.

Required range: x >= 0

Response

Successful Response

Standard response wrapper for list responses.

Declare ListResponse[list[SomeModel]] to render the real data array schema in OpenAPI/Swagger; a bare ListResponse 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.

​
row_count
integer
required

Total rows matching the request filters (not just this page).

Required range: x >= 0
​
limit
integer | null

Page size used for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
​
current_page
integer | null

1-indexed page number for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
​
total_page_number
integer | null

Total number of pages given the current limit. Null for cursor-paginated endpoints.

Required range: x >= 0
​
next_cursor
string | null

Cursor for the next page, if available.