Criar Pedido

curl --request POST \
  --url https://zeus-sandbox.autorizou.dev/api/v1/charges/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "code": "<string>",
  "mcc": "<string>",
  "notification_url": "<string>",
  "customer": {
    "customer.id": 123,
    "customer.name": "<string>",
    "customer.email": "<string>",
    "customer.documents": [
      {
        "customer.documents[].type": "<string>",
        "customer.documents[].value": "<string>"
      }
    ],
    "customer.addresses": [
      {
        "customer.addresses[].type": "<string>",
        "customer.addresses[].postal_code": "<string>",
        "customer.addresses[].line_1": "<string>",
        "customer.addresses[].line_2": "<string>",
        "customer.addresses[].number": "<string>",
        "customer.addresses[].neighborhood": "<string>",
        "customer.addresses[].city": "<string>",
        "customer.addresses[].state": "<string>",
        "customer.addresses[].country": "<string>"
      }
    ],
    "customer.phone": {
      "customer.phone.type": "<string>",
      "customer.phone.ddi": "<string>",
      "customer.phone.ddd": "<string>",
      "customer.phone.number": "<string>"
    }
  },
  "payment": {
    "payment.amount": 123,
    "payment.currency": "<string>",
    "payment.payment_method": "<string>",
    "payment.installments": 123,
    "payment.discount": 123,
    "payment.interest": 123,
    "payment.metadata": {}
  },
  "payment.credit_card": {
    "payment.credit_card.id": 123,
    "payment.credit_card.statement_descriptor": "<string>",
    "payment.credit_card.capture": true,
    "payment.credit_card.capture_delay_hours": 123,
    "payment.credit_card.processing_model": "<string>"
  },
  "payment.pix": {
    "payment.pix.expires_at": "<string>"
  },
  "payment.bank_slip": {
    "payment.bank_slip.due_at": "<string>"
  },
  "payment.google_pay": {
    "payment.google_pay.google_pay_token": "<string>",
    "payment.google_pay.statement_descriptor": "<string>",
    "payment.google_pay.capture": true,
    "payment.google_pay.capture_delay_hours": 123
  },
  "payment.apple_pay": {
    "payment.apple_pay.apple_pay_token": "<string>",
    "payment.apple_pay.digital_wallet_uuid": "<string>",
    "payment.apple_pay.statement_descriptor": "<string>",
    "payment.apple_pay.capture": true,
    "payment.apple_pay.capture_delay_hours": 123
  },
  "payment.split": [
    {
      "payment.split[].recipient_id": 123,
      "payment.split[].amount": 123,
      "payment.split[].type": "<string>",
      "payment.split[].allow_charge_processing_fee": true,
      "payment.split[].allow_charge_remainder_fee": true,
      "payment.split[].is_liable": true
    }
  ],
  "authentication_data": {
    "authentication_data.attempt_authentication": "<string>",
    "authentication_data.browser_info": {
      "authentication_data.browser_info.accept_header": "<string>",
      "authentication_data.browser_info.color_depth": "<string>",
      "authentication_data.browser_info.java_enabled": true,
      "authentication_data.browser_info.language": "<string>",
      "authentication_data.browser_info.screen_height": "<string>",
      "authentication_data.browser_info.screen_width": "<string>",
      "authentication_data.browser_info.timezone_offset": "<string>",
      "authentication_data.browser_info.user_agent": "<string>"
    },
    "authentication_data.origin": "<string>",
    "authentication_data.ip_address": "<string>"
  },
  "items": [
    {
      "items[].name": "<string>",
      "items[].description": "<string>",
      "items[].quantity": 123,
      "items[].amount": 123
    }
  ]
}
'

POST

api

charges

orders

Criar Pedido

