Transaction

Call this method to provide Dynamic currency conversion (DCC) inquiry details for your customer

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/DccInquiry

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request identifier]",
    "RetryIndicator": 0
  },
  "TerminalId": "[your terminal id]",
  "CardNumber": "1234123412341234",
  "Amount": {
    "Value": "100",
    "CurrencyCode": "EUR"
  }
}

200Success

{
  "DccToken": "e8dc9c0d-128c-4619-bc87-7974248ee0ef",
  "DccAvailable": true,
  "DccInfo": {
    "CardHolderAmount": {
      "Value": "171",
      "CurrencyCode": "AUD"
    },
    "MerchantAmount": {
      "Value": "100",
      "CurrencyCode": "EUR"
    },
    "Markup": "3%",
    "ExchangeRate": "0.58620689",
    "Source": "European Central Bank",
    "Brand": {
      "PaymentMethod": "MASTERCARD",
      "Name": "MasterCard"
    }
  },
  "Expiration": "2025-10-30T00:45:44"
}

Call this method to get information about a previously initialized alternative payment transaction

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/QueryAlternativePayment

POST /Api/Payment/v1/Transaction/QueryAlternativePayment 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": "CAPTURED",
    "Id": "ChAChMA5hx89vAAzEh52AUYvxWCb",
    "CaptureId": "ChAChMA5hx89vAAzEh52AUYvxWCb",
    "Date": "2019-06-19T15:04:48.733+02:00",
    "Amount": {
      "Value": "100",
      "CurrencyCode": "EUR"
    },
    "AcquirerName": "Bancontact Saferpay Test",
    "AcquirerReference": "32332251189",
    "SixTransactionReference": "0:0:3:723n4MAjMdhjSAhAKEUdA8jtl9jb",
    "ApprovalCode": "945011"
  },
  "PaymentMeans": {
    "Brand": {
      "PaymentMethod": "BANCONTACT",
      "Name": "Bancontact"
    },
    "DisplayText": "xxxx xxxx xxxx x000 5",
    "Card": {
      "MaskedNumber": "xxxxxxxxxxxxx0005",
      "ExpYear": 2020,
      "ExpMonth": 6,
      "CountryCode": "BE"
    }
  },
  "Liability": {
    "LiabilityShift": true,
    "LiableEntity": "THREEDS",
    "ThreeDs": {
      "Authenticated": true,
      "Xid": "ARkvCgk5Y1t/BDFFXkUPGX9DUgs="
    }
  }
}

This method can be used to authorize the payments that do not have a payment-page or for the payments that before authorization some additional steps such as authentication should be done.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/AlternativePayment

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[your request id]",
    "RetryIndicator": 0
  },
  "TerminalId": "[your terminal id]",
  "Payment": {
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    }
  },
  "PaymentMethod": "BANCONTACT"
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Token": "234uhfh78234hlasdfh8234e",
  "Expiration": "2015-01-30T12:45:22.258+01:00",
  "ProcessingData": {
    "Bancontact": {
      "QrCodeData": "someQRcodeData",
      "IntentUrl": "https://www.saferpay.com/vt2/Api/..."
    }
  }
}

This method can be used to get the details of a transaction that has been authorized successfully. Fair use:This method is not intended for polling. You have to restrict the usage of this method in order to provide a fair data access to all our customers. We may contact you if we notice the excessive usage of this function and in some exceptional cases we preserve the right to limit the access to it.

post

ATTENTION: If you change the name of this method, make sure that the value of the field ActionIdOfCallToTransactionInquire in AnalyzerLogRepository is updated as well.

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/Inquire

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "TransactionReference": {
    "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Transaction": {
    "Type": "PAYMENT",
    "Status": "CAPTURED",
    "Id": "UlKpE6A2UxlttAOQtnYIbCj1CpIA",
    "Date": "2019-04-05T10:49:55.76+02:00",
    "Amount": {
      "Value": "1200",
      "CurrencyCode": "CHF"
    },
    "AcquirerName": "Saferpay Test Card",
    "AcquirerReference": "32436794662",
    "SixTransactionReference": "0:0:3:723n4MAjMdhjSAhAKEUdA8jtl9jb",
    "ApprovalCode": "012345"
  },
  "PaymentMeans": {
    "Brand": {
      "PaymentMethod": "VISA",
      "Name": "VISA"
    },
    "DisplayText": "xxxx xxxx xxxx 0004",
    "Card": {
      "MaskedNumber": "901050xxxxxx0004",
      "ExpYear": 2022,
      "ExpMonth": 6,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH"
    }
  },
  "Liability": {
    "LiabilityShift": true,
    "LiableEntity": "THREEDS",
    "ThreeDs": {
      "Authenticated": true,
      "Xid": "ARkvCgk5Y1t/BDFFXkUPGX9DUgs="
    }
  }
}

