A API Verification of Payee
Uma chamada REST em tempo real para confirmar o nome de um beneficiário face a um IBAN — resultado, BIC do banco respondente e tempo de processamento na resposta. Construída sobre a plataforma RoxPay e o esquema SEPA VoP.
{ "Name": "ACME Trading Ltd", "Iban": "DE89 3704 0044 0532 0130 00" }
{ "VopResult": "MATCH", "MatchType": "MTCH", "RespondingBic": "CRACIT33XXX" }
A verificação do beneficiário num único pedido
A API Verification of Payee expõe o esquema SEPA VoP como um endpoint REST limpo: envie um nome e um IBAN, receba um resultado padronizado em tempo real — sem ter de construir você mesmo a canalização do esquema.
É a mesma verificação que a RoxPay executa dentro da sua plataforma bancária SwiftLine / RoxBusiness, disponível para bancos, PSP e empresas através de uma API autenticada e de um painel. Cada resposta inclui o tipo de correspondência, o BIC da instituição respondente e o tempo de processamento do PSP.
Como é entregue sobre a infraestrutura europeia de open banking da RoxPay, liga-se uma vez e alcança a verificação do beneficiário em toda a SEPA — em vez de se integrar com cada banco respondente.
De zero a verificado em quatro passos
Uma integração REST padrão que se encaixa no seu fluxo de pagamento existente.
Obtenha as suas credenciais
Ative o serviço e autentique-se com um bearer token — sem onboarding banco a banco para gerir.
Envie nome + IBAN
Envie por POST o nome e o IBAN do beneficiário para o endpoint de verificação, com um id de referência opcional para a reconciliação.
Leia o resultado
Receba o resultado (correspondência / parcial / nenhuma / não aplicável), o BIC respondente e o tempo de processamento.
Aja na sua UI
Mostre um sinal claro ao pagador, ou condicione ao resultado uma remessa, um mandato ou um passo de onboarding.
O que a API devolve
Cada resposta corresponde a um código do esquema SEPA VoP, pelo que a sua lógica se mantém simples.
MATCH · MTCH
O nome corresponde ao titular da conta. A resposta também traz o BIC do banco respondente.
CLOSE_MATCH · CMTC
Correspondência parcial — trate-a como um aviso e sugira o nome verificado.
NO_MATCH · NMTC
O nome não corresponde. Mostre um aviso claro antes de o pagamento ser confirmado.
NOT_APPLICABLE · NOAP
Verificação não disponível para este IBAN agora. Deixe o utilizador decidir.
Construir a VoP sozinho vs. a API
O que evita ao chamar um endpoint em vez de aderir ao esquema sozinho.
Desenvolvimento interno
- Conectividade ao esquema Integração por PSP respondente
- Tempo até produção Meses
- Detalhe da resposta Você normaliza-a
- Reutilização entre produtos Recablar cada fluxo
- Manutenção A seu cargo
API Verification of Payee
- Conectividade ao esquema Uma ligação, alcance SEPA
- Tempo até produção Semanas
- Detalhe da resposta Resultado padronizado + BIC + tempos
- Reutilização entre produtos Uma API para UI, lote e mandatos
- Manutenção Tratada pela plataforma
Uma API, três públicos
O mesmo endpoint resolve necessidades muito diferentes.
Bancos e PSP
Ofereça a Verification of Payee aos titulares de contas e cumpra o Regulamento de Pagamentos Instantâneos sem construir a conectividade ao esquema.
Programadores
Um contrato REST previsível, respostas em tempo real, os seus próprios id de referência e códigos de esquema claros para ramificar.
Empresas e ERP
Verifique em massa os IBAN de fornecedores e salários antes de uma remessa, reduzindo o risco de desvio de faturas.
A API, respondida
As primeiras perguntas de programadores e equipas de produto.
Sim. Uma chamada de verificação responde de forma síncrona, normalmente em muito menos de um segundo, e inclui o BIC do banco respondente e o tempo de processamento do PSP para monitorizar o desempenho.
As chamadas são autenticadas com um bearer token sobre HTTPS. Também pode usar o painel RoxBusiness para verificações pontuais sem escrever código.
Um resultado normalizado (MATCH, CLOSE_MATCH, NO_MATCH, NOT_APPLICABLE), o código de tipo de correspondência do esquema SEPA, um id de verificação, o BIC respondente, o tempo de processamento e o seu id externo opcional.
Sim — chame o endpoint por registo para verificar um ficheiro inteiro de fornecedores ou beneficiários antes de uma remessa. Está construída para alto débito.
Sim. A verificação compara o nome submetido com o titular da conta registado, seja uma pessoa singular ou uma empresa, e é usada no fluxo de mandatos SEPA Direct Debit da RoxPay como pré-verificação.
NO_MATCH não é um erro de transporte — é uma resposta 200 válida que indica que o nome não pertence ao IBAN. Trate-a como uma paragem firme na sua UI ou remessa: mostre um aviso claro, bloqueie a aprovação automática e faça reverificar o beneficiário antes do envio.
CLOSE_MATCH (código de esquema CMTC) significa que o nome está quase certo — falta um nome do meio, uma razão social vs um nome comercial. A resposta traz o nome verificado do titular, pelo que pode mostrá-lo como sugestão e pedir confirmação ao pagador em vez de rejeitar o pagamento.
Para pessoas coletivas o esquema permite a verificação face ao identificador da organização além do nome. Submete o identificador no pedido e a API devolve o resultado padrão — útil quando a razão social e o nome comercial diferem.
Sim. Para uma remessa, percorra o seu ficheiro de fornecedores ou salários e chame o endpoint de verificação por registo antes de libertar o lote. Construída para alto débito, permite às equipas financeiras validar em massa os IBAN face aos nomes antes de cada remessa.
Integre a Verification of Payee
Obtenha as suas credenciais e entre em produção no esquema SEPA VoP com uma única integração REST.