PhysicalSaleTerminal | ePay documentation

Optional terminal selection. If omitted, ePay uses the fallback terminal for the given point of sale.

idstring

Required

The ID of the terminal to target. The terminal must belong to the provided point of sale.

Default:

null

Format:

uuid

Example:

"0197c07b-3f6d-7be2-b848-702b08958128"

suppressAppNotificationsboolean

Nullable

If true no notification is sent to the SoftPay terminal, this might be relevant on "same-device" POS systems, where a App Switch initiates the payment. If the SoftPay app is always in the foreground, then it is recommended to use false, as this makes the SoftPay terminal more responsive.

Default:

false

Example:

false

switchBackTimeoutinteger

Nullable

The number of milliseconds the SoftPay terminal waits, before switching back to the origin app / activity. A null indicates no switch back. A 0 indicates "as fast as allowed". SoftPay enforces a minimum of 1 second for successful payments and 2 seconds for failed payments, due to scheme regulations. This can also be controlled in the intent redirect from a POS app to the SoftPay app.

Default:

null

Example:

0

activityToResumestring

Nullable

ComponentName, e.g. package name / activity class to switch back to, once the payment is completed. This can also be controlled in the intent redirect from a POS app to the SoftPay app.

Default:

null

surchargeboolean

Nullable

Specify if surcharge should be applied to the transaction, if applicable.

Default:

null

Example:

false

dccboolean

Nullable

Specify if dynamic currency conversion (DCC) should be applied to the transaction, if applicable.

Default:

null

Example:

false