integradoras.comMinha seleção
Autenticação & Identidade

API Hosted onboarding API

Consulte Hosted onboarding API, do provedor adyen.com, versão 6: documentação, especificação OpenAPI 3.1.0 e referências para planejar a integração.

adyen.com · Versão 6

Referência de documentação (abre em nova aba)Visitar Hosted onboarding API (abre em nova aba)

Conheça a plataforma

O que integrar com Hosted onboarding 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.

This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead. The Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an onboarding page or a PCI compliance questionnaire. You can provide these links to your account holders so that they can complete their onboarding. 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 -U "[email protected]_PLATFORM_ACCOUNT":"YOUR_WS_PASSWORD" \ -H "Content-Type: application/json" \ ... When going live, you need to generate new web service user credentials to access the live endpoints. Versioning The Hosted onboarding 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://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl

Segurança e IdentidadeHosted Onboarding PagePCI Compliance Questionnaire Pagepayment

Ficha técnica

Como funciona a integração

Autenticação
API KeyInformada no diretório de origem; confirme no contrato da API.Método informado no catálogo de origem; confirme requisitos e escopos na documentação atual.Referência de autenticação (abre em nova aba)
Provedor
adyen.com
Versão catalogada
6
Formato da especificação
OpenAPI 3.1.0
Operações no contrato
2
Arquitetura
REST / HTTP
SDKs no catálogo
Nenhum SDK informado. Consulte a documentação oficial.

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 Hosted onboarding API

  1. Defina o fluxo. Identifique quais dados precisam circular, o sistema de origem e o resultado esperado.
  2. Leia os requisitos oficiais. Verifique acesso à API, plano necessário, versão e ambiente de testes.
  3. 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.
  4. Teste a primeira requisição. Valide os campos, a paginação e o formato de resposta com dados de teste.
  5. Prepare o tratamento de falhas. Considere limites de requisição, retentativas com espera e prevenção de operações duplicadas.
  6. Acompanhe a integração. Registre erros sem expor dados sensíveis e monitore alterações na API.

Continue explorando

Conheça plataformas da mesma categoria e confira os recursos de cada uma.

Ver categoria
Autenticação & Identidade

VA Forms

Use the VA Forms API to search for VA forms, get the form's PDF link and metadata, and check for new versions. Visit our VA Lighthouse Contact Us page for further assistance. Background This API offers an efficient way to stay up-to-date with the latest VA forms and information. The forms information listed on VA.gov matches the information returned by this API.

Explorar API
Autenticação & Identidade

Adyen Balance Control API

The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account. Authentication To connect to the Balance Control API, you must authenticate your requests with an API key or basic auth username and password. To learn how you can generate these, see API credentials.Here is an example of authenticating a request with an API key: curl -H "X-API-Key: Your_API_key" \ -H "Content-Type: application/json" \ ... Note that when going live, you need to generate API credentials to access the live endpoints.

Explorar API
Autenticação & Identidade

Adyen Checkout Utility Service

A web service containing utility functions available for merchants integrating with Checkout APIs. Authentication Each request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in How to get the Checkout API key. Then set this key to the X-API-Key header value, for example: curl -H "Content-Type: application/json" \ -H "X-API-Key: Your_Checkout_API_key" \ ... Note that when going live, you need to generate a new API Key to access the live endpoints. Versioning Checkout API supports versioning of its endpoints through a version suffix in the endpoint URL.

Explorar API
Autenticação & Identidade

Configuration API

The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts. 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" \ ...

Explorar API

Voltar ao catálogo de APIs