Skip to main content
POST
/
exchange
/
bank-accounts
Criar Conta Bancária
curl --request POST \
  --url https://gateway.3xpay.co/exchange/bank-accounts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --header 'api_secret: <api-key>' \
  --data '
{
  "name": "<string>",
  "pix_key": "<string>"
}
'
{
  "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

Cria uma conta bancária do tipo PIX vinculada ao seu usuário. É necessário enviar o header X-API-Key para autenticação.

​
Parâmetros

​
headers
object
​
X-API-Key
string
required
Chave de API para autenticação
​
Content-Type
string
application/json
​
body
object

​
Resposta

​
success
boolean
Indica se a operação foi bem-sucedida
​
message
string
Mensagem descritiva
​
data
object
​
id
number
ID interno da conta
​
userId
number
ID do usuário
​
type
string
Tipo da conta (ex: “pix”)
​
name
string
Nome da conta
​
pix_key
string
Chave PIX cadastrada
​
created_at
string
Data de criação
​
updated_at
string
Data da última atualização

​
Exemplos

cURL 
curl --request POST \
  --url https://api.seudominio.com/bank-accounts \
  --header 'X-API-Key: sua-api-key-aqui' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Minha Conta PIX",
    "pix_key": "12345678900"
  }'
Requisição (JSON) 
{
  "name": "Minha Conta PIX",
  "pix_key": "12345678900"
}
Resposta de Sucesso 
{
  "success": true,
  "message": "Bank account created successfully",
  "data": {
    "id": 1,
    "userId": 123,
    "type": "pix",
    "name": "Minha Conta PIX",
    "pix_key": "12345678900",
    "created_at": "2025-12-23T10:00:00.000Z",
    "updated_at": "2025-12-23T10:00:00.000Z"
  }
}

​
Exemplo de Erro Retornado

Chave PIX duplicada 
{
  "statusCode": 409,
  "message": "Já existe uma conta bancária com esta chave PIX"
}
Nome duplicado 
{
  "statusCode": 409,
  "message": "Já existe uma conta bancária com este nome"
}

Authorizations

​
api_key
string
header
required
​
api_secret
string
header
required

Body

application/json
​
name
string
required

Nome identificador da conta PIX

​
pix_key
string
required

Chave PIX

Response

201 - application/json

Conta bancária criada com sucesso

​
success
boolean

Indica se a operação foi bem-sucedida

​
message
string

Mensagem descritiva da operação

​
data
object