Qodex.ai

Adyen Terminal API

Number of APIs: 20

Overview

The Adyen Terminal API lets you make payments, issue refunds, collect shopper information, and perform other shopper-terminal interactions using a payment terminal supplied by Adyen.

This API reference provides information on available operations and how to use them. To learn more about the terminal API, visit terminal API documentation. To know about In-Person payments, visit In-Person payments documentation.

The collection consists of only operations using terminal API. For other operations like capture a payment, pay with token in case of recurring payments, authorisation adjustments, use [Adyen's checkout API] collection. For operations like create stores, manage terminal fleet, use [Adyen's management API collection]

How to use it

Fork the Adyen Terminal API env environment and configure the variables: Base URL, API key etc..

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

Fill the variables values before sending any request.

baseUrl: The endpoint you are using to process payments. More info.

X-API-Key: The API Key of the web service user you want to use to process the payment. You get this API key from Adyen's Customer Area. This key is needed only for cloud terminal API.

poiId: The terminal ID of the tarminal that is going to be use for payments. e.g. V400m-321987654

saleId: Your unique ID for the POS system component to send this request from.e.g. TestPOS

currency: The currency you want to process the payment.e.g. EUR

Fork the Adyen Terminal API collection

  1. Payments - MKE payment POST {{baseUrl}}

  2. Refund - Unreferenced refund POST {{baseUrl}}

  3. Status and Abort - Verify transaction status POST {{baseUrl}}

  4. Preauth - Payment preauth request POST {{baseUrl}}

  5. Reconcile - Recall reconciliation POST {{baseUrl}}

  6. Get Input - Text POST {{baseUrl}}

  7. Cancel Input - Cancel collecting input POST {{baseUrl}}

  8. Pay at table / Split - IdleScreen POST {{baseUrl}}

  9. Tag - Identify tag POST {{baseUrl}}

  10. Shopper engagement - Cancel card acquisition POST {{baseUrl}}