List Segments

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/register/segments \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.wepayout.com.br/v2/register/segments"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.wepayout.com.br/v2/register/segments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.wepayout.com.br/v2/register/segments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.wepayout.com.br/v2/register/segments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v2/register/segments")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v2/register/segments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 1,
    "name": "Banking"
  },
  {
    "id": 2,
    "name": "Retail"
  }
]

{
  "message": "Segment not found"
}

{
  "message": "Error listing segments"
}

GET

segments

List Segments

curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/register/segments \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.wepayout.com.br/v2/register/segments"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.wepayout.com.br/v2/register/segments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.wepayout.com.br/v2/register/segments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.wepayout.com.br/v2/register/segments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.wepayout.com.br/v2/register/segments")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v2/register/segments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 1,
    "name": "Banking"
  },
  {
    "id": 2,
    "name": "Retail"
  }
]

{
  "message": "Segment not found"
}

{
  "message": "Error listing segments"
}

Segments are a small, closed set of values accepted by WE, so this endpoint returns all of them in a single response — there is no pagination.Provide the optional id query parameter to filter by a specific segment. The response is always an array, even when filtering by id (it returns an array containing a single item).

The name field is localized based on the authenticated user’s locale: when the locale is English (en), the English name is returned, falling back to the default name when no translation is available.

Query Parameters

integer

The ID of the segment to retrieve. When provided, the response contains only the matching segment (as a single-item array).

Response

array

List of segments

Show segment object

integer

Unique identifier of the segment.

name

string

Name of the segment, localized according to the authenticated user’s locale.

[
  {
    "id": 1,
    "name": "Banking"
  },
  {
    "id": 2,
    "name": "Retail"
  }
]

{
  "message": "Segment not found"
}

{
  "message": "Error listing segments"
}

Get Account Opening Request By ID Setup

Account

Banks

Payin

Payout

KYC

Markup

List Segments

Query Parameters

Response

​Query Parameters

​Response

Query Parameters

Response