WARNING: This feature is deprecated and replaced by the Payment Page. Please use the parameter PaymentMethods to directly select the desired 3rd party provider!

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/AssertRedirectPayment

POST /Api/Payment/v1/Transaction/AssertRedirectPayment 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",
    "AcquirerReference": "8EZRQVT0ODW4ME525",
    "SixTransactionReference": "0:0:3:723n4MAjMdhjSAhAKEUdA8jtl9jb",
    "ApprovalCode": "012345"
  },
  "PaymentMeans": {
    "Brand": {
      "PaymentMethod": "VISA",
      "Name": "VISA Saferpay Test"
    },
    "DisplayText": "9123 45xx xxxx 1234",
    "Card": {
      "Number": "912345678901234",
      "MaskedNumber": "912345xxxxxx1234",
      "ExpYear": 2022,
      "ExpMonth": 9,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH"
    }
  }
}

WARNING: This feature is deprecated and replaced by the Payment Page. Please use the parameter PaymentMethods to directly select the desired 3rd party provider!

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/RedirectPayment

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[your request id]",
    "RetryIndicator": 0
  },
  "TerminalId": "[your terminal id]",
  "Payment": {
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    }
  },
  "ServiceProvider": "POSTFINANCE",
  "ReturnUrl": {
    "Url": "[your shop payment url]"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Token": "234uhfh78234hlasdfh8234e",
  "Expiration": "2015-01-30T12:45:22.258+01:00",
  "RedirectUrl": "https://www.saferpay.com/vt2/Api/..."
}

This method may be used to cancel previously authorized transactions and refunds.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/Cancel

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "TransactionReference": {
    "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb",
  "OrderId": "c52ad18472354511ab2c33b59e796901",
  "Date": "2015-01-30T12:45:22.258+01:00"
}

This method may be called to refund an amount to the given means of payment (not supported for all means of payment) without referencing a previous transaction. This might be the case if the original transaction was done with a card which is not valid any more. Warning: Only PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/RefundDirect

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[your request id]",
    "RetryIndicator": 0
  },
  "TerminalId": "[your terminal id]",
  "Refund": {
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    }
  },
  "PaymentMeans": {
    "Alias": {
      "Id": "alias35nfd9mkzfw0x57iwx"
    }
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Transaction": {
    "Type": "REFUND",
    "Status": "AUTHORIZED",
    "Id": "723n4MAjMdhjSAhAKEUdA8jtl9jb",
    "Date": "2015-01-30T12:45:22.258+01:00",
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    },
    "AcquirerName": "Saferpay Test",
    "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"
    }
  }
}

This method may be used to inquire the status and further information of pending refunds. Attention: This method is only supported for pending refunds. A pending refund is only applicable for paydirekt or WL Crypto Payments transactions at the moment.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/AssertRefund

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "TransactionReference": {
    "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb",
  "Status": "CAPTURED",
  "Date": "2015-01-30T12:45:22.258+01:00"
}

This method may be called to refund a previous transaction.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/Refund

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[your request id]",
    "RetryIndicator": 0
  },
  "Refund": {
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    }
  },
  "CaptureReference": {
    "CaptureId": "723n4MAjMdhjSAhAKEUdA8jtl9jb_c"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Transaction": {
    "Type": "REFUND",
    "Status": "AUTHORIZED",
    "Id": "723n4MAjMdhjSAhAKEUdA8jtl9jb",
    "Date": "2015-01-30T12:45:22.258+01:00",
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    },
    "AcquirerName": "Saferpay Test",
    "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"
    }
  }
}

This method may be used to finalize a transaction having one or more partial captures (i.e. marks the end of partial captures).

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/MultipartFinalize

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request identifier]",
    "RetryIndicator": 0
  },
  "TransactionReference": {
    "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[unique request identifier]"
  }
}

Attention: This method is only supported for pending captures. A pending capture is only applicable for PostFinance Instant Payout transactions at the moment. This method is only supported for pending capture transactions (only used for PostFinance Instant Payout at the moment)

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/AssertCapture

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "CaptureReference": {
    "CaptureId": "24218eabae254caea6f898e413fe_c"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb",
  "Status": "CAPTURED",
  "Date": "2015-01-30T12:45:22.258+01:00"
}

