Skip to main content
POST
/
v1
/
integrations
/
create-transaction
Gerar cobranca
curl --request POST \
  --url https://api.axnpay.com.br/v1/integrations/create-transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 150,
  "currency": "brl",
  "productName": "Pedido #1001",
  "description": "Plano Premium",
  "clientName": "Maria",
  "clientEmail": "maria@example.com",
  "referenceId": "9e4a5fb4-61bb-4b38-9bb6-b7029b74bdf6",
  "checkoutUiMode": "hosted",
  "paymentMethodTypes": [
    "card",
    "link"
  ],
  "successUrl": "https://merchant.example.com/checkout/success",
  "cancelUrl": "https://merchant.example.com/checkout/cancel",
  "tracking_parameters": {
    "utm_source": "google",
    "utm_medium": "cpc",
    "utm_campaign": "launch"
  }
}
'
{
  "transactionId": "9e4a5fb4-61bb-4b38-9bb6-b7029b74bdf6",
  "status": "PENDING",
  "type": "CASHIN",
  "source": "CREDIT_CARD",
  "origin": "API",
  "amount": 150,
  "feeAmount": 0,
  "finalAmount": 150,
  "description": "Plano Premium",
  "productName": "Pedido #1001",
  "trackingParameters": {
    "utm_source": "google",
    "utm_medium": "cpc",
    "utm_campaign": "launch"
  },
  "pixCode": null,
  "pixKeyType": null,
  "pixKey": null,
  "clientName": "Maria",
  "clientEmail": "maria@example.com",
  "clientPhone": null,
  "clientCpf": null,
  "externalId": "checkout_sess_abc123",
  "gatewayId": null,
  "endToEndId": null,
  "receiptUrl": null,
  "transactionDate": "2026-05-02T18:46:16.748Z",
  "paidAt": null,
  "createdAt": "2026-05-02T18:46:16.748Z",
  "updatedAt": "2026-05-02T18:46:16.748Z",
  "balanceImpact": true,
  "settlementMode": "internal",
  "checkout": {
    "sessionId": "checkout_sess_abc123",
    "uiMode": "hosted",
    "url": "https://checkout.axnpay.com/session/checkout_sess_abc123",
    "clientSecret": null,
    "publishableKey": null,
    "accountDisplayName": "AXON SERVICOS FINANCEIROS LTDA",
    "paymentMethodConfigurationId": null,
    "requestedPaymentMethodTypes": [
      "card",
      "link"
    ],
    "livemode": true,
    "paymentStatus": "unpaid",
    "status": "open",
    "expiresAt": null,
    "webhookConfigured": true,
    "settlementMode": "internal",
    "balanceImpact": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.axnpay.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Cria uma cobranca de entrada e retorna o transactionId publico.
Para PIX, a resposta inclui pixCode. Para cartao, a resposta inclui checkout. Se quiser atribuicao de campanha, envie tracking_parameters com seus UTMs.
Se voce estiver implementando checkout de cartao, veja tambem a pagina Cartao.

Authorizations

​
Authorization
string
header
required

Use sua secret key: Bearer sk_live_prod_...

Body

application/json
​
amount
number
required

Valor bruto da cobranca.

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

Descricao livre da cobranca.

​
productName
string

Nome do produto ou servico.

​
clientName
string

Nome do pagador.

​
clientEmail
string<email>

Email do pagador.

​
clientPhone
string

Telefone do pagador.

​
clientCpf
string

Documento do pagador.

​
tracking_parameters
object
​
utm_source
string
​
utm_medium
string
​
utm_campaign
string
​
utm_content
string
​
utm_term
string
​
referenceId
string<uuid>

Chave de idempotencia do merchant.

​
paymentMethod
string

Exemplo: credit_card, visa, master, bolbradesco.

​
paymentMethodTypes
string[]

Usado quando o checkout web de cartao ativo suportar selecao de metodos no frontend. Exemplo: ["card"], ["card","link"], ["paypal"].

​
cardToken
string

Token de cartao usado em fluxos Mercado Pago.

​
installments
integer
Required range: 1 <= x <= 12
​
currency
string

Moeda ISO-4217. Default: brl. A disponibilidade dos metodos depende do checkout ativo na conta.

​
pixKeyType
enum<string>
Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
​
pixKey
string
​
checkoutUiMode
enum<string>
Available options:
hosted,
embedded,
custom
​
successUrl
string<uri>
​
cancelUrl
string<uri>
​
returnUrl
string<uri>

Response

Cobranca 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
​
gatewayId
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
​
balanceImpact
boolean
​
settlementMode
string
​
checkout
object