curl --request POST \
  --url https://zeus-sandbox.autorizou.dev/api/v1/charges/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "code": "<string>",
  "mcc": "<string>",
  "notification_url": "<string>",
  "customer": {
    "customer.id": 123,
    "customer.name": "<string>",
    "customer.email": "<string>",
    "customer.documents": [
      {
        "customer.documents[].type": "<string>",
        "customer.documents[].value": "<string>"
      }
    ],
    "customer.addresses": [
      {
        "customer.addresses[].type": "<string>",
        "customer.addresses[].postal_code": "<string>",
        "customer.addresses[].line_1": "<string>",
        "customer.addresses[].line_2": "<string>",
        "customer.addresses[].number": "<string>",
        "customer.addresses[].neighborhood": "<string>",
        "customer.addresses[].city": "<string>",
        "customer.addresses[].state": "<string>",
        "customer.addresses[].country": "<string>"
      }
    ],
    "customer.phone": {
      "customer.phone.type": "<string>",
      "customer.phone.ddi": "<string>",
      "customer.phone.ddd": "<string>",
      "customer.phone.number": "<string>"
    }
  },
  "payment": {
    "payment.amount": 123,
    "payment.currency": "<string>",
    "payment.payment_method": "<string>",
    "payment.installments": 123,
    "payment.discount": 123,
    "payment.interest": 123,
    "payment.metadata": {}
  },
  "payment.credit_card": {
    "payment.credit_card.id": 123,
    "payment.credit_card.statement_descriptor": "<string>",
    "payment.credit_card.capture": true,
    "payment.credit_card.capture_delay_hours": 123,
    "payment.credit_card.processing_model": "<string>"
  },
  "payment.pix": {
    "payment.pix.expires_at": "<string>"
  },
  "payment.bank_slip": {
    "payment.bank_slip.due_at": "<string>"
  },
  "payment.google_pay": {
    "payment.google_pay.google_pay_token": "<string>",
    "payment.google_pay.statement_descriptor": "<string>",
    "payment.google_pay.capture": true,
    "payment.google_pay.capture_delay_hours": 123
  },
  "payment.apple_pay": {
    "payment.apple_pay.apple_pay_token": "<string>",
    "payment.apple_pay.digital_wallet_uuid": "<string>",
    "payment.apple_pay.statement_descriptor": "<string>",
    "payment.apple_pay.capture": true,
    "payment.apple_pay.capture_delay_hours": 123
  },
  "payment.split": [
    {
      "payment.split[].recipient_id": 123,
      "payment.split[].amount": 123,
      "payment.split[].type": "<string>",
      "payment.split[].allow_charge_processing_fee": true,
      "payment.split[].allow_charge_remainder_fee": true,
      "payment.split[].is_liable": true
    }
  ],
  "authentication_data": {
    "authentication_data.attempt_authentication": "<string>",
    "authentication_data.browser_info": {
      "authentication_data.browser_info.accept_header": "<string>",
      "authentication_data.browser_info.color_depth": "<string>",
      "authentication_data.browser_info.java_enabled": true,
      "authentication_data.browser_info.language": "<string>",
      "authentication_data.browser_info.screen_height": "<string>",
      "authentication_data.browser_info.screen_width": "<string>",
      "authentication_data.browser_info.timezone_offset": "<string>",
      "authentication_data.browser_info.user_agent": "<string>"
    },
    "authentication_data.origin": "<string>",
    "authentication_data.ip_address": "<string>"
  },
  "items": [
    {
      "items[].name": "<string>",
      "items[].description": "<string>",
      "items[].quantity": 123,
      "items[].amount": 123
    }
  ]
}
'

Este endpoint permite criar pedidos e processar pagamentos usando diferentes métodos (cartão, PIX, boleto, Google Pay), com suporte completo a parcelamento, split de pagamento, 3D Secure e Network Tokens.

Parâmetros Obrigatórios

description

string

required

Descrição da transaçãoMáximo: 255 caracteres

code

string

required

Referência única para este pedido no sistema do comercianteExemplo: ORDER-2024-001 | Máximo: 255 caracteres

mcc

string

required

Merchant Category Code (código de categoria do estabelecimento)Formato: 4 dígitos | Exemplo: 5411 (supermercado)

Parâmetros Opcionais

notification_url

string

URL para receber notificações de mudança de status (webhook)Exemplo: https://seusite.com/webhook/autorizou

Dados do Cliente

customer

object

required

Show Informações do cliente

customer.id

integer

required

ID do cliente (cadastrado previamente)Nota: Usar endpoint Criar Cliente numa etapa anterior ao pagamento.

customer.name

string

required

Nome completo do clienteMáximo: 64 caracteres

customer.email

string

required

Email válido do clienteMáximo: 64 caracteres

customer.documents

array

Lista de documentos do clienteObrigatório se: payment_method for pix ou bank_slip

Show Estrutura do documento

customer.documents[].type

string

required

Tipo do documentoValores: CPF, CNPJ

customer.documents[].value

string

required

Número do documento (apenas dígitos)Exemplo CPF: 12345678901 | Exemplo CNPJ: 12345678000195

customer.addresses

array

Endereços do cliente (opcional mas recomendado). Não necessário se já cadastrado na etapa de criação do cliente. Recomendando para aumentar % de conversão com cartões de crédito.Obrigatório se: payment_method for bank_slip

Show Estrutura do endereço

customer.addresses[].type

string

Tipo do endereçoValores: billing (cobrança), shipping (entrega)

customer.addresses[].postal_code

string

CEP (apenas números, sem traços ou pontos)Exemplo: "01310100" | Formato: String numérica de 8 dígitos

customer.addresses[].line_1

string

Logradouro (rua, avenida, etc.)

customer.addresses[].line_2

string

Complemento (apartamento, sala, etc.)

customer.addresses[].number

string

Número do endereço

customer.addresses[].neighborhood

string

Bairro

customer.addresses[].city

string

Cidade

customer.addresses[].state

string

Estado (2 caracteres)Exemplo: SP, RJ

customer.addresses[].country

string

País (ISO 3166-1 alpha-2)Exemplo: BR

customer.phone

object

Telefone de contato (opcional mas recomendado)

Show Estrutura do telefone

customer.phone.type

string

