Configuration API (v2)

Configuration API (v2) integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Adyen Developers.

Configuration API (v2) | Adyen APIs Workspace | API documentation

Content-Type

Accept

Complete the registration of an SCA device

Complete the registration of an SCA device Manage SCA devices Configuration API (v2) integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Adyen Developers.

Complete the registration of an SCA device Manage SCA devices Configuration API (v2) | Adyen APIs Workspace | API documentation

Manage SCA devices-/registeredDevices/:id

Manage SCA devices Configuration API (v2) integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Adyen Developers.

Manage SCA devices Configuration API (v2) | Adyen APIs Workspace | API documentation

<h2>About Adyen API</h2>

The Adyen Payment API is a comprehensive set of endpoints designed to facilitate various payment operations on the Adyen payments platform. This API enables businesses to initiate, settle, and modify payments, supporting a wide range of payment methods including card payments (with features like One-Click and 3D Secure), bank transfers, and e-wallets.
Key features of the Adyen API include: 
<ol>
 <li>Versatile payment processing: Handles authorizations, captures, cancellations, and refunds.</li>
 <li>Multi-method support: Accommodates various payment methods to cater to diverse customer preferences.</li>
 <li>Security features: Implements 3D Secure and 3D Secure 2 for enhanced transaction security.</li>
 <li>Flexible operations: Allows for partial captures, multiple refunds, and authorization adjustments.</li>
 <li>Custom references: Supports operations using merchant-defined references for easier reconciliation.</li>
</ol>
The API is designed for what Adyen calls a "Classic integration," providing developers with granular control over the payment flow. It's particularly useful for businesses requiring complex payment scenarios or those looking to build a fully customized payment experience. 

<h2>Getting Started</h2>

To begin using the Adyen Payment API, follow these steps: 
<ol>
 <li>Set up an Adyen account:<ul>
 <li>Visit the Adyen website and sign up for an account if you haven't already.</li>
 <li>Once approved, you'll gain access to the Adyen dashboard. </li>
 </ul>
 </li>
 <li>Create API credentials:<ul>
 <li>Log in to your Adyen dashboard.</li>
 <li>Navigate to "Developers" &gt; "API credentials".</li>
 <li>Click "Create new credential".</li>
 <li>Select "Web service user" as the credential type.</li>
 <li>Name your credential and assign the necessary roles (e.g., Payments API).</li>
 <li>Save the generated API key and username securely. </li>
 </ul>
 </li>
 <li>Choose your environment:<ul>
 <li>Start with the TEST environment for development and testing.</li>
 <li>The production environment should only be used when you're ready to process real transactions. </li>
 </ul>
 </li>
 <li>Authentication:
 <ul>
 <li>Use Basic Authentication with your web service user credentials.</li>
 <li>Example curl command: curl -U "ws@Company.YourCompany":"YourWsPassword" \ -H "Content-Type: application/json" \ ... </li>
 </ul>
 </li>
 <li>Make your first API call:<ul>
 <li>Start with a simple call, like the /authorise endpoint.</li>
 <li>Construct your request payload according to the API documentation.</li>
 <li>Send the request to the appropriate endpoint URL. </li>
 </ul>
 </li>
 <li>Handle the response:<ul>
 <li>Parse the JSON response from Adyen.</li>
 <li>Check for the resultCode to determine the outcome of your request. </li>
 </ul>
 </li>
 <li>Implement error handling:<ul>
 <li>Prepare to handle various HTTP status codes and error messages.</li>
 <li>Implement proper logging for troubleshooting. </li>
 </ul>
 </li>
 <li>Test thoroughly:<ul>
 <li>Use Adyen's test card numbers and other test payment method details.</li>
 <li>Simulate various scenarios (successful payments, refunds, errors, etc.). </li>
 </ul>
 </li>
 <li>Implement additional features:
 <ul>
 <li>Gradually add more complex operations like 3D Secure, recurring payments, etc. </li>
 </ul>
 </li>
 <li>Go live:<ul>
 <li>Once testing is complete, generate new credentials for the live environment.</li>
 <li>Update your integration to use the live endpoints and credentials.</li>
 <li>Perform final end-to-end testing in the live environment with real payment methods.</li>
 </ul>
 </li>
</ol>



<h2>How to use it</h2>

Fork the <q>Adyen APIs</q> environment and configure the variables you need: Merchant Account, Balance Account (for Platforms), etc..

<blockquote>
 VERY IMPORTANT: fork it in a PRIVATE workspace. Keep your credentials, tokens and sensitive data private. 
</blockquote>

Fork the collections and start hacking

Look at the demo in the <a href="https://www.youtube.com/watch?v=SrbqSV1mtns">Adyen Qodex Collections</a> video and read <a href="https://www.adyen.com/knowledge-hub/adyen-Qodex-collections">blog</a>.
<h3>List of API Endpoints</h3><ul><li>/authorise: Creates a payment authorization.</li><li>/authorise3d: Completes a 3D Secure payment authorization.</li><li>/authorise3ds2: Completes a 3D Secure 2 payment authorization.</li><li>/capture: Captures an authorized payment.</li><li><a href="https://developers.qodex.ai/adyen-apis/adyen-checkout-api-v71">/cancel</a>: Cancels an authorized payment.</li><li>/cancelOrRefund: Cancels or refunds a payment based on its status.</li><li>/refund: Refunds a captured payment.</li><li>/adjustAuthorisation: Increases or decreases the authorized amount.</li><li>/technicalCancel: Cancels a payment using a custom reference.</li><li>/getAuthenticationResult: Returns the 3D Secure authentication result.</li><li>/retrieve3ds2Result: Retrieves the 3D Secure 2 authentication result.</li><li>/voidPendingRefund: Cancels a POS refund request before completion.</li></ul>

<h3>Older versions</h3>

You find here the latest version of the Adyen APIs. Do you need an older version? Check out our Github <a href="https://github.com/adyen/adyen-Qodex">adyen-Qodex</a> repository where we store the Qodex (JSON) files for all API releases.

<h3>Report an issue</h3>

Let us know about problems or improvements by creating a <a href="https://github.com/adyen/adyen-Qodex">GitHub</a> issue.

<h4>Change Log</h4>

See our <a href="https://github.com/Adyen/adyen-Qodex/blob/main/adyendev-Qodex-release-notes.md">Release Notes</a>.

<h4>Going Further</h4>

And if you want to dive further into our content:

<ul>
 <li>
 find us out on <a href="https://developers.adyen.com/">developers.adyen.com</a>
 </li>
 <li>
 check out our <a href="https://docs.adyen.com/api-explorer/">API Explorer</a> for a complete reference
 </li>
 <li>
 you can access all older versions of the API at any time on <a href="https://github.com/Adyen/adyen-Qodex/tree/main">our adyen-Qodex GitHub repo</a>
 </li>
</ul>

🦸If you're running into issues, don't hesitate to contact us <a href="https://mailto:devrel@adyen.com">devrel@adyen.com</a>🦸🏼‍♀️

Adyen APIs

Github

Twitter

Developer Website

Adyen APIs projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Adyen APIs.

Key	Datatype	Required	Description
Content-Type	string
Accept	string