Cancel or refund a transaction directly from a POS to the Adyen Payments Platform

POS Object

Name Description
POS POS object representing the Cash Register Application.

With a PSP Reference

Method

Name Description
CancelOrRefundPspReference Initiates the cancel or refund process. Use the PSP reference to identify the transaction to be cancelled.

Parameters

Name

Type

Required

Description

merchantAccount

String

(tick)

The merchant account account that is cancelling the transaction and refunding the money (if applicable).

pspreference String (tick)

PSP reference of the original transaction.

reference String (tick) Reference for the merchant, used in reporting.

Callback

Name Description

CancelOrRefundCB

Refund Callback returns the result of a partial refund, as well as any errors.

The response contains a cancelOrRefundObj. This object contains a getResponse method which should return a result of "refund-received". The response also includes the following parameters:

Name

Type

Description

pedResult

int

Result denoting whether an error occurred on the PED. A value of 0 means no error occurred.

pspResult

int

Result denoting whether an error occurred on the PSP. A value of 0 means no error occurred.
libResult int Result denoting whether an error occurred in the Library. A value of 0 means no error occurred.
errorMessage String Reference for the transaction, used as the PSP reference is not available.

With a Tender Reference

Method

Name

Description

CancelOrRefundTenderReference

Initiates the cancel or refund process where the PSP reference is unknown. Use the tender reference instead of the PSP reference.

Occurs when the original sale transaction was performed offline, where the PspReference was not generated as it requires online access. In this case, provide the TerminalId and TenderReference. The property PspReference is not required.

Parameters

Name

Type

Required

Description

merchantAccount

String

(tick)

The merchant account that is cancelling the transaction and refunding the money (if applicable).

uniqueTerminalId Long (tick)

Unique terminal ID to reference the PED that is processing the request.

tenderReference String (tick) Reference for the transaction, used as the PSP reference is not available.
reference String (tick) Reference for the merchant, used in reporting.

Callback

Name Description

CancelOrRefundCB

The Cancel or Refund Callback returns the result of a cancellation or refund, as well as any errors.

The response contains a cancelOrRefundObj. This object contains a getResponse method which should return a result of "refund-received". The response also includes the following parameters:

Name

Type

Description

pedResult

int

Result denoting whether an error occurred on the PED. A value of 0 means no error occurred.

pspResult

int

Result denoting whether an error occurred on the PSP. A value of 0 means no error occurred.
libResult int Result denoting whether an error occurred in the Library. A value of 0 means no error occurred.
errorMessage String Reference for the transaction, used as the PSP reference is not available.