Tipo do telefoneValores: mobile, home, work

customer.phone.ddi

string

Código internacional do paísExemplo: 55 (Brasil)

customer.phone.ddd

string

Código de áreaExemplo: 11 (São Paulo)

customer.phone.number

string

Número do telefone (apenas dígitos)Exemplo: 987654321

Dados do Pagamento

payment

object

required

Show Configurações de pagamento

payment.amount

integer

required

Valor total em centavosExemplo: 10000 = R

100,00 | **Mínimo:** `500` (R

5,00)

payment.currency

string

required

Moeda da transação (padrão ISO 4217)Valor: BRL

payment.payment_method

string

required

Método de pagamentoValores: credit_card, pix, bank_slip, google_pay, apple_pay

payment.installments

integer

required

Número de parcelasPadrão: 1 | Mínimo: 1 | Máximo: 12Restrições:

Parcelamento disponível apenas para credit_card e google_pay
PIX e boleto devem usar installments = 1
Parcelamento só é permitido para moeda BRL (Real Brasileiro)

payment.discount

integer

Valor de desconto em centavosExemplo: 500 = R$ 5,00 de desconto

payment.interest

integer

Valor de juros em centavosExemplo: 200 = R$ 2,00 de juros

payment.metadata

object

Metadados customizados do pagamento (formato JSON livre)Use este campo para armazenar informações adicionais sobre o pagamento que sejam relevantes para seu sistema (ex: order_id, campaign_id, user_tier, etc.)Exemplo: {"order_id": "12345", "campaign": "black-friday"}

Pagamento com Cartão de Crédito

payment.credit_card

object

Obrigatório quando: payment_method = "credit_card"

Show Configurações de cartão

payment.credit_card.id

integer

required

ID interno do cartão salvo previamenteNota: Use o endpoint Criar Cartão primeiro

payment.credit_card.statement_descriptor

string

required

Nome que aparece na fatura do cartãoMáximo: 22 caracteres | Exemplo: LOJA*PRODUTO

payment.credit_card.capture

boolean

required

Se deve capturar automaticamente o pagamentoValores: true (captura imediata), false (captura manual posterior)

payment.credit_card.capture_delay_hours

integer

Horas de atraso para captura automáticaObrigatório se: capture = false | Mínimo: 0

payment.credit_card.processing_model

string

required

Modelo de processamento do cartão, indica quem iniciou a transação e se o cliente está presente no ato do pagamento.Valores: customer_initiated, merchant_initiated, merchant_initiated_subscription

Pagamento PIX

payment.pix

object

Obrigatório quando: payment_method = "pix"

Show Configurações PIX

payment.pix.expires_at

string

required

Data/hora de expiração do QR Code (ISO 8601)Exemplo: 2024-12-31 23:59:59 | Deve ser: Após agora e antes de 24h

Pagamento com Boleto

payment.bank_slip

object

Obrigatório quando: payment_method = "bank_slip"

Show Configurações de boleto

payment.bank_slip.due_at

string

required

Data de vencimento do boleto (ISO 8601)Exemplo: 2024-12-31 23:59:59 | Deve ser: Após agora

Pagamento com Google Pay

payment.google_pay

object

Obrigatório quando: payment_method = "google_pay"

Show Configurações Google Pay

payment.google_pay.google_pay_token

string

required

Token gerado pelo Google Pay

payment.google_pay.statement_descriptor

string

required

Nome que aparece na faturaMáximo: 22 caracteres

payment.google_pay.capture

boolean

required

Se deve capturar automaticamente

payment.google_pay.capture_delay_hours

integer

Horas de atraso para capturaObrigatório se: capture = false

Pagamento com Apple Pay

payment.apple_pay

object

Obrigatório quando: payment_method = "apple_pay"

Show Configurações Apple Pay

payment.apple_pay.apple_pay_token

string

Token gerado pelo Apple Pay (objeto JSON stringificado)Este token é obtido do evento onpaymentauthorized do ApplePaySession. Deve ser o JSON.stringify(event.payment) — o objeto ApplePayPayment completo, não apenas event.payment.token.Obrigatório: Sim, exceto se digital_wallet_uuid for fornecido (para pagamentos recorrentes)Exemplo de uso:

apple_pay_token: JSON.stringify(event.payment)

Estrutura esperada:

{
  "token": {
    "paymentData": {
      "version": "EC_v1",
      "data": "...",
      "signature": "...",
      "header": {
        "ephemeralPublicKey": "...",
        "publicKeyHash": "...",
        "transactionId": "..."
      }
    },
    "paymentMethod": {
      "displayName": "Visa 1234",
      "network": "Visa",
      "type": "credit"
    },
    "transactionIdentifier": "..."
  },
  "billingContact": {},
  "shippingContact": {}
}

payment.apple_pay.digital_wallet_uuid

string

UUID da carteira digital salva anteriormenteUse este campo para cobranças recorrentes com Apple Pay. Quando fornecido, o apple_pay_token não é necessário.Formato: UUID válidoExemplo: "550e8400-e29b-41d4-a716-446655440000"

