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.

A resposta traz pix.emv (copia e cola) 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).

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.

POST/v1/charges

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

Authorizations

bearer

Authorization

string · header · required

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

Escopos requeridos

checkouts/write

Body

application/json

Content-Type:application/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",
    "phone": "+5511999998888"
  },
  "items": [
    {
      "priceId": "price_abc123",
      "quantity": 1
    }
  ],
  "billingDay": 15,
  "couponCode": "PROMO10",
  "metadata": { "referencia": "assinatura-001" },
  "description": "Assinatura Premium",
  "split": [
    { "type": "fixed", "accountNumber": "896532569", "amount": 0.10 }
  ],
  "installments": 1,
  "freeInstallments": 1,
  "passFeesToCustomer": false,
  "allowedPaymentMethods": ["pix", "creditcard"],
  "nfConfigId": "nfc_1788364755079_psuecwgdc",
  "notifications": ["oneoff.pix.generated", "new.sale"],
  "discounts": [
    {
      "type": "percentage",
      "value": 10,
      "paymentMethod": "pix",
      "fromCycle": 1,
      "toCycle": 3,
      "durationMonths": 3
    }
  ],
  "tokenId": "tok_abc123",
  "productId": "prod_123456_example",
  "recurrencyStartDate": "2026-10-01",
  "prorataStartDate": "2026-09-15",
  "prorataDueDate": "2026-09-20",
  "mergeWithNextCycle": false
}

Schema

paymentMethodstringRequired

Valores aceitos:pixcreditcardboletopix_automatico

Forma de pagamento (fixo: pix_automatico)

customerobjectRequired

Dados do comprador

items[1]arrayRequired

Itens da assinatura; o preço precisa ser recorrente

externalIdstringOptional

Regra:até 100 caracteres

Identificador único do pedido no seu sistema; usado como idempotencyKey (evita cobrança duplicada)

externalTxidstringOptional

Regra:até 100 caracteres

Identifica a loja, o caixa ou o vendedor responsável pela cobrança

billingDaynumberOptional

Regra:1 a 31

Dia do mês das cobranças seguintes (1 a 31)

couponCodestringOptional

Código de cupom de desconto

metadataobject

descriptionstringOptional

Descricao livre da cobranca

split[1]arrayOptional

Divisao do valor. Nao suportado em creditcard nem pix_automatico

installmentsnumberOptional

Regra:1 a 12

Parcelas no cartao, de 1 a 12

freeInstallmentsnumberOptional

Regra:0 a 12

Parcelas sem juros para o comprador, de 0 a 12

passFeesToCustomerbooleanOptional

Repassa a taxa de parcelamento ao comprador

allowedPaymentMethods[2]array

Valores aceitos:pixcreditcardboletopix_automatico

nfConfigIdstringOptional

Emite nota fiscal com esta configuracao. Exige customer.address

notifications[2]array

Valores aceitos:oneoff.pix.generatedoneoff.boleto.generatedoneoff.payment.successoneoff.payment.failednew.saleseller.charge.pending

discounts[1]arrayOptional

Descontos aplicados a cobranca

tokenIdstringOptional

Alternativa a card e a paymentMethodId no cartao

productIdstringOptional

Regra:^prod_

Cria a cobranca a partir de um produto

recurrencyStartDatestringOptional

Regra:^\d{4}-\d{2}-\d{2}$

Primeira cobranca da recorrencia (YYYY-MM-DD)

prorataStartDatestringOptional

Inicio do calculo pro rata

prorataDueDatestringOptional

Regra:^\d{4}-\d{2}-\d{2}$

Vencimento da cobranca pro rata (YYYY-MM-DD)

mergeWithNextCyclebooleanOptional

Junta a pro rata com o proximo ciclo em vez de cobrar agora

Headers

Name	Type	Value	Required
Content-Type	-	application/json	Optional

← Anterior

Gerar cobrança PIX

Gerar cobrança Boleto

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",
    "phone": "+5511999998888"
  },
  "items": [
    {
      "priceId": "price_abc123",
      "quantity": 1
    }
  ],
  "billingDay": 15,
  "couponCode": "PROMO10",
  "metadata": { "referencia": "assinatura-001" },
  "description": "Assinatura Premium",
  "split": [
    { "type": "fixed", "accountNumber": "896532569", "amount": 0.10 }
  ],
  "installments": 1,
  "freeInstallments": 1,
  "passFeesToCustomer": false,
  "allowedPaymentMethods": ["pix", "creditcard"],
  "nfConfigId": "nfc_1788364755079_psuecwgdc",
  "notifications": ["oneoff.pix.generated", "new.sale"],
  "discounts": [
    {
      "type": "percentage",
      "value": 10,
      "paymentMethod": "pix",
      "fromCycle": 1,
      "toCycle": 3,
      "durationMonths": 3
    }
  ],
  "tokenId": "tok_abc123",
  "productId": "prod_123456_example",
  "recurrencyStartDate": "2026-10-01",
  "prorataStartDate": "2026-09-15",
  "prorataDueDate": "2026-09-20",
  "mergeWithNextCycle": false
})
};

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

Response Examples

200200

{
  "success": true,
  "customerId": "cus_xxx",
  "chargeId": "cha_abc123",
  "pix": {
    "emv": "00020126330014br.gov.bcb.pix...5204000053039865802BR6304ABCD",
    "recurrencyId": "RN1234567890abcdef"
  }
}

400400 PIX_AUTOMATICO_PJ_ONLY

{
  "error": {
    "message": "Pix Automático está disponível apenas para contas PJ",
    "code": "PIX_AUTOMATICO_PJ_ONLY"
  }
}

400400 PIX_AUTOMATICO_MIN_AMOUNT

{
  "error": {
    "message": "Pix Automático exige valor mínimo de R$ 4,99",
    "code": "PIX_AUTOMATICO_MIN_AMOUNT"
  }
}

← Anterior

Gerar cobrança PIX

Gerar cobrança Boleto