This method may be used to capture multiple parts of an authorized transaction. Important: MultipartCapture is available for PayPal, Klarna and card payments Visa, Mastercard, Maestro, Diners/Discover, JCB and American Express which are acquired by Worldline. No MultipartCapture request should be sent before receiving the response of a preceding request (i.e. no parallel calls are allowed). The sum of multipart captures must not exceed the authorized amount. A unique OrderPartId must be used for each request.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/MultipartCapture

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request identifier]",
    "RetryIndicator": 0
  },
  "TransactionReference": {
    "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb"
  },
  "Amount": {
    "Value": "1000",
    "CurrencyCode": "CHF"
  },
  "Type": "PARTIAL",
  "OrderPartId": "123456789",
  "Marketplace": {
    "SubmerchantId": "17312345",
    "Fee": {
      "Value": "500",
      "CurrencyCode": "CHF"
    }
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[unique request identifier]"
  },
  "CaptureId": "723n4MAjMdhjSAhAKEUdA8jtl9jb_c",
  "Status": "CAPTURED",
  "Date": "2018-08-08T13:45:22.258+02:00"
}

This method may be used to finalize previously authorized transactions and refunds.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/Capture

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "TransactionReference": {
    "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "CaptureId": "723n4MAjMdhjSAhAKEUdA8jtl9jb",
  "Status": "CAPTURED",
  "Date": "2015-01-30T12:45:22.258+01:00"
}

This method may be used to perform follow-up authorizations to an earlier transaction. At this time, the referenced (initial) transaction must have been performed setting either the recurring or installment option.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/AuthorizeReferenced

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "TerminalId": "[your terminal id]",
  "Payment": {
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    },
    "Description": "Test123",
    "PayerNote": "Order123_Testshop"
  },
  "Authentication": {
    "Exemption": "RECURRING"
  },
  "TransactionReference": {
    "TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb"
  }
}

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": "AcquirerName",
    "AcquirerReference": "Reference",
    "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": 7,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH"
    }
  },
  "Payer": {
    "IpAddress": "1.2.3.4",
    "IpLocation": "DE"
  },
  "Dcc": {
    "PayerAmount": {
      "Value": "109",
      "CurrencyCode": "USD"
    }
  }
}

This function may be used to directly authorize transactions which do not require a redirect of the customer (e.g. direct debit or recurring transactions based on a previously registered alias). Warning: Only PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information! Important: This function does not perform 3D Secure! Only the PaymentPage or Transaction Initialize do support 3D Secure!

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/AuthorizeDirect

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "TerminalId": "[your terminal id]",
  "Payment": {
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    },
    "Description": "Test123",
    "PayerNote": "Order123_Testshop"
  },
  "PaymentMeans": {
    "Card": {
      "Number": "912345678901234",
      "ExpYear": 2015,
      "ExpMonth": 9,
      "HolderName": "Max Mustermann",
      "VerificationCode": "123"
    }
  },
  "Authentication": {
    "Exemption": "RECURRING"
  }
}

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": "AcquirerName",
    "AcquirerReference": "Reference",
    "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": 7,
      "HolderName": "Max Mustermann",
      "CountryCode": "CH"
    }
  },
  "Payer": {
    "IpAddress": "1.2.3.4",
    "IpLocation": "DE"
  }
}

This function may be called to authorize a transaction which was started by a call to Transaction/Initialize.

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/Authorize

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "Token": "sdu5ymxx210y2dz1ggig2ey0o",
  "VerificationCode": "123"
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Transaction": {
    "Type": "PAYMENT",
    "Status": "AUTHORIZED",
    "Id": "MUOGAWA9pKr6rAv5dUKIbAjrCGYA",
    "Date": "2015-09-18T09:19:27.078Z",
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    },
    "AcquirerName": "AcquirerName",
    "AcquirerReference": "Reference",
    "SixTransactionReference": "0:0:3:MUOGAWA9pKr6rAv5dUKIbAjrCGYA",
    "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"
    }
  },
  "Payer": {
    "IpAddress": "1.2.3.4",
    "IpLocation": "DE"
  },
  "Liability": {
    "LiabilityShift": true,
    "LiableEntity": "THREEDS",
    "ThreeDs": {
      "Authenticated": true,
      "Xid": "ARkvCgk5Y1t/BDFFXkUPGX9DUgs="
    }
  }
}

This method may be used to start a transaction which may involve either DCC and / or 3d-secure. Warning: Only PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!

post

Authorizations

AuthorizationstringRequired

Basic authentication with your Saferpay API user credentials.

