Use CreateSpecialTender to start Alipay and WeChat Pay transactions

PedDevice Object

Name

Description

PedDevice

PED object that represents the terminal.

Create a SpecialTenderRequest object

Name Description
CreateSpecialTenderRequest

Use this method to create a request object to hold the special tender details. Instantiates an Adyen.SpecialTenderRequest object.

Adding Parameters to a SpecialTenderRequest

Parameters

Key

Type

Required

Description

merchantAccount String (tick)

The transaction reference provided by the Merchant (reported in the Adyen payments platform).

amountValue

String

(tick)

The transaction amount in minor units (100 is 1.00 with EUR). The Amount field should be a strong typed field with a string for currency code and a number (long) for the minor digits value (similar to the current API (of the terminal)).

amountCurrency long (tick) The transaction currency.
TransactionType String (tick)

Type of transaction. TransactionType takes the following value:

  • payment
paymentMethodType String (tick)

The type of payment method, in this case wallets. PaymentMethodType takes the following values:

    • Pass "alipay" for an Alipay transaction.
    • Pass "wechatpay_pos" for WeChat Pay transaction.
specialOptions SpecialTenderOptions (error)

Holds tender attributes.

handleReceipt Boolean (error) Specifies that the POS handles and prints receipts. If omitted, it is required that the PED prints the receipt. If there is no printer unit, the transaction will fail.

Add parameters to the SpecialTenderRequest using the SpecialOptions.Add method. 

Remove parameters from the SpecialTenderRequest using the SpecialOptions.Rm method. 

Name Type Required Description
cardNumber String (error) The scanned number from the wallet app (to be provided only for Flow 3: Cash register scans Shopper barcode)
forceEntryMode String (tick) The entry mode for the transaction. In this case, use the value "Keyed".

Not all languages using COM handle empty parameters equally. This has the potential to cause unexpected behavior. To prevent this, provide empty strings or pass Null objects for C++/C#, and the default value Nothing for vb.net.

Code example

specialTenderRequest.SpecialOptions.Add("cardNumber", "60362821657200117610")

Create a special tender 

Name Description
CreateSpecialTender

Use this method to create a special tender and pass the Adyen.SpecialTenderRequest object.

Callbacks

Name

Description

Progress Event Callback

Reports the progress of a running tender.

PrintReceipt Callback

Returns the receipt for printing, and requests that the POS confirms it has received the receipt.
Final Callback

When the system finishes processing the tender, it triggers the final state callback.