payment.apple_pay.statement_descriptor

string

required

Nome que aparece na fatura do cartãoMáximo: 22 caracteres | Exemplo: MINHA LOJA

payment.apple_pay.capture

boolean

required

Se deve capturar automaticamente o pagamentoValores: true (captura imediata), false (captura manual posterior)

payment.apple_pay.capture_delay_hours

integer

Horas de atraso para captura automáticaObrigatório se: capture = false | Mínimo: 0 | Máximo: 168 (7 dias)

Novo! Apple Pay agora está disponível. Veja o guia completo de integração para começar.

Split de Pagamento

payment.split

array

Divisão do pagamento entre múltiplos destinatários

Show Configuração do split

payment.split[].recipient_id

integer

required

ID interno do destinatário cadastradoNota: Use o endpoint Criar Recebedor primeiro

payment.split[].amount

integer

required

Valor em centavos destinado a este recipienteExemplo: 5000 = R$ 50,00

payment.split[].type

string

required

Tipo de divisãoValores: flat (valor fixo), percentage (percentual do total)

payment.split[].allow_charge_processing_fee

boolean

required

Se este destinatário deve pagar a taxa de processamentoPadrão: false

payment.split[].allow_charge_remainder_fee

boolean

required

Se este destinatário deve pagar a taxa de resto/ajustePadrão: false

payment.split[].is_liable

boolean

required

Se este destinatário é responsável por chargebacksPadrão: false

Importante sobre validação do Split:

Cada split individual não pode ser maior que payment.amount
A soma de todos os splits não pode ultrapassar payment.amount
A soma pode ser menor que o total (a diferença fica com o merchant principal)

3D Secure (3DS)

authentication_data

object

Dados para autenticação 3D Secure (recomendado para maior segurança)

Show Configurações 3DS

authentication_data.attempt_authentication

string

required

Quando tentar autenticação 3DSValores: always, never

authentication_data.browser_info

object

Informações do navegador do clienteObrigatório se: attempt_authentication = "always"

Show Dados do navegador

authentication_data.browser_info.accept_header

string

required

Header Accept do navegadorExemplo: text/html,application/xhtml+xml

authentication_data.browser_info.color_depth

string

required

Profundidade de cor da telaExemplo: 24

authentication_data.browser_info.java_enabled

boolean

required

Se Java está habilitado

authentication_data.browser_info.language

string

required

Idioma do navegadorExemplo: pt-BR

authentication_data.browser_info.screen_height

string

required

Altura da tela em pixelsExemplo: 1080

authentication_data.browser_info.screen_width

string

required

Largura da tela em pixelsExemplo: 1920

authentication_data.browser_info.timezone_offset

string

required

Diferença de fuso horário em minutosExemplo: 180 (UTC-3 = Brasil)

authentication_data.browser_info.user_agent

string

required

User Agent do navegadorExemplo: Mozilla/5.0 (Windows NT 10.0; Win64; x64)...

authentication_data.origin

string

URL de origem da requisiçãoObrigatório se: attempt_authentication = "always"Exemplo: https://seusite.com

authentication_data.ip_address

string

Endereço IP do clienteObrigatório se: attempt_authentication = "always"Exemplo: 192.168.1.100

3D Secure 2.0: Melhora significativamente a taxa de aprovação e reduz fraudes. Altamente recomendado para transações de alto valor.

Itens do Pedido

items

array

Lista de itens/produtos do pedido (opcional mas recomendado)

Show Estrutura de item

items[].name

string

Nome do produto/serviçoMáximo: 64 caracteres

items[].description

string

Descrição detalhadaMáximo: 256 caracteres

items[].quantity

integer

QuantidadeMínimo: 1

items[].amount

integer

Valor unitário em centavos

Estrutura da Resposta

A resposta contém informações completas sobre o pedido e pagamento criados:

Campos do Pedido (Order)

Campo	Tipo	Descrição
`id`	string	UUID único do pedido
`hash`	string	Hash único do pedido para referência
`status`	string	Status do pedido: `pending`, `paid`, `failed`, `canceled`
`is_closed`	boolean	Indica se o pedido está fechado/finalizado
`payment`	object	Objeto contendo dados do pagamento (ver abaixo)
`fee`	object	Objeto contendo informações de taxas (ver abaixo)
`customer`	object	Dados do cliente (`id`, `name`, `email`)

Campos do Pagamento (Payment)

Campo	Tipo	Descrição
`id`	string	UUID único do pagamento
`hash`	string	Hash único do pagamento
`merchant_reference`	string	Referência do merchant (campo `code` da requisição)
`status`	string	Status do pagamento: `pending`, `authorized`, `paid`, `refused`, `failed`
`payment_method`	string	Método usado: `credit_card`, `pix`, `bank_slip`, `google_pay`, `apple_pay`
`amount`	integer	Valor em centavos
`installments`	integer	Número de parcelas
`currency`	string	Moeda (ISO 4217): `BRL`
`description`	string	Descrição da transação
`metadata`	object	Metadados customizados (se fornecidos)
`refused_reason`	string	Motivo da recusa (se aplicável)
`return_code`	string	Código de retorno do adquirente
`created_at`	string	Data/hora de criação (formato: `Y-m-d H:i:s`)
`updated_at`	string	Data/hora da última atualização

