Skip to main content
GET
/
exchange
/
bank-accounts
Listar Contas Bancárias
curl --request GET \
  --url https://gateway.3xpay.co/exchange/bank-accounts \
  --header 'api_key: <api-key>' \
  --header 'api_secret: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": 123,
      "userId": 123,
      "type": "<string>",
      "name": "<string>",
      "pix_key": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "pageSize": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

​
Visão Geral

Retorna todas as contas bancárias cadastradas para o usuário. É necessário o header X-API-Key.

​
Parâmetros

​
headers
object
​
X-API-Key
string
required
Chave de API para autenticação
​
Content-Type
string
application/json
​
query
object
​
page
string
Número da página (default: “1”)
​
pageSize
string
Itens por página (default: “10”)
​
name
string
Filtro parcial por nome (case-insensitive)
​
pix_key
string
Filtro parcial por chave PIX (case-insensitive)
​
type
string
Filtro exato por tipo de conta (ex: “pix”)

​
Resposta

​
success
boolean
Indica se a operação foi bem-sucedida
​
message
string
Mensagem descritiva
​
data
array
Lista de contas bancárias
​
pagination
object
​
total
number
Total de registros
​
page
number
Página atual
​
pageSize
number
Itens por página
​
totalPages
number
Total de páginas
​
hasNextPage
boolean
Indica se há próxima página
​
hasPreviousPage
boolean
Indica se há página anterior

​
Exemplos

cURL

​
Exemplos de uso

  • Sem filtros (página 1, 10 itens):
    GET /exchange/bank-accounts?page=1&pageSize=10
  • Com filtro por nome e tipo (exemplo solicitado):
    GET /exchange/bank-accounts?page=2&pageSize=20&name=Conta&type=pix
  • Filtro por pix_key:
    GET /exchange/bank-accounts?pix_key=12345678900
cURL (com paginação) 
curl --request GET \
  --url "https://api.seudominio.com/exchange/bank-accounts?page=1&pageSize=10" \
  --header 'X-API-Key: sua-api-key-aqui'
Resposta (200 OK com paginação) 
{
  "success": true,
  "message": "Bank accounts retrieved successfully",
  "data": [
    {
      "id": 1,
      "userId": 123,
      "type": "pix",
      "name": "Conta Principal PIX",
      "pix_key": "12345678900",
      "created_at": "2025-12-23T10:00:00.000Z",
      "updated_at": "2025-12-23T10:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 25,
    "page": 1,
    "pageSize": 10,
    "totalPages": 3,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Authorizations

​
api_key
string
header
required
​
api_secret
string
header
required

Query Parameters

​
page
string
default:1

Número da página

​
pageSize
string
default:10

Itens por página

​
name
string

Filtro parcial por nome (case-insensitive)

​
pix_key
string

Filtro parcial por chave PIX (case-insensitive)

​
type
string

Filtro exato por tipo de conta (ex: pix)

Response

200 - application/json

Contas bancárias listadas com sucesso

​
success
boolean

Indica se a operação foi bem-sucedida

​
message
string

Mensagem descritiva da operação

​
data
object[]

Lista de contas bancárias

​
pagination
object