Search docs

Are you looking for test card numbers?

Would you like to contact support?

Start searching Adyen's documentation...

  Documentation

GiftcardCashbackRequest

Component Type Required Description

SaleToPOIRequest

Defined datastructure

 

  

Defined datastructure

 

  

  

ProtocolVersion

String

Conditional

Rule: If MessageCategory is Login or Diagnosis.

  

  

Enumeration

Required

Class of the message.

  

  

Enumeration

Required

Category of message.

  

  

Enumeration

Required

Type of message of the Sale to POI protocol.

  

  

ServiceID

String

Conditional

Identification of a message pair, which processes a transaction.
Rule: Required if 'Service' or 'Event' MessageClass message or if 'Device' MessageClass and request from POI or response from Sale.

  

  

SaleID

String

Required

Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.

  

  

POIID

String

Required

Identification of a POI System or a POI Terminal for the Sale to POI protocol.

  

Defined datastructure

 

  

  

Defined datastructure

Required

Data related to the Sale System.

  

  

  

Defined datastructure

Required

Unique identification of a Sale transaction.

  

  

  

  

TransactionID

String

Required

Unique identification of a transaction. To identify the transaction on the Sale System (e.g. ticket number), or the POI System.

  

  

  

  

TimeStamp

ISODateTime

Required

Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.

  

  

  

SaleReferenceID

String

Conditional

Identification of a Sale global transaction for a sequence of related POI transactions.
Rule: If payment reservation.

  

  

  

SaleToAcquirerData

String

Conditional

Sale information intended for the Acquirer.
Rule: Send to the Acquirer if present.

  

  

Defined datastructure

Required

Data related to the payment and loyalty transaction.

  

  

  

Defined datastructure

Required

Various amounts related to the payment and loyalty request from the Sale System.

  

  

  

  

Currency

ISOCurrency

Required

Currency of a monetary amount.

  

  

  

  

RequestedAmount

SimpleAmount

Conditional

Amount requested by the Sale for the payment.

  

  

Defined datastructure

Conditional

Data related to the payment transaction.
Rule: If one data element is present.

  

  

  

Enumeration

Conditional

  

  

  

Defined datastructure

Conditional

  

  

  

  

Enumeration

Required

Type of payment instrument.

  

  

  

  

Defined datastructure

Conditional

  

  

  

  

  

Enumeration

Required

  

  

  

  

  

Cluster

Required

  

  

  

  

  

StoredValueProvider

String

Conditional

  

  

  

  

  

StoredValueID

String

Required

  

  

  

  

  

Enumeration

Required

  

  

  

  

  

ExpiryDate

DigitString

Conditional