Links de pagamento

Buscar sessão de pagamento

Retorna os dados de uma sessão de checkout ativa, como produtos disponíveis e formas de pagamento.

GET/v1/checkout-sessions/:id

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

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

Authorizations

bearer

Authorization

string obrigatório

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

Escopos requeridos

checkouts/read

Path Parameters

idstringobrigatório

ID da sessão de checkout (ex: cs_xxx) - required

← Anterior

Criar sessão de pagamento

Gerar cobrança PIX

const url = 'https://sandbox.validapay.com.br/v1/checkout-sessions/:id';

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {{token}}'
  },
};

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

Response Examples

200▾

JSON

{
  "id": "cs_xxx", 
  "status": "active", 
  "allowedPaymentMethods": ["pix", "creditcard", "boleto"], 
  "companyName": "Minha Empresa", 
  "pathLogo": "customer-logo/123456", 
  "publicId": "2f78cfce-e0bd-4a1e-ae70-5d9bd808f1ee", 
  "cardProvider": "MAL", 
  "threeDsRequired": false, 
  "internationalEnabled": false, 
  "locale": "pt-BR", 
  "customer": { 
    "name": "João Silva",
    "email": "joao@email.com",
    "documentNumber": "12345678901",
    "phone": "51999999999"
  },
  "items": [ 
    {
      "priceId": "price_xxx",
      "productId": "prod_xxx",
      "product": { "productId": "prod_xxx", "name": "Plano Premium", "type": "RECURRING", "pathImage": null },
      "title": "Mensal",
      "description": null,
      "amount": 99.90,
      "compareAtPrice": null,
      "currency": "BRL",
      "quantity": 1,
      "discounts": [],
      "pixDiscount": null,
      "priceSchedule": null,
      "recurrenceType": "MONTHLY",
      "recurrenceInterval": 1,
      "chargeType": "B2C",
      "trialDays": null,
      "statementDescriptor": "Plano Premium"
    }
  ],
  "chargeId": "cha_xxx", 
  "transactionId": "5f8a1c2e-0000-4000-8000-000000000000", 
  "pix": { 
    "emv": "00020101021226910014br.gov.bcb.pix2569qrcode...",
    "base64": "data:image/png;base64,iVBORw0KGgo..."
  },
  "boleto": { 
    "digitableLine": "23793381286000782184950000000000000000000000",
    "barCode": "23791234500000019900000000000000000000000000",
    "dueDate": "2026-07-30",
    "emv": "00020101021226910014br.gov.bcb.pix2569qrcode...",
    "base64": "data:image/png;base64,iVBORw0KGgo..."
  },
  "billingDay": null, 
  "prorataStartDate": null, 
  "prorataEndDate": null, 
  "prorataAmount": null, 
  "mergeWithNextCycle": false, 
  "mergedAmount": null, 
  "installments": null, 
  "maxInstallments": null, 
  "freeInstallments": 1, 
  "passFeesToCustomer": false, 
  "boletoDueDays": null, 
  "expirationAfterDueDate": null, 
  "boletoInstructions": null, 
  "pixInstructions": null, 
  "discounts": null, 
  "orderBumps": null, 
  "primaryColor": null, 
  "secondaryColor": null, 
  "fontColor": null, 
  "metadata": null, 
  "redirectAfterPaymentUrl": "https://meusite.com/obrigado", 
  "successUrl": null, 
  "failureUrl": null, 
  "successMessage": null, 
  "termsOfServiceUrl": null, 
  "privacyPolicyUrl": null, 
  "cancelUrl": null, 
  "description": null, 
  "failureMessage": null, 
  "statementDescriptor": null, 
  "createdAt": "2026-07-14T21:39:36.322Z", 
  "updatedAt": "2026-07-14T21:39:36.322Z" 
}

Campos da resposta

idstring

Identificador da sessão

statusstring

active aceita pagamento, completed já foi paga, expired passou dos 30 dias

Valores aceitos:activecompletedexpired

allowedPaymentMethodsarray[3]

Formas de pagamento exibidas no checkout

Valores aceitos:pixcreditcardboletopix_automatico

companyNamestring

Nome exibido no topo do checkout

pathLogostring

Caminho do logo da conta

publicIdstring

Identificador público da conta, usado na tokenização do cartão

cardProviderstring

Adquirente de cartão da conta

threeDsRequiredboolean

Exige autenticação 3DS no cartão

internationalEnabledboolean

Aceita comprador de fora do Brasil

localestring

Idioma do checkout

customerobject

Dados do cliente pré-preenchidos na criação, ou null

itemsarray[1]

Itens cobrados na sessão

chargeIdstring

Só aparece quando há Pix ou boleto emitido e ainda não pago

transactionIdstring

Identificador da transação no provedor, quando há cobrança emitida

pixobject

Só aparece quando há um Pix emitido e ainda não pago: reabrir o link devolve o mesmo código

boletoobject

Só aparece quando há um boleto emitido e ainda não pago

billingDayobject

Dia do mês das cobranças recorrentes

Regra:1 a 31

prorataStartDateobject

Início do cálculo de pró-rata

prorataEndDateobject

Fim do período de pró-rata

prorataAmountobject

Valor pró-rata calculado

mergeWithNextCycleboolean

Junta a cobrança pró-rata com o próximo ciclo

mergedAmountobject

Soma do pró-rata com o ciclo, quando mergeWithNextCycle é true

installmentsobject

Parcelas fixas definidas na criação

Regra:1 a 12

maxInstallmentsobject

Limite de parcelas exibido

Regra:1 a 12

freeInstallmentsnumber

Parcelas sem juros

Regra:0 a 12

passFeesToCustomerboolean

Repassa as taxas ao cliente

boletoDueDaysobject

Dias até o vencimento do boleto

Regra:1

expirationAfterDueDateobject

Dias após o vencimento em que o boleto ainda aceita pagamento

Regra:0 a 60

boletoInstructionsobject

Multa, juros e desconto do boleto

pixInstructionsobject

Desconto por antecipação no Pix

discountsobject

Descontos aplicados à sessão

orderBumpsobject

Ofertas adicionais exibidas no checkout

primaryColorobject

Cor primária em hex

secondaryColorobject

Cor secundária em hex

fontColorobject

Cor do texto em hex

metadataobject

Objeto livre informado na criação

redirectAfterPaymentUrlstring

Redireciona sozinho após o pagamento ser confirmado

Regra:uri

successUrlobject

Redireciona após pagamento aprovado

Regra:uri

failureUrlobject

Redireciona após pagamento recusado

successMessageobject

Mensagem exibida após o pagamento

termsOfServiceUrlobject

Termos de serviço exibidos para aceite

Regra:uri

privacyPolicyUrlobject

Política de privacidade exibida para aceite

Regra:uri

cancelUrlobject

Sempre null na sessão; existe no link de pagamento

Regra:uri

descriptionobject

Texto de apoio exibido no checkout

failureMessageobject

Mensagem exibida quando o pagamento falha

statementDescriptorobject

Texto exibido na fatura do cartão

createdAtstring

Criação da sessão

updatedAtstring

Última atualização

404▾

JSON

{
    "error": {
        "message": "Sessão não encontrada",
        "code": "SESSION_NOT_FOUND",
        "details": null,
        "timestamp": "2026-07-14T21:39:36.322Z"
    }
}

← Anterior

Criar sessão de pagamento

Gerar cobrança PIX