Campos Específicos de Cartão (quando `payment_method = credit_card`)

Campo	Tipo	Descrição
`credit_card.id`	string	UUID do cartão
`credit_card.holder`	string	Nome do titular
`credit_card.brand`	string	Bandeira: `visa`, `mastercard`, `elo`, etc.
`credit_card.first_6`	string	Primeiros 6 dígitos (BIN)
`credit_card.last_4`	string	Últimos 4 dígitos
`credit_card.exp_month`	integer	Mês de expiração (1-12)
`credit_card.exp_year`	integer	Ano de expiração (YYYY)
`credit_card.statement_descriptor`	string	Descrição na fatura
`credit_card.capture`	boolean	Se foi capturado automaticamente
`credit_card.three_ds`	object	Dados do 3D Secure (se autenticado)

Campos Específicos de Apple Pay (quando `payment_method = apple_pay`)

Campo	Tipo	Descrição
`apple_pay.id`	string	UUID da carteira digital salva (para uso em cobranças recorrentes)
`apple_pay.statement_descriptor`	string	Descrição na fatura
`apple_pay.capture`	boolean	Se foi capturado automaticamente
`apple_pay.three_ds`	object	Dados do 3D Secure (se autenticado)
`apple_pay.brand`	string	Bandeira do cartão (ex: `visa`, `mastercard`)
`apple_pay.last_4`	string	Últimos 4 dígitos do cartão
`apple_pay.card_type`	string	Tipo do cartão: `credit`, `debit`

Campos de Taxas (Fee)

Campo	Tipo	Descrição
`fixed_fee_amount`	integer	Taxa fixa em centavos
`platform_fee_percentage`	float	Percentual da taxa da plataforma
`platform_fee_amount`	integer	Valor da taxa da plataforma em centavos

Objeto 3DS (three_ds): Quando a autenticação 3D Secure é realizada, este objeto conterá informações sobre o resultado da autenticação, incluindo authentication_url caso seja necessário redirecionar o cliente.

Exemplos de Requisição

Pagamento com Cartão

Requisição

curl -X POST https://zeus-sandbox.autorizou.dev/api/v1/charges/orders \
  -H "Authorization: Bearer 4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Compra na Loja Virtual",
    "code": "ORDER-2024-001",
    "mcc": "5411",
    "customer": {
      "name": "João Silva",
      "email": "joao@exemplo.com.br",
      "documents": [
        {
          "type": "CPF",
          "value": "12345678901"
        }
      ],
      "addresses": [
        {
          "type": "billing",
          "postal_code": "01310100",
          "line_1": "Av. Paulista",
          "number": "1000",
          "neighborhood": "Bela Vista",
          "city": "São Paulo",
          "state": "SP",
          "country": "BR"
        }
      ]
    },
    "payment": {
      "amount": 15000,
      "currency": "BRL",
      "payment_method": "credit_card",
      "installments": 3,
      "credit_card": {
        "id": 12345,
        "statement_descriptor": "LOJA*PRODUTO",
        "capture": true,
        "processing_model": "normal"
      }
    }
  }'

Resposta

{
  "id": "pay_abc123def456ghi789",
  "status": "paid",
  "amount": 15000,
  "currency": "BRL",
  "payment_method": "credit_card",
  "description": "Compra na Loja Virtual",
  "merchant_reference": "ORDER-2024-001",
  "card": {
    "id": "card_def456ghi789jkl012",
    "brand": "visa",
    "last_four": "1111",
    "holder_name": "JOAO SILVA",
    "installments": 3,
    "authorization_code": "ABC123",
    "network_token_used": true
  },
  "customer": {
    "id": 12345,
    "name": "João Silva",
    "email": "joao@exemplo.com.br"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "authorized_at": "2024-01-15T10:30:02Z",
  "paid_at": "2024-01-15T10:30:03Z"
}

Autenticação 3D Secure: Se o pagamento requer autenticação 3DS, a resposta terá status: "requires_action" com um campo three_d_secure contendo a authentication_url para onde você deve redirecionar o cliente. Veja a seção 3D Secure (3DS) para mais detalhes.

Pagamento PIX

Requisição

curl -X POST https://zeus-sandbox.autorizou.dev/api/v1/charges/orders \
  -H "Authorization: Bearer 4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Pagamento PIX - Pedido #12345",
    "code": "PIX-ORDER-12345",
    "mcc": "5411",
    "customer": {
      "name": "João Silva",
      "email": "joao@exemplo.com.br",
      "documents": [
        {
          "type": "CPF",
          "value": "12345678901"
        }
      ]
    },
    "payment": {
      "amount": 5000,
      "currency": "BRL",
      "payment_method": "pix",
      "installments": 1,
      "pix": {
        "expires_at": "2024-12-31T23:59:59Z"
      }
    }
  }'

