List Merchant Pix Keys

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

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

fetch('https://api.sandbox.wepayout.com.br/v2/register/pix-keys', 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/pix-keys",
  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/pix-keys"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "summary": {
    "total_accounts": 3,
    "filtered": 3
  },
  "data": [
    {
      "merchant_id": 1020100,
      "is_main": true,
      "name": "Example Fictitious Corp",
      "document": "11111111000111",
      "pix_key": {
        "key": "a3f1c8e2-0000-4000-8000-000000000000",
        "type": "EVP",
        "status": "ACTIVE",
        "owner_name": "Example Fictitious Corp",
        "owner_document": "11111111000111",
        "ispb": "32708748",
        "bank_name": "WEpayments",
        "created_at": "2025-03-01T10:00:00-03:00"
      }
    },
    {
      "merchant_id": 1020101,
      "is_main": false,
      "name": "Fictitious Retail Ltda",
      "document": "22222222000122",
      "pix_key": {
        "key": "22222222000122",
        "type": "CNPJ",
        "status": "ACTIVE",
        "owner_name": "Fictitious Retail Ltda",
        "owner_document": "22222222000122",
        "ispb": "32708748",
        "bank_name": "WEpayments",
        "created_at": "2025-04-12T09:31:20-03:00"
      }
    },
    {
      "merchant_id": 1020102,
      "is_main": false,
      "name": "Fictitious Cross Border Ltda",
      "document": "33333333000133",
      "pix_key": {
        "key": "b7d4e5a1-1111-4111-8111-111111111111",
        "type": "EVP",
        "status": "ACTIVE",
        "owner_name": "WE PAY OUT INSTITUICAO DE PAGAMENTO LTDA",
        "owner_document": "32708748000130",
        "ispb": "32708748",
        "bank_name": "WEpayments",
        "created_at": "2025-06-20T14:05:00-03:00"
      }
    }
  ]
}

{
  "summary": {
    "total_accounts": 0,
    "filtered": 0
  },
  "data": []
}

{
  "error_code": "authentication",
  "error_description": "Unauthenticated."
}

{
  "message": "You are not allowed to access this merchant"
}

{
  "error_code": "validation",
  "error_description": "Validation error",
  "fields": {
    "we_id": [
      "The we id field is required."
    ]
  }
}

{
  "message": "Could not retrieve the Pix keys right now"
}

GET

pix-keys

List Merchant Pix Keys

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

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

fetch('https://api.sandbox.wepayout.com.br/v2/register/pix-keys', 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/pix-keys",
  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/pix-keys"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "summary": {
    "total_accounts": 3,
    "filtered": 3
  },
  "data": [
    {
      "merchant_id": 1020100,
      "is_main": true,
      "name": "Example Fictitious Corp",
      "document": "11111111000111",
      "pix_key": {
        "key": "a3f1c8e2-0000-4000-8000-000000000000",
        "type": "EVP",
        "status": "ACTIVE",
        "owner_name": "Example Fictitious Corp",
        "owner_document": "11111111000111",
        "ispb": "32708748",
        "bank_name": "WEpayments",
        "created_at": "2025-03-01T10:00:00-03:00"
      }
    },
    {
      "merchant_id": 1020101,
      "is_main": false,
      "name": "Fictitious Retail Ltda",
      "document": "22222222000122",
      "pix_key": {
        "key": "22222222000122",
        "type": "CNPJ",
        "status": "ACTIVE",
        "owner_name": "Fictitious Retail Ltda",
        "owner_document": "22222222000122",
        "ispb": "32708748",
        "bank_name": "WEpayments",
        "created_at": "2025-04-12T09:31:20-03:00"
      }
    },
    {
      "merchant_id": 1020102,
      "is_main": false,
      "name": "Fictitious Cross Border Ltda",
      "document": "33333333000133",
      "pix_key": {
        "key": "b7d4e5a1-1111-4111-8111-111111111111",
        "type": "EVP",
        "status": "ACTIVE",
        "owner_name": "WE PAY OUT INSTITUICAO DE PAGAMENTO LTDA",
        "owner_document": "32708748000130",
        "ispb": "32708748",
        "bank_name": "WEpayments",
        "created_at": "2025-06-20T14:05:00-03:00"
      }
    }
  ]
}

{
  "summary": {
    "total_accounts": 0,
    "filtered": 0
  },
  "data": []
}

{
  "error_code": "authentication",
  "error_description": "Unauthenticated."
}

{
  "message": "You are not allowed to access this merchant"
}

{
  "error_code": "validation",
  "error_description": "Validation error",
  "fields": {
    "we_id": [
      "The we id field is required."
    ]
  }
}

{
  "message": "Could not retrieve the Pix keys right now"
}

Returns one row per account — the merchant identified by we_id plus every submerchant registered under it — together with the Pix key held by that account. There is no pagination: the response always covers the whole hierarchy, and the filters narrow down the rows that are returned.Accounts with no Pix key are not listed. A merchant with no eligible account still answers 200 with an empty data array and zeroed counters — never 404.

Query Parameters

integer

required

WE ID of the merchant whose hierarchy is listed. The response covers this merchant and its submerchants.Must be within the scope of the authenticated credentials, otherwise the request is rejected with 403.Example: 1020100

string

Narrows the result down to the accounts whose WE ID starts with the supplied value, so the search box of a panel filters the list while the ID is being typed.Digits only, up to 20 characters. 10201 matches 1020101; 0101 does not.Example: 1020101

