Skip to main content
POST
A cada compra, quando o cliente toca no botão Apple Pay, o Apple Pay JS dispara o evento onvalidatemerchant e pede uma sessão de merchant. O seu front-end chama esta rota com a validationURL recebida da Apple e o hostname da página, e repassa a resposta para session.completeMerchantValidation(). Sem esse passo, a folha de pagamento não abre.
Para o negócio: esta é a única chamada do fluxo feita pelo navegador do cliente. Ela usa a chave pública, que pode ficar no código do site. A cobrança continua sendo criada pelo seu backend, com a chave secreta.

Autenticação com a chave pública

Esta rota usa Basic com a chave pública (pk_ em produção ou pk_test_ no Modo Teste) como usuário e senha vazia: Authorization: Basic base64("pk_...:"). A chave secreta (sk_) não deve ir para o navegador.
  • A conta dona da chave pública precisa estar ativa.
  • A sessão é sempre validada no provedor real, mesmo com pk_test_, porque a folha do Safari só abre com uma sessão real. A cobrança feita depois com a chave de teste cai no ambiente de teste.

Quando usar

Antes de chamar

  • O hostname da página está registrado e verified na conta da chave pública (Registrar domínio e Validar domínio).
  • A conta já registrou pelo menos um domínio. Sem nenhum, a API responde 422 APPLE_PAY_PROVIDER_NOT_ENABLED.

Corpo da requisição

string
required
O valor de event.validationURL recebido no onvalidatemerchant. Precisa ser https, com host apple.com ou um subdomínio dele, sem porta e com até 2048 caracteres. Repasse sem alterar.
string
required
O hostname da página, window.location.hostname, com até 255 caracteres. Precisa ser um domínio registrado e verificado na conta da chave pública. Ex.: checkout.minhaloja.com.br.

Respostas

A resposta 200 é o objeto de sessão de merchant da Apple. Ele é opaco: não leia nem altere os campos. Repasse o objeto inteiro, como veio, para session.completeMerchantValidation(). Os erros APPLE_PAY_* vêm no formato { "code": "...", "message": "..." }, sem statusCode. Erros de validação de campo vêm como { "statusCode": 400, "message": [...], "error": "Bad Request" }. Em qualquer erro, chame session.abort() e ofereça outra forma de pagamento.

Erros comuns

O exemplo 200 mostra a forma usual da sessão da Apple, com valores omitidos. O conteúdo é definido pela Apple e pode mudar: trate o objeto como opaco.

Veja também

Guia de Apple Pay

Fluxo completo no navegador e no backend.

Criar uma cobrança

Envio do token em paymentMethod.wallet.

Credenciais e ambientes

Onde obter a chave pública.

Listar domínios

Confira os domínios verificados.