Skip to main content
GET
/
v1
/
platform
/
international
/
branches
List Payout Branches
curl --request GET \
  --url https://api-sandbox.finogates.com/v1/platform/international/branches \
  --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.

Query Parameters

​
country
string | null

Optional. Filter to one destination country.

​
currency
string | null

Optional. Filter to one payout currency.

​
payer_id
integer | null

Optional. Filter to one payer.

​
delivery_type
integer | null

Optional. Filter to one delivery type.

​
max_results
integer
default:500

The most branches to return at once.

​
next_id
integer | null

Used to fetch the next page of branches; pass the value given by the previous 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.