API Transfers API
Consulte Transfers API, do provedor adyen.com, versão 3: documentação, especificação OpenAPI 3.1.0 e referências para planejar a integração.
adyen.com · Versão 3
Conheça a plataforma
O que integrar com Transfers API
Descrição técnica preservada da especificação de origem. A versão do contrato ajuda a identificar a API; confirme a disponibilidade atual no fornecedor.
The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. Authentication Your Adyen contact will provide your API credential and an API key. To connect to the API, add an X-API-Key header with the API key as the value, for example: curl -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ ... Alternatively, you can use the username and password to connect to the API using basic authentication. For example: curl -H "Content-Type: application/json" \ -U "[email protected]_BALANCE_PLATFORM":"YOUR_WS_PASSWORD" \ ... Roles and permissions To use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you. Versioning The Transfers API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number. For example: https://balanceplatform-api-test.adyen.com/btl/v3/transfers Going live When going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to https://balanceplatform-api-live.adyen.com/btl/v3.
Ficha técnica
Como funciona a integração
Versões, permissões, preços e limites podem mudar. Consulte a documentação da plataforma antes de implementar.
Do planejamento à produção
Checklist para integrar Transfers API
- Defina o fluxo. Identifique quais dados precisam circular, o sistema de origem e o resultado esperado.
- Leia os requisitos oficiais. Verifique acesso à API, plano necessário, versão e ambiente de testes.
- Configure o acesso com segurança. Guarde credenciais secretas no servidor e conceda apenas as permissões necessárias. Restrinja chaves públicas conforme a documentação do fornecedor.
- Teste a primeira requisição. Valide os campos, a paginação e o formato de resposta com dados de teste.
- Prepare o tratamento de falhas. Considere limites de requisição, retentativas com espera e prevenção de operações duplicadas.
- Acompanhe a integração. Registre erros sem expor dados sensíveis e monitore alterações na API.