Resposta

{
  "id": "pay_pix789abc012def345",
  "status": "pending",
  "amount": 5000,
  "currency": "BRL",
  "payment_method": "pix",
  "description": "Pagamento PIX - Pedido #12345",
  "merchant_reference": "PIX-ORDER-12345",
  "pix": {
    "qr_code": "00020126580014BR.GOV.BCB.PIX0136123e4567-e12b-12d1-a456-426655440000520400005303986540550.005802BR5913Autorizou Ltda6009SAO PAULO62070503***63041D3D",
    "qr_code_url": "https://chart.googleapis.com/chart?chs=200x200&cht=qr&chl=00020126580014BR.GOV.BCB.PIX...",
    "expires_at": "2024-12-31T23:59:59Z"
  },
  "customer": {
    "id": 12347,
    "name": "João Silva",
    "email": "joao@exemplo.com.br"
  },
  "created_at": "2024-01-15T12:00:00Z"
}

Pagamento Apple Pay

Requisição

curl -X POST https://zeus-sandbox.autorizou.dev/api/v1/charges/orders \
  -H "Authorization: Bearer 4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Compra via Apple Pay",
    "code": "APPLE-PAY-ORDER-001",
    "mcc": "5411",
    "customer": {
      "id": 12345,
      "name": "João Silva",
      "email": "joao@exemplo.com.br",
      "documents": [
        {
          "type": "CPF",
          "value": "12345678901"
        }
      ]
    },
    "payment": {
      "amount": 25000,
      "currency": "BRL",
      "payment_method": "apple_pay",
      "installments": 1,
      "apple_pay": {
        "apple_pay_token": "{\"token\":{\"paymentData\":{\"version\":\"EC_v1\",\"data\":\"...\",\"signature\":\"...\",\"header\":{...}},\"paymentMethod\":{\"displayName\":\"Visa 1234\",\"network\":\"Visa\",\"type\":\"credit\"},\"transactionIdentifier\":\"...\"}}",
        "statement_descriptor": "MINHA LOJA",
        "capture": true
      }
    }
  }'

Resposta

{
  "id": "ord_applepay123abc456def",
  "hash": "abc123def456",
  "status": "paid",
  "is_closed": false,
  "payment": {
    "id": "pay_applepay123abc456def",
    "hash": null,
    "merchant_reference": "APPLE-PAY-ORDER-001",
    "status": "paid",
    "payment_method": "apple_pay",
    "amount": 25000,
    "installments": 1,
    "currency": "BRL",
    "description": "Compra via Apple Pay",
    "bank_slip": null,
    "credit_card": null,
    "pix": null,
    "pix_recurring": null,
    "google_pay": null,
    "apple_pay": {
      "statement_descriptor": "MINHA LOJA",
      "capture": true,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "three_ds": null,
      "brand": "visa",
      "last_4": "1234",
      "card_type": "credit"
    },
    "refused_reason": null,
    "return_code": null,
    "created_at": "2024-01-15 13:30:00",
    "updated_at": "2024-01-15 13:30:03"
  },
  "fee": {
    "fixed_fee_amount": 0,
    "platform_fee_percentage": 0,
    "platform_fee_amount": 0
  },
  "customer": {
    "id": "cus_abc123",
    "name": "João Silva",
    "email": "joao@exemplo.com.br"
  }
}

Integração Apple Pay: Para implementar o Apple Pay em seu frontend e obter o apple_pay_token, consulte o Guia Completo de Integração Apple Pay.

Salvamento Automático: A Autorizou salva automaticamente a carteira digital após o primeiro pagamento bem-sucedido com Apple Pay. O apple_pay.id retornado na resposta pode ser usado como digital_wallet_uuid em cobranças futuras, eliminando a necessidade de solicitar o token Apple Pay novamente.

Venda com Split

Requisição

curl -X POST https://zeus-sandbox.autorizou.dev/api/v1/charges/orders \
  -H "Authorization: Bearer 4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Venda no Marketplace",
    "code": "MARKETPLACE-ORD-789",
    "mcc": "5411",
    "customer": {
      "name": "Cliente Marketplace",
      "email": "cliente@exemplo.com.br",
      "documents": [
        {
          "type": "CPF",
          "value": "98765432100"
        }
      ]
    },
    "payment": {
      "amount": 100000,
      "currency": "BRL",
      "payment_method": "credit_card",
      "installments": 1,
      "credit_card": {
        "id": 67890,
        "statement_descriptor": "MARKETPLACE*VND",
        "capture": true,
        "processing_model": "normal"
      },
      "split": [
        {
          "recipient_id": 100,
          "amount": 10000,
          "type": "flat",
          "allow_charge_processing_fee": false,
          "allow_charge_remainder_fee": false,
          "is_liable": false
        },
        {
          "recipient_id": 200,
          "amount": 90000,
          "type": "flat",
          "allow_charge_processing_fee": true,
          "allow_charge_remainder_fee": true,
          "is_liable": true
        }
      ]
    }
  }'

