Skip to main content
POST
/
v1
/
integrations
/
create-transaction
Gerar cobrança PIX
curl --request POST \
  --url https://api.axnpay.com.br/v1/integrations/create-transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 20,
  "description": "Pedido #1234",
  "productName": "Plano Pro",
  "clientName": "Matteo Augusto",
  "clientEmail": "axonaxolote@gmail.com",
  "clientPhone": "11999999999",
  "clientCpf": "52998224725",
  "tracking_parameters": {
    "utm_source": "meta_ads",
    "utm_medium": "cpc",
    "utm_campaign": "black_friday",
    "utm_content": "criativo_1",
    "utm_term": "checkout"
  },
  "referenceId": "77823bb5-3d84-4cbf-a2a4-43230cc3b1d1"
}
'
{
  "transactionId": "77823bb5-3d84-4cbf-a2a4-43230cc3b1d1",
  "status": "PENDING",
  "type": "CASHIN",
  "source": "PIX",
  "origin": "API",
  "amount": 20,
  "feeAmount": 1.15,
  "finalAmount": 18.85,
  "description": "Pedido #1234",
  "productName": "Plano Pro",
  "trackingParameters": {
    "utm_source": "meta_ads",
    "utm_medium": "cpc",
    "utm_campaign": "black_friday",
    "utm_content": "criativo_1",
    "utm_term": "checkout"
  },
  "pixCode": "00020101021226800014br.gov.bcb.pix...",
  "pixKeyType": null,
  "pixKey": null,
  "clientName": "Matteo Augusto",
  "clientEmail": "axonaxolote@gmail.com",
  "clientPhone": "11999999999",
  "clientCpf": "52998224725",
  "externalId": "7f1b51df-2f3f-4c73-8e9f-fd31df9f7e77",
  "endToEndId": null,
  "receiptUrl": null,
  "transactionDate": "2026-04-01T20:46:16.748Z",
  "paidAt": null,
  "createdAt": "2026-04-01T20:46:16.748Z",
  "updatedAt": "2026-04-01T20:46:16.748Z"
}
Cria uma cobrança PIX e retorna o transactionId público + pixCode (copia e cola EMV).
No endpoint de cobrança, envie apenas os campos de cobrança/pagador. Campos internos como acquirer, pixKey e pixKeyType não fazem parte do contrato público. Se quiser atribuição de campanha, envie tracking_parameters com seus UTMs.

Authorizations

​
Authorization
string
header
required

Use sua secret key: Bearer sk_live_prod_...

Body

application/json
​
amount
number
required

Valor bruto da cobrança em reais (ex.: 20.00).

Required range: 0.01 <= x <= 1000000
​
description
string

Descrição livre da cobrança.

​
productName
string

Nome do produto/serviço.

​
clientName
string

Nome do pagador.

​
clientEmail
string<email>

E-mail do pagador.

​
clientPhone
string

Telefone do pagador.

​
clientCpf
string

CPF/CNPJ do pagador (somente números).

​
tracking_parameters
object

Parâmetros opcionais de tracking para conciliação e repasse via webhook.

​
referenceId
string<uuid>

Chave de idempotência para CASHIN. Reutilize em retries da mesma cobrança.

Response

Transação criada

​
transactionId
string<uuid> | null
​
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
REVERSED,
CANCELLED,
CHARGEBACK
​
type
enum<string>
Available options:
CASHIN,
CASHOUT,
INFRACTION
​
source
string
​
origin
enum<string>
Available options:
API,
PAINEL,
APP
​
amount
number
​
feeAmount
number
​
finalAmount
number
​
description
string | null
​
productName
string | null
​
trackingParameters
object
​
pixCode
string | null
​
pixKeyType
enum<string>
Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
​
pixKey
string | null
​
clientName
string | null
​
clientEmail
string | null
​
clientPhone
string | null
​
clientCpf
string | null
​
externalId
string | null
​
endToEndId
string | null
​
receiptUrl
string | null
​
transactionDate
string<date-time> | null
​
paidAt
string<date-time> | null
​
createdAt
string<date-time> | null
​
updatedAt
string<date-time> | null