Adyen Terminal API
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.
OpenAPI Specification
openapi: 3.1.0
info:
version: '1'
title: Adyen Terminal API
description: >-
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.
servers:
- description: with cloud integration
url: https://terminal-api-test.adyen.com/sync
- description: with cloud integration
url: https://terminal-api-test.adyen.com/async
- description: with local-hosting
url: <local-terminal-IP-address>
paths:
/login:
post:
description: >-
It conveys Information related to the session (period between a Login
and the following Logout) to process. Content of the Login Request
message.
summary: Adyen Login Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoginResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
POISystemData: example_value
TokenRequestStatus: true
CustomerOrderStatus: true
description: >-
It conveys Information related to the Login to process. Content of
the Login Response message.
tags:
- Login
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/logout:
post:
description: Empty. Content of the Logout Request message.
summary: Adyen Logout Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LogoutRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LogoutResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
description: >-
It conveys the result of the Logout. Content of the Logout Response
message.
tags:
- Logout
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/enableservice:
post:
description: >-
It conveys the services that will be enabled for the POI Terminal
without the request of the Sale System, and a possible invitation for
the Customer to start the services. Content of the Enable Service
Request message.
summary: Adyen EnableService Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableServiceRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EnableServiceResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
description: >-
It conveys the result of the Enable Service processing. Content of
the Enable Service Response message.
tags:
- Enableservice
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin:
post:
description: Empty. Content of the Custom Admin Request message.
summary: Adyen Admin Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdminRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AdminResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
description: >-
It conveys the result of the Custom Admin. Content of the Custom
Admin Response message.
tags:
- Admin
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/payment:
post:
description: >-
Request sent to terminal to initiate payment. It conveys Information
related to the Payment transaction to process. Content of the Payment
Request message.
summary: Adyen Payment Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
SaleData: example_value
POIData: example_value
PaymentResult: example_value
LoyaltyResult:
- example_value
PaymentReceipt:
- example_value
CustomerOrder:
- example_value
description: >-
It conveys Information related to the Payment transaction processed
by the POI System. Content of the Payment Response message.
tags:
- Payment
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/cardacquisition:
post:
description: >-
It conveys Information related to the payment and loyalty cards to read
and analyse. This message pair is usually followed by a message pair
(e.g. payment or loyalty) which refers to this Card Acquisition message
pair. Content of the Card Acquisition Request message.
summary: Adyen CardAcquisition Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CardAcquisitionRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CardAcquisitionResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
SaleData: example_value
POIData: example_value
CustomerLanguage: example_value
PaymentBrand:
- example_value
PaymentInstrumentData: example_value
LoyaltyAccount:
- example_value
description: >-
It conveys Information related to the payment and loyalty cards read
and processed by the POI System and entered by the Customer. Content
of the Card Acquisition Response message.
tags:
- Cardacquisition
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/loyalty:
post:
description: >-
It conveys Information related to the Loyalty transaction to process.
Content of the Loyalty Request message.
summary: Adyen Loyalty Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoyaltyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoyaltyResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
SaleData: example_value
POIData: example_value
LoyaltyResult:
- example_value
PaymentReceipt:
- example_value
description: >-
It conveys Information related to the Loyalty transaction processed
by the POI System. Content of the Loyalty Response message.
tags:
- Loyalty
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/storedvalue:
post:
description: >-
It conveys Information related to the Stored Value transaction to
process. Content of the Stored Value Request message.
summary: Adyen StoredValue Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StoredValueRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StoredValueResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
SaleData: example_value
POIData: example_value
StoredValueResult:
- example_value
PaymentReceipt:
- example_value
description: >-
It conveys Information related to the Stored Value transaction
processed by the POI System. Content of the Stored Value Response
message.
tags:
- Storedvalue
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/reversal:
post:
description: >-
It conveys Information related to the reversal of a previous payment or
a loyalty transaction. Content of the Reversal Request message.
summary: Adyen Reversal Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReversalRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReversalResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
POIData: example_value
OriginalPOITransaction: example_value
ReversedAmount: 0.0
CustomerOrder:
- example_value
PaymentReceipt:
- example_value
description: >-
It conveys Information related to the reversal processed by the POI
System. Content of the Reversal Response message.
tags:
- Reversal
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/reconciliation:
post:
description: >-
It conveys Information related to the Reconciliation requested by the
Sale System. Content of the Reconciliation Request message.
summary: Adyen Reconciliation Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReconciliationRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReconciliationResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
ReconciliationType: standard
POIReconciliationID: 500
TransactionTotals:
- example_value
description: >-
It conveys Information related to the Reconciliation transaction
processed by the POI System. Content of the Reconciliation Response
message.
tags:
- Reconciliation
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/gettotals:
post:
description: >-
It conveys information from the Sale System related to the scope and the
format of the totals to be computed by the POI System. Content of the
Get Totals Request message.
summary: Adyen GetTotals Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetTotalsRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GetTotalsResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
POIReconciliationID: 500
TransactionTotals:
- example_value
description: >-
It conveys Information related to the Reconciliation transaction
processed by the POI System. Content of the Reconciliation Response
message.
tags:
- Gettotals
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/balanceinquiry:
post:
description: >-
It conveys Information related to the account for which a Balance
Inquiry is requested. Content of the Balance Inquiry Request message.
summary: Adyen BalanceInquiry Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceInquiryRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceInquiryResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
PaymentAccountStatus: active
LoyaltyAccountStatus: active
PaymentReceipt:
- example_value
description: >-
It conveys the balance and the identification of the associated
payment, loyalty or stored value account. Content of the Balance
Inquiry Response message.
tags:
- Balanceinquiry
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/transactionstatus:
post:
description: >-
It conveys Information requested for status of the last or current
Payment, Loyalty or Reversal transaction. Content of the
TransactionStatus Request message.
summary: Adyen TransactionStatus Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionStatusRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionStatusResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
MessageReference: REF-001
RepeatedMessageResponse: example_value
description: >-
It conveys Information related to the status of the last or current
Payment, Loyalty or Reversal transaction. Content of the
TransactionStatus Response message.
tags:
- Transactionstatus
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/diagnosis:
post:
description: >-
It conveys Information related to the target POI for which the diagnosis
is requested. Content of the Diagnosis Request message.
summary: Adyen Diagnosis Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DiagnosisRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DiagnosisResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
LoggedSaleID:
- '500123'
POIStatus: active
HostStatus:
- active
description: >-
It conveys the result of the requested diagnosis and a possible
message to display on a logical device. Content of the Diagnosis
Response message.
tags:
- Diagnosis
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/display:
post:
description: >-
It conveys the data to display and the way to process the display. It
contains the complete content to display. It might contain an operation
(the DisplayOutput element) per Display Device type. Content of the
Display Request message.
summary: Adyen Display Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisplayRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DisplayResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
OutputResult:
- example_value
description: >-
It conveys the result of the display, parallel to the message
request, except if response not required and absent. Content of the
Display Response message.
tags:
- Display
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/input:
post:
description: >-
It conveys data to display and the way to process the display, and
contains the complete content to display. In addition to the display on
the Input Device, it might contain an operation (the DisplayOutput
element) per Display Device type. Content of the Input Request message.
summary: Adyen Input Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InputRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InputResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
OutputResult: example_value
InputResult: example_value
description: >-
It conveys the result of the input or the result of the outputs,
parallel to the message request, except if response not required and
absent. Content of the Input Response message.
tags:
- Input
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/print:
post:
description: >-
It conveys the data to print and the way to process the print. It
contains the complete content to print. Content of the Print Request
message.
summary: Adyen Print Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
DocumentQualifier: example_value
Response: example_value
description: >-
It conveys the result of the print, parallel to the message request,
except if response not required and absent. Content of the Print
Response message.
tags:
- Print
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/cardreaderapdu:
post:
description: >-
It contains the APDU request to send to the chip of the card, and a
possible invitation message to display on the CashierInterface or the
CustomerInterface. Content of the Card Reader APDU Request message.
summary: Adyen CardReaderAPDU Request
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CardReaderAPDURequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CardReaderAPDUResponse'
examples:
operation200Example:
summary: Default operation 200 response
x-microcks-default: true
value:
Response: example_value
APDUData: example_value
CardStatusWords: active
description: >-
It contains the result of the requested service, APDU response sent
by the chip of the card in response to the APDU request. Content of
the Card Reader APDU Response message.
tags:
- Cardreaderapdu
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
TerminalEnvironment:
type: string
enum:
- Attended
- SemiAttended
- Unattended
GenericProfile:
type: string
enum:
- Basic
- Extended
- Standard
ServiceProfiles:
type: array
items:
type: string
enum:
- Batch
- CardReader
- Communication
- Loyalty
- OneTimeRes
- PIN
- Reservation
- Sound
- StoredValue
- Synchro
SaleCapabilities:
type: array
items:
type: string
enum:
- CashierDisplay
- CashierError
- CashierInput
- CashierStatus
- CustomerAssistance
- CustomerDisplay
- CustomerError
- CustomerInput
- EMVContactless
- ICC
- MagStripe
- POIReplication
- PrinterDocument
- PrinterReceipt
- PrinterVoucher
TokenRequestedType:
type: string
enum:
- Customer
- Transaction
CustomerOrderReq:
type: array
items:
type: string
enum:
- Both
- Closed
- Open
TrackFormat:
type: string
enum:
- AAMVA
- ISO
EntryMode:
type: array
items:
type: string
enum:
- Contactless
- File
- ICC
- Keyed
- MagStripe
- Manual
- Mobile
- RFID
- Scanned
- SynchronousICC
- Tapped
Result:
type: string
enum:
- Failure
- Partial
- Success
ErrorCondition:
type: string
enum:
- Aborted
- Busy
- Cancel
- DeviceOut
- InProgress
- InsertedCard
- InvalidCard
- LoggedOut
- MessageFormat
- NotAllowed
- NotFound
- PaymentRestriction
- Refusal
- UnavailableDevice
- UnavailableService
- UnreachableHost
- WrongPIN
GlobalStatus:
type: string
enum:
- Busy
- Maintenance
- OK
- Unreachable
PrinterStatus:
type: string
enum:
- NoPaper
- OK
- OutOfOrder
- PaperJam
- PaperLow
POICapabilities:
type: array
items:
type: string
enum:
- CashHandling
- CashierDisplay
- CashierError
- CashierInput
- CustomerDisplay
- CustomerError
- CustomerInput
- EMVContactless
- ICC
- MagStripe
- PrinterDocument
- PrinterReceipt
- PrinterVoucher
Device:
type: string
enum:
- CashierDisplay
- CashierInput
- CustomerDisplay
- CustomerInput
InfoQualify:
type: string
enum:
- CustomerAssistance
- Display
- Document
- Error
- Input
- POIReplication
- Receipt
- Sound
- Status
- Voucher
OutputFormat:
type: string
enum:
- BarCode
- MessageRef
- Text
- XHTML
Color:
type: string
enum:
- Black
- Blue
- Cyan
- Green
- Magenta
- Red
- White
- Yellow
CharacterWidth:
type: string
enum:
- DoubleWidth
- SingleWidth
CharacterHeight:
type: string
enum:
- DoubleHeight
- HalfHeight
- SingleHeight
CharacterStyle:
type: string
enum:
- Bold
- Italic
- Normal
- Underline
Alignment:
type: string
enum:
- Centred
- Justified
- Left
- Right
BarcodeType:
type: string
enum:
- Code128
- Code25
- EAN13
- EAN8
- PDF417
- QRCode
- UPCA
MenuEntryTag:
type: string
description: Characteristics related to the selection of a menu entry.
enum:
- NonSelectable
- NonSelectableSubMenu
- Selectable
- SubMenu
TransactionAction:
type: string
description: Action to realise on a transaction.
enum:
- AbortTransaction
- StartTransaction
ServicesEnabled:
type: array
items:
type: string
enum:
- CardAcquisition
- Loyalty
- Payment
UnitOfMeasure:
type: string
enum:
- Case
- Centilitre
- Centimetre
- Foot
- Gram
- Inch
- Kilogram
- Kilometre
- Litre
- Meter
- Mile
- Other
- Ounce
- Pint
- Pound
- Quart
- UKGallon
- USGallon
- Yard
PaymentType:
type: string
enum:
- CashAdvance
- CashDeposit
- Completion
- FirstReservation
- Instalment
- IssuerInstalment
- Normal
- OneTimeReservation
- PaidOut
- Recurring
- Refund
- UpdateReservation
PaymentInstrumentType:
type: string
enum:
- Card
- Cash
- Check
- Mobile
- StoredValue
TypeCode:
type: string
enum:
- Company
- Personal
StoredValueAccountType:
type: string
enum:
- GiftCard
- Other
- PhoneCard
IdentificationType:
type: string
enum:
- AccountNumber
- BarCode
- ISOTrack2
- PAN
- PhoneNumber
LoyaltyUnit:
type: string
enum:
- Monetary
- Point
IdentificationSupport:
type: string
enum:
- HybridCard
- LinkedCard
- LoyaltyCard
- NoCard
InstalmentType:
type: string
enum:
- DeferredInstalments
- EqualInstalments
- InequalInstalments
PeriodUnit:
type: string
enum:
- Annual
- Daily
- Monthly
- Weekly
LoyaltyHandling:
type: string
enum:
- Allowed
- Forbidden
- Processed
- Proposed
- Required
ForceEntryMode:
type: array
items:
type: string
enum:
- CheckReader
- Contactless
- File
- ICC
- Keyed
- MagStripe
- Manual
- RFID
- Scanned
- SynchronousICC
- Tapped
DocumentQualifier:
type: string
enum:
- CashierReceipt
- CustomerReceipt
- Document
- Journal
- SaleReceipt
- Voucher
AuthenticationMethod:
type: array
items:
type: string
enum:
- Bypass
- ManualVerification
- MerchantAuthentication
- OfflinePIN
- OnlinePIN
- PaperSignature
- SecureCertificate
- SecureNoCertificate
- SecuredChannel
- SignatureCapture
- UnknownMethod
LoyaltyTransactionType:
type: string
enum:
- Award
- AwardRefund
- Rebate
- RebateRefund
- Redemption
- RedemptionRefund
StoredValueTransactionType:
type: string
enum:
- Activate
- Duplicate
- Load
- Reserve
- Reverse
- Unload
ReversalReason:
type: string
description: Reason of the payment or loyalty reversal..
enum:
- CustCancel
- Malfunction
- MerchantCancel
- Unable2Compl
ReconciliationType:
type: string
enum:
- AcquirerReconciliation
- AcquirerSynchronisation
- PreviousReconciliation
- SaleReconciliation
TransactionType:
type: string
enum:
- Award
- CashAdvance
- CompletedDeffered
- CompletedReservation
- Credit
- Debit
- Declined
- Failed
- FirstReservation
- IssuerInstalment
- OneTimeReservation
- Rebate
- Redemption
- ReverseAward
- ReverseCredit
- ReverseDebit
- ReverseRebate
- ReverseRedemption
- UpdateReservation
TotalDetails:
type: array
items:
type: string
enum:
- OperatorID
- POIID
- SaleID
- ShiftNumber
- TotalsGroupID
AccountType:
type: string
enum:
- CardTotals
- Checking
- CreditCard
- Default
- EpurseCard
- Investment
- Savings
- Universal
MessageCategory:
type: string
enum:
- Abort
- Admin
- BalanceInquiry
- CardAcquisition
- CardReaderAPDU
- Diagnosis
- Display
- EnableService
- Event
- GetTotals
- Input
- InputUpdate
- Login
- Logout
- Loyalty
- Payment
# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/terminal-openapi-original.yml