string

Narrows the result down to the accounts whose company name contains the supplied value. Case and accent insensitive: jose matches JOSÉ.Up to 150 characters.Example: retail

string

Narrows the result down to the accounts whose company document contains the supplied digits. Both sides are compared digits only, so a mask is accepted: 34.881.207/0001-46, 34881207000146 and 34881 all match the same account.Up to 20 characters. A value with no digit at all is treated as no filter, instead of matching everything.Example: 34.881

string

default:"active"

Status of the Pix key. Applied by default even when omitted, so a request with no status returns the active keys.Allowed values: activeThis is currently the only accepted value — any other value is rejected with 422. Consequently, pix_key.status always comes back as ACTIVE.

Filters are combined with AND: an account is returned only when it satisfies every supplied filter.

Response

object

Counters of the listing, meant to feed a “X of Y accounts” label.

Show summary object

integer

Number of accounts in the hierarchy holding a Pix key, before the merchant_id, name and document filters. This is the denominator: an account with no key is neither listed nor counted.

integer

Number of accounts left after every filter. Always equal to the length of data.

array

Accounts and their Pix keys. The queried merchant always comes first, followed by the submerchants ordered by ascending WE ID.

Show account object

integer

WE ID of the account.

boolean

true on the merchant supplied as we_id, false on its submerchants. Lets the client render the main account apart without comparing IDs.

string

Legal name of the company that owns the account.

string

Document (CNPJ) of the company that owns the account, digits only.

object

The Pix key held by the account.

Show pix_key object

string

Value of the Pix key, as registered at the DICT.

string

Type of the key.Values: CPF, CNPJ, EVP, EMAIL, PHONE

string

Status of the key, reported in upper case.Values: ACTIVE

string

Name of the Pix key holder registered at the DICT.

string

Document of the Pix key holder registered at the DICT, digits only.

string

ISPB of the institution holding the key. Always 32708748 (WEpayments).

string

Name of the institution holding the key. Always WEpayments.

string | null

When the key was created. ISO 8601 with offset. null when the date is unknown.

{
  "summary": {
    "total_accounts": 3,
    "filtered": 3
  },
  "data": [
    {
      "merchant_id": 1020100,
      "is_main": true,
      "name": "Example Fictitious Corp",
      "document": "11111111000111",
      "pix_key": {
        "key": "a3f1c8e2-0000-4000-8000-000000000000",
        "type": "EVP",
        "status": "ACTIVE",
        "owner_name": "Example Fictitious Corp",
        "owner_document": "11111111000111",
        "ispb": "32708748",
        "bank_name": "WEpayments",
        "created_at": "2025-03-01T10:00:00-03:00"
      }
    },
    {
      "merchant_id": 1020101,
      "is_main": false,
      "name": "Fictitious Retail Ltda",
      "document": "22222222000122",
      "pix_key": {
        "key": "22222222000122",
        "type": "CNPJ",
        "status": "ACTIVE",
        "owner_name": "Fictitious Retail Ltda",
        "owner_document": "22222222000122",
        "ispb": "32708748",
        "bank_name": "WEpayments",
        "created_at": "2025-04-12T09:31:20-03:00"
      }
    },
    {
      "merchant_id": 1020102,
      "is_main": false,
      "name": "Fictitious Cross Border Ltda",
      "document": "33333333000133",
      "pix_key": {
        "key": "b7d4e5a1-1111-4111-8111-111111111111",
        "type": "EVP",
        "status": "ACTIVE",
        "owner_name": "WE PAY OUT INSTITUICAO DE PAGAMENTO LTDA",
        "owner_document": "32708748000130",
        "ispb": "32708748",
        "bank_name": "WEpayments",
        "created_at": "2025-06-20T14:05:00-03:00"
      }
    }
  ]
}

{
  "summary": {
    "total_accounts": 0,
    "filtered": 0
  },
  "data": []
}

{
  "error_code": "authentication",
  "error_description": "Unauthenticated."
}

{
  "message": "You are not allowed to access this merchant"
}

{
  "error_code": "validation",
  "error_description": "Validation error",
  "fields": {
    "we_id": [
      "The we id field is required."
    ]
  }
}

{
  "message": "Could not retrieve the Pix keys right now"
}

Errors

Status	When
`401`	Missing or invalid credentials.
`403`	`we_id` is outside the scope of the authenticated credentials. The message is deliberately generic and never discloses whether the merchant exists.
`422`	`we_id` is missing or not a positive integer, or a filter does not match its expected format.
`502`	The Pix keys could not be retrieved from the upstream service. Retry — this never means the merchant has no keys.
`400`	Unexpected error while listing the keys.

Because the response depends on the scope of the caller, it is never cached at the gateway. Two different credentials asking for the same we_id may legitimately receive different results.

Example request

cURL

curl -X GET "https://api.sandbox.wepayout.com.br/v2/register/pix-keys?we_id=1020100&merchant_id=10201" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

List Account Opening Requests

Find the WE IDs of the accounts in your hierarchy

Account

Banks

Payin

Payout

KYC

Markup

List Merchant Pix Keys

Query Parameters

Response

Errors

Example request

List Account Opening Requests

Create Company

​Query Parameters

​Response

​Errors

​Example request

​Related Resources

List Account Opening Requests

Create Company

Query Parameters

Response

Errors

Example request

Related Resources