Regras de contrato

Contrato de integração para transações de entrada (CASHIN).

Identificadores

• transactionId é o ID público (UUID) para conciliação.
• id inteiro é legado e não deve ser usado como chave principal no cliente.

Payload público de criação (PIX)

No endpoint POST /v1/integrations/create-transaction, o contrato público usa:

• amount (obrigatório)
• description, productName
• clientName, clientEmail, clientPhone, clientCpf
• tracking_parameters com utm_source, utm_medium, utm_campaign, utm_content, utm_term
• referenceId (idempotência)

Campos internos como acquirer, pixKey e pixKeyType não fazem parte do contrato público de cobrança PIX.

Tracking e atribuição

Se enviados na criação da cobrança, os UTMs ficam salvos na transação e também são reenviados nos webhooks da AXNPAY dentro de trackingParameters.

Status de transação

• PENDING: criada e aguardando pagamento.
• PROCESSING: em processamento interno/provedor.
• COMPLETED: pagamento confirmado.
• FAILED: falhou.
• REVERSED: estornada.
• CANCELLED: cancelada.
• CHARGEBACK: chargeback/disputa.

Campo pixCode

Para PIX, a API retorna pixCode (copia e cola EMV).
Considere transação paga apenas quando status = COMPLETED.

Privacidade de dados

A resposta da Integrations API foi reduzida para expor apenas dados necessários ao integrador.