Dashboard

Checkout Transparente

Gerar cobrança Pix Automático

Inicia uma assinatura com Pix Automático pelo checkout transparente. O cliente informa os dados na sua própria interface e você os envia para a API.

POST/v1/charges
Base URL Produção:https://api.validapay.com.br
Base URL Sandbox:https://sandbox.validapay.com.br

subscriptionId só vem quando a cobrança é recorrente. Esta rota cria cobranças avulsas e recorrentes. Com items de um preço recorrente, a resposta traz subscriptionId, o ID da assinatura criada. A cobrança avulsa (enviada com amount, ou com items só de preços de pagamento único) não é assinatura e não traz o campo: identifique-a por chargeId. A mesma regra vale para o webhook charge.created e para GET /v1/charges/{chargeId}, onde a avulsa vem com subscription: null.

A resposta traz pix.emv (copia e cola), pix.qrCode — a mesma imagem já renderizada como data URL PNG, pronta para um <img src> — e pix.recurrencyId.

Enquanto o banco do pagador não confirma a autorização, a assinatura fica com status PENDING.

Requisitos:

  • conta ValidaPay cadastrada como PJ (CNPJ)
  • items com preço recorrente (recurrenceType WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL ou YEARLY); não use amount avulso
  • valor mínimo de R$ 4,99 por cobrança

Notificações por e-mail: use notifications para escolher quais e-mails saem nesta cobrança. Eventos aceitos aqui: oneoff.payment.success (confirmação ao comprador quando o Pix compensa) e new.sale (avisa você, vendedor, da venda paga). Os eventos destinados ao comprador exigem customer.email. Sem o campo, uma cobrança avulsa (enviada com amount) não dispara e-mail nenhum; com items de um produto, vale a configuração de notificações do produto, e notifications no payload tem precedência sobre ela.

⚠️ Atenção: envie o campo externalId como chave de idempotência (idempotencyKey). Se duas cobranças forem enviadas com o mesmo externalId, a segunda é recusada com 409 DUPLICATE_CHARGE, retornando o chargeId da cobrança original.

Erros comuns: 400 PIX_AUTOMATICO_PJ_ONLY (conta PF), 400 PIX_AUTOMATICO_MIN_AMOUNT (valor abaixo do mínimo), 409 DUPLICATE_CHARGE (externalId já utilizado) e 404 PRICE_NOT_FOUND (preço inexistente). Esta rota não aceita split no Pix Automático (400 INVALID_DATA).

Use externalTxid para identificar a loja, o caixa ou o vendedor responsável pela cobrança.

Correlação com o pedido: use externalId — ele é persistido e devolvido. O campo metadata é aceito nesta rota mas não é gravado na cobrança nem volta no webhook; ele só é persistido em POST /v1/charges/pix.

Authorizations

bearer

Authorization

string obrigatório

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

charges/write

Body

application/json

Content-Type:application/json
JSON
{
  "paymentMethod": "pix_automatico",
  "externalId": "assinatura-2026-0001",
  "externalTxid": "loja-01-caixa-03",
  "customer": {
    "name": "João da Silva",
    "email": "joao@email.com",
    "documentNumber": "12345678901",  
    "metadata": { "origem": "site" },
    "phone": "+5511999998888",  
    "address": {
      "type": "BILLING",
      "street": "Av. Paulista",
      "number": "1000",
      "complement": "Apto 52",
      "neighborhood": "Bela Vista",
      "city": "Sao Paulo",
      "state": "SP",
      "zipCode": "01310100",
      "country": "BR",
      "cityCode": "3550308"
    }
  },
  "items": [
    {
      "priceId": "price_abc123",
      "quantity": 1,
      "isOrderBump": false
    }
  ],
  "billingDay": 15,
  "couponCode": "PROMO10",
  "metadata": { "referencia": "assinatura-001" },
  "allowedPaymentMethods": ["pix", "creditcard"],
  "nfConfigId": "nfc_1788364755079_psuecwgdc",
  "notifications": ["oneoff.pix.generated", "new.sale"],
  "discounts": [
    {
      "type": "percentage",
      "value": 10,
      "paymentMethod": "pix_automatico",
      "amount": 10.0,
      "couponCode": "PROMO10",
      "fromCycle": 1,
      "toCycle": 3,
      "durationMonths": 3
    }
  ],
  "cartId": "cart_2026_0001"
}

Schema

