O mesmo envelope de sempre
Se já utiliza a API da Wealthreader, a MyBankMatch responde com a mesma estrutura e os mesmos hábitos de integração.
Programadores
A MyBankMatch é um ponto de acesso da API da Wealthreader: HTTPS, parâmetros de formulário e resposta JSON. Envie o IBAN e o nome, e receba o resultado da verificação.
Para ativar o serviço, associamos uma única vez uma conta da sua empresa a partir do painel de Clientes da Wealthreader: é a que realiza as consultas de Verificação do Beneficiário. Os seus clientes e fornecedores não têm de fazer nada.
Um pedido POST com a sua chave de API, o IBAN da conta e o nome da pessoa ou empresa que diz ser a titular.
curl https://api.wealthreader.com/my-bank-match/ \
-d api_key=$API_KEY \
-d iban=ES9121000418450200051332 \
--data-urlencode name="Talleres Ruiz SL"
A resposta chega na mesma chamada, com o mesmo envelope do resto da API: success, payload e statistics.
{
"success": true,
"payload": {
"result": "MATCH"
},
"statistics": {
"SESSION": "…",
"execution_time": 1.84,
"warnings": []
}
}
Se o nome for semelhante mas não idêntico, a resposta inclui suggested_name com o nome que consta no banco.
Os valores são ilustrativos.
{
"success": true,
"payload": {
"result": "PARTIAL_MATCH",
"suggested_name": "Talleres Ruiz Martínez SL"
}
}
Parâmetros, resultados e erros de POST /my-bank-match/. O detalhe completo está no guia de integração.
| Parâmetro | Validação |
|---|---|
api_key | A sua chave de API, com o produto MyBankMatch ativo e quota disponível. |
iban | IBAN de um país SEPA. Ignoram-se espaços e maiúsculas; verificam-se o comprimento do respetivo país e os dígitos de controlo. |
name | Nome da pessoa ou empresa que diz ser titular, com um máximo de 140 caracteres. |
result | Significado | Consome quota | Campos adicionais |
|---|---|---|---|
MATCH |
O nome coincide com o titular da conta. | Sim | — |
PARTIAL_MATCH |
O nome é semelhante ao do titular; suggested_name traz o nome que consta no banco. | Sim | suggested_name |
NO_MATCH |
O nome não corresponde ao titular da conta. | Sim | — |
NOT_CONFIGURED |
A sua chave ainda não tem uma conta associada; setup_url conduz à associação. | Não | setup_url |
REAUTH_REQUIRED |
O banco associado pede uma nova autenticação; setup_url conduz à religação. | Não | setup_url, reason_code |
NOT_POSSIBLE |
O banco não conseguiu verificar a conta neste momento; reason indica o motivo. | Não | reason |
| Código de erro | Significado |
|---|---|
2 | Chamada incorreta: método, chave de API, produto não ativo ou limite de chamadas. |
4000 | IBAN inválido. |
4001 | Nome do titular inválido. |
1 | Erro interno. |
Os erros não são cobrados nem consomem quota.
Se já utiliza a API da Wealthreader, a MyBankMatch responde com a mesma estrutura e os mesmos hábitos de integração.
O IBAN e o nome são validados antes de consultar o banco: um dado mal formado devolve um erro de imediato.
MATCH, PARTIAL_MATCH e NO_MATCH consomem quota. As consultas que não chegam a uma conclusão, não.
O guia passo a passo e a referência da API descrevem o contrato completo, com exemplos.
Abrir o guia da MyBankMatch (abre num novo separador) Abrir a referência da API (abre num novo separador) Pedir acesso
Mostramos-lhe a MyBankMatch com os pagamentos e os registos do seu negócio.