Resposta

{
  "id": "pay_split123abc456def",
  "status": "paid",
  "amount": 100000,
  "currency": "BRL",
  "payment_method": "credit_card",
  "description": "Venda no Marketplace",
  "merchant_reference": "MARKETPLACE-ORD-789",
  "card": {
    "id": "card_mno345pqr678stu901",
    "brand": "visa",
    "last_four": "4242",
    "installments": 1,
    "authorization_code": "DEF456"
  },
  "split": [
    {
      "recipient_id": 100,
      "amount": 10000,
      "type": "flat"
    },
    {
      "recipient_id": 200,
      "amount": 90000,
      "type": "flat"
    }
  ],
  "customer": {
    "id": 12348,
    "name": "Cliente Marketplace",
    "email": "cliente@exemplo.com.br"
  },
  "created_at": "2024-01-15T13:00:00Z",
  "authorized_at": "2024-01-15T13:00:02Z",
  "paid_at": "2024-01-15T13:00:03Z"
}

Códigos de Erro

400 - Bad Request

Requisição malformada ou parâmetros inválidos

{
  "error": {
    "code": "validation_error",
    "message": "Dados inválidos",
    "details": {
      "payment.amount": ["O valor deve ser maior que 100"],
      "customer.email": ["Email inválido"],
      "payment.split": ["A soma dos splits deve ser igual ao valor total"]
    }
  }
}

Possíveis causas:

Parâmetros obrigatórios faltando
Tipos de dados incorretos
Valores fora dos limites permitidos
Soma do split diferente do valor total

402 - Payment Required

Transação recusada pelo processador

{
  "error": {
    "code": "card_declined",
    "message": "Cartão recusado",
    "details": {
      "decline_reason": "insufficient_funds",
      "authorization_code": null
    }
  }
}

Motivos comuns de recusa:

insufficient_funds - Saldo insuficiente
invalid_card - Cartão inválido ou não existe
expired_card - Cartão expirado
card_restricted - Cartão bloqueado ou restrito
do_not_honor - Emissor recusou sem especificar motivo
invalid_cvv - CVV incorreto
suspected_fraud - Suspeita de fraude

404 - Not Found

Recurso não encontrado

{
  "error": {
    "code": "not_found",
    "message": "Recurso não encontrado",
    "details": {
      "resource": "customer",
      "identifier": "12345"
    }
  }
}

Possíveis causas:

Cliente não existe
Cartão não encontrado
Recebedor de split inexistente

422 - Unprocessable Entity

Erro no processamento da transação

{
  "error": {
    "code": "processing_error",
    "message": "Erro no processamento",
    "details": {
      "reasons": ["invalid_cvv", "authentication_failed"]
    }
  }
}

Possíveis causas:

Falha na autenticação 3DS
Problema com o processador de pagamentos
Configuração inválida do merchant

Regras de Negócio

Valores e Limites

💰 Valores Permitidos

Mínimo: R$ 1,00 (100 centavos)
Máximo: Conforme limite do merchant
Parcelamento: Até 12x para cartão de crédito
Taxa: Calculada automaticamente conforme tabela do merchant

⏰ Prazos de Captura

Cartão: Captura imediata ou até 5 dias
PIX: Expiração configurável (até 24h)
Boleto: Vencimento configurável
3DS: Autenticação deve ser concluída em 15 minutos

🚫 Restrições

Cartão deve estar ativo e não expirado
Split deve somar exatamente o valor total
Cliente deve ter cadastro válido
MCC deve estar autorizado para o merchant

Split de Pagamentos

Como Funciona

O Split permite dividir o valor de uma transação entre múltiplos destinatários. Ideal para marketplaces, plataformas multi-vendor e agregadores.

Regras de Split

Soma dos valores deve ser igual a payment.amount
Recebedors devem estar previamente cadastrados
Taxas podem ser atribuídas a destinatários específicos
Responsabilidade por chargebacks pode ser configurada

Tipos de Split

Flat (Valor Fixo)

Valor fixo em centavos destinado ao recipiente

{
  "recipient_id": 100,
  "amount": 5000, // R$ 50,00 fixo
  "type": "flat"
}

Percentage (Percentual)

Percentual do valor total

{
  "recipient_id": 100,
  "amount": 10000, // R$ 100,00 (calculado como 10% de R$ 1.000,00)
  "type": "percentage"
}

Nota: Mesmo com type = "percentage", o campo amount deve conter o valor já calculado em centavos.

Configuração de Taxas

allow_charge_processing_fee

Define se o destinatário paga a taxa de processamentoExemplo: Taxa de 3% = R

30,00 em uma venda de R

1.000,00

true: Recebedor recebe R$ 970,00 (desconta a taxa)
false: Recebedor recebe R$ 1.000,00 (marketplace paga)

allow_charge_remainder_fee

