HostedConfiguration | ePay documentation

The hosted configuration acts as the default values for most of the session initialization parameters. If fields such as maxAttempts is not defined within the /cit call, the value will be fetched from the hosted configuration instead.

instantCapturestring

Required

If the payment should be captured instantly or not.

OFF indicates that the payment should not be captured instantly.

VOID indicates that the payment should be captured instantly and if somehow the instant capture fails the payment is voided.

NO_VOID indicates that the payment should be captured instantly and if the capture fails the authorization is kept (no void is made)

scaModestring

Required

How 3D secure is handled:

SKIP 3DS is not tried and full liability is put at merchant.

NORMAL 3DS flow is attempted as normal guidelines suggests - Both challenge and frictionless can occur.

FORCE A challenge flow is forced. Note: Third parties in the 3DS flow might ignore this instruction.

Possible values:

"SKIP""NORMAL""FORCE"

timeoutinteger

Required

How many minutes sessions stays active.

notificationUrlstring

Required

The URL to receive notifications for successful transaction attempts. Failed transaction attempts are sent only when reportFailure is true, and expired sessions are sent only when reportExpired is true.

Format:

uri

successUrlstring

Required

The URL the client is redirected to on successful payments

Format:

uri

failureUrlstring

Required

The URL the client is redirected to when no more payment attempts is possible for the current session.

Format:

uri

retryUrlstring

Nullable

The URL the client is redirected to on failed payments while there is still more attempts available. If null, then failureUrl is used as a fallback.

Format:

uri

maxAttemptsinteger

Required

The maximum number of transaction attempts allowed for the payment session

DEPRECATED: This parameter will soon be removed and will no longer have any effect. The functionality has been replaced by routing rules in the ePay back office.

List of processors to use. This is the routing of the payment. The value can be shift4, clearhaus and nets.

The priority of the processors is made on the order. That means that if the first processor fails / declines then the next in the list will be used and so on until all processors in the list have been tried. The order is not guaranteed as it depends on external factors such as the specific payment card used by the cardholder.

List of exemptions to apply when possible. Note exemptions shifts liability from the issuer to the merchant.

reportFailureboolean

Required

If true, the notificationUrl will also receive webhooks for failed transactions. Otherwise, only successful transactions is notified.

reportExpiredboolean

Boolean flag to enable / disable receiving webhook notifications for sessions that reach the expired state.

HostedConfiguration

{  "instantCapture": "OFF",  "scaMode": "SKIP",  "timeout": 60,  "notificationUrl": "https://example.com/notification",  "successUrl": "https://example.com/success",  "failureUrl": "https://example.com/failure",  "retryUrl": null,  "maxAttempts": 10,  "processor": [    "shift4",    "nets"  ],  "exemptions": [    "TRA",    "LVT"  ],  "reportFailure": false}