PaymentPage

Call this function to safely check the status of the transaction from your server, either after the payer was redirected back to your shop or your shop system received the server-to-server notification call. Important: Do not poll this function! Wait until the payer is redirected back to the shop or until the notification was called (we strongly recommend using the notification feature). Depending on the payment provider, the resulting transaction may either be an authorization or may already be captured (meaning the financial flow was already triggered). This will be visible in the status of the transaction container returned in the response. This function can be called up to 24 hours after the transaction was initialized. For pending transaction the token expiration is increased to 120 hours. If the transaction failed (the payer was redirected to the Fail url or he manipulated the return url), an error response with an http status code 400 or higher containing an error message will be returned providing some information on the transaction failure.

post

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

application/json

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/PaymentPage/Assert

HTTPcURLJavaScriptPython

POST /Api/Payment/v1/PaymentPage/Assert HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request identifier]",
    "RetryIndicator": 0
  },
  "Token": "234uhfh78234hlasdfh8234e"
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Transaction": {
    "Type": "PAYMENT",
    "Status": "AUTHORIZED",
    "Id": "723n4MAjMdhjSAhAKEUdA8jtl9jb",
    "Date": "2015-01-30T12:45:22.258+01:00",
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    },
    "AcquirerName": "Saferpay Test Card",
    "AcquirerReference": "000000",
    "SixTransactionReference": "0:0:3:723n4MAjMdhjSAhAKEUdA8jtl9jb",
    "ApprovalCode": "012345"
  },
  "PaymentMeans": {
    "Brand": {
      "PaymentMethod": "VISA",
      "Name": "VISA Saferpay Test"
    },
    "DisplayText": "9123 45xx xxxx 1234",
    "Card": {
      "MaskedNumber": "912345xxxxxx1234",
      "ExpYear": 2015,
      "ExpMonth": 9,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH"
    }
  },
  "Liability": {
    "LiabilityShift": true,
    "LiableEntity": "THREEDS",
    "ThreeDs": {
      "Authenticated": true,
      "Xid": "ARkvCgk5Y1t/BDFFXkUPGX9DUgs="
    }
  }
}

This method can be used to start a transaction with the Payment Page which may involve either DCC and / or 3d-secure

post

Authorizations

Authorization

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

application/json

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/PaymentPage/Initialize

HTTPcURLJavaScriptPython

POST /Api/Payment/v1/PaymentPage/Initialize HTTP/1.1
Host: test.saferpay.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request identifier]",
    "RetryIndicator": 0
  },
  "TerminalId": "[your terminal id]",
  "Payment": {
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    },
    "OrderId": "Id of the order",
    "Description": "Description of payment"
  },
  "ReturnUrl": {
    "Url": "[your shop payment url]"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "Id of the request"
  },
  "Token": "234uhfh78234hlasdfh8234e1234",
  "Expiration": "2015-01-30T12:45:22.258+01:00",
  "RedirectUrl": "https://www.saferpay.com/vt2/api/..."
}