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.
Na prática, chama-a no momento em que um beneficiário é criado ou um pagamento está prestes a sair: um checkout, um registo de fornecedor, uma ordem de pagamento. A resposta chega de forma síncrona, pelo que pode mostrar ao pagador o nome verificado - ou travar o pagamento - antes de este ser enviado.
É 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.
Se procura uma API Confirmation of Payee, é a mesma verificação com o nome europeu: Confirmation of Payee (CoP) é o esquema britânico e Verification of Payee (VoP) é o esquema EPC usado em toda a UE e no espaço SEPA. O pedido e os quatro resultados seguem a mesma lógica, pelo que as equipas que já trabalham com CoP reconhecem o contrato de imediato.
Em resumo: é um único endpoint REST autenticado. Envia por POST o nome do beneficiário e um IBAN e recebe de volta um resultado de correspondência, o código do esquema SEPA, o BIC do banco respondente e o tempo de processamento. Não há sessão para manter, nem URL de callback para alojar, nem integração banco a banco para construir.
Como integrar a API Verification of Payee no seu fluxo de pagamento
Uma integração REST padrão que se encaixa no seu fluxo de pagamento existente - das credenciais a uma verificação em produção em cinco passos.
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.
Ramifique consoante o resultado
Avance em MATCH, mostre o nome sugerido e peça confirmação em CLOSE_MATCH, bloqueie a aprovação automática em NO_MATCH e deixe o pagador decidir em NOT_APPLICABLE.
Aja na sua UI
Mostre um sinal claro ao pagador, ou condicione ao resultado uma remessa, um mandato ou um passo de onboarding.
Onde a chamada se encaixa num fluxo de pagamento real
O endpoint não guarda estado, pelo que a mesma chamada serve qualquer passo em que os dados do beneficiário são recolhidos ou reutilizados - incluindo verificar beneficiários no onboarding e de novo no momento do pagamento.
Onboarding do beneficiário
Verifique o IBAN de um vendedor, fornecedor ou colaborador no momento em que é adicionado e guarde o nome verificado junto do registo.
Checkout e pagamentos pontuais
Chame a API enquanto o pagador ainda está no ecrã, para que uma divergência seja detetada antes da autorização.
Remessas e pagamentos em massa
Percorra o ficheiro e verifique cada beneficiário antes de libertar o lote, retendo apenas as exceções.
Reverificar antes do pagamento
Verifique de novo imediatamente antes de o dinheiro sair - é nos dados bancários alterados após o onboarding que se esconde a fraude de desvio de pagamentos.
Como usar a API para a verificação de conta em tempo real
Um contrato síncrono de pedido/resposta, pelo que a resposta está disponível enquanto o pagador ainda está a decidir.
Síncrona por conceção
A chamada de verificação responde no mesmo pedido - normalmente bem abaixo de um segundo - pelo que não são necessários polling, webhooks ou filas.
Tempos na resposta
Cada resposta inclui o tempo de processamento do PSP, para poder monitorizar a latência e criar alertas como faria com qualquer outra API.
Pensada para pagamentos instantâneos
A verificação cabe dentro da janela dos pagamentos instantâneos SEPA, pelo que nunca se torna o motivo de um pagamento atrasar.
Repetições idempotentes
Envie um id externo estável em cada chamada, para que uma repetição não crie uma verificação duplicada e cada resultado seja rastreável.
Uma chamada, uma resposta
A verificação de conta em tempo real é simplesmente enviar por POST o nome + IBAN e ler o resultado: sem sessão, sem URL de callback e sem estado a manter entre chamadas.
Verificações de beneficiários em massa sem atingir limites de frequência
Para ficheiros de pagamento com milhares de beneficiários, a verificação é uma chamada por registo, ao ritmo que definir - pelo que um ficheiro grande é uma questão de débito, não um bloqueio.
Uma chamada por registo
Percorra o seu ficheiro de beneficiários e chame o endpoint de verificação para cada beneficiário - o contrato é o mesmo quer envie um registo ou dez mil.
Débito dimensionado consigo
A API está construída para alto débito e é você que regula o ciclo conforme a sua janela de libertação, em vez de ficar limitado pelo onboarding banco a banco.
Recolher e depois libertar
Reúna os resultados de todo o ficheiro, liberte automaticamente as correspondências e encaminhe as correspondências parciais e as não correspondências para uma fila de revisão humana.
Reutilizar o nome verificado
Guarde o nome verificado do titular no registo do beneficiário, para que remessas posteriores o possam comparar e assinalar alterações silenciosas.
Marketplaces, salários e contas a pagar
O mesmo endpoint cobre o onboarding e o momento do pagamento - os dois instantes em que os dados do beneficiário estão mais expostos.
Marketplaces e plataformas
Verifique o IBAN de um vendedor quando adere à plataforma e verifique de novo antes de cada pagamento. Reverificar no momento do pagamento deteta dados bancários alterados após o onboarding, que é onde costuma acontecer a fraude de desvio de pagamentos. O mesmo endpoint serve os dois momentos, pelo que não precisa de uma verificação separada para o onboarding e para o pagamento.
Salários
Verifique os IBAN dos colaboradores quando são adicionados e de novo antes do dia de pagamento, para que um salário nunca seja enviado para uma conta que já não pertence ao colaborador.
Contas a pagar
Valide em massa os IBAN dos fornecedores face aos nomes antes de libertar uma remessa e retenha apenas os registos que voltam como correspondência parcial ou nenhuma correspondência.
Tesouraria e ERP
Chame a API a partir do seu ERP ou sistema de tesouraria, para que a verificação faça parte da preparação do ficheiro de pagamento e não seja um passo manual separado.
O que a API devolve: correspondência, parcial, nenhuma
Cada resposta corresponde a um código do esquema SEPA VoP, pelo que a sua lógica se mantém simples. Ramifique pelo código, não pelo texto.
MATCH · MTCH
O nome corresponde ao titular da conta. A resposta também traz o BIC do banco respondente. Avance com confiança.
CLOSE_MATCH · CMTC
Correspondência parcial - quase certa, por exemplo um nome comercial face a uma razão social. Mostre o nome verificado como sugestão e peça ao pagador que confirme.
NO_MATCH · NMTC
O nome não corresponde. Mostre um aviso claro antes de o pagamento ser confirmado e bloqueie a aprovação automática.
NOT_APPLICABLE · NOAP
Verificação não disponível para este IBAN neste momento. Informe o pagador e deixe-o 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
- Verificações de beneficiários em massa Constrói e regula o ciclo você mesmo
- Ambas as direções da VoP Pedido e resposta construídos em separado
- 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
- Verificações de beneficiários em massa Chamadas por registo dimensionadas à sua janela de libertação
- Ambas as direções da VoP Pedido e resposta numa única integração
- 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. O endpoint não guarda estado, pelo que pode chamá-lo sempre que um beneficiário é criado - um passo de onboarding de vendedor ou fornecedor - e de novo imediatamente antes de cada pagamento. Reverificar no momento do pagamento deteta dados bancários alterados após o onboarding, que é onde costuma acontecer a fraude de desvio de faturas e pagamentos.
A verificação é uma chamada REST por registo, pelo que um ficheiro de pagamento com milhares de beneficiários é tratado como um lote: percorra o ficheiro, chame o endpoint por registo e recolha os resultados antes de libertar a remessa. Como a API está construída para alto débito, pode regular o ciclo conforme a sua própria janela de libertação, em vez de ficar limitado pelo onboarding banco a banco. Fale connosco sobre os seus volumes e dimensionamos o débito consigo.
Sim. A mesma verificação está disponível no painel RoxBusiness, pelo que uma equipa financeira ou de operações pode verificar um único beneficiário - uma verificação de 'know your payee' antes de enviar dinheiro - enquanto os programadores usam a API para fluxos automatizados.
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 (por exemplo, a Partita IVA / Codice Fiscale italiana) além do nome. Envia o identificador no pedido e a API devolve o resultado padrão de correspondência - ú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.
Sim. Envia um pedido JSON com o nome e o IBAN do beneficiário e recebe o resultado, o nome verificado (numa correspondência parcial) e o BIC respondente. Veja um pedido e uma resposta completos no nosso exemplo de VoP, ou os payloads e códigos de esquema na documentação da API.
Trate a chamada de verificação como um passo adicional antes de o pagamento ser autorizado. Autentique-se com um bearer token, envie por POST o nome e o IBAN do beneficiário, leia o resultado e ramifique: avance em MATCH, mostre o nome sugerido e peça confirmação em CLOSE_MATCH, bloqueie a aprovação automática em NO_MATCH e deixe o pagador decidir em NOT_APPLICABLE. Como o endpoint não guarda estado, a mesma chamada encaixa no checkout, no onboarding de fornecedores, numa remessa ou num lote de pagamentos sem alterar os seus canais de pagamento.
É as duas coisas, consoante a tarefa. Como verificador de beneficiário, responde a 'a quem pertence este IBAN?' para um único beneficiário - útil para uma equipa financeira ou para quem paga antes de enviar dinheiro. Como API de validação de pagamentos, executa a mesma verificação dentro de um fluxo automatizado, pelo que cada pagamento ou transferência é validado face ao titular da conta antes de sair.
'Know your payee' é o hábito prático de confirmar o nome do titular da conta antes de pagar, em vez de confiar nos dados de uma fatura ou de um email. A API transforma esse hábito num passo automatizado: o nome é comparado com o IBAN e obtém uma resposta clara - correspondência, correspondência parcial, sem correspondência ou não possível - em muito menos de um segundo.
Confirmation of Payee (CoP) é o esquema britânico de verificação de nomes; Verification of Payee (VoP) é o esquema EPC usado em toda a UE e no espaço SEPA. Se precisar dos dois, procure um fornecedor que cubra o esquema SEPA VoP através de uma única integração e devolva os resultados normalizados, para que o seu código não mude de mercado para mercado. A RoxPay fornece a VoP como uma única API REST, com os códigos de esquema, o BIC respondente e o tempo de processamento em cada resposta.
Cinco coisas. Cobertura: que bancos e países o fornecedor consegue alcançar em toda a SEPA. Latência: se os resultados cabem de forma fiável na janela dos pagamentos instantâneos. Precisão: como a correspondência de nomes trata as correspondências parciais e os nomes comerciais face às razões sociais. Direções: se o pedido e a resposta da VoP passam pela mesma integração. E apoio: quem monitoriza o serviço e o que acontece quando um PSP respondente está inacessível. Peça por escrito o payload da resposta e os códigos de erro - dizem-lhe mais do que uma lista de funcionalidades.
Ramifique pelo código do esquema, não pelo rótulo apresentado. Na sua UI, trate MTCH como uma passagem silenciosa, CMTC como um aviso suave que mostra o nome sugerido e pede confirmação ao pagador, e NMTC como um aviso firme que bloqueia a aprovação automática. NOAP não é nenhum dos dois: significa que a verificação não pôde ser concluída, por isso diga ao pagador que a verificação não estava disponível e deixe-o decidir. Manter os quatro códigos separados no seu código é o que torna o comportamento dos avisos previsível.
Sim, e deve. O endpoint não guarda estado, pelo que a mesma chamada verifica um beneficiário quando o registo é criado - um passo de onboarding de vendedor, fornecedor ou colaborador - e de novo imediatamente antes de o dinheiro sair. Reverificar no momento do pagamento é o que deteta dados bancários alterados após o onboarding, que é onde costuma acontecer a fraude de desvio de pagamentos. Um único endpoint serve os dois momentos, pelo que não mantém duas verificações.
Sim. As credenciais de sandbox são emitidas separadamente das de produção, para que possa testar os fluxos de correspondência, correspondência parcial e sem correspondência contra a API antes de entrar em produção. As mesmas credenciais dão também acesso ao painel RoxBusiness, onde pode fazer verificações pontuais sem escrever código.
Recebe NOT_APPLICABLE (código de esquema NOAP) como uma resposta 200 válida, não como um erro de transporte. Significa que a verificação não pôde ser concluída para esse IBAN naquele momento. Trate-a como uma incógnita e não como uma falha: informe o pagador de que a verificação não estava disponível e deixe-o decidir se quer continuar. As falhas técnicas reais usam códigos de estado 4xx e 5xx com um código de erro legível por máquina.
Continue a ler
Integre a Verification of Payee
Obtenha as suas credenciais e entre em produção no esquema SEPA VoP com uma única integração REST.