Body

Responses

200Success

application/json

Responseone of | nullable

post

/Payment/v1/Transaction/Initialize

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

{
  "RequestHeader": {
    "SpecVersion": "[current Spec-Version]",
    "CustomerId": "[your customer id]",
    "RequestId": "[unique request id]",
    "RetryIndicator": 0
  },
  "TerminalId": "[your terminal id]",
  "Payment": {
    "Amount": {
      "Value": "100",
      "CurrencyCode": "CHF"
    }
  },
  "Payer": {
    "LanguageCode": "en"
  },
  "ReturnUrl": {
    "Url": "[your shop payment url]"
  },
  "Styling": {
    "CssUrl": "[your shop css url]"
  }
}

200Success

{
  "ResponseHeader": {
    "SpecVersion": "[current Spec-Version]",
    "RequestId": "[your request id]"
  },
  "Token": "234uhfh78234hlasdfh8234e",
  "Expiration": "2015-01-30T12:45:22.258+01:00",
  "LiabilityShift": true,
  "RedirectRequired": true,
  "Redirect": {
    "RedirectUrl": "https://www.saferpay.com/vt2/Api/...",
    "PaymentMeansRequired": true
  }
}

PreviousChangelog NextPaymentPage

Last updated 9 minutes ago

Was this helpful?

hashtagCall this method to provide Dynamic currency conversion (DCC) inquiry details for your customer

hashtagCall this method to get information about a previously initialized alternative payment transaction

hashtagThis method can be used to authorize the payments that do not have a payment-page or for the payments that before authorization some additional steps such as authentication should be done.

hashtag WARNING: This feature is deprecated and replaced by the Payment Page. Please use the parameter PaymentMethods to directly select the desired 3rd party provider!

hashtag WARNING: This feature is deprecated and replaced by the Payment Page. Please use the parameter PaymentMethods to directly select the desired 3rd party provider!

hashtagThis method may be used to cancel previously authorized transactions and refunds.

hashtagThis method may be used to inquire the status and further information of pending refunds. Attention: This method is only supported for pending refunds. A pending refund is only applicable for paydirekt or WL Crypto Payments transactions at the moment.

hashtagThis method may be called to refund a previous transaction.

hashtagThis method may be used to finalize a transaction having one or more partial captures (i.e. marks the end of partial captures).

hashtag Attention: This method is only supported for pending captures. A pending capture is only applicable for PostFinance Instant Payout transactions at the moment. This method is only supported for pending capture transactions (only used for PostFinance Instant Payout at the moment)

hashtagThis method may be used to finalize previously authorized transactions and refunds.

hashtagThis method may be used to perform follow-up authorizations to an earlier transaction. At this time, the referenced (initial) transaction must have been performed setting either the recurring or installment option.

hashtagThis function may be called to authorize a transaction which was started by a call to Transaction/Initialize.

hashtagThis method may be used to start a transaction which may involve either DCC and / or 3d-secure. Warning: Only PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!

Call this method to provide Dynamic currency conversion (DCC) inquiry details for your customer

Call this method to get information about a previously initialized alternative payment transaction

This method can be used to authorize the payments that do not have a payment-page or for the payments that before authorization some additional steps such as authentication should be done.

WARNING: This feature is deprecated and replaced by the Payment Page. Please use the parameter PaymentMethods to directly select the desired 3rd party provider!

WARNING: This feature is deprecated and replaced by the Payment Page. Please use the parameter PaymentMethods to directly select the desired 3rd party provider!

This method may be used to cancel previously authorized transactions and refunds.

This method may be used to inquire the status and further information of pending refunds. Attention: This method is only supported for pending refunds. A pending refund is only applicable for paydirekt or WL Crypto Payments transactions at the moment.

This method may be called to refund a previous transaction.

This method may be used to finalize a transaction having one or more partial captures (i.e. marks the end of partial captures).

Attention: This method is only supported for pending captures. A pending capture is only applicable for PostFinance Instant Payout transactions at the moment. This method is only supported for pending capture transactions (only used for PostFinance Instant Payout at the moment)

This method may be used to finalize previously authorized transactions and refunds.

This method may be used to perform follow-up authorizations to an earlier transaction. At this time, the referenced (initial) transaction must have been performed setting either the recurring or installment option.

This function may be called to authorize a transaction which was started by a call to Transaction/Initialize.

This method may be used to start a transaction which may involve either DCC and / or 3d-secure. Warning: Only PCI certified merchants may submit the card-data directly, or use their own HTML form! Click here for more information!