Skip to main content
GET
/
exchange
/
bank-accounts
/
{id}
Buscar Conta Bancária
curl --request GET \
  --url https://gateway.3xpay.co/exchange/bank-accounts/{id} \
  --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"
  }
}

​
Visão Geral

Retorna os dados de uma conta bancária PIX pelo ID. Requer header X-API-Key.

​
Parâmetros

​
headers
object
​
X-API-Key
string
required
Chave de API para autenticação
​
path.id
string
required
ID da conta bancária

​
Resposta

​
success
boolean
Indica se a operação foi bem-sucedida
​
message
string
Mensagem descritiva
​
data
object
Dados da conta bancária

​
Exemplos

cURL 
curl --request GET \
  --url https://api.seudominio.com/exchange/bank-accounts/1 \
  --header 'X-API-Key: sua-api-key-aqui'
Resposta (200 OK) 
{
  "success": true,
  "message": "Bank account 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"
  }
}

​
Erros Possíveis

  • 404 NOT_FOUND — Conta não encontrada
  • 400 BAD_REQUEST — Conta não pertence ao usuário

Authorizations

​
api_key
string
header
required
​
api_secret
string
header
required

Path Parameters

​
id
string
required

ID da conta bancária

Response

200 - application/json

Conta bancária encontrada com sucesso

​
success
boolean

Indica se a operação foi bem-sucedida

​
message
string

Mensagem descritiva da operação

​
data
object