Terminal-2 icon

Terminal API go-live checklist

Follow this checklist to take your Terminal API integration live.

Support

Articles, FAQs, and requesting support: Adyen Help

An integration with Adyen's Terminal API lets you start payments from your POS app and process these payments through Adyen using our payment terminals.

Here we describe how you can take your Terminal API integration live.

Requirements

Step 1: Set up your Adyen live account

The structure from your test account is not copied over. This means you need to set up a structure for your live account using your live Customer Area.

  1. Request the merchant accounts that you need, providing as many details as possible and ensuring you submit the correct documents and links. The usual processing time is around four business days.

  2. If you require stores in your account structure, wait for confirmation that your live merchant accounts are created and then submit a store request form. The usual processing time is around two business days.

Step 2: Review your finance settings

  1. Receive payouts from Adyen:

    1. Provide information about the bank accounts where you want to receive the payouts from Adyen. If you are accepting payments in multiple currencies, you can add a separate bank account for each currency.
    2. Optionally change the payout schedule in your Customer Area > Finance > Payout model.
      The default is Sales-Day payout. With this schedule, we pay out funds on a daily basis (from Monday to Friday), with transactions processed on a single day paid out in one batch.

  2. Use reports for reconciliation:

    1. Set up automatic generation and downloading of reports.
    2. Use the Settlement details report to reconcile your accounts on a transaction level.
    3. Consider automating your reconciliation process.

  3. Consider setting up a Reserve and auto-funding.
    Your Reserve is used for refunds and other operational expenses in case of insufficient in-process funds. To make sure there's always enough balance available on your account for refunds, you can also set up auto-funding.

Step 3: Order live payment terminals

Your test terminals are for testing purposes only. They cannot process live payments. This means you need to order new terminals from your live Customer Area.

  1. Order the terminals that are needed in your physical stores.

It usually takes around four business days before your terminals arrive.

Step 4: Prepare your terminals

The configured settings from your test environment are not copied over. This means you need to configure your live terminals and payment features from scratch in your live Customer Area. You can configure settings at the company account level, the merchant account level, the store level, or the terminal level.

  1. Enable Terminal API for your terminals.

  2. Add payment methods and configure the terminal and payment features that you want to use. Our Support Team will help you with any features that you cannot fully configure yourself.

  3. Assign the live terminals to a store. This makes it easier to start using terminals when you receive them. You can assign terminals from your Customer Area or using our Terminal Management API.

Step 5: Update your integration

  1. Add API credentials and optionally add users to your live Customer Area.
    For your live account we recommend creating a new API credential in addition to the default one. For example, you could add a new API credential to each merchant account, or one for point of sale and one for ecommerce.
    You can also create additional Customer Area users for your team members and assign the roles they need for their tasks.

  2. Update your code:

    • For a local integration, update your integration to reflect the IP addresses (or resolvable hostnames) of the live terminals, and install and verify our live terminal certificate (or use a library). If you skipped encrypting communications in your test integration, you need to implement encryption now.

      A live terminal will not accept API requests without encryption.

    • For a cloud integration, generate a new API key for the API credential you are using, and switch to the live endpoints and the new API key.

  3. When you receive the terminals, follow the steps in the manual for the terminal model to get the terminals up and running. The steps are to:

    • Inspect the terminal, to verify it has not been tampered with.
    • Insert the receipt paper roll (if applicable).
    • Turn on the terminal.
    • Connect the terminal to your network.
    • Board the terminal.
    • Test the connection with the Adyen payments platform.

Step 6: Test your integration

To make sure your live integration is working as expected, you should do end-to-end tests from making a payment with a real card to completing your reconciliation.

For example:

  1. Make a low-value payment with a real card.

  2. Log in to your live Customer Area and verify that the payment was successful:

    1. Go to Transactions > Payments and find the payment.
    2. Click on the payment's PSP reference.

    3. Under History, you should see the JournalTypes transition from:

      • Received
      • Authorised

      • Settled

    If the payment reached a JournalType of Settled the payment was successfully processed by the card issuer.

  3. Refund the payment, to test your refund flow.