Skip to main content

HostedConfiguration

instantCapturestringrequired

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)

scaModestringrequired

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.

timeoutintegerrequired

How many minutes sessions stays active.

notificationUrlurirequired

The URL to receive webhook notifications for any attempted transactions

successUrlurirequired

The URL the client is redirected to on successful payments

failureUrlurirequired

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

retryUrlurinullable

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.

maxAttemptsintegerrequired

The maximum number of transaction attempts allowed for the payment session

processorstring[]required

A priority list of processors to attempt when processing card transactions

exemptionsstring[]required

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

reportFailurebooleanrequired

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

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
}