# UvviPay Public API

> Documentação pública da API UvviPay para integradores externos.

## Docs

- [Obter resultados 3DS](https://developers.uvvipay.com.br/api-reference/3ds/authentication-results.md): Obtém o resultado final da autenticação 3DS após o challenge. Aceita header CLIENT-ID (integração API) ou PAYMENT-LINK-ID (checkout do link de pagamento).
- [Iniciar autenticação 3DS](https://developers.uvvipay.com.br/api-reference/3ds/authentications.md): Inicia a autenticação 3DS. Chamado pelo script 3ds.js. Aceita header CLIENT-ID (integração API) ou PAYMENT-LINK-ID (checkout do link de pagamento, sem merchant_credentials). O access token vem de /v1/3ds/generateToken ou /v1/3ds/generate-token.
- [Gerar token 3DS](https://developers.uvvipay.com.br/api-reference/3ds/generate-token.md): Gera o access token JWT necessário para iniciar o fluxo de autenticação 3DS.
- [Script JS 3DS (CDN)](https://developers.uvvipay.com.br/api-reference/3ds/script.md): Script oficial para embarcar o fluxo 3DS no front-end (API com CLIENT-ID ou checkout de payment link com PAYMENT-LINK-ID)
- [Guardar cartão no Cofre](https://developers.uvvipay.com.br/api-reference/card-tokenization/tokenize.md): Guarda um cartão de crédito no Cofre para o customer informado. Requer o produto `tokenization` habilitado. Se já existir um token ativo para o mesmo customer e cartão, retorna o `cardTokenId` existente (HTTP 201).
- [Ativar certificado](https://developers.uvvipay.com.br/api-reference/certificates/activate.md): Ativa o certificado com o arquivo emitido pela autoridade (ex.: apple_pay.cer). Só é aceito um certificado criado a partir do CSR emitido neste registro — a chave pública precisa corresponder ao par sob nossa custódia.
- [Emitir CSR](https://developers.uvvipay.com.br/api-reference/certificates/issue.md): Gera um par de chaves sob custódia da UvviPay e devolve o CSR (signingRequestPem) para você levar à autoridade certificadora (Apple). O registro nasce com status issued. Nenhuma chave privada cruza esta API.
- [Listar certificados](https://developers.uvvipay.com.br/api-reference/certificates/list.md): Lista os certificados da organização com status, validade e fingerprint — a tabela de referência dos seus certificados.
- [Revogar certificado](https://developers.uvvipay.com.br/api-reference/certificates/revoke.md): Revoga o certificado — deixa de valer para novas transações. Idempotente.
- [Registrar domínio](https://developers.uvvipay.com.br/api-reference/payment-method-domains/create.md): Registra um domínio do merchant para exibir carteiras digitais na web (Apple Pay hoje; Google Pay futuramente). O domínio nasce com status pending e passa a verified quando a verificação da carteira conclui — para Apple Pay, isso exige hospedar o arquivo de associação em /.well-known/apple-developer…
- [Listar domínios](https://developers.uvvipay.com.br/api-reference/payment-method-domains/list.md): Lista os domínios registrados pelo merchant e os respectivos status de verificação.
- [Verificar domínio](https://developers.uvvipay.com.br/api-reference/payment-method-domains/validate.md): Dispara a verificação do domínio junto à carteira (Apple Pay): registramos o domínio na Apple, que busca o arquivo de verificação em https://<dominio>/.well-known/apple-developer-merchantid-domain-association no ato. Sucesso = status verified de fato; falha fica registrada em lastVerificationError e…
- [Validar sessão Apple Pay (web)](https://developers.uvvipay.com.br/api-reference/payments/apple-pay-validate-merchant.md): Merchant validation do Apple Pay on the Web, server-to-server: repasse o validationURL do evento onvalidatemerchant e devolva o merchant session retornado ao ApplePaySession. Aceita apenas domínios com status verified em /v1/payment-method-domains.
- [Criar pagamento](https://developers.uvvipay.com.br/api-reference/payments/create.md): Cria um novo pagamento (PIX, cartão de crédito ou boleto). Valores sempre em centavos.
- [Consultar pagamento](https://developers.uvvipay.com.br/api-reference/payments/get.md): Consulta o status e detalhes de um pagamento pelo ID.
- [Estornar pagamento](https://developers.uvvipay.com.br/api-reference/payments/refund.md): Processa o estorno **total** de um pagamento. O valor estornado é sempre o valor integral da transação original.
- [Ativar plano](https://developers.uvvipay.com.br/api-reference/recurrency/plans/activate.md): Ativa um plano de assinatura.
- [Criar plano](https://developers.uvvipay.com.br/api-reference/recurrency/plans/create.md): Cria um novo plano de assinatura.
- [Desativar plano](https://developers.uvvipay.com.br/api-reference/recurrency/plans/deactivate.md): Desativa um plano de assinatura.
- [Consultar plano](https://developers.uvvipay.com.br/api-reference/recurrency/plans/get.md): Retorna os detalhes de um plano de assinatura.
- [Listar planos](https://developers.uvvipay.com.br/api-reference/recurrency/plans/list.md): Lista todos os planos de assinatura da sua conta.
- [Atualizar plano](https://developers.uvvipay.com.br/api-reference/recurrency/plans/update.md): Atualiza um plano de assinatura existente.
- [Cancelar assinatura](https://developers.uvvipay.com.br/api-reference/recurrency/subscriptions/cancel.md): Cancela uma assinatura.
- [Criar assinatura](https://developers.uvvipay.com.br/api-reference/recurrency/subscriptions/create.md): Cria uma nova assinatura.
- [Consultar assinatura](https://developers.uvvipay.com.br/api-reference/recurrency/subscriptions/get.md): Retorna os detalhes de uma assinatura.
- [Listar assinaturas](https://developers.uvvipay.com.br/api-reference/recurrency/subscriptions/list.md): Lista todas as assinaturas da sua conta.
- [Reativar assinatura](https://developers.uvvipay.com.br/api-reference/recurrency/subscriptions/reactivate.md): Reativa uma assinatura cancelada.
- [Atualizar método de pagamento](https://developers.uvvipay.com.br/api-reference/recurrency/subscriptions/update-payment-method.md): Atualiza o método de pagamento de uma assinatura.
- [Criar subconta](https://developers.uvvipay.com.br/api-reference/submerchants/create.md): Cria uma nova subconta vinculada ao merchant autenticado. Aceita upload de documentos via multipart/form-data (arquivos binários; base64 não é aceito). Os documentos obrigatórios variam conforme o documentType — consulte a descrição de cada campo.
- [Gerar link de onboarding](https://developers.uvvipay.com.br/api-reference/submerchants/create-onboarding-link.md): Retorna o link de onboarding ativo da organização. Se não houver link ativo (ou o ativo estiver expirado), cria um novo e retorna a URL com token. Requer produto PaaS habilitado.
- [Buscar subconta](https://developers.uvvipay.com.br/api-reference/submerchants/get.md): Retorna os detalhes completos de uma subconta pelo internalId.
- [Consultar saldo](https://developers.uvvipay.com.br/api-reference/submerchants/get-balance.md): Retorna o saldo agregado da subconta com os campos: identificador interno (internalId), disponível (available), agendado (scheduled) e reserva financeira (financialReserved). Todos os valores monetários são retornados em centavos.
- [Consultar conta bancária](https://developers.uvvipay.com.br/api-reference/submerchants/get-bank-account.md): Retorna a conta bancária ou chave PIX cadastrada na subconta.
- [Consultar taxas](https://developers.uvvipay.com.br/api-reference/submerchants/get-fees.md): Retorna as taxas atualmente aplicadas à subconta.
- [Consultar link de onboarding](https://developers.uvvipay.com.br/api-reference/submerchants/get-onboarding-link.md): Retorna o link de onboarding ativo da organização autenticada, ou null quando não houver link ativo. Requer produto PaaS habilitado.
- [Consultar status](https://developers.uvvipay.com.br/api-reference/submerchants/get-status.md): Retorna o status atual de uma subconta a partir do internalId.
- [Listar subcontas](https://developers.uvvipay.com.br/api-reference/submerchants/list.md): Retorna a lista paginada de subcontas vinculadas ao merchant autenticado, com filtros opcionais.
- [Solicitar alteração de dados bancários](https://developers.uvvipay.com.br/api-reference/submerchants/request-account-data-change.md): Cria uma solicitacao de alteracao dos dados da conta bancaria (ispb, bankName, codigo do banco, agencia, conta, digito verificador, tipo). Todos os campos sao obrigatorios. A alteracao fica pendente ate aprovacao.
- [Solicitar alteração de chave PIX](https://developers.uvvipay.com.br/api-reference/submerchants/request-pix-key-change.md): Cria uma solicitacao de alteracao da chave PIX da subconta. A alteracao fica pendente ate aprovacao.
- [Solicitar saque de subconta](https://developers.uvvipay.com.br/api-reference/submerchants/request-withdrawal.md): Cria uma solicitação de saque para a subconta informada (resolvida pelo internalId). Requer header x-idempotency-key.
- [Atualizar dados](https://developers.uvvipay.com.br/api-reference/submerchants/update.md): Atualiza dados cadastrais da subconta. Não permite alterar status ou dados bancários.
- [Atualizar taxas](https://developers.uvvipay.com.br/api-reference/submerchants/update-fees.md): Atualiza as taxas (payment, service, anticipation, reserved) aplicadas à subconta.
- [Criar webhook](https://developers.uvvipay.com.br/api-reference/webhooks/create.md): Cria um endpoint de webhook para o merchant autenticado. Informe `webhook_url` e `events` (ao menos um). Limite de 3 endpoints por conta.
- [Listar webhooks](https://developers.uvvipay.com.br/api-reference/webhooks/get.md): Lista os endpoints de webhook do merchant autenticado. Apenas endpoints com status `active` são retornados (um item por URL).
- [Atualizar webhook](https://developers.uvvipay.com.br/api-reference/webhooks/update.md): Atualiza a URL e os eventos de um endpoint de webhook existente. O id é o identificador retornado na listagem. `events` é obrigatório (ao menos um).
- [Apple Pay](https://developers.uvvipay.com.br/apple-pay.md): Aceite Apple Pay no seu app iOS ou no seu site processando os pagamentos pela UvviPay
- [Autenticação](https://developers.uvvipay.com.br/authentication.md): Como autenticar suas requisições na API pública da UvviPay
- [Cofre](https://developers.uvvipay.com.br/card-tokenization.md): Como guardar cartões de crédito no Cofre via API pública e obter um cardTokenId
- [Erros](https://developers.uvvipay.com.br/errors.md): Códigos HTTP e formato de erro retornado pela API
- [Introdução](https://developers.uvvipay.com.br/introduction.md): Visão geral da API pública UvviPay para subcontas, pagamentos, 3DS e Cofre
- [Pagamentos com Split](https://developers.uvvipay.com.br/pedidos-com-split.md): Divida o valor líquido de uma transação entre múltiplas subcontas (recebedores) no momento da criação do pagamento
- [Cobrança recorrente e assinaturas](https://developers.uvvipay.com.br/recurrency.md): Crie planos, assine clientes e automatize cobranças recorrentes (mensalidades, SaaS, clubes) com renovação, trial e webhooks na UvviPay.
- [Recusas de cartão](https://developers.uvvipay.com.br/recusas-de-cartao.md): Entenda por que uma transação de cartão é recusada, o que o campo refusedReason retorna e como orientar o seu cliente
- [Webhooks](https://developers.uvvipay.com.br/webhooks.md): Receba notificações em tempo real no contexto da sua organização registrando endpoints de webhook