Skip to main content
POST
/
transactions
Criar Transação
curl --request POST \
  --url https://app.pixzypay.com/api/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 1000,
  "client_name": "João Silva",
  "client_email": "joao@email.com",
  "client_doc": "123.456.789-00",
  "client_phone": "(11) 99999-9999",
  "webhook_url": "https://api.loja.com/pix",
  "metadata": {
    "pedido_id": "ABC-123"
  }
}
'
{
  "status": "success",
  "data": {
    "transaction_id": "019c7547-0433-7363-b8d8-704680370307",
    "br_code": "00020126580014BR.GOV.BCB.PIX...",
    "amount": 1000,
    "status": "pending",
    "metadata": {
      "pedido_id": "ABC-123"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer Token gerado em Configurações > Tokens de API.

Body

application/json
amount
integer
required

Valor em centavos (mínimo: 500 = R$ 5,00).

Required range: x >= 500
Example:

1000

client_name
string
required

Nome completo do pagador.

Example:

"João Silva"

client_email
string<email>
required

E-mail válido do pagador.

Example:

"joao@email.com"

client_doc
string
required

CPF ou CNPJ (apenas números ou formatado).

Example:

"123.456.789-00"

client_phone
string

Telefone do pagador.

Example:

"(11) 99999-9999"

webhook_url
string<uri>

URL para receber notificações de status.

ip
string

IP do cliente. Se não enviado, é capturado automaticamente.

metadata
object

Objeto JSON com dados extras (máximo 20 chaves).

utms
object

Objeto com parâmetros UTM de rastreamento.

Response

Transação criada

status
string
Example:

"success"

data
object