paymentMethodstringobrigatório
Forma de pagamento (fixo: pix_automatico)
Valores aceitos:pixcreditcardboletopix_automatico
customerobjectobrigatório
Dados do comprador
itemsarray[1]obrigatório
Itens da assinatura; o preço precisa ser recorrente
externalIdstringopcional
Identificador único do pedido no seu sistema; usado como idempotencyKey (evita cobrança duplicada)
Regra:até 100 caracteres
externalTxidstringopcional
Identifica a loja, o caixa ou o vendedor responsável pela cobrança
Regra:até 100 caracteres
billingDaynumberopcional
Dia do mês das cobranças seguintes (1 a 31)
Regra:1 a 31
couponCodestringopcional
Código de cupom de desconto
metadataobjectopcional
Objeto livre, aceita as chaves e valores que você quiser ("referência" é só exemplo); salvo na cobrança
allowedPaymentMethodsarray[2]opcional
Métodos aceitos quando a cobrança vira link
Valores aceitos:pixcreditcardboletopix_automatico
nfConfigIdstringopcional
Emite nota fiscal com esta configuração. Exige customer.address e customer.email
notificationsarray[2]opcional
E-mails disparados nesta cobrança
Valores aceitos:oneoff.pix.generatedoneoff.boleto.generatedoneoff.payment.successoneoff.payment.failednew.saleseller.charge.pending
discountsarray[1]opcional
Descontos aplicados a cobrança
cartIdstringopcional
Agrupa numa única compra as assinaturas criadas juntas e deduplica o evento de conversão

Headers

Content-Typeopcional
application/json
const url = 'https://sandbox.validapay.com.br/v1/charges';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "paymentMethod": "pix_automatico",
  "externalId": "assinatura-2026-0001",
  "externalTxid": "loja-01-caixa-03",
  "customer": {
    "name": "João da Silva",
    "email": "joao@email.com",
    "documentNumber": "12345678901",  
    "metadata": { "origem": "site" },
    "phone": "+5511999998888",  
    "address": {
      "type": "BILLING",
      "street": "Av. Paulista",
      "number": "1000",
      "complement": "Apto 52",
      "neighborhood": "Bela Vista",
      "city": "Sao Paulo",
      "state": "SP",
      "zipCode": "01310100",
      "country": "BR",
      "cityCode": "3550308"
    }
  },
  "items": [
    {
      "priceId": "price_abc123",
      "quantity": 1,
      "isOrderBump": false
    }
  ],
  "billingDay": 15,
  "couponCode": "PROMO10",
  "metadata": { "referencia": "assinatura-001" },
  "allowedPaymentMethods": ["pix", "creditcard"],
  "nfConfigId": "nfc_1788364755079_psuecwgdc",
  "notifications": ["oneoff.pix.generated", "new.sale"],
  "discounts": [
    {
      "type": "percentage",
      "value": 10,
      "paymentMethod": "pix_automatico",
      "amount": 10.0,
      "couponCode": "PROMO10",
      "fromCycle": 1,
      "toCycle": 3,
      "durationMonths": 3
    }
  ],
  "cartId": "cart_2026_0001"
})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200▾
JSON
{
  "success": true,
  "customerId": "cus_xxx",
  "chargeId": "cha_abc123",
  "subscriptionId": "sub_1790920815522_46aumd4fa", 
  "pix": {
    "emv": "00020126330014br.gov.bcb.pix...5204000053039865802BR6304ABCD",
    "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASIAAAEiAQAAAAB1xeIbAAAB...",
    "recurrencyId": "RN1234567890abcdef"
  }
}

Campos da resposta

successboolean
customerIdstring
chargeIdstring
subscriptionIdstringopcional
Só em cobrança recorrente: ID da assinatura criada. Ausente na cobrança avulsa
pixobject
400PIX_AUTOMATICO_PJ_ONLY▾
JSON
{
  "error": {
    "message": "Pix Automático está disponível apenas para contas PJ",
    "code": "PIX_AUTOMATICO_PJ_ONLY"
  }
}
400PIX_AUTOMATICO_MIN_AMOUNT▾
JSON
{
  "error": {
    "message": "Pix Automático exige valor mínimo de R$ 4,99",
    "code": "PIX_AUTOMATICO_MIN_AMOUNT"
  }
}

← Anterior

Gerar cobrança PIX

Próximo →

Gerar cobrança Boleto