Define se o destinatário paga taxas de ajuste/restoTaxas residuais de arredondamento ou divisões não exatas

is_liable

Define responsabilidade por chargebacks

true: Recebedor é responsável e terá valores descontados em caso de chargeback
false: Marketplace/Plataforma assume o risco

Exemplo Prático de Split

// Cenário: Marketplace com comissão de 10%
// Venda de R$ 1.000,00

const splitConfig = [
  {
    recipient_id: 100, // Marketplace
    amount: 10000, // R$ 100,00 (10% de comissão)
    type: 'flat',
    allow_charge_processing_fee: false, // Marketplace não paga taxa
    allow_charge_remainder_fee: false,
    is_liable: false // Marketplace não assume risco
  },
  {
    recipient_id: 200, // Vendedor
    amount: 90000, // R$ 900,00 (90% do valor)
    type: 'flat',
    allow_charge_processing_fee: true, // Vendedor paga taxa de processamento
    allow_charge_remainder_fee: true,
    is_liable: true // Vendedor assume risco de chargeback
  }
];

// Taxa de processamento: 3% = R$ 30,00
// Vendedor receberá: R$ 900,00 - R$ 30,00 = R$ 870,00
// Marketplace receberá: R$ 100,00 (sem desconto)

3D Secure (3DS)

3D Secure é um protocolo de autenticação adicional que aumenta a segurança e taxa de aprovação.

Quando Usar

Transações de alto valor (acima de R$ 500)
Primeiro uso do cartão
Cliente internacional
Comportamento suspeito detectado

Implementação Básica

Para usar 3DS, envie o parâmetro authentication_data com informações do navegador:

const order = await fetch('https://zeus-sandbox.autorizou.dev/api/v1/charges/orders', {
  method: 'POST',
  body: JSON.stringify({
    // ... outros parâmetros
    authentication_data: {
      attempt_authentication: 'always',
      browser_info: {
        accept_header: 'text/html',
        color_depth: '24',
        java_enabled: false,
        language: 'pt-BR',
        screen_height: '1080',
        screen_width: '1920',
        timezone_offset: '180',
        user_agent: navigator.userAgent
      },
      origin: window.location.origin,
      ip_address: '192.168.1.100'
    }
  })
});

// Se retornar status 'requires_action', redirecione para authentication_url
if (order.status === 'requires_action') {
  window.location.href = order.three_d_secure.authentication_url;
}

Próximos Passos

Após criar um pedido:

Configurar webhooks para notificações em tempo real
Consultar detalhes do pagamento
Processar estornos quando necessário
Consultar recebedores do split

Integração com Keranos Criar Assinatura

​Parâmetros Obrigatórios

​Parâmetros Opcionais

​Dados do Cliente

​Dados do Pagamento

​Pagamento com Cartão de Crédito

​Pagamento PIX

​Pagamento com Boleto

​Pagamento com Google Pay

​Pagamento com Apple Pay

​Split de Pagamento

​3D Secure (3DS)

​Itens do Pedido

​Estrutura da Resposta

​Campos do Pedido (Order)

​Campos do Pagamento (Payment)

​Campos Específicos de Cartão (quando payment_method = credit_card)

​Campos Específicos de Apple Pay (quando payment_method = apple_pay)

​Campos de Taxas (Fee)

​Exemplos de Requisição

​Pagamento com Cartão

​Requisição

​Resposta

​Pagamento PIX

​Requisição

​Resposta

​Pagamento Apple Pay

​Requisição

​Resposta

​Venda com Split

​Requisição

​Resposta

​Códigos de Erro

​Regras de Negócio

​Valores e Limites

​Split de Pagamentos

​Como Funciona

​Regras de Split

​Tipos de Split

​Configuração de Taxas

​Exemplo Prático de Split

​3D Secure (3DS)

​Quando Usar

​Implementação Básica

​Próximos Passos

Parâmetros Obrigatórios

Parâmetros Opcionais

Dados do Cliente

Dados do Pagamento

Pagamento com Cartão de Crédito

Pagamento PIX

Pagamento com Boleto

Pagamento com Google Pay

Pagamento com Apple Pay

Split de Pagamento

3D Secure (3DS)

Itens do Pedido

Estrutura da Resposta

Campos do Pedido (Order)

Campos do Pagamento (Payment)

Campos Específicos de Cartão (quando `payment_method = credit_card`)

Campos Específicos de Apple Pay (quando `payment_method = apple_pay`)

Campos de Taxas (Fee)

Exemplos de Requisição

Pagamento com Cartão

Requisição

Resposta

Pagamento PIX

Requisição

Resposta

Pagamento Apple Pay

Requisição

Resposta

Venda com Split

Requisição

Resposta

Códigos de Erro

Regras de Negócio

Valores e Limites

Split de Pagamentos

Como Funciona

Regras de Split

Tipos de Split

Configuração de Taxas

Exemplo Prático de Split

3D Secure (3DS)

Quando Usar

Implementação Básica

Próximos Passos