Adyen Loyalty API

The Loyalty API from Adyen — 1 operation(s) for loyalty.

Documentation Provider Profile APIs.io OpenAPI GitHub

Adyen Loyalty API is one of 202 APIs that Adyen publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Loyalty. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 45 schemas. It is described by OpenAPI 3.1.0, at version 6.

Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.

1 operations 1 paths 45 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

Base URL

https://cal-test.adyen.com

Authentication

API Key, HTTP Basic

Contact

Adyen Developer Experience team

View terms

Resource Areas

Authentication & Security 2

Adyen Loyalty API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Loyalty 1

POST

/loyalty

Adyen Loyalty Request

body → 200

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are SaleData (12 properties), OutputText (11 properties), SaleItem (11 properties), OriginalPOITransaction (9 properties). Each schema is shown below with its type and property counts.

POIData

object

In the Message Response, identification of the POI transaction. Data related to the POI System.

2 properties 1 required

LoyaltyTransaction

object

6 properties 1 required

LoyaltyAccountID

object

In the Payment or the Loyalty Request message, it allows to identify the loyalty account by the Sale Terminal instead of the POI Terminal (e.g. because the acc…

4 properties 3 required

ErrorCondition

string

TransactionConditions

object

Conditions on which the transaction must be processed.

9 properties

EntryMode

array

LoyaltyUnit

string

Rebates

object

3 properties

Response

object

If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can r…

3 properties 1 required

TransactionIDType

object

Identification of a transaction for the Sale System or the POI System.

2 properties 2 required

Result

string

SaleItem

object

In loyalty or value added payment card transaction, the items of the sale are entering in the processing of the transaction. Sale items of a transaction.

11 properties 3 required

CharacterWidth

string

OutputContent

object

This is a sequence of elements if they have different formats. Content to display or print.

5 properties 1 required

IdentificationType

string

BarcodeType

string

Color

string

Alignment

string

SaleItemRebate

object

To be differentiated from the award which is the amount or quantity earned on the loyalty account. The awarded amount that is attached to an item as a rebate.

7 properties 2 required

OutputFormat

string

SaleData

object

Data associated to the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition. Data related to t…

12 properties 1 required

CharacterStyle

string

UnitOfMeasure

string

CharacterHeight

string

LoyaltyResult

object

In the Message Response, the result of each loyalty brand transaction. Data related to the result of a processed loyalty transaction.

5 properties 1 required

LoyaltyData

object

In the Payment, Loyalty or Balance Inquiry Request message, it allows the Sale Terminal to send the identification of the loyalty account or an awarded amount…

3 properties

OutputBarcode

object

2 properties 1 required

ForceEntryMode

array

OutputText

object

It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print a…

11 properties 1 required

DocumentQualifier

string

PaymentReceipt

object

If the payment receipts are printed by the Sale system and the POI or the Sale does not implement the Print exchange (Basic profile). Customer or Merchant paym…

4 properties 2 required

TokenRequestedType

string

LoyaltyTransactionType

string

LoyaltyRequest

object

It conveys Information related to the Loyalty transaction to process. Content of the Loyalty Request message.

3 properties 3 required

LoyaltyAcquirerData

object

4 properties

OriginalPOITransaction

object

In the Payment or the Loyalty Request message, it allows using the card of a previous CardAcquisition or Payment/Loyalty request. Identification of a previous…

9 properties

PredefinedContent

object

It conveys Information related to the predefined message. Reference of a predefined message to display or print.

2 properties 1 required

SaleTerminalData

object

In the Login Request, if a Sale Terminal is involved in the login. In other messages, when a logical device is out of order (SaleCapabilites), or when the othe…

1 property

CustomerOrderReq

array

SaleToIssuerData

object

The POI System receives this information and sends it to the Acquirer for the Issuer without any change. Sale information intended for the Issuer.

1 property

LoyaltyHandling

string

IdentificationSupport

string

LoyaltyResponse

object

It conveys Information related to the Loyalty transaction processed by the POI System. Content of the Loyalty Response message.

5 properties 3 required

LoyaltyAccount

object

This data structure conveys the identification of the account and the associated loyalty brand. Data related to a loyalty account processed in the transaction.

2 properties 1 required

LoyaltyAmount

object

An awarded amount or an amount to redeem to the loyalty account might be sent in the Payment request message. Amount of a loyalty account.

3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Adyen publishes across the network.

Adyen acceptDispute API

AE Profile APIs.io

Adyen Account API

AE Profile APIs.io

Adyen accountHolderBalance API

AE Profile APIs.io

Adyen accountHolders API

AE Profile APIs.io

Adyen accountHolderTransactionList API

AE Profile APIs.io

Adyen Accounting Notifications API

AE Profile APIs.io

Adyen Accounts API

AE Profile APIs.io

Adyen adjustAuthorisation API

AE Profile APIs.io

Adyen Admin API

AE Profile APIs.io

Adyen Amount API

AE Profile APIs.io

Adyen Apple API

AE Profile APIs.io

Adyen applePay API

AE Profile APIs.io

#Loyalty

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Adyen Loyalty API

Metadata

Authentication & Security 2

Paths & Operations 1

Schemas 45

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Adyen Loyalty API

Metadata

Authentication & Security 2

Paths & Operations 1

Schemas 45

Specification

Source

More from Adyen 12

API Details

Provider

Explore more