From 13d7036a2b1acf71f361926ee7b7da2a773e0cb0 Mon Sep 17 00:00:00 2001 From: Martin Distler Date: Mon, 1 Jul 2024 13:49:03 +0200 Subject: [PATCH 1/2] Update json api with content for v1.41 --- .github/workflows/create-gh-pages.yml | 2 +- texts/ChapterAliasStore.md | 288 +-- texts/ChapterManagementApi.md | 208 +- texts/ChapterOmniChannel.md | 90 +- texts/ChapterPaymentPage.md | 268 +-- texts/ChapterTransaction.md | 1398 ++++++------ texts/ContainerDictionary.md | 2978 ++++++++++++------------- texts/ErrorResponse.md | 58 +- 8 files changed, 2638 insertions(+), 2652 deletions(-) diff --git a/.github/workflows/create-gh-pages.yml b/.github/workflows/create-gh-pages.yml index b4688a7..b2b70dd 100644 --- a/.github/workflows/create-gh-pages.yml +++ b/.github/workflows/create-gh-pages.yml @@ -17,7 +17,7 @@ jobs: path: _gh_pages - name: build new version page - run: libs/GitHubPagesGenerator.exe -i "${{ github.workspace }}" -s "${{ github.workspace }}/Sitemap.json" -c "${{ github.workspace }}" -o _gh_pages -t "JSON API Spec-Version 1.40" + run: libs/GitHubPagesGenerator.exe -i "${{ github.workspace }}" -s "${{ github.workspace }}/Sitemap.json" -c "${{ github.workspace }}" -o _gh_pages -t "JSON API Spec-Version 1.41" - name: push updated gh pages uses: s0/git-publish-subdir-action@develop diff --git a/texts/ChapterAliasStore.md b/texts/ChapterAliasStore.md index e5afd6d..781301f 100644 --- a/texts/ChapterAliasStore.md +++ b/texts/ChapterAliasStore.md @@ -30,170 +30,170 @@ This function may be used to insert an alias without knowledge about the card de - RequestHeader
+ CardForm
- - mandatory, - - object + object -
General information about the request.
+
Options for card data entry form (if applicable)
- RegisterAlias
+ Check
- - mandatory, - - object + object -
Registration parameters
+
Parameters for checking the means of payment before registering.
IMPORTANT NOTE: The Check function is only available for certain brands / acquirers! For more information, see Saferpay Integration Guide for Secure Card Data

- Type
+ LanguageCode
- - mandatory, - string -
Type of payment means to register
+
Language used for displaying forms. Format: ISO 639-1 (two-letter language code), optionally followed by a hyphen and ISO 3166-1 alpha-2 (two-letter country code).
The supported language codes are listed below. This list may be extended in the future as more languages become available.
We recommend to only use supported language and country codes. If the submitted value has a valid format, but the language is unsupported, then the default language is used.
For supported languages, using different country codes than those explicitly listed here may or may not work as expected.

Code-List:
bg - Bulgarian
cs - Czech
da - Danish
de - German
de-CH - Swiss German
el - Greek
en - English
es - Spanish
et - Estonian
fi - Finnish
fr - French
hr - Croatian
hu - Hungarian
is - Icelandic
it - Italian
ja - Japanese
lt - Lithuanian
lv - Latvian
nl - Dutch
nn - Norwegian
pl - Polish
pt - Portuguese
ro - Romanian
ru - Russian
sk - Slovak
sl - Slovenian
sv - Swedish
tr - Turkish
uk - Ukrainian
zh - Chinese
-Possible values: CARD, BANK_ACCOUNT, POSTFINANCEPAY, TWINT.
- Example: CARD + Example: de - ReturnUrl
+ Notification
- - mandatory, - - object + object -
URL which is used to redirect the payer back to the shop.

This Url is used by Saferpay to redirect the shopper back to the merchant shop. You may add query string parameters to identify your session, but please be aware that the shopper could modify these parameters inside the browser!
The whole url including query string parameters should be as short as possible to prevent issues with specific browsers and must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents is plainly visible inside the browser and will be logged by our web servers.
+
Url to which Saferpay will send the asynchronous confirmation for the process completion. Supported schemes are http and https. You also have to make sure to support the GET-method.
- + Example: https://merchanthost/notify/123 + - Styling
+ PaymentMeans
- object + object -
Custom styling resource for the Hosted Register form.
+
Means of payment to register
- LanguageCode
+ PaymentMethods
- string + array of strings -
Language used for displaying forms.
The supported language codes are listed below. This list may be extended in the future as more languages become available. If the submitted language code has a valid format, but is not supported, then the default language is used.

Code-List:
bg - Bulgarian
cs - Czech
da - Danish
de - German
de-ch - Swiss German
el - Greek
en - English
es - Spanish
et - Estonian
fi - Finnish
fr - French
hr - Croatian
hu - Hungarian
is - Icelandic
it - Italian
ja - Japanese
lt - Lithuanian
lv - Latvian
nl - Dutch
nn - Norwegian
pl - Polish
pt - Portuguese
ro - Romanian
ru - Russian
sk - Slovak
sl - Slovenian
sv - Swedish
tr - Turkish
uk - Ukrainian
zh - Chinese
+
Used to restrict the means of payment which are available to the payer
- Example: de +Possible values: AMEX, BONUS, DINERS, DIRECTDEBIT, JCB, MAESTRO, MASTERCARD, MYONE, VISA. Additional values may be accepted but are ignored.
+ Example: ["VISA", "MASTERCARD"] - Check
+ RegisterAlias
+ + mandatory, + - object + object -
Parameters for checking the means of payment before registering.
IMPORTANT NOTE: The Check function is only available for certain brands / acquirers! For more information, see Saferpay Integration Guide for Secure Card Data

+
Registration parameters
- PaymentMethods
+ RequestHeader
- array of strings + + mandatory, + + + object -
Used to restrict the means of payment which are available to the payer
+
General information about the request.
-Possible values: AMEX, BONUS, DINERS, DIRECTDEBIT, JCB, MAESTRO, MASTERCARD, MYONE, VISA. Additional values may be accepted but are ignored.
- Example: ["VISA", "MASTERCARD"] - + - CardForm
+ ReturnUrl
+ + mandatory, + - object + object -
Options for card data entry form (if applicable)
+
URL which is used to redirect the payer back to the shop.

This Url is used by Saferpay to redirect the shopper back to the merchant shop. You may add query string parameters to identify your session, but please be aware that the shopper could modify these parameters inside the browser!
The whole url including query string parameters should be as short as possible to prevent issues with specific browsers and must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents is plainly visible inside the browser and will be logged by our web servers.
- PaymentMeans
+ Styling
- object + object -
Means of payment to register
+
Custom styling resource for the Hosted Register form.
- Notification
+ Type
- - object + + mandatory, + + string -
Url to which Saferpay will send the asynchronous confirmation for the process completion. Supported schemes are http and https. You also have to make sure to support the GET-method.
+
Type of payment means to register
- Example: https://merchanthost/notify/123 +Possible values: CARD, BANK_ACCOUNT, POSTFINANCEPAY, TWINT.
+ Example: CARD @@ -239,80 +239,80 @@ Possible values: AMEX, BONUS, DINERS, DIRECTDEBIT, JCB, MAESTRO, MASTERCARD, MYO - ResponseHeader
+ Expiration
mandatory, - - object + date -
Contains general information about the response.
+
Expiration date / time of the generated token in ISO 8601 format in UTC.
After this time is exceeded, the token will not be accepted for any further actions except Asserts.
- + Example: 2015-01-30T13:45:22.258+02:00 + - Token
+ Redirect
- - mandatory, - - string + + object -
Id for referencing later
+
Mandatory if RedirectRequired is true. Contains the URL for the redirect to use for example the Saferpay hosted register form.
- Example: 234uhfh78234hlasdfh8234e - + - Expiration
+ RedirectRequired
- - mandatory, - - date + boolean -
Expiration date / time of the generated token in ISO 8601 format in UTC.
After this time is exceeded, the token will not be accepted for any further actions except Asserts.
+
True if a redirect must be performed to continue, false otherwise
- Example: 2015-01-30T13:45:22.258+02:00 - + - RedirectRequired
+ ResponseHeader
- boolean + + mandatory, + + + object -
True if a redirect must be performed to continue, false otherwise
+
Contains general information about the response.
- Redirect
+ Token
- - object + + mandatory, + + string -
Mandatory if RedirectRequired is true. Contains the URL for the redirect to use for example the Saferpay hosted register form.
+
Id for referencing later
- + Example: 234uhfh78234hlasdfh8234e + @@ -444,34 +444,31 @@ Id[1..50]
- ResponseHeader
+ Alias
mandatory, - object + object -
Contains general information about the response.
+
Information about the registered alias.
- Alias
+ CheckResult
- - mandatory, - - object + object -
Information about the registered alias.
+
Result of the Check
@@ -495,14 +492,17 @@ Id[1..50]
- CheckResult
+ ResponseHeader
+ + mandatory, + - object + object -
Result of the Check
+
Contains general information about the response.
@@ -577,34 +577,28 @@ This method may be used to insert an alias directly with card-data collected by - RequestHeader
+ Check
- - mandatory, - - object + object -
General information about the request.
+
Parameters for checking the means of payment before registering. IMPORTANT NOTE: The Check function is only available for SIX Payment Services VISA and Mastercard acquiring contracts!
- RegisterAlias
+ IssuerReference
- - mandatory, - - object + object -
Registration parameters
+
Contains that is received from the issuer in the response of a successful payment by other payment providers. This data will be used for authorizations based on this alias.
@@ -628,28 +622,34 @@ This method may be used to insert an alias directly with card-data collected by - Check
+ RegisterAlias
+ + mandatory, + - object + object -
Parameters for checking the means of payment before registering. IMPORTANT NOTE: The Check function is only available for SIX Payment Services VISA and Mastercard acquiring contracts!
+
Registration parameters
- IssuerReference
+ RequestHeader
+ + mandatory, + - object + object -
Contains that is received from the issuer in the response of a successful payment by other payment providers. This data will be used for authorizations based on this alias.
+
General information about the request.
@@ -701,34 +701,31 @@ This method may be used to insert an alias directly with card-data collected by - ResponseHeader
+ Alias
mandatory, - object + object -
Contains general information about the response.
+
Information about the registered alias.
- Alias
+ CheckResult
- - mandatory, - - object + object -
Information about the registered alias.
+
Result of the Check
@@ -752,14 +749,17 @@ This method may be used to insert an alias directly with card-data collected by - CheckResult
+ ResponseHeader
+ + mandatory, + - object + object -
Result of the Check
+
Contains general information about the response.
@@ -924,51 +924,51 @@ This method may be used to update an alias' lifetime and / or its credit card ex - ResponseHeader
+ Alias
mandatory, - object + object -
Contains general information about the response.
+
Information about the registered alias.
- Alias
+ PaymentMeans
mandatory, - object + object -
Information about the registered alias.
+
Information about the registered means of payment
- PaymentMeans
+ ResponseHeader
mandatory, - object + object -
Information about the registered means of payment
+
Contains general information about the response.
@@ -1039,37 +1039,37 @@ This method may be used to delete previously inserted aliases. - RequestHeader
+ AliasId
mandatory, - - object + string -
General information about the request.
+
The Alias you want to delete. This value is case-insensitive.
- +Id[1..40]
+ Example: alias35nfd9mkzfw0x57iwx + - AliasId
+ RequestHeader
mandatory, - string + + object -
The Alias you want to delete. This value is case-insensitive.
+
General information about the request.
-Id[1..40]
- Example: alias35nfd9mkzfw0x57iwx - + diff --git a/texts/ChapterManagementApi.md b/texts/ChapterManagementApi.md index 75cec7f..ef0d5c7 100644 --- a/texts/ChapterManagementApi.md +++ b/texts/ChapterManagementApi.md @@ -99,34 +99,34 @@ No example available - Package
+ Features
mandatory, - object + array of objects -
Information about the configured package
+
All features contained in the configured package or assigned additionally
- Features
+ Package
mandatory, - array of objects + object -
All features contained in the configured package or assigned additionally
+
Information about the configured package
@@ -212,34 +212,34 @@ No example available - Package
+ Features
mandatory, - object + array of objects -
Information about the configured package
+
All features contained in the configured package or assigned additionally
- Features
+ Package
mandatory, - array of objects + object -
All features contained in the configured package or assigned additionally
+
Information about the configured package
@@ -302,36 +302,36 @@ Create a Saferpay Fields Access Token that can be used to integrate Saferpay Fie - SourceUrls
+ Description
mandatory, - string[] + string -
The fully qualified URL of the shop (the page that integrates Saferpay Fields). We recommend that URLs end with a trailing slash. Only HTTPS is allowed.
+
A human readable description that will be shown in the Saferpay Backoffice to easily identify the Access Token.
- Example: https://yourshop.com/ - +Utf8[1..128]
+ - Description
+ SourceUrls
mandatory, - string + string[] -
A human readable description that will be shown in the Saferpay Backoffice to easily identify the Access Token.
+
The fully qualified URL of the shop (the page that integrates Saferpay Fields). We recommend that URLs end with a trailing slash. Only HTTPS is allowed.
-Utf8[1..128]
- + Example: https://yourshop.com/ + @@ -428,36 +428,30 @@ This function may be used to create a single use payment link - Payment
+ BillingAddressForm
- - mandatory, - - object + object -
Information about the payment (amount, currency, ...)
+
Used to have the payer enter or change his billing address in the payment process.
- ExpirationDate
+ Condition
- - mandatory, - string -
The date after which the offer expires in ISO 8601 format.
yyyy-MM-ddTHH:mm:ssK
Must be at least 1h in the future and within the next 180 days.
+
THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED: the authorization will be executed if the previous 3d-secure process indicates that the liability shift to the issuer is possible
(liability shift may still be declined with the authorization though). This condition will be ignored for brands which Saferpay does not offer 3d-secure for.
WITH_SUCCESSFUL_THREE_DS_CHALLENGE: Will force the 3D-Secure challenge.
---
If left out, the authorization will be done if allowed, but possibly without liability shift to the issuer. See the specific result codes in the response message.
-AlphaNumeric[10..25]
- Example: 2019-10-20T00:00:00+02:00 +Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED, WITH_SUCCESSFUL_THREE_DS_CHALLENGE.
+ Example: NONE @@ -478,76 +472,82 @@ Id[1..20]
- Payer
+ ExpirationDate
mandatory, - - object + string -
Information about the payer
+
The date after which the offer expires in ISO 8601 format.
yyyy-MM-ddTHH:mm:ssK
Must be at least 1h in the future and within the next 180 days.
- +AlphaNumeric[10..25]
+ Example: 2019-10-20T00:00:00+02:00 + - BillingAddressForm
+ Order
- object + object -
Used to have the payer enter or change his billing address in the payment process.
+
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
- RegisterAlias
+ Payer
+ + mandatory, + - object + object -
Controls whether the means of payment used for paying the offer should be stored inside the Saferpay Secure Card Data storage.
If the offer is paid using a payment means that does not support being stored in the Secure Card Data storage, this parameter has no effect.
+
Information about the payer
- Order
+ Payment
+ + mandatory, + - object + object -
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
+
Information about the payment (amount, currency, ...)
- Condition
+ RegisterAlias
- string + + object -
THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED: the authorization will be executed if the previous 3d-secure process indicates that the liability shift to the issuer is possible
(liability shift may still be declined with the authorization though). This condition will be ignored for brands which Saferpay does not offer 3d-secure for.
WITH_SUCCESSFUL_THREE_DS_CHALLENGE: Will force the 3D-Secure challenge.
---
If left out, the authorization will be done if allowed, but possibly without liability shift to the issuer. See the specific result codes in the response message.
+
Controls whether the means of payment used for paying the offer should be stored inside the Saferpay Secure Card Data storage.
If the offer is paid using a payment means that does not support being stored in the Secure Card Data storage, this parameter has no effect.
-Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED, WITH_SUCCESSFUL_THREE_DS_CHALLENGE.
- Example: NONE - + @@ -703,100 +703,100 @@ No example available - OfferId
+ CreationDate
- globally unique identifier + date -
The Id of the SecurePayGate offer
+
The creation date and time of the SecurePayGate offer
- Example: 503a3d7b-072b-400f-9e7e-8ec15191c737 + Example: 2023-02-24T11:34:11.128+01:00 - PaymentLink
+ ExpirationDate
- string + date -
The SecurePayGate link for the payment
+
The date after which the offer expires
- Example: https://www.saferpay.com/SecurePayGate/Payment/123456/12345678/503a3d7b-072b-400f-9e7e-8ec15191c737 + Example: 2023-04-20T00:00:00.000+02:00 - Status
+ OfferId
- string + globally unique identifier -
The status of the SecurePayGate offer
+
The Id of the SecurePayGate offer
-Possible values: OPEN, PAID, EXPIRED.
- Example: PAID + Example: 503a3d7b-072b-400f-9e7e-8ec15191c737 - TransactionId
+ Payment
- string + + object -
The transaction id once a transaction was made
+
Information about the payment (amount, currency, description, orderId)
- Example: vA3bhlAht2WlSAOKOvQSAOnbAdCb - + - Payment
+ PaymentLink
- - object + string -
Information about the payment (amount, currency, description, orderId)
+
The SecurePayGate link for the payment
- + Example: https://www.saferpay.com/SecurePayGate/Payment/123456/12345678/503a3d7b-072b-400f-9e7e-8ec15191c737 + - CreationDate
+ Status
- date + string -
The creation date and time of the SecurePayGate offer
+
The status of the SecurePayGate offer
- Example: 2023-02-24T11:34:11.128+01:00 +Possible values: OPEN, PAID, EXPIRED.
+ Example: PAID - ExpirationDate
+ TransactionId
- date + string -
The date after which the offer expires
+
The transaction id once a transaction was made
- Example: 2023-04-20T00:00:00.000+02:00 + Example: vA3bhlAht2WlSAOKOvQSAOnbAdCb @@ -914,55 +914,55 @@ No example available - TerminalId
+ Description
string -
The Id of the terminal
+
Description of the terminal
- Type
+ PaymentMethods
- string + + array of objects -
The type of the terminal
+
Array of payment methods that are available for the terminal
-Possible values: ECOM, SPG, MPO.
 - Description
+ TerminalId
string -
Description of the terminal
+
The Id of the terminal
- PaymentMethods
+ Type
- - array of objects + string -
Array of payment methods that are available for the terminal
+
The type of the terminal
+Possible values: ECOM, SPG, MPO.
 @@ -1093,28 +1093,28 @@ No example available - PaymentMethods
+ Wallets
- array of objects + array of objects -
Array of payment methods that are available for the terminal
+
Array of wallets that are available for the terminal
- Wallets
+ PaymentMethods
- array of objects + array of objects -
Array of wallets that are available for the terminal
+
Array of payment methods that are available for the terminal
diff --git a/texts/ChapterOmniChannel.md b/texts/ChapterOmniChannel.md index 5d850a2..a70cff9 100644 --- a/texts/ChapterOmniChannel.md +++ b/texts/ChapterOmniChannel.md @@ -26,34 +26,34 @@ This function may be used to create an alias by providing a SixTransactionRefere - RequestHeader
+ RegisterAlias
mandatory, - object + object -
General information about the request.
+
Registration parameters
- RegisterAlias
+ RequestHeader
mandatory, - object + object -
Registration parameters
+
General information about the request.
@@ -114,51 +114,51 @@ This function may be used to create an alias by providing a SixTransactionRefere - ResponseHeader
+ Alias
mandatory, - object + object -
Contains general information about the response.
+
Information about the registered alias.
- Alias
+ PaymentMeans
mandatory, - object + object -
Information about the registered alias.
+
Information about the registered means of payment
- PaymentMeans
+ ResponseHeader
mandatory, - object + object -
Information about the registered means of payment
+
Contains general information about the response.
@@ -229,57 +229,56 @@ This request allows to acquire an OmniChannel transaction. - RequestHeader
+ OrderId
- - mandatory, - - - object + string -
General information about the request.
+
Unambiguous order identifier defined by the merchant/ shop. This identifier might be used as reference later on.
- +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901 + - TerminalId
+ RequestHeader
mandatory, - string + + object -
Saferpay terminal id
+
General information about the request.
-Numeric[8..8]
- Example: 12345678 - + - OrderId
+ SixTransactionReference
+ + mandatory, + string -
Unambiguous order identifier defined by the merchant/ shop. This identifier might be used as reference later on.
+
SIX Transaction Reference
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 + Example: 1:100002:199970683910 - SixTransactionReference
+ TerminalId
mandatory, @@ -288,9 +287,10 @@ Id[1..80]
 -
SIX Transaction Reference
+
Saferpay terminal id
- Example: 1:100002:199970683910 +Numeric[8..8]
+ Example: 12345678 @@ -332,51 +332,51 @@ This response returns an acquired OmniChannel transaction. - ResponseHeader
+ PaymentMeans
mandatory, - object + object -
Contains general information about the response.
+
Information about the means of payment
- Transaction
+ ResponseHeader
mandatory, - object + object -
Information about the transaction
+
Contains general information about the response.
- PaymentMeans
+ Transaction
mandatory, - object + object -
Information about the means of payment
+
Information about the transaction
diff --git a/texts/ChapterPaymentPage.md b/texts/ChapterPaymentPage.md index bc55be9..b10fdda 100644 --- a/texts/ChapterPaymentPage.md +++ b/texts/ChapterPaymentPage.md @@ -51,127 +51,115 @@ This method can be used to start a transaction with the Payment Page which may i - RequestHeader
+ Authentication
- - mandatory, - - object + object -
General information about the request.
+
Strong Customer Authentication (exemptions, ...)
- ConfigSet
+ BillingAddressForm
- string + + object -
This parameter let you define your payment page config (PPConfig) by name. If this parameters is not set, your default PPConfig will be applied if available.
When the PPConfig can't be found (e.g. wrong name), the Saferpay basic style will be applied to the payment page.
+
Use this container if you need to get a billing address from the payer during the payment process.
Saferpay can show an address form and depending on the means of payment, it is also possible to get the address from the means of payment (e.g. PayPal or any kind of wallet) if available.
Check the options in the container for different behaviors.
In case you also provide payer addresses, these are used as default values to prefill the address form (if displayed) and are overwritten by the final address entered by the payer or provided by the payment method.
-Id[1..20]
- Example: name of your payment page config (case-insensitive) - + - TerminalId
+ CardForm
- - mandatory, - - string + + object -
Saferpay terminal id
+
Options for card data entry form (if applicable)
-Numeric[8..8]
- Example: 12345678 - + - Payment
+ Condition
- - mandatory, - - - object + string -
Information about the payment (amount, currency, ...)
+
Optional Condition for Authorization (only 3DSv2), to control, whether or not, transactions without LiabilityShift should be accepted. Important Note: This only filters out transactions, where the condition is conclusive before the authorization itself. It is possible, that LiabilityShift is rejected after the authorization. Please always check the Liability container, within the authorization-response, to be 100% sure, if LiabilityShift applies, or not!
Default: NONE (empty)
+Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED.
 - PaymentMethods
+ ConfigSet
- array of strings + string -
Used to restrict the means of payment which are available to the payer for this transaction. If only one payment method id is set, the payment selection step will be skipped.
+
This parameter let you define your payment page config (PPConfig) by name. If this parameters is not set, your default PPConfig will be applied if available.
When the PPConfig can't be found (e.g. wrong name), the Saferpay basic style will be applied to the payment page.
-Possible values: ACCOUNTTOACCOUNT, ALIPAY, AMEX, BANCONTACT, BONUS, DINERS, CARD, DIRECTDEBIT, EPRZELEWY, EPS, GIROPAY, IDEAL, INVOICE, JCB, KLARNA, MAESTRO, MASTERCARD, MYONE, PAYCONIQ, PAYDIREKT, PAYPAL, POSTFINANCEPAY, SOFORT, TWINT, UNIONPAY, VISA, WECHATPAY, WLCRYPTOPAYMENTS.
- Example: ["VISA", "MASTERCARD"] +Id[1..20]
+ Example: name of your payment page config (case-insensitive) - PaymentMethodsOptions
+ DeliveryAddressForm
- object + object -
Optional. May be used to set specific options for some payment methods.
+
Use this container if you need to get a delivery address from the payer during the payment process.
Saferpay can show an address form and depending on the means of payment, it is also possible to get the address from the means of payment (e.g. PayPal or any kind of wallet) if available.
Check the options in the container for different behaviors.
In case you also provide payer addresses, these are used as default values to prefill the address form (if displayed) and are overwritten by the final address entered by the payer or provided by the payment method.
- Authentication
+ Notification
- object + object -
Strong Customer Authentication (exemptions, ...)
+
Notification options
- Wallets
+ Order
- array of strings + + object -
Used to control if wallets should be enabled on the payment selection page.
+
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
-Possible values: APPLEPAY, GOOGLEPAY.
- Example: ["APPLEPAY"] - + @@ -190,131 +178,143 @@ Possible values: APPLEPAY, GOOGLEPAY.
- RegisterAlias
+ Payment
+ + mandatory, + - object + object -
If the given means of payment should be stored in Saferpay Secure Card Data storage (if applicable)
+
Information about the payment (amount, currency, ...)
- ReturnUrl
+ PaymentMethods
- - mandatory, - - - object + array of strings -
URL which is used to redirect the payer back to the shop

This Url is used by Saferpay to redirect the shopper back to the merchant shop. You may add query string parameters to identify your session, but please be aware that the shopper could modify these parameters inside the browser!
The whole url including query string parameters should be as short as possible to prevent issues with specific browsers and must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents is plainly visible inside the browser and will be logged by our web servers.
+
Used to restrict the means of payment which are available to the payer for this transaction. If only one payment method id is set, the payment selection step will be skipped.
- +Possible values: ACCOUNTTOACCOUNT, ALIPAY, AMEX, BANCONTACT, BONUS, DINERS, CARD, DIRECTDEBIT, EPRZELEWY, EPS, GIROPAY, IDEAL, INVOICE, JCB, KLARNA, MAESTRO, MASTERCARD, MYONE, PAYCONIQ, PAYDIREKT, PAYPAL, POSTFINANCEPAY, SOFORT, TWINT, UNIONPAY, VISA, WECHATPAY, WLCRYPTOPAYMENTS.
+ Example: ["VISA", "MASTERCARD"] + - Notification
+ PaymentMethodsOptions
- object + object -
Notification options
+
Optional. May be used to set specific options for some payment methods.
- BillingAddressForm
+ RegisterAlias
- object + object -
Use this container if you need to get a billing address from the payer during the payment process.
Saferpay can show an address form and depending on the means of payment, it is also possible to get the address from the means of payment (e.g. PayPal or any kind of wallet) if available.
Check the options in the container for different behaviors.
In case you also provide payer addresses, these are used as default values to prefill the address form (if displayed) and are overwritten by the final address entered by the payer or provided by the payment method.
+
If the given means of payment should be stored in Saferpay Secure Card Data storage (if applicable)
- DeliveryAddressForm
+ RequestHeader
+ + mandatory, + - object + object -
Use this container if you need to get a delivery address from the payer during the payment process.
Saferpay can show an address form and depending on the means of payment, it is also possible to get the address from the means of payment (e.g. PayPal or any kind of wallet) if available.
Check the options in the container for different behaviors.
In case you also provide payer addresses, these are used as default values to prefill the address form (if displayed) and are overwritten by the final address entered by the payer or provided by the payment method.
+
General information about the request.
- CardForm
+ ReturnUrl
+ + mandatory, + - object + object -
Options for card data entry form (if applicable)
+
URL which is used to redirect the payer back to the shop

This Url is used by Saferpay to redirect the shopper back to the merchant shop. You may add query string parameters to identify your session, but please be aware that the shopper could modify these parameters inside the browser!
The whole url including query string parameters should be as short as possible to prevent issues with specific browsers and must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents is plainly visible inside the browser and will be logged by our web servers.
- Condition
+ RiskFactors
- string + + object -
Optional Condition for Authorization (only 3DSv2), to control, whether or not, transactions without LiabilityShift should be accepted. Important Note: This only filters out transactions, where the condition is conclusive before the authorization itself. It is possible, that LiabilityShift is rejected after the authorization. Please always check the Liability container, within the authorization-response, to be 100% sure, if LiabilityShift applies, or not!
Default: NONE (empty)
+
Optional risk factors
-Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED.
 - Order
+ TerminalId
- - object + + mandatory, + + string -
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
+
Saferpay terminal id
- +Numeric[8..8]
+ Example: 12345678 + - RiskFactors
+ Wallets
- - object + array of strings -
Optional risk factors
+
Used to control if wallets should be enabled on the payment selection page.
- +Possible values: APPLEPAY, GOOGLEPAY.
+ Example: ["APPLEPAY"] + @@ -364,24 +364,24 @@ Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED.
- ResponseHeader
+ Expiration
mandatory, - - object + date -
Contains general information about the response.
+
Expiration date / time of the RedirectUrl in ISO 8601 format in UTC. After this time, the RedirectUrl can't be called anymore.
- + Example: 2011-07-14T19:43:37+01:00 + - Token
+ RedirectUrl
mandatory, @@ -390,32 +390,32 @@ Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED.
 -
Token for later referencing
+
RedirectUrl for the payment page transaction. Simply add this to a "Pay Now"-button or do an automatic redirect.
- Example: 234uhfh78234hlasdfh8234e1234 + Example: https://www.saferpay.com/vt2/api/PaymentPage/1234/12341234/234uhfh78234hlasdfh8234e1234 - Expiration
+ ResponseHeader
mandatory, - date + + object -
Expiration date / time of the RedirectUrl in ISO 8601 format in UTC. After this time, the RedirectUrl can't be called anymore.
+
Contains general information about the response.
- Example: 2011-07-14T19:43:37+01:00 - + - RedirectUrl
+ Token
mandatory, @@ -424,9 +424,9 @@ Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED.
 -
RedirectUrl for the payment page transaction. Simply add this to a "Pay Now"-button or do an automatic redirect.
+
Token for later referencing
- Example: https://www.saferpay.com/vt2/api/PaymentPage/1234/12341234/234uhfh78234hlasdfh8234e1234 + Example: 234uhfh78234hlasdfh8234e1234 @@ -562,135 +562,135 @@ Id[1..50]
- ResponseHeader
+ Dcc
- - mandatory, - - object + object -
Contains general information about the response.
+
Dcc information, if applicable
- Transaction
+ FraudPrevention
- - mandatory, - - object + object -
Information about the transaction
+
Contains details of a performed fraud prevention check
- PaymentMeans
+ Liability
- - mandatory, - - object + object -
Information about the means of payment
+
LiabilityShift information, replaces ThreeDs Info from api version 1.8
- Payer
+ MastercardIssuerInstallments
- object + object -
Information about the payer / card holder
+
Mastercard card issuer installment payment options, if applicable
- RegistrationResult
+ Payer
- object + object -
Information about the SCD registration outcome
+
Information about the payer / card holder
- Liability
+ PaymentMeans
+ + mandatory, + - object + object -
LiabilityShift information, replaces ThreeDs Info from api version 1.8
+
Information about the means of payment
- Dcc
+ RegistrationResult
- object + object -
Dcc information, if applicable
+
Information about the SCD registration outcome
- MastercardIssuerInstallments
+ ResponseHeader
+ + mandatory, + - object + object -
Mastercard card issuer installment payment options, if applicable
+
Contains general information about the response.
- FraudPrevention
+ Transaction
+ + mandatory, + - object + object -
Contains details of a performed fraud prevention check
+
Information about the transaction
diff --git a/texts/ChapterTransaction.md b/texts/ChapterTransaction.md index 8d482fa..ddcc1eb 100644 --- a/texts/ChapterTransaction.md +++ b/texts/ChapterTransaction.md @@ -53,95 +53,71 @@ This method may be used to start a transaction which may involve either DCC and - RequestHeader
+ Authentication
- - mandatory, - - object + object -
General information about the request.
+
Strong Customer Authentication (exemptions, ...)
- ConfigSet
+ CardForm
- string + + object -
This parameter let you define your payment page config (PPConfig) by name. If this parameters is not set, your default PPConfig will be applied if available.
When the PPConfig can't be found (e.g. wrong name), the Saferpay basic style will be applied to the payment page.
+
Options for card data entry form (if applicable)
-Id[1..20]
- Example: name of your payment page config (case-insensitive) - + - TerminalId
+ ConfigSet
- - mandatory, - string -
Saferpay terminal to use for this authorization
+
This parameter let you define your payment page config (PPConfig) by name. If this parameters is not set, your default PPConfig will be applied if available.
When the PPConfig can't be found (e.g. wrong name), the Saferpay basic style will be applied to the payment page.
-Numeric[8..8]
- Example: 12341234 +Id[1..20]
+ Example: name of your payment page config (case-insensitive) - Payment
- - - mandatory, - - - object - - - -
Information about the payment (amount, currency, ...)
- - - - - - - PaymentMeans
+ Notification
- object + object -
Means of payment (either card data or a reference to a previously stored card).
Important: Only fully PCI certified merchants may directly use the card data. If your system is not explicitly certified to handle card data directly, then use the Saferpay Secure Card Data-Storage instead. If the customer enters a new card, you may want to use the Saferpay Hosted Register Form to capture the card data through Saferpay.
+
Notification options
- Authentication
+ Order
- object + object -
Strong Customer Authentication (exemptions, ...)
+
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
@@ -162,31 +138,31 @@ Numeric[8..8]
- ReturnUrl
+ Payment
mandatory, - object + object -
URL which is used to redirect the payer back to the shop if the transaction requires some kind of browser redirection (3d-secure, dcc)

This Url is used by Saferpay to redirect the shopper back to the merchant shop. You may add query string parameters to identify your session, but please be aware that the shopper could modify these parameters inside the browser!
The whole url including query string parameters should be as short as possible to prevent issues with specific browsers and must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents is plainly visible inside the browser and will be logged by our web servers.
+
Information about the payment (amount, currency, ...)
- Styling
+ PaymentMeans
- object + object -
Styling options
+
Means of payment (either card data or a reference to a previously stored card).
Important: Only fully PCI certified merchants may directly use the card data. If your system is not explicitly certified to handle card data directly, then use the Saferpay Secure Card Data-Storage instead. If the customer enters a new card, you may want to use the Saferpay Hosted Register Form to capture the card data through Saferpay.
@@ -208,72 +184,96 @@ Possible values: AMEX, BANCONTACT, BONUS, DINERS, DIRECTDEBIT, JCB, MAESTRO, MAS - Order
+ RedirectNotifyUrls
- object + object -
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
+
If a redirect of the payer is required, these URLs will be used by Saferpay to notify you when the payer has completed the required steps and the transaction is ready to be authorized or when the operation has failed or has been aborted by the payer.
If no redirect of the payer is required, then these URLs will not be called (see RedirectRequired attribute of the Transaction Initialize response).

Supported schemes are http and https. You also have to make sure to support the GET-method.
The whole url including query string parameters must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents are logged by our web servers.
- RiskFactors
+ RequestHeader
+ + mandatory, + - object + object -
Optional risk factors
+
General information about the request.
- CardForm
+ ReturnUrl
+ + mandatory, + - object + object -
Options for card data entry form (if applicable)
+
URL which is used to redirect the payer back to the shop if the transaction requires some kind of browser redirection (3d-secure, dcc)

This Url is used by Saferpay to redirect the shopper back to the merchant shop. You may add query string parameters to identify your session, but please be aware that the shopper could modify these parameters inside the browser!
The whole url including query string parameters should be as short as possible to prevent issues with specific browsers and must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents is plainly visible inside the browser and will be logged by our web servers.
- RedirectNotifyUrls
+ RiskFactors
- object + object -
If a redirect of the payer is required, these URLs will be used by Saferpay to notify you when the payer has completed the required steps and the transaction is ready to be authorized or when the operation has failed or has been aborted by the payer.
If no redirect of the payer is required, then these URLs will not be called (see RedirectRequired attribute of the Transaction Initialize response).

Supported schemes are http and https. You also have to make sure to support the GET-method.
The whole url including query string parameters must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents are logged by our web servers.
+
Optional risk factors
- Notification
+ Styling
- object + object -
Notification options
+
Styling options
+ + + + + TerminalId
+ + + mandatory, + + string + + + +
Saferpay terminal to use for this authorization
+ +Numeric[8..8]
+ Example: 12341234 + @@ -327,96 +327,96 @@ Possible values: AMEX, BANCONTACT, BONUS, DINERS, DIRECTDEBIT, JCB, MAESTRO, MAS - ResponseHeader
+ Expiration
mandatory, - - object + date -
Contains general information about the response.
+
Expiration date / time of the generated token in ISO 8601 format in UTC.
After this time is exceeded, the token will not be accepted for any further actions except Asserts.
- + Example: 2015-01-30T13:45:22.258+02:00 + - Token
+ LiabilityShift
- - mandatory, - - string + boolean -
Id for referencing later
+
Indicates if liability shift to issuer is possible or not. Not present if PaymentMeans container was not present in InitializeTransaction request. True, if liability shift to issuer is possible, false if not.
- Example: 234uhfh78234hlasdfh8234e - + - Expiration
+ Redirect
- - mandatory, - - date + + object -
Expiration date / time of the generated token in ISO 8601 format in UTC.
After this time is exceeded, the token will not be accepted for any further actions except Asserts.
+
Mandatory if RedirectRequired is true. Contains the URL for the redirect to use for example the Saferpay hosted register form.
- Example: 2015-01-30T13:45:22.258+02:00 - + - LiabilityShift
+ RedirectRequired
+ + mandatory, + boolean -
Indicates if liability shift to issuer is possible or not. Not present if PaymentMeans container was not present in InitializeTransaction request. True, if liability shift to issuer is possible, false if not.
+
True if a redirect must be performed to continue, false otherwise
- RedirectRequired
+ ResponseHeader
mandatory, - boolean + + object -
True if a redirect must be performed to continue, false otherwise
+
Contains general information about the response.
- Redirect
+ Token
- - object + + mandatory, + + string -
Mandatory if RedirectRequired is true. Contains the URL for the redirect to use for example the Saferpay hosted register form.
+
Id for referencing later
- + Example: 234uhfh78234hlasdfh8234e + @@ -475,6 +475,35 @@ This function may be called to authorize a transaction which was started by a ca + Condition
+ + string + + + +
THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED: the authorization will be executed if the previous 3d-secure process indicates that the liability shift to the issuer is possible
(liability shift may still be declined with the authorization though). This condition will be ignored for brands which Saferpay does not offer 3d-secure for.
---
If left out, the authorization will be done if allowed, but possibly without liability shift to the issuer. See the specific result codes in the response message.
+ +Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED.
+ Example: NONE + + + + + + RegisterAlias
+ + + object + + + +
Controls whether the given means of payment should be stored inside the Saferpay Secure Card Data storage.
+ + + + + + RequestHeader
@@ -506,21 +535,6 @@ This function may be called to authorize a transaction which was started by a ca Id[1..50]
Example: 234uhfh78234hlasdfh8234e - - - - - Condition
- - string - - - -
THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED: the authorization will be executed if the previous 3d-secure process indicates that the liability shift to the issuer is possible
(liability shift may still be declined with the authorization though). This condition will be ignored for brands which Saferpay does not offer 3d-secure for.
---
If left out, the authorization will be done if allowed, but possibly without liability shift to the issuer. See the specific result codes in the response message.
- -Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED.
- Example: NONE - @@ -536,20 +550,6 @@ Possible values: NONE, THREE_DS_AUTHENTICATION_SUCCESSFUL_OR_ATTEMPTED.
Numeric[3..4]
Example: 123 - - - - - RegisterAlias
- - - object - - - -
Controls whether the given means of payment should be stored inside the Saferpay Secure Card Data storage.
- - @@ -589,135 +589,135 @@ Numeric[3..4]
- ResponseHeader
+ Dcc
- - mandatory, - - object + object -
Contains general information about the response.
+
Dcc information, if applicable
- Transaction
+ FraudPrevention
- - mandatory, - - object + object -
Information about the transaction
+
Contains details of a performed fraud prevention check
- PaymentMeans
+ Liability
- - mandatory, - - object + object -
Information about the means of payment
+
LiabilityShift information, replaces ThreeDs Info from API version 1.8
- Payer
+ MastercardIssuerInstallments
- object + object -
Information about the payer / card holder
+
Mastercard card issuer installment payment options, if applicable
- RegistrationResult
+ Payer
- object + object -
Information about the Secure Card Data registration outcome.
+
Information about the payer / card holder
- MastercardIssuerInstallments
+ PaymentMeans
+ + mandatory, + - object + object -
Mastercard card issuer installment payment options, if applicable
+
Information about the means of payment
- Liability
+ RegistrationResult
- object + object -
LiabilityShift information, replaces ThreeDs Info from API version 1.8
+
Information about the Secure Card Data registration outcome.
- Dcc
+ ResponseHeader
+ + mandatory, + - object + object -
Dcc information, if applicable
+
Contains general information about the response.
- FraudPrevention
+ Transaction
+ + mandatory, + - object + object -
Contains details of a performed fraud prevention check
+
Information about the transaction
@@ -819,125 +819,122 @@ This function may be used to directly authorize transactions which do not requir - RequestHeader
+ Authentication
- - mandatory, - - object + object -
General information about the request.
+
Strong Customer Authentication exemption for this transaction.
Some exemptions are only applicable to payer-initiated transactions and will be ignored otherwise. If you are performing a payer-initiated transaction, make sure you set the 'Initiator' attribute properly (see below).
- TerminalId
+ Initiator
- - mandatory, - string -
Saferpay Terminal-Id
+
Specify if the transaction was initiated by the merchant (default behavior if not specified) or by the payer.
This is relevant for most credit and debit cards managed by Mastercard, Visa and American Express card schemes (in card scheme jargon: MERCHANT means MIT, PAYER means CIT).
For these schemes, transactions initiated by the payer usually require authentication of the card holder, which is not possible if you use Transaction/AuthorizeDirect (use Transaction/Initialize or PaymentPage/Initialize if you're not sure).
Saferpay will flag the transaction accordingly (also taking the optional Exemption in the Authentication container into account) on the protocols which support this and card issuers might approve or decline transactions depending on this flagging.
-Numeric[8..8]
- Example: 12341234 +Possible values: MERCHANT, PAYER.
+ Example: MERCHANT - Payment
+ Order
- - mandatory, - - object + object -
Information about the payment (amount, currency, ...)
+
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
- PaymentMeans
+ Payer
- - mandatory, - - object + object -
Information on the means of payment. Important: Only fully PCI certified merchants may directly use the card data. If your system is not explicitly certified to handle card data directly, then use the Saferpay Secure Card Data-Storage instead. If the customer enters a new card, you may want to use the Saferpay Hosted Register Form to capture the card data through Saferpay.
+
Information on the payer (IP-address)
- Authentication
+ Payment
+ + mandatory, + - object + object -
Strong Customer Authentication exemption for this transaction.
Some exemptions are only applicable to payer-initiated transactions and will be ignored otherwise. If you are performing a payer-initiated transaction, make sure you set the 'Initiator' attribute properly (see below).
+
Information about the payment (amount, currency, ...)
- RegisterAlias
+ PaymentMeans
+ + mandatory, + - object + object -
Controls whether the given means of payment should be stored inside the Saferpay Secure Card Data storage.
+
Information on the means of payment. Important: Only fully PCI certified merchants may directly use the card data. If your system is not explicitly certified to handle card data directly, then use the Saferpay Secure Card Data-Storage instead. If the customer enters a new card, you may want to use the Saferpay Hosted Register Form to capture the card data through Saferpay.
- Payer
+ RegisterAlias
- object + object -
Information on the payer (IP-address)
+
Controls whether the given means of payment should be stored inside the Saferpay Secure Card Data storage.
- Order
+ RequestHeader
+ + mandatory, + - object + object -
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
+
General information about the request.
@@ -958,16 +955,19 @@ Numeric[8..8]
- Initiator
+ TerminalId
+ + mandatory, + string -
Specify if the transaction was initiated by the merchant (default behavior if not specified) or by the payer.
This is relevant for most credit and debit cards managed by Mastercard, Visa and American Express card schemes (in card scheme jargon: MERCHANT means MIT, PAYER means CIT).
For these schemes, transactions initiated by the payer usually require authentication of the card holder, which is not possible if you use Transaction/AuthorizeDirect (use Transaction/Initialize or PaymentPage/Initialize if you're not sure).
Saferpay will flag the transaction accordingly (also taking the optional Exemption in the Authentication container into account) on the protocols which support this and card issuers might approve or decline transactions depending on this flagging.
+
Saferpay Terminal-Id
-Possible values: MERCHANT, PAYER.
- Example: MERCHANT +Numeric[8..8]
+ Example: 12341234 @@ -1027,51 +1027,42 @@ Possible values: MERCHANT, PAYER.
- ResponseHeader
+ FraudPrevention
- - mandatory, - - object + object -
Contains general information about the response.
+
Contains details of a performed fraud prevention check
- Transaction
+ Liability
- - mandatory, - - object + object -
Information about the transaction
+
LiabilityShift information, replaces ThreeDs Info from api version 1.26
- PaymentMeans
+ MastercardIssuerInstallments
- - mandatory, - - object + object -
Information about the means of payment
+
Mastercard card issuer installment payment options, if applicable
@@ -1092,56 +1083,65 @@ Possible values: MERCHANT, PAYER.
- RegistrationResult
+ PaymentMeans
+ + mandatory, + - object + object -
Information about the Secure Card Data registration outcome.
+
Information about the means of payment
- MastercardIssuerInstallments
+ RegistrationResult
- object + object -
Mastercard card issuer installment payment options, if applicable
+
Information about the Secure Card Data registration outcome.
- FraudPrevention
+ ResponseHeader
+ + mandatory, + - object + object -
Contains details of a performed fraud prevention check
+
Contains general information about the response.
- Liability
+ Transaction
+ + mandatory, + - object + object -
LiabilityShift information, replaces ThreeDs Info from api version 1.26
+
Information about the transaction
@@ -1226,37 +1226,30 @@ This method may be used to perform follow-up authorizations to an earlier transa - RequestHeader
+ Authentication
- - mandatory, - - object + object -
General information about the request.
+
Strong Customer Authentication (exemptions, ...)
- TerminalId
+ Notification
- - mandatory, - - string + + object -
Saferpay Terminal-Id
+
Notification options
-Numeric[8..8]
- Example: 12341234 - + @@ -1278,58 +1271,65 @@ Numeric[8..8]
- TransactionReference
+ RequestHeader
mandatory, - object + object -
Reference to previous transaction.

Exactly one element must be set.
+
General information about the request.
- Authentication
+ SuppressDcc
- - object + boolean -
Strong Customer Authentication (exemptions, ...)
+
Used to suppress direct currency conversion
- SuppressDcc
+ TerminalId
- boolean + + mandatory, + + string -
Used to suppress direct currency conversion
+
Saferpay Terminal-Id
- +Numeric[8..8]
+ Example: 12341234 + - Notification
+ TransactionReference
+ + mandatory, + - object + object -
Notification options
+
Reference to previous transaction.

Exactly one element must be set.
@@ -1384,34 +1384,28 @@ Numeric[8..8]
- ResponseHeader
+ Dcc
- - mandatory, - - object + object -
Contains general information about the response.
+
Dcc information, if applicable
- Transaction
+ Payer
- - mandatory, - - object + object -
Information about the transaction
+
Information about the payer / card holder
@@ -1435,28 +1429,34 @@ Numeric[8..8]
- Payer
+ ResponseHeader
+ + mandatory, + - object + object -
Information about the payer / card holder
+
Contains general information about the response.
- Dcc
+ Transaction
+ + mandatory, + - object + object -
Dcc information, if applicable
+
Information about the transaction
@@ -1547,62 +1547,56 @@ This method may be used to finalize previously authorized transactions and refun - RequestHeader
+ Amount
- - mandatory, - - object + object -
General information about the request.
+
Currency must match the original transaction currency (request will be declined if currency does not match)
- TransactionReference
+ Billpay
- - mandatory, - - object + object -
Reference to authorization.

Exactly one element must be set.
+
Optional Billpay specific options.
- Amount
+ Marketplace
- object + object -
Currency must match the original transaction currency (request will be declined if currency does not match)
+
Optional Marketplace capture parameters.
- Billpay
+ MastercardIssuerInstallments
- object + object -
Optional Billpay specific options.
+
Selected Mastercard card issuer installment payment option, if applicable
@@ -1623,28 +1617,34 @@ This method may be used to finalize previously authorized transactions and refun - Marketplace
+ RequestHeader
+ + mandatory, + - object + object -
Optional Marketplace capture parameters.
+
General information about the request.
- MastercardIssuerInstallments
+ TransactionReference
+ + mandatory, + - object + object -
Selected Mastercard card issuer installment payment option, if applicable
+
Reference to authorization.

Exactly one element must be set.
@@ -1687,81 +1687,81 @@ This method may be used to finalize previously authorized transactions and refun - ResponseHeader
+ CaptureId
- - mandatory, - - - object + string -
Contains general information about the response.
+
CaptureId of the created capture. Must be stored for later reference (eg refund).
- +Id[1..64]
+ Example: ECthWpbv1SI6SAIdU2p6AIC1bppA_c + - CaptureId
+ Date
- string + + mandatory, + + date -
CaptureId of the created capture. Must be stored for later reference (eg refund).
- -Id[1..64]
- Example: ECthWpbv1SI6SAIdU2p6AIC1bppA_c +
Date and time of capture. Not set if the capture state is pending.
+ + Example: 2014-04-25T08:33:44.159+01:00 - Status
+ Invoice
- - mandatory, - - string + + object -
Current status of the capture. (PENDING is only used for paydirekt at the moment)
+
Optional infos for invoice based payments.
-Possible values: PENDING, CAPTURED.
 - Date
+ ResponseHeader
mandatory, - date + + object -
Date and time of capture. Not set if the capture state is pending.
+
Contains general information about the response.
- Example: 2014-04-25T08:33:44.159+01:00 - + - Invoice
+ Status
- - object + + mandatory, + + string -
Optional infos for invoice based payments.
+
Current status of the capture. (PENDING is only used for paydirekt at the moment)
+Possible values: PENDING, CAPTURED.
 @@ -1826,101 +1826,101 @@ This method may be used to capture multiple parts of an authorized transaction. - RequestHeader
+ Amount
mandatory, - object + object -
General information about the request.
+
Currency must match the original transaction currency (request will be declined if currency does not match)
- TransactionReference
+ Marketplace
- - mandatory, - - object + object -
Reference to authorization.

Exactly one element must be set.
+
Optional Marketplace capture parameters.
- Amount
+ OrderPartId
mandatory, - - object + string -
Currency must match the original transaction currency (request will be declined if currency does not match)
+
Must be unique. It identifies each individual step and is especially important for follow-up actions such as refund.
- +Id[1..80]
+ Example: kh9ngajrfe6wfu3d0c + - Type
+ RequestHeader
mandatory, - string + + object -
'PARTIAL' if more captures should be possible later on, 'FINAL' if no more captures will be done on this authorization.
+
General information about the request.
-Possible values: PARTIAL, FINAL.
 - OrderPartId
+ TransactionReference
mandatory, - string + + object -
Must be unique. It identifies each individual step and is especially important for follow-up actions such as refund.
+
Reference to authorization.

Exactly one element must be set.
-Id[1..80]
- Example: kh9ngajrfe6wfu3d0c - + - Marketplace
+ Type
- - object + + mandatory, + + string -
Optional Marketplace capture parameters.
+
'PARTIAL' if more captures should be possible later on, 'FINAL' if no more captures will be done on this authorization.
+Possible values: PARTIAL, FINAL.
 @@ -1975,68 +1975,68 @@ Id[1..80]
- ResponseHeader
+ CaptureId
- - mandatory, - - - object + string -
Contains general information about the response.
+
CaptureId of the created capture. Must be stored for later reference (eg refund).
- +Id[1..64]
+ Example: ECthWpbv1SI6SAIdU2p6AIC1bppA_c + - CaptureId
+ Date
- string + + mandatory, + + date -
CaptureId of the created capture. Must be stored for later reference (eg refund).
+
Date and time of capture. Not set if the capture state is pending.
-Id[1..64]
- Example: ECthWpbv1SI6SAIdU2p6AIC1bppA_c + Example: 2018-08-08T12:45:22.258+01:00 - Status
+ ResponseHeader
mandatory, - string + + object -
Current status of the capture. (PENDING is only used for paydirekt at the moment)
+
Contains general information about the response.
-Possible values: PENDING, CAPTURED.
 - Date
+ Status
mandatory, - date + string -
Date and time of capture. Not set if the capture state is pending.
+
Current status of the capture. (PENDING is only used for paydirekt at the moment)
- Example: 2018-08-08T12:45:22.258+01:00 - +Possible values: PENDING, CAPTURED.
+ @@ -2094,34 +2094,34 @@ This method is only supported for pending capture transactions (only used for pa - RequestHeader
+ CaptureReference
mandatory, - object + object -
General information about the request.
+
Reference to the capture.
- CaptureReference
+ RequestHeader
mandatory, - object + object -
Reference to the capture.
+
General information about the request.
@@ -2164,52 +2164,51 @@ This method is only supported for pending capture transactions (only used for pa - ResponseHeader
+ Date
mandatory, - - object + date -
Contains general information about the response.
+
Date and time of capture. Not set if the capture state is pending.
- + Example: 2014-04-25T08:33:44.159+01:00 + - TransactionId
+ OrderId
- - mandatory, - string -
Id of the referenced transaction.
+
OrderId of the referenced transaction. If present.
-AlphaNumeric[1..64]
- Example: 723n4MAjMdhjSAhAKEUdA8jtl9jb +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901 - OrderId
+ ResponseHeader
- string + + mandatory, + + + object -
OrderId of the referenced transaction. If present.
+
Contains general information about the response.
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 - + @@ -2231,18 +2230,19 @@ Possible values: PENDING, CAPTURED.
- Date
+ TransactionId
mandatory, - date + string -
Date and time of capture. Not set if the capture state is pending.
+
Id of the referenced transaction.
- Example: 2014-04-25T08:33:44.159+01:00 +AlphaNumeric[1..64]
+ Example: 723n4MAjMdhjSAhAKEUdA8jtl9jb @@ -2430,79 +2430,79 @@ This method may be called to refund a previous transaction. - RequestHeader
+ CaptureReference
mandatory, - object + object -
General information about the request.
+
Reference to the capture you want to refund.
- Refund
+ PaymentMethodsOptions
- - mandatory, - - object + object -
Information about the refund (amount, currency, ...)
+
- CaptureReference
+ PendingNotification
- - mandatory, - - object + object -
Reference to the capture you want to refund.
+
Optional pending notification options
- PendingNotification
+ Refund
+ + mandatory, + - object + object -
Optional pending notification options
+
Information about the refund (amount, currency, ...)
- PaymentMethodsOptions
+ RequestHeader
+ + mandatory, + - object + object -
+
General information about the request.
@@ -2551,65 +2551,65 @@ This method may be called to refund a previous transaction. - ResponseHeader
+ Dcc
- - mandatory, - - object + object -
Contains general information about the response.
+
Dcc information, if applicable
- Transaction
+ PaymentMeans
mandatory, - object + object -
Information about the transaction
+
Information about the means of payment
- PaymentMeans
+ ResponseHeader
mandatory, - object + object -
Information about the means of payment
+
Contains general information about the response.
- Dcc
+ Transaction
+ + mandatory, + - object + object -
Dcc information, if applicable
+
Information about the transaction
@@ -2765,52 +2765,51 @@ This method may be used to inquire the status and further information of pending - ResponseHeader
+ Date
mandatory, - - object + date -
Contains general information about the response.
+
Date and time of capture. Not set if the capture state is pending.
- + Example: 2014-04-25T08:33:44.159+01:00 + - TransactionId
+ OrderId
- - mandatory, - string -
Id of the referenced transaction.
+
OrderId of the referenced transaction. If present.
-AlphaNumeric[1..64]
- Example: 723n4MAjMdhjSAhAKEUdA8jtl9jb +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901 - OrderId
+ ResponseHeader
- string + + mandatory, + + + object -
OrderId of the referenced transaction. If present.
+
Contains general information about the response.
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 - + @@ -2832,18 +2831,19 @@ Possible values: PENDING, CAPTURED.
- Date
+ TransactionId
mandatory, - date + string -
Date and time of capture. Not set if the capture state is pending.
+
Id of the referenced transaction.
- Example: 2014-04-25T08:33:44.159+01:00 +AlphaNumeric[1..64]
+ Example: 723n4MAjMdhjSAhAKEUdA8jtl9jb @@ -2903,37 +2903,33 @@ This method may be called to refund an amount to the given means of payment (not - RequestHeader
+ OriginalCreditTransfer
- - mandatory, - - object + object -
General information about the request.
+
Information about the Original Credit Transfer like the Address of the Recipient.
- TerminalId
+ PaymentMeans
mandatory, - string + + object -
Saferpay Terminal-Id
+
Information on the means of payment. Important: Only fully PCI certified merchants may directly use the card data.
If your system is not explicitly certified to handle card data directly, then use the Saferpay Secure Card Data-Storage instead.
If the customer enters a new card, you may want to use the Saferpay Hosted Register Form to capture the card data through Saferpay.
-Numeric[8..8]
- Example: 12341234 - + @@ -2955,33 +2951,37 @@ Numeric[8..8]
- PaymentMeans
+ RequestHeader
mandatory, - object + object -
Information on the means of payment. Important: Only fully PCI certified merchants may directly use the card data.
If your system is not explicitly certified to handle card data directly, then use the Saferpay Secure Card Data-Storage instead.
If the customer enters a new card, you may want to use the Saferpay Hosted Register Form to capture the card data through Saferpay.
+
General information about the request.
- OriginalCreditTransfer
+ TerminalId
- - object + + mandatory, + + string -
Information about the Original Credit Transfer like the Address of the Recipient.
+
Saferpay Terminal-Id
- +Numeric[8..8]
+ Example: 12341234 + @@ -3031,51 +3031,51 @@ Numeric[8..8]
- ResponseHeader
+ PaymentMeans
mandatory, - object + object -
Contains general information about the response.
+
Information about the means of payment
- Transaction
+ ResponseHeader
mandatory, - object + object -
Information about the transaction
+
Contains general information about the response.
- PaymentMeans
+ Transaction
mandatory, - object + object -
Information about the means of payment
+
Information about the transaction
@@ -3226,66 +3226,66 @@ This method may be used to cancel previously authorized transactions and refunds - ResponseHeader
+ Date
mandatory, - - object + date -
Contains general information about the response.
+
Date and time of cancel.
- + Example: 2014-04-25T08:33:44.159+01:00 + - TransactionId
+ OrderId
- - mandatory, - string -
Id of the referenced transaction.
+
OrderId of the referenced transaction. If present.
- Example: qiuwerhfi23h4189asdhflk23489 + Example: c52ad18472354511ab2c33b59e796901 - OrderId
+ ResponseHeader
- string + + mandatory, + + + object -
OrderId of the referenced transaction. If present.
+
Contains general information about the response.
- Example: c52ad18472354511ab2c33b59e796901 - + - Date
+ TransactionId
mandatory, - date + string -
Date and time of cancel.
+
Id of the referenced transaction.
- Example: 2014-04-25T08:33:44.159+01:00 + Example: qiuwerhfi23h4189asdhflk23489 @@ -3343,37 +3343,30 @@ This method may be used to cancel previously authorized transactions and refunds - RequestHeader
+ Notification
- - mandatory, - - object + object -
General information about the request.
+
Notification options
- TerminalId
+ Payer
- - mandatory, - - string + + object -
Saferpay terminal to use for this authorization
+
Information on the payer (IP-address)
-Numeric[8..8]
- Example: 12341234 - + @@ -3395,51 +3388,54 @@ Numeric[8..8]
- ServiceProvider
+ RequestHeader
mandatory, - string + + object -
Service provider to be used for this payment
+
General information about the request.
-Possible values: POSTCARD, POSTFINANCE.
- Example: POSTFINANCE - + - Payer
+ ReturnUrl
+ + mandatory, + - object + object -
Information on the payer (IP-address)
+
URL which is used to redirect the payer back to the shop if the transaction requires some kind of browser redirection (3d-secure, dcc)

This Url is used by Saferpay to redirect the shopper back to the merchant shop. You may add query string parameters to identify your session, but please be aware that the shopper could modify these parameters inside the browser!
The whole url including query string parameters should be as short as possible to prevent issues with specific browsers and must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents is plainly visible inside the browser and will be logged by our web servers.
- ReturnUrl
+ ServiceProvider
mandatory, - - object + string -
URL which is used to redirect the payer back to the shop if the transaction requires some kind of browser redirection (3d-secure, dcc)

This Url is used by Saferpay to redirect the shopper back to the merchant shop. You may add query string parameters to identify your session, but please be aware that the shopper could modify these parameters inside the browser!
The whole url including query string parameters should be as short as possible to prevent issues with specific browsers and must not exceed 2000 characters.
Note: you should not add sensitive data to the query string, as its contents is plainly visible inside the browser and will be logged by our web servers.
+
Service provider to be used for this payment
- +Possible values: POSTCARD, POSTFINANCE.
+ Example: POSTFINANCE + @@ -3458,16 +3454,20 @@ Possible values: POSTCARD, POSTFINANCE.
- Notification
+ TerminalId
- - object + + mandatory, + + string -
Notification options
+
Saferpay terminal to use for this authorization
- +Numeric[8..8]
+ Example: 12341234 + @@ -3492,7 +3492,7 @@ Possible values: POSTCARD, POSTFINANCE.
"CurrencyCode": "CHF" } }, - "ServiceProvider": "PAYPAL", + "ServiceProvider": "POSTFINANCE", "ReturnUrl": { "Url": "[your shop payment url]" } @@ -3516,66 +3516,66 @@ Possible values: POSTCARD, POSTFINANCE.
- ResponseHeader
+ Expiration
mandatory, - - object + date -
Contains general information about the response.
+
Expiration date / time of the generated token in ISO 8601 format in UTC. After this time, the token won’t be accepted for any further action.
- + Example: 2015-01-30T13:45:22.258+02:00 + - Token
+ RedirectUrl
- - mandatory, - string -
Id for referencing later
+
Url to redirect the browser to for payment processing
- Example: 234uhfh78234hlasdfh8234e + Example: https://www.saferpay.com/VT2/api/... - Expiration
+ ResponseHeader
mandatory, - date + + object -
Expiration date / time of the generated token in ISO 8601 format in UTC. After this time, the token won’t be accepted for any further action.
+
Contains general information about the response.
- Example: 2015-01-30T13:45:22.258+02:00 - + - RedirectUrl
+ Token
+ + mandatory, + string -
Url to redirect the browser to for payment processing
+
Id for referencing later
- Example: https://www.saferpay.com/VT2/api/... + Example: 234uhfh78234hlasdfh8234e @@ -3702,65 +3702,65 @@ Id[1..50]
- ResponseHeader
+ Payer
- - mandatory, - - object + object -
Contains general information about the response.
+
Information about the payer / card holder
- Transaction
+ PaymentMeans
mandatory, - object + object -
Information about the transaction
+
Information about the means of payment
- PaymentMeans
+ ResponseHeader
mandatory, - object + object -
Information about the means of payment
+
Contains general information about the response.
- Payer
+ Transaction
+ + mandatory, + - object + object -
Information about the payer / card holder
+
Information about the transaction
@@ -3916,51 +3916,42 @@ This method can be used to get the details of a transaction that has been author - ResponseHeader
+ Dcc
- - mandatory, - - object + object -
Contains general information about the response.
+
Dcc information, if applicable
- Transaction
+ FraudPrevention
- - mandatory, - - object + object -
Information about the transaction
+
Contains details of a performed fraud prevention check
- PaymentMeans
+ Liability
- - mandatory, - - object + object -
Information about the means of payment
+
LiabilityShift information, replaces ThreeDs Info from api version 1.8
@@ -3981,42 +3972,51 @@ This method can be used to get the details of a transaction that has been author - Liability
+ PaymentMeans
+ + mandatory, + - object + object -
LiabilityShift information, replaces ThreeDs Info from api version 1.8
+
Information about the means of payment
- Dcc
+ ResponseHeader
+ + mandatory, + - object + object -
Dcc information, if applicable
+
Contains general information about the response.
- FraudPrevention
+ Transaction
+ + mandatory, + - object + object -
Contains details of a performed fraud prevention check
+
Information about the transaction
@@ -4106,37 +4106,47 @@ for the payments that before authorization some additional steps such as authent - RequestHeader
+ Notification
mandatory, - object + object -
General information about the request.
+
Notification options
- TerminalId
+ Order
- - mandatory, - - string + + object -
Saferpay terminal to use for this authorization
+
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
-Numeric[8..8]
- Example: 12341234 - + + + + + + Payer
+ + + object + + + +
Information on the payer (IP-address)
+ + @@ -4190,61 +4200,51 @@ Possible values: BANCONTACT.
- Payer
- - - object - - - -
Information on the payer (IP-address)
- - - - - - - Notification
+ RequestHeader
mandatory, - object + object -
Notification options
+
General information about the request.
- Order
+ RiskFactors
- object + object -
Optional order information. Only used for payment method Klarna (mandatory) and for Fraud Intelligence (optional).
+
Optional risk factors
- RiskFactors
+ TerminalId
- - object + + mandatory, + + string -
Optional risk factors
+
Saferpay terminal to use for this authorization
- +Numeric[8..8]
+ Example: 12341234 + @@ -4290,67 +4290,67 @@ Possible values: BANCONTACT.
- ResponseHeader
+ Expiration
mandatory, - - object + date -
Contains general information about the response.
+
Expiration date / time of the generated token in ISO 8601 format in UTC. After this time, the token won’t be accepted for any further action.
- + Example: 2015-01-30T13:45:22.258+02:00 + - Token
+ ProcessingData
- - mandatory, - - string + + object -
Id for referencing later
+
data required by the merchant system to process the payment (e.g. QR-code data, intent URL, ...)

Payment method specific data required to process an alternative payment.
Only one container (matching the PaymentMethod of the AlternativePaymentRequest message) will be present
- Example: 234uhfh78234hlasdfh8234e - + - Expiration
+ ResponseHeader
mandatory, - date + + object -
Expiration date / time of the generated token in ISO 8601 format in UTC. After this time, the token won’t be accepted for any further action.
+
Contains general information about the response.
- Example: 2015-01-30T13:45:22.258+02:00 - + - ProcessingData
+ Token
- - object + + mandatory, + + string -
data required by the merchant system to process the payment (e.g. QR-code data, intent URL, ...)

Payment method specific data required to process an alternative payment.
Only one container (matching the PaymentMethod of the AlternativePaymentRequest message) will be present
+
Id for referencing later
- + Example: 234uhfh78234hlasdfh8234e + @@ -4478,93 +4478,93 @@ Id[1..50]
- ResponseHeader
+ FraudPrevention
- - mandatory, - - object + object -
Contains general information about the response.
+
Contains details of a performed fraud prevention check
- Transaction
+ Liability
- - mandatory, - - object + object -
Information about the transaction
+
LiabilityShift information, replaces ThreeDs Info from api version 1.8
- PaymentMeans
+ Payer
- - mandatory, - - object + object -
Information about the means of payment
+
Information about the payer / card holder
- Payer
+ PaymentMeans
+ + mandatory, + - object + object -
Information about the payer / card holder
+
Information about the means of payment
- Liability
+ ResponseHeader
+ + mandatory, + - object + object -
LiabilityShift information, replaces ThreeDs Info from api version 1.8
+
Contains general information about the response.
- FraudPrevention
+ Transaction
+ + mandatory, + - object + object -
Contains details of a performed fraud prevention check
+
Information about the transaction
diff --git a/texts/ContainerDictionary.md b/texts/ContainerDictionary.md index 1ada94a..7f932e4 100644 --- a/texts/ContainerDictionary.md +++ b/texts/ContainerDictionary.md @@ -5,7 +5,7 @@ - Value
+ CurrencyCode
mandatory, @@ -14,15 +14,15 @@ -
Amount in minor unit (CHF 1.00 ⇒ Value=100). Only Integer values will be accepted!
+
ISO 4217 3-letter currency code (CHF, USD, EUR, ...)
- Example: 100 + Example: CHF - CurrencyCode
+ Value
mandatory, @@ -31,9 +31,9 @@ -
ISO 4217 3-letter currency code (CHF, USD, EUR, ...)
+
Amount in minor unit (CHF 1.00 ⇒ Value=100). Only Integer values will be accepted!
- Example: CHF + Example: 100 @@ -44,7 +44,7 @@ - Value
+ CurrencyCode
mandatory, @@ -53,15 +53,15 @@ -
Amount in minor unit (CHF 1.00 ⇒ Value=100). Only Integer values will be accepted!
+
ISO 4217 3-letter currency code (CHF, USD, EUR, ...)
- Example: 100 + Example: CHF - CurrencyCode
+ Value
mandatory, @@ -70,9 +70,9 @@ -
ISO 4217 3-letter currency code (CHF, USD, EUR, ...)
+
Amount in minor unit (CHF 1.00 ⇒ Value=100). Only Integer values will be accepted!
- Example: CHF + Example: 100 @@ -157,56 +157,57 @@ Possible values: CITY, COMPANY, COUNTRY, EMAIL, FIRSTNAME, LASTNAME, PHONE, SALU - IpAddress
+ AcceptHeader
string -
IPv4 address of the card holder / payer if available. Dotted quad notation.
+
Browser accept header
- Example: 111.111.111.111 + Example: text/html,application/xhtml\u002Bxml,application/xml - Ipv6Address
+ BillingAddress
- string + + object -
IPv6 address of the card holder / payer if available.
+
Information on the payers billing address
- Example: 2001:0db8:0000:08d3:0000:8a2e:0070:7344 - + - LanguageCode
+ ColorDepth
string -
Language to force Saferpay to display something to the payer in a certain language. Per default, Saferpay will determine the language using the payers browser agent.
The supported language codes are listed below. This list may be extended in the future as more languages become available. If the submitted language code has a valid format, but is not supported, then the default language is used.

Code-List:
bg - Bulgarian
cs - Czech
da - Danish
de - German
de-ch - Swiss German
el - Greek
en - English
es - Spanish
et - Estonian
fi - Finnish
fr - French
hr - Croatian
hu - Hungarian
is - Icelandic
it - Italian
ja - Japanese
lt - Lithuanian
lv - Latvian
nl - Dutch
nn - Norwegian
pl - Polish
pt - Portuguese
ro - Romanian
ru - Russian
sk - Slovak
sl - Slovenian
sv - Swedish
tr - Turkish
uk - Ukrainian
zh - Chinese
+
Color depth
- Example: de +Possible values: 1bit, 4bits, 8bits, 15bits, 16bits, 24bits, 32bits, 48bits.
+ Example: 32bits - BillingAddress
+ DeliveryAddress
- object + object -
Information on the payers billing address
+
Information on the payers delivery address
@@ -227,43 +228,29 @@ PayerId[1..256]
- DeliveryAddress
- - - object - - - -
Information on the payers delivery address
- - - - - - - AcceptHeader
+ IpAddress
string -
Browser accept header
+
IPv4 address of the card holder / payer if available. Dotted quad notation.
- Example: text/html,application/xhtml\u002Bxml,application/xml + Example: 111.111.111.111 - UserAgent
+ Ipv6Address
string -
User agent
+
IPv6 address of the card holder / payer if available.
- Example: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 + Example: 2001:0db8:0000:08d3:0000:8a2e:0070:7344 @@ -295,15 +282,15 @@ PayerId[1..256]
- ScreenWidth
+ LanguageCode
- integer + string -
Screen width
+
Language to force Saferpay to display something to the payer in a certain language. Per default, Saferpay will determine the language using the payers browser agent.
Format: ISO 639-1 (two-letter language code), optionally followed by a hyphen and ISO 3166-1 alpha-2 (two-letter country code).
The supported language codes are listed below. This list may be extended in the future as more languages become available.
We recommend to only use supported language and country codes. If the submitted value has a valid format, but the language is unsupported, then the default language is used.
For supported languages, using different country codes than those explicitly listed here may or may not work as expected.

Code-List:
bg - Bulgarian
cs - Czech
da - Danish
de - German
de-CH - Swiss German
el - Greek
en - English
es - Spanish
et - Estonian
fi - Finnish
fr - French
hr - Croatian
hu - Hungarian
is - Icelandic
it - Italian
ja - Japanese
lt - Lithuanian
lv - Latvian
nl - Dutch
nn - Norwegian
pl - Polish
pt - Portuguese
ro - Romanian
ru - Russian
sk - Slovak
sl - Slovenian
sv - Swedish
tr - Turkish
uk - Ukrainian
zh - Chinese
- Example: 1920 + Example: de @@ -323,16 +310,15 @@ PayerId[1..256]
- ColorDepth
+ ScreenWidth
- string + integer -
Color depth
+
Screen width
-Possible values: 1bit, 4bits, 8bits, 15bits, 16bits, 24bits, 32bits, 48bits.
- Example: 32bits + Example: 1920 @@ -349,6 +335,20 @@ Possible values: 1bit, 4bits, 8bits, 15bits, 16bits, 24bits, 32bits, 48bits.
Example: 720 120 + + + + + UserAgent
+ + string + + + +
User agent
+ + Example: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 + @@ -358,26 +358,26 @@ Possible values: 1bit, 4bits, 8bits, 15bits, 16bits, 24bits, 32bits, 48bits.
- PreAuth
+ AllowPartialAuthorization
boolean -
Indicates the desired transaction type. When set to true the transaction is processed as a pre-authorization otherwise as a final authorization. Please note that not all payment methods support both options and the effective transaction type is determined by Saferpay.
+
When set to true, a transaction might be authorized with an amount less than requested authorization amount.

Important:

  • Not all the payment methods support this option.
  • This option is currently supported only in Transaction/Initialize and Transaction/AuthorizeDirect.
  • Using this option in Transaction/Initialize prevents DCC.
- AllowPartialAuthorization
+ PreAuth
boolean -
When set to true, a transaction might be authorized with an amount less than requested authorization amount.

Important:

  • Not all the payment methods support this option.
  • This option is currently supported only in Transaction/Initialize and Transaction/AuthorizeDirect.
  • Using this option in Transaction/Initialize prevents DCC.
+
Indicates the desired transaction type. When set to true the transaction is processed as a pre-authorization otherwise as a final authorization. Please note that not all payment methods support both options and the effective transaction type is determined by Saferpay.
@@ -389,195 +389,195 @@ Possible values: 1bit, 4bits, 8bits, 15bits, 16bits, 24bits, 32bits, 48bits.
- FirstName
+ City
string -
The payer's first name
+
The payer's city
Utf8[1..100]
- Example: John + Example: Zurich - LastName
+ Company
string -
The payer's last name
+
The payer's company
Utf8[1..100]
- Example: Doe + Example: ACME Corp. - Company
+ CountryCode
string -
The payer's company
+
The payer's country code
ISO 3166-1 alpha-2 country code
(Non-standard: XK for Kosovo)
-Utf8[1..100]
- Example: ACME Corp. +Alphabetic[2..2]
+ Example: CH - Gender
+ CountrySubdivisionCode
string -
The payer's gender
+
The payer's country subdivision code
Allows country codes formatted as ISO 3166 or ISO 3166-2.
-Possible values: MALE, FEMALE, DIVERSE, COMPANY.
- Example: COMPANY +Iso3166[1..6]
+ Example: ZH / CH-ZH - Street
+ DateOfBirth
string -
The payer's street
+
The payer's date of birth in ISO 8601 extended date notation
YYYY-MM-DD
-Utf8[1..100]
- Example: Bakerstreet 32 +AlphaNumeric[10..10]
+ Example: 1990-05-31 - Zip
+ Email
string -
The payer's zip code
+
The payer's email address
-Utf8[1..100]
- Example: 8000 + Example: payer@provider.com - City
+ FirstName
string -
The payer's city
+
The payer's first name
Utf8[1..100]
- Example: Zurich + Example: John - CountryCode
+ Gender
string -
The payer's country code
ISO 3166-1 alpha-2 country code
(Non-standard: XK for Kosovo)
+
The payer's gender
-Alphabetic[2..2]
- Example: CH +Possible values: MALE, FEMALE, DIVERSE, COMPANY.
+ Example: COMPANY - Email
+ LastName
string -
The payer's email address
+
The payer's last name
- Example: payer@provider.com +Utf8[1..100]
+ Example: Doe - DateOfBirth
+ Phone
string -
The payer's date of birth in ISO 8601 extended date notation
YYYY-MM-DD
+
The payer's phone number
-AlphaNumeric[10..10]
- Example: 1990-05-31 +Utf8[1..100]
+ Example: +41 12 345 6789 - Street2
+ Street
string -
The payer's street, second line. Only use this, if you need two lines. It may not be supported by all acquirers.
+
The payer's street
Utf8[1..100]
- Example: Stewart House + Example: Bakerstreet 32 - Phone
+ Street2
string -
The payer's phone number
+
The payer's street, second line. Only use this, if you need two lines. It may not be supported by all acquirers.
Utf8[1..100]
- Example: +41 12 345 6789 + Example: Stewart House - CountrySubdivisionCode
+ Zip
string -
The payer's country subdivision code
Allows country codes formatted as ISO 3166 or ISO 3166-2.
+
The payer's zip code
-Iso3166[1..6]
- Example: ZH / CH-ZH +Utf8[1..100]
+ Example: 8000 @@ -588,180 +588,180 @@ Iso3166[1..6]
- FirstName
+ City
string -
The payer's first name
+
The payer's city
Utf8[1..100]
- Example: John + Example: Zurich - LastName
+ Company
string -
The payer's last name
+
The payer's company
Utf8[1..100]
- Example: Doe + Example: ACME Corp. - Company
+ CountryCode
string -
The payer's company
+
The payer's country code
ISO 3166-1 alpha-2 country code
(Non-standard: XK for Kosovo)
-Utf8[1..100]
- Example: ACME Corp. +Alphabetic[2..2]
+ Example: CH - Gender
+ CountrySubdivisionCode
string -
The payer's gender
+
The payer's country subdivision code
Allows country codes formatted as ISO 3166 or ISO 3166-2.
-Possible values: MALE, FEMALE, DIVERSE, COMPANY.
- Example: COMPANY +Iso3166[1..6]
+ Example: ZH / CH-ZH - Street
+ DateOfBirth
string -
The payer's street
+
The payer's date of birth in ISO 8601 extended date notation
YYYY-MM-DD
-Utf8[1..100]
- Example: Bakerstreet 32 +AlphaNumeric[10..10]
+ Example: 1990-05-31 - Zip
+ Email
string -
The payer's zip code
+
The payer's email address
-Utf8[1..100]
- Example: 8000 + Example: payer@provider.com - City
+ FirstName
string -
The payer's city
+
The payer's first name
Utf8[1..100]
- Example: Zurich + Example: John - CountryCode
+ Gender
string -
The payer's country code
ISO 3166-1 alpha-2 country code
(Non-standard: XK for Kosovo)
+
The payer's gender
-Alphabetic[2..2]
- Example: CH +Possible values: MALE, FEMALE, DIVERSE, COMPANY.
+ Example: COMPANY - Email
+ LastName
string -
The payer's email address
+
The payer's last name
- Example: payer@provider.com +Utf8[1..100]
+ Example: Doe - DateOfBirth
+ Phone
string -
The payer's date of birth in ISO 8601 extended date notation
YYYY-MM-DD
+
The payer's phone number
-AlphaNumeric[10..10]
- Example: 1990-05-31 +Utf8[1..100]
+ Example: +41 12 345 6789 - Street2
+ Street
string -
The payer's street, second line. Only use this, if you need two lines. It may not be supported by all acquirers.
+
The payer's street
Utf8[1..100]
- Example: Stewart House + Example: Bakerstreet 32 - Phone
+ Street2
string -
The payer's phone number
+
The payer's street, second line. Only use this, if you need two lines. It may not be supported by all acquirers.
Utf8[1..100]
- Example: +41 12 345 6789 + Example: Stewart House @@ -781,16 +781,16 @@ Utf8[1..25]
- CountrySubdivisionCode
+ Zip
string -
The payer's country subdivision code
Allows country codes formatted as ISO 3166 or ISO 3166-2.
+
The payer's zip code
-Iso3166[1..6]
- Example: ZH / CH-ZH +Utf8[1..100]
+ Example: 8000 @@ -801,195 +801,195 @@ Iso3166[1..6]
- FirstName
+ City
string -
The payer's first name
+
The payer's city
Utf8[1..100]
- Example: John + Example: Zurich - LastName
+ Company
string -
The payer's last name
+
The payer's company
Utf8[1..100]
- Example: Doe + Example: ACME Corp. - Company
+ CountryCode
string -
The payer's company
+
The payer's country code
ISO 3166-1 alpha-2 country code
(Non-standard: XK for Kosovo)
-Utf8[1..100]
- Example: ACME Corp. +Alphabetic[2..2]
+ Example: CH - Gender
+ CountrySubdivisionCode
string -
The payer's gender
+
The payer's country subdivision code in ISO 3166-2
-Possible values: MALE, FEMALE, DIVERSE, COMPANY.
- Example: COMPANY +AlphaNumeric[1..3]
+ Example: ZH - Street
+ DateOfBirth
string -
The payer's street
+
The payer's date of birth in ISO 8601 extended date notation
YYYY-MM-DD
-Utf8[1..100]
- Example: Bakerstreet 32 +AlphaNumeric[10..10]
+ Example: 1990-05-31 - Zip
+ Email
string -
The payer's zip code
+
The payer's email address
-Utf8[1..100]
- Example: 8000 + Example: payer@provider.com - City
+ FirstName
string -
The payer's city
+
The payer's first name
Utf8[1..100]
- Example: Zurich + Example: John - CountryCode
+ Gender
string -
The payer's country code
ISO 3166-1 alpha-2 country code
(Non-standard: XK for Kosovo)
+
The payer's gender
-Alphabetic[2..2]
- Example: CH +Possible values: MALE, FEMALE, DIVERSE, COMPANY.
+ Example: COMPANY - Email
+ LastName
string -
The payer's email address
+
The payer's last name
- Example: payer@provider.com +Utf8[1..100]
+ Example: Doe - DateOfBirth
+ Phone
string -
The payer's date of birth in ISO 8601 extended date notation
YYYY-MM-DD
+
The payer's phone number
-AlphaNumeric[10..10]
- Example: 1990-05-31 +Utf8[1..100]
+ Example: +41 12 345 6789 - Street2
+ Street
string -
The payer's street, second line. Only use this, if you need two lines. It may not be supported by all acquirers.
+
The payer's street
Utf8[1..100]
- Example: Stewart House + Example: Bakerstreet 32 - Phone
+ Street2
string -
The payer's phone number
+
The payer's street, second line. Only use this, if you need two lines. It may not be supported by all acquirers.
Utf8[1..100]
- Example: +41 12 345 6789 + Example: Stewart House - CountrySubdivisionCode
+ Zip
string -
The payer's country subdivision code in ISO 3166-2
+
The payer's zip code
-AlphaNumeric[1..3]
- Example: ZH +Utf8[1..100]
+ Example: 8000 @@ -1000,180 +1000,180 @@ AlphaNumeric[1..3]
- FirstName
+ City
string -
The payer's first name
+
The payer's city
Utf8[1..100]
- Example: John + Example: Zurich - LastName
+ Company
string -
The payer's last name
+
The payer's company
Utf8[1..100]
- Example: Doe + Example: ACME Corp. - Company
+ CountryCode
string -
The payer's company
+
The payer's country code
ISO 3166-1 alpha-2 country code
(Non-standard: XK for Kosovo)
-Utf8[1..100]
- Example: ACME Corp. +Alphabetic[2..2]
+ Example: CH - Gender
+ CountrySubdivisionCode
string -
The payer's gender
+
The payer's country subdivision code in ISO 3166-2
-Possible values: MALE, FEMALE, DIVERSE, COMPANY.
- Example: COMPANY +AlphaNumeric[1..3]
+ Example: ZH - Street
+ DateOfBirth
string -
The payer's street
+
The payer's date of birth in ISO 8601 extended date notation
YYYY-MM-DD
-Utf8[1..100]
- Example: Bakerstreet 32 +AlphaNumeric[10..10]
+ Example: 1990-05-31 - Zip
+ Email
string -
The payer's zip code
+
The payer's email address
-Utf8[1..100]
- Example: 8000 + Example: payer@provider.com - City
+ FirstName
string -
The payer's city
+
The payer's first name
Utf8[1..100]
- Example: Zurich + Example: John - CountryCode
+ Gender
string -
The payer's country code
ISO 3166-1 alpha-2 country code
(Non-standard: XK for Kosovo)
+
The payer's gender
-Alphabetic[2..2]
- Example: CH +Possible values: MALE, FEMALE, DIVERSE, COMPANY.
+ Example: COMPANY - Email
+ LastName
string -
The payer's email address
+
The payer's last name
- Example: payer@provider.com +Utf8[1..100]
+ Example: Doe - DateOfBirth
+ Phone
string -
The payer's date of birth in ISO 8601 extended date notation
YYYY-MM-DD
+
The payer's phone number
-AlphaNumeric[10..10]
- Example: 1990-05-31 +Utf8[1..100]
+ Example: +41 12 345 6789 - Street2
+ Street
string -
The payer's street, second line. Only use this, if you need two lines. It may not be supported by all acquirers.
+
The payer's street
Utf8[1..100]
- Example: Stewart House + Example: Bakerstreet 32 - Phone
+ Street2
string -
The payer's phone number
+
The payer's street, second line. Only use this, if you need two lines. It may not be supported by all acquirers.
Utf8[1..100]
- Example: +41 12 345 6789 + Example: Stewart House @@ -1193,16 +1193,16 @@ Utf8[1..25]
- CountrySubdivisionCode
+ Zip
string -
The payer's country subdivision code in ISO 3166-2
+
The payer's zip code
-AlphaNumeric[1..3]
- Example: ZH +Utf8[1..100]
+ Example: 8000 @@ -1250,6 +1250,20 @@ Possible values: CITY, COMPANY, VATNUMBER, COUNTRY, EMAIL, FIRSTNAME, LASTNAME, + BillingAddress
+ + + object + + + +
Information on the payers billing address
+ + + + + + IpAddress
string @@ -1284,47 +1298,29 @@ Possible values: CITY, COMPANY, VATNUMBER, COUNTRY, EMAIL, FIRSTNAME, LASTNAME, -
Language to force Saferpay to display something to the payer in a certain language. Per default, Saferpay will determine the language using the payers browser agent.
The supported language codes are listed below. This list may be extended in the future as more languages become available. If the submitted language code has a valid format, but is not supported, then the default language is used.

Code-List:
bg - Bulgarian
cs - Czech
da - Danish
de - German
de-ch - Swiss German
el - Greek
en - English
es - Spanish
et - Estonian
fi - Finnish
fr - French
hr - Croatian
hu - Hungarian
is - Icelandic
it - Italian
ja - Japanese
lt - Lithuanian
lv - Latvian
nl - Dutch
nn - Norwegian
pl - Polish
pt - Portuguese
ro - Romanian
ru - Russian
sk - Slovak
sl - Slovenian
sv - Swedish
tr - Turkish
uk - Ukrainian
zh - Chinese
+
Language to force Saferpay to display something to the payer in a certain language. Per default, Saferpay will determine the language using the payers browser agent.
Format: ISO 639-1 (two-letter language code), optionally followed by a hyphen and ISO 3166-1 alpha-2 (two-letter country code).
The supported language codes are listed below. This list may be extended in the future as more languages become available.
We recommend to only use supported language and country codes. If the submitted value has a valid format, but the language is unsupported, then the default language is used.
For supported languages, using different country codes than those explicitly listed here may or may not work as expected.

Code-List:
bg - Bulgarian
cs - Czech
da - Danish
de - German
de-CH - Swiss German
el - Greek
en - English
es - Spanish
et - Estonian
fi - Finnish
fr - French
hr - Croatian
hu - Hungarian
is - Icelandic
it - Italian
ja - Japanese
lt - Lithuanian
lv - Latvian
nl - Dutch
nn - Norwegian
pl - Polish
pt - Portuguese
ro - Romanian
ru - Russian
sk - Slovak
sl - Slovenian
sv - Swedish
tr - Turkish
uk - Ukrainian
zh - Chinese
Example: de + + +

Container "Common_RequestHeader"

+ + - - -
- BillingAddress
+ ClientInfo
- object + object 		-
Information on the payers billing address
+
Information about the caller (merchant host)
-
-

Container "Common_RequestHeader"

- - - - - @@ -1383,16 +1379,20 @@ Range: inclusive between 0 and 9
@@ -1431,8 +1431,8 @@ Id[1..50]
@@ -1466,26 +1466,26 @@ Utf8[1..50]
@@ -1531,46 +1531,46 @@ Id[1..64]
@@ -1619,7 +1619,7 @@ Numeric[3..4]
@@ -1672,7 +1672,7 @@ Possible values: OK, NOT_SUPPORTED.
@@ -1711,7 +1711,7 @@ Possible values: OK, NOT_SUPPORTED.
@@ -1791,7 +1791,7 @@ Numeric[8..8]
@@ -1832,63 +1832,63 @@ Numeric[8..8]
@@ -1899,70 +1899,56 @@ Possible values: OK, OK_AUTHENTICATED, NOT_PERFORMED.
- - - - @@ -1983,14 +1969,14 @@ Possible values: OK, OK_AUTHENTICATED, NOT_PERFORMED.
@@ -2020,6 +2006,20 @@ Possible values: OK, OK_AUTHENTICATED, NOT_PERFORMED.
+ + + + + + + + @@ -2054,58 +2068,30 @@ Possible values: OK, OK_AUTHENTICATED, NOT_PERFORMED.
- - - - - - - - @@ -2206,98 +2192,98 @@ Base64 encoded string
@@ -2309,26 +2295,26 @@ Base64 encoded string
@@ -2340,63 +2326,63 @@ Base64 encoded string
@@ -2406,76 +2392,76 @@ AlphaNumeric[8..11]
@@ -2499,6 +2485,21 @@ AlphaNumeric[8..11]
Amount data (currency, value, etc.)
+ + + + + @@ -2532,21 +2533,6 @@ Id[1..80]
Utf8[1..50]
Example: Payernote - - - - - @@ -2575,33 +2561,33 @@ Utf8[1..1000]
@@ -2611,18 +2597,19 @@ Possible values: ACCOUNTTOACCOUNT, ALIPAY, AMEX, BANCONTACT, BONUS, DINERS, CARD @@ -2646,34 +2633,33 @@ Range: inclusive between 2000 and 9999
@@ -2754,24 +2740,21 @@ Possible values: NONE, MANDATORY.
@@ -2866,31 +2852,31 @@ Possible values: UNSPECIFIED, CONSUMER, CORPORATE, CORPORATE_AND_CONSUMER.
@@ -2901,32 +2887,27 @@ Iso885915[1..100]
@@ -2946,27 +2927,32 @@ Iso885915[1..100]
@@ -2992,19 +2978,19 @@ Iso885915[1..100]
@@ -3026,19 +3012,19 @@ Iso885915[1..100]
@@ -3048,7 +3034,7 @@ Iso885915[1..100]
@@ -3106,30 +3092,30 @@ Iso885915[1..100]
@@ -3175,28 +3161,28 @@ Possible values: DEFAULT, SIX, NONE.
@@ -3229,30 +3215,27 @@ Possible values: DEFAULT, SIX, NONE.
@@ -3273,28 +3256,31 @@ Range: inclusive between 2 and 99
@@ -3333,40 +3319,40 @@ Range: inclusive between 2 and 99
@@ -3378,34 +3364,34 @@ Range: inclusive between 2 and 99
@@ -3416,26 +3402,26 @@ String length: inclusive between 4 and 4
@@ -3447,7 +3433,7 @@ String length: inclusive between 4 and 4
@@ -3508,62 +3494,62 @@ Utf8[1..100000]
@@ -3574,46 +3560,46 @@ Possible values: YES, NO, UNKNOWN.
@@ -3624,28 +3610,28 @@ Id[1..15]
@@ -3689,29 +3675,33 @@ Id[1..15]
@@ -3731,25 +3721,21 @@ Id[1..15]
@@ -4039,50 +4025,31 @@ Max length: 2000
- - - - @@ -4116,28 +4083,47 @@ Id[1..35]
- + + + + + @@ -4149,6 +4135,20 @@ Id[1..35]
+ + + + + + + + @@ -4183,65 +4197,65 @@ Id[1..35]
+ +
- SpecVersion
- - - mandatory, - - string - -		 -
Version number of the interface specification. For new implementations, the newest Version should be used.
- -Possible values: 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25, 1.26, 1.27, 1.28, 1.29, 1.30, 1.31, 1.32, 1.33, 1.34, 1.35, 1.36, 1.37, 1.38, 1.39, 1.40
- Example: 1.40 -
- ClientInfo
+ SpecVersion
- - object + + mandatory, + + string 		-
Information about the caller (merchant host)
+
Version number of the interface specification. For new implementations, the newest Version should be used.
- +Possible values: 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25, 1.26, 1.27, 1.28, 1.29, 1.30, 1.31, 1.32, 1.33, 1.34, 1.35, 1.36, 1.37, 1.38, 1.39, 1.40, 1.41
+ Example: 1.41 +
Version number of the interface specification.
-Possible values: 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25, 1.26, 1.27, 1.28, 1.29, 1.30, 1.31, 1.32, 1.33, 1.34, 1.35, 1.36, 1.37, 1.38, 1.39, 1.40
- Example: 1.40 +Possible values: 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24, 1.25, 1.26, 1.27, 1.28, 1.29, 1.30, 1.31, 1.32, 1.33, 1.34, 1.35, 1.36, 1.37, 1.38, 1.39, 1.40, 1.41
+ Example: 1.41
- AppDefaultRedirectUrl
+ AppCompletionRedirectUrl
URI 		-
This URL is called by the bancontact payment app when the payer cancels the payment.
The maximum allowed length for this URL is 256 characters.
+
This URL is called by the bancontact payment app once the payment is authorized successfully.
The maximum allowed length for this URL is 256 characters.
- AppCompletionRedirectUrl
+ AppDefaultRedirectUrl
URI 		-
This URL is called by the bancontact payment app once the payment is authorized successfully.
The maximum allowed length for this URL is 256 characters.
+
This URL is called by the bancontact payment app when the payer cancels the payment.
The maximum allowed length for this URL is 256 characters.
- TransactionId
+ OrderId
string 		-
Id of the referenced transaction. This should only be used if you don't have the CaptureId of the referenced Capture (probably, because it was performed with an older SpecVersion)
+
Unambiguous OrderId of the referenced transaction.
-AlphaNumeric[1..64]
- Example: 723n4MAjMdhjSAhAKEUdA8jtl9jb +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901
- OrderId
+ OrderPartId
string 		-
Unambiguous OrderId of the referenced transaction.
+
OrderPartId of the referenced capture if a partial capture should be referenced and the CaptureId/TransactionId of the partial capture is not available.
Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 + Example: kh9ngajrfe6wfu3d0c
- OrderPartId
+ TransactionId
string 		-
OrderPartId of the referenced capture if a partial capture should be referenced and the CaptureId/TransactionId of the partial capture is not available.
+
Id of the referenced transaction. This should only be used if you don't have the CaptureId of the referenced Capture (probably, because it was performed with an older SpecVersion)
-Id[1..80]
- Example: kh9ngajrfe6wfu3d0c +AlphaNumeric[1..64]
+ Example: 723n4MAjMdhjSAhAKEUdA8jtl9jb
- Result
+ Message
mandatory, @@ -1628,15 +1628,15 @@ Numeric[3..4]
 		-
The result of the card holder authentication.
+
More details, if available. Contents may change at any time, so don’t parse it.
-Possible values: OK, NOT_SUPPORTED.
- + Example: Card holder authentication with 3DSv2 successful. +
- Message
+ Result
mandatory, @@ -1645,10 +1645,10 @@ Possible values: OK, NOT_SUPPORTED.
 		-
More details, if available. Contents may change at any time, so don’t parse it.
+
The result of the card holder authentication.
- Example: Card holder authentication with 3DSv2 successful. - +Possible values: OK, NOT_SUPPORTED.
+
- Result
+ Message
mandatory, @@ -1681,15 +1681,15 @@ Possible values: OK, NOT_SUPPORTED.
 		-
The result of the card holder authentication.
+
More details, if available. Contents may change at any time, so don’t parse it.
-Possible values: OK, NOT_SUPPORTED.
- + Example: Card holder authentication with 3DSv2 successful. +
- Message
+ Result
mandatory, @@ -1698,10 +1698,10 @@ Possible values: OK, NOT_SUPPORTED.
 		-
More details, if available. Contents may change at any time, so don’t parse it.
+
The result of the card holder authentication.
- Example: Card holder authentication with 3DSv2 successful. - +Possible values: OK, NOT_SUPPORTED.
+
- Type
+ TerminalId
mandatory, @@ -1720,16 +1720,16 @@ Possible values: OK, NOT_SUPPORTED.
 		-
Type of check to perform.
+
Saferpay Terminal-Id to be used for checking.
-Possible values: ONLINE.
- Example: ONLINE +Numeric[8..8]
+ Example: 12341234
- TerminalId
+ Type
mandatory, @@ -1738,10 +1738,10 @@ Possible values: ONLINE.
 		-
Saferpay Terminal-Id to be used for checking.
+
Type of check to perform.
-Numeric[8..8]
- Example: 12341234 +Possible values: ONLINE.
+ Example: ONLINE
- Type
+ TerminalId
mandatory, @@ -1800,16 +1800,16 @@ Numeric[8..8]
 		-
Type of check to perform (subject to availability for the brand/acquirer).
ONLINE performs an online account check (one transaction point will be billed for such a check)
ONLINE_STRONG performs a strong customer authentication (SCA) which involves a 3DS v2 authentication and an online account check (for which one transaction point will be billed)
+
Saferpay Terminal-Id to be used for checking.
-Possible values: ONLINE, ONLINE_STRONG.
- Example: ONLINE +Numeric[8..8]
+ Example: 12341234
- TerminalId
+ Type
mandatory, @@ -1818,10 +1818,10 @@ Possible values: ONLINE, ONLINE_STRONG.
 		-
Saferpay Terminal-Id to be used for checking.
+
Type of check to perform (subject to availability for the brand/acquirer).
ONLINE performs an online account check (one transaction point will be billed for such a check)
ONLINE_STRONG performs a strong customer authentication (SCA) which involves a 3DS v2 authentication and an online account check (for which one transaction point will be billed)
-Numeric[8..8]
- Example: 12341234 +Possible values: ONLINE, ONLINE_STRONG.
+ Example: ONLINE
- Result
+ Authentication
- - mandatory, - - string + + object 		-
The result of the card check.
+
More details about the card holder authentication.
-Possible values: OK, OK_AUTHENTICATED, NOT_PERFORMED.
- Message
+ IssuerReference
- - mandatory, - - string + + object 		-
More details, if available. Contents may change at any time, so don’t parse it.
+
- Example: Online card check was successful. - +
- Authentication
+ Message
- - object + + mandatory, + + string 		-
More details about the card holder authentication.
+
More details, if available. Contents may change at any time, so don’t parse it.
- + Example: Online card check was successful. +
- IssuerReference
+ Result
- - object + + mandatory, + + string 		-
+
The result of the card check.
+Possible values: OK, OK_AUTHENTICATED, NOT_PERFORMED.
- SaferpayFields
- - - object - -		 -
Payment means data collected with SaferpayFields.
- - -
- Card
+ Alias
- object + object 		-
Card data
+
Alias data if payment means was registered with Secure Card Data before.
- Alias
+ ApplePay
- object + object 		-
Alias data if payment means was registered with Secure Card Data before.
+
Payment Data from ApplePay
- SchemeToken
+ BankAccount
- object + object 		-
Surrogate values that replace the primary account number (PAN) according to the EMV Payment Tokenization Specification.
Note: LiabilityShift is only possible with Transaction Initialize, AuthorizeDirect and RefundDirect.
Note: Scheme tokens MDES and VTS are only available for Worldline Acquiring.
+
Bank account data for direct debit transaction
- BankAccount
+ Card
- object + object 		-
Bank account data for direct debit transaction
+
Card data
- ApplePay
+ SchemeToken
- object + object 		-
Payment Data from Apple Pay Wallet
+
Surrogate values that replace the primary account number (PAN) according to the EMV Payment Tokenization Specification.
Note: LiabilityShift is only possible with Transaction Initialize, AuthorizeDirect and RefundDirect.
Note: Scheme tokens MDES and VTS are only available for Worldline Acquiring.
+ BankAccount
+ + + object + +		 +
Bank account data for direct debit transactions.
+ + +
Brand
@@ -2033,6 +2033,20 @@ Possible values: OK, OK_AUTHENTICATED, NOT_PERFORMED.
Brand information
+
+ Card
+ + + object + +		 +
Card data
+ +
- Wallet
+ Twint
- string + + object 		-
Name of Wallet, if the transaction was done by a wallet
+
Twint data
- Example: APPLEPAY - +
- Card
+ Wallet
- - object - -		 -
Card data
- - -
- BankAccount
- - - object - -		 -
Bank account data for direct debit transactions.
- - -
- Twint
- - - object + string 		-
Twint data
+
Name of Wallet, if the transaction was done by a wallet
- + Example: APPLEPAY +
- SaferpayFields
+ Alias
- object + object 		-
Payment means data collected with SaferpayFields.
+
Alias data if payment means was registered with Secure Card Data before.
- Card
+ ApplePay
- object + object 		-
Card data
+
Payment Data from Apple Pay Wallet
- Alias
+ BankAccount
- object + object 		-
Alias data if payment means was registered with Secure Card Data before.
+
Bank account data for direct debit transaction
- SchemeToken
+ Card
- object + object 		-
Surrogate values that replace the primary account number (PAN) according to the EMV Payment Tokenization Specification.
Note: LiabilityShift is only possible with Transaction Initialize, AuthorizeDirect and RefundDirect.
Note: Scheme tokens MDES and VTS are only available for Worldline Acquiring.
+
Card data
- BankAccount
+ GooglePay
- object + object 		-
Bank account data for direct debit transaction
+
Payment Data from GooglePay
- GooglePay
+ SaferpayFields
- object + object 		-
Payment Data from GooglePay
+
Payment means data collected with SaferpayFields.
- ApplePay
+ SchemeToken
- object + object 		-
Payment Data from Apple Pay Wallet
+
Surrogate values that replace the primary account number (PAN) according to the EMV Payment Tokenization Specification.
Note: LiabilityShift is only possible with Transaction Initialize, AuthorizeDirect and RefundDirect.
Note: Scheme tokens MDES and VTS are only available for Worldline Acquiring.
- QrCodeData
+ IntentUrl
string 		-
Data which should be integrated into a QR code. In order to make the scanning as easy as possible,
the recommended format of QR code encoding is version 3, with lower error rate correction level
in character mode, resulting with a 29 x 29 pixels image maximum.
+
Url to be used for payment on the same device (web-to-app or app-to-app switch)
- IntentUrl
+ QrCodeData
string 		-
Url to be used for payment on the same device (web-to-app or app-to-app switch)
+
Data which should be integrated into a QR code. In order to make the scanning as easy as possible,
the recommended format of QR code encoding is version 3, with lower error rate correction level
in character mode, resulting with a 29 x 29 pixels image maximum.
- IBAN
+ BankName
- - mandatory, - string 		-
International Bank Account Number in electronical format (without spaces).
+
Name of the Bank.
-AlphaNumeric[1..50]
- Example: DE12500105170648489890 - +
- HolderName
+ BIC
string 		-
Name of the account holder.
+
Bank Identifier Code without spaces.
-Iso885915[1..50]
- Example: John Doe +AlphaNumeric[8..11]
+ Example: INGDDEFFXXX
- BIC
+ HolderName
string 		-
Bank Identifier Code without spaces.
+
Name of the account holder.
-AlphaNumeric[8..11]
- Example: INGDDEFFXXX +Iso885915[1..50]
+ Example: John Doe
- BankName
+ IBAN
+ + mandatory, + string 		-
Name of the Bank.
+
International Bank Account Number in electronical format (without spaces).
- +AlphaNumeric[1..50]
+ Example: DE12500105170648489890 +
- IBAN
+ BankName
- - mandatory, - string 		-
International Bank Account Number in electronical format (without spaces).
+
Name of the Bank.
-AlphaNumeric[1..50]
- Example: DE12500105170648489890 - +
- HolderName
+ BIC
string 		-
Name of the account holder.
+
Bank Identifier Code without spaces.
-Iso885915[1..50]
- Example: John Doe +AlphaNumeric[8..11]
+ Example: INGDDEFFXXX
- BIC
+ CountryCode
string 		-
Bank Identifier Code without spaces.
+
ISO 2-letter country code of the IBAN origin (if available)
-AlphaNumeric[8..11]
- Example: INGDDEFFXXX + Example: CH
- BankName
+ HolderName
string 		-
Name of the Bank.
+
Name of the account holder.
- +Iso885915[1..50]
+ Example: John Doe +
- CountryCode
+ IBAN
+ + mandatory, + string 		-
ISO 2-letter country code of the IBAN origin (if available)
+
International Bank Account Number in electronical format (without spaces).
- Example: CH +AlphaNumeric[1..50]
+ Example: DE12500105170648489890
+ Description
+ + string + +		 +
A human readable description provided by the merchant that can be displayed in web sites.
+ +Utf8[1..1000]
+ Example: Description of payment +
- Description
- - string - -		 -
A human readable description provided by the merchant that can be displayed in web sites.
- -Utf8[1..1000]
- Example: Description -
- PaymentMethod
+ Name
+ + mandatory, + string 		-
alphanumeric id of the payment method / brand
+
Name of the Brand (Visa, Mastercard, an so on – might change over time, only use for display, never for parsing). Only use it for display, never for parsing and/or mapping! Use PaymentMethod instead.
-Possible values: ACCOUNTTOACCOUNT, ALIPAY, AMEX, BANCONTACT, BONUS, DINERS, CARD, DIRECTDEBIT, EPRZELEWY, EPS, GIROPAY, IDEAL, INVOICE, JCB, KLARNA, MAESTRO, MASTERCARD, MYONE, PAYCONIQ, PAYDIREKT, PAYPAL, POSTCARD, POSTFINANCE, POSTFINANCEPAY, SOFORT, TWINT, UNIONPAY, VISA, WECHATPAY, WLCRYPTOPAYMENTS.
- + Example: VISA +
- Name
+ PaymentMethod
- - mandatory, - string 		-
Name of the Brand (Visa, Mastercard, an so on – might change over time, only use for display, never for parsing). Only use it for display, never for parsing and/or mapping! Use PaymentMethod instead.
+
alphanumeric id of the payment method / brand
- Example: VISA - +Possible values: ACCOUNTTOACCOUNT, ALIPAY, AMEX, BANCONTACT, BONUS, DINERS, CARD, DIRECTDEBIT, EPRZELEWY, EPS, GIROPAY, IDEAL, INVOICE, JCB, KLARNA, MAESTRO, MASTERCARD, MYONE, PAYCONIQ, PAYDIREKT, PAYPAL, POSTCARD, POSTFINANCE, POSTFINANCEPAY, SOFORT, TWINT, UNIONPAY, VISA, WECHATPAY, WLCRYPTOPAYMENTS.
+
- Number
+ ExpMonth
mandatory, - string + integer 		-
Card number without separators
+
Month of expiration (eg 9 for September)
- Example: 1234123412341234 +Range: inclusive between 1 and 12
+ Example: 9
- ExpMonth
+ HolderName
- - mandatory, - - integer + string 		-
Month of expiration (eg 9 for September)
+
Name of the card holder
-Range: inclusive between 1 and 12
- Example: 9 +Utf8[1..50]
+ Example: John Doe
- HolderName
+ Number
+ + mandatory, + string 		-
Name of the card holder
+
Card number without separators
-Utf8[1..50]
- Example: John Doe + Example: 1234123412341234
- MaskedNumber
+ CountryCode
- - mandatory, - string 		-
Masked card number
+
ISO 2-letter country code of the card origin (if available)
- Example: 912345xxxxxx1234 + Example: CH
- ExpYear
+ ExpMonth
mandatory, @@ -2780,15 +2763,15 @@ Possible values: NONE, MANDATORY.
 		-
Year of expiration
+
Month of expiration (eg 9 for September)
- Example: 2015 + Example: 9
- ExpMonth
+ ExpYear
mandatory, @@ -2797,66 +2780,69 @@ Possible values: NONE, MANDATORY.
 		-
Month of expiration (eg 9 for September)
+
Year of expiration
- Example: 9 + Example: 2015
- HolderName
+ HashValue
string 		-
Name of the card holder (if known)
+
The HashValue, if the hash generation is configured for the customer.
- Example: John Doe - +
- HolderSegment
+ HolderName
string 		-
The Segment of card holder. Only returned for Alias/AssertInsert, Alias/InsertDirect and Alias/Update calls if available.
+
Name of the card holder (if known)
-Possible values: UNSPECIFIED, CONSUMER, CORPORATE, CORPORATE_AND_CONSUMER.
- Example: CORPORATE + Example: John Doe
- CountryCode
+ HolderSegment
string 		-
ISO 2-letter country code of the card origin (if available)
+
The Segment of card holder. Only returned for Alias/AssertInsert, Alias/InsertDirect and Alias/Update calls if available.
- Example: CH +Possible values: UNSPECIFIED, CONSUMER, CORPORATE, CORPORATE_AND_CONSUMER.
+ Example: CORPORATE
- HashValue
+ MaskedNumber
+ + mandatory, + string 		-
The HashValue, if the hash generation is configured for the customer.
+
Masked card number
- + Example: 912345xxxxxx1234 +
- ShopInfo
+ OsInfo
string 		-
Name and version of the shop software
+
Information on the operating system
Iso885915[1..100]
- Example: My Shop + Example: Windows Server 2013
- OsInfo
+ ShopInfo
string 		-
Information on the operating system
+
Name and version of the shop software
Iso885915[1..100]
- Example: Windows Server 2013 + Example: My Shop
- MinimumNumberOfInstallments
+ AnnualPercentageRate
- - mandatory, - - integer + string 		-
Maximum Number of Installments. Valid values are 2–99 and
MaximumNumberOfInstallments must be bigger or equal MinimumNumberOfInstallments.
+
Annual percentage rate in hundreth of a percent. e.g. value 125 means 1.25%.
Valid values are 0-99999
- MaximumNumberOfInstallments
+ InstallmentFee
- - mandatory, - - integer + + object 		-
Minimum Number of Installments. Valid values are 2–99 and
MinimumNumberOfInstallments must be smaller or equal MaximumNumberOfInstallments.
+
Installment Fee
- InstallmentFee
+ MaximumNumberOfInstallments
- - object + + mandatory, + + integer 		-
Installment Fee
+
Minimum Number of Installments. Valid values are 2–99 and
MinimumNumberOfInstallments must be smaller or equal MaximumNumberOfInstallments.
- AnnualPercentageRate
+ MinimumNumberOfInstallments
- string + + mandatory, + + integer 		-
Annual percentage rate in hundreth of a percent. e.g. value 125 means 1.25%.
Valid values are 0-99999
+
Maximum Number of Installments. Valid values are 2–99 and
MaximumNumberOfInstallments must be bigger or equal MinimumNumberOfInstallments.
- PayerAmount
+ ExchangeRate
mandatory, - - object + string 		-
Amount in payer’s currency
+
The used exchange rate including markup
The decimal separator used is '.' regardless of location
- + Example: 1.2345 +
- ExchangeRate
+ PayerAmount
mandatory, - string + + object 		-
The used exchange rate including markup
The decimal separator used is '.' regardless of location
+
Amount in payer’s currency
- Example: 1.2345 - +
- MandateId
+ CreditorId
mandatory, @@ -3057,14 +3043,14 @@ Iso885915[1..100]
 		-
The unique Mandate reference, required for german direct debit payments.
+
Creditor id, required for german direct debit payments.
- CreditorId
+ MandateId
mandatory, @@ -3073,7 +3059,7 @@ Iso885915[1..100]
 		-
Creditor id, required for german direct debit payments.
+
The unique Mandate reference, required for german direct debit payments.
- CssUrl
+ ContentSecurityEnabled
- string + boolean 		-
Custom styling resource (url) which will be referenced in web pages displayed by Saferpay to apply your custom styling.
This file must be hosted on a SSL/TLS secured web server (the url must start with https://).
If a custom CSS is provided, any design related settings set in the payment page config (PPConfig) will be ignored and the default design will be used.
+
When enabled, then ContentSecurity/SAQ-A is requested, which leads to the CSS being loaded from the saferpay server.
-Max length: 2000
- Example: https://merchanthost/merchant.css - +
- ContentSecurityEnabled
+ CssUrl
- boolean + string 		-
When enabled, then ContentSecurity/SAQ-A is requested, which leads to the CSS being loaded from the saferpay server.
+
Custom styling resource (url) which will be referenced in web pages displayed by Saferpay to apply your custom styling.
This file must be hosted on a SSL/TLS secured web server (the url must start with https://).
If a custom CSS is provided, any design related settings set in the payment page config (PPConfig) will be ignored and the default design will be used.
- +Max length: 2000
+ Example: https://merchanthost/merchant.css +
- SaferpayFields
+ Card
- object + object 		-
Payment means data collected with SaferpayFields.
+
Card data
- Card
+ SaferpayFields
- object + object 		-
Card data
+
Payment means data collected with SaferpayFields.
- NumberOfInstallments
+ AnnualPercentageRate
- - mandatory, - - integer + string 		-
Number of Installments. Valid values are 2–99.
+
Annual percentage rate in hundredth of a percent. e.g. value 125 means 1.25%.
Valid values are 0-99999
-Range: inclusive between 2 and 99
- InterestRate
+ FirstInstallmentAmount
- string + + object 		-
Interest rate in hundredth of a percent. e.g. value 125 means 1.25%.
Valid values are 0-99999
+
First Installment Amount
- AnnualPercentageRate
+ InterestRate
string 		-
Annual percentage rate in hundredth of a percent. e.g. value 125 means 1.25%.
Valid values are 0-99999
+
Interest rate in hundredth of a percent. e.g. value 125 means 1.25%.
Valid values are 0-99999
- FirstInstallmentAmount
+ NumberOfInstallments
- - object + + mandatory, + + integer 		-
First Installment Amount
+
Number of Installments. Valid values are 2–99.
+Range: inclusive between 2 and 99
- Payee
+ DueDate
- - object + date 		-
Information about the payee, eg billpay, who is responsible for collecting the bill
+
The date by which the invoice needs to be settled
- ReasonForTransfer
+ Payee
- string + + object 		-
The reason for transfer to be stated when paying the invoice (transfer of funds)
+
Information about the payee, eg billpay, who is responsible for collecting the bill
- DueDate
+ ReasonForTransfer
- date + string 		-
The date by which the invoice needs to be settled
+
The reason for transfer to be stated when paying the invoice (transfer of funds)
- TransactionStamp
+ SettlementDate
- - mandatory, - string 		-
TransactionStamp
+
SettlementDate with the format MMDD
-Max length: 50
- Example: 9406957728464714731817 +String length: inclusive between 4 and 4
+ Example: 0122
- SettlementDate
+ TransactionStamp
+ + mandatory, + string 		-
SettlementDate with the format MMDD
+
TransactionStamp
-String length: inclusive between 4 and 4
- Example: 0122 +Max length: 50
+ Example: 9406957728464714731817
- TransactionStamp
+ SettlementDate
string 		-
SCA transaction stamp, created by the card issuer
+
SCA transaction settlement date, created by the card issuer. For MasterCard schemes only.
- SettlementDate
+ TransactionStamp
string 		-
SCA transaction settlement date, created by the card issuer. For MasterCard schemes only.
+
SCA transaction stamp, created by the card issuer
- ContentType
+ Body
mandatory, @@ -3458,13 +3444,13 @@ String length: inclusive between 4 and 4
-Utf8[1..1000]
+Utf8[1..100000]
- Body
+ ContentType
mandatory, @@ -3475,7 +3461,7 @@ Utf8[1..1000]
-Utf8[1..100000]
+Utf8[1..1000]
- LiabilityShift
+ InPsd2Scope
- - mandatory, - - boolean + string 		-
Is liability shifted for this transaction
+
Determines if the transaction is in the PSD2 Scope (Payment Service Directive 2 of the European Union)
+Possible values: YES, NO, UNKNOWN.
- LiableEntity
+ LiabilityShift
mandatory, - string + boolean 		-
Indicates who takes the liability for the transaction
+
Is liability shifted for this transaction
-Possible values: MERCHANT, THREEDS.
- ThreeDs
+ LiableEntity
- - object + + mandatory, + + string 		-
Details about ThreeDs if applicable
+
Indicates who takes the liability for the transaction
+Possible values: MERCHANT, THREEDS.
- InPsd2Scope
+ ThreeDs
- string + + object 		-
Determines if the transaction is in the PSD2 Scope (Payment Service Directive 2 of the European Union)
+
Details about ThreeDs if applicable
-Possible values: YES, NO, UNKNOWN.
- SubmerchantId
+ Fee
- - mandatory, - - string + + object 		-
The id of the marketplace submerchant on whose behalf a multipart capture or refund capture is being made.
+
The marketplace fee that will be charged from the marketplace to the submerchant.
The properties Fee and FeeRefund cannot be used simultaneously.
-Id[1..15]
- Fee
+ FeeRefund
object 		-
The marketplace fee that will be charged from the marketplace to the submerchant.
The properties Fee and FeeRefund cannot be used simultaneously.
+
The fee amount that will be refunded from the marketplace to the submerchant.
The properties Fee and FeeRefund cannot be used simultaneously.
- FeeRefund
+ SubmerchantId
- - object + + mandatory, + + string 		-
The fee amount that will be refunded from the marketplace to the submerchant.
The properties Fee and FeeRefund cannot be used simultaneously.
+
The id of the marketplace submerchant on whose behalf a multipart capture or refund capture is being made.
+Id[1..15]
- InstallmentPlans
+ CustomPlan
- array of objects + object 		-
A maximum number of 12 fixed installment plans
If InstallmentPlans is present, CustomPlan must not be present
+
An installment plan with customizable numbers of installments
If CustomPlan is present, InstallmentPlans must not be present

An installment plan with customizable numbers of installments
- CustomPlan
+ InstallmentPlans
- object + array of objects 		-
An installment plan with customizable numbers of installments
If CustomPlan is present, InstallmentPlans must not be present

An installment plan with customizable numbers of installments
+
A maximum number of 12 fixed installment plans
If InstallmentPlans is present, CustomPlan must not be present
- MerchantEmails
+ FailNotifyUrl
- array of strings + + recommended, + + string 		-
Email addresses to which a confirmation email will be sent to the merchants after successful authorizations.
A maximum of 10 email addresses is allowed.
+
Url to which Saferpay will send the asynchronous failure notification for the transaction. Supported schemes are http and https. You also have to make sure to support the GET-method.
- Example: ["merchant1@saferpay.com", "merchant2@saferpay.com"] +Max length: 2000
+ Example: https://merchanthost/notify/123
- PayerEmail
+ MerchantEmails
- string + array of strings 		-
Email address to which a confirmation email will be sent to the payer after successful authorizations.
+
Email addresses to which a confirmation email will be sent to the merchants after successful authorizations.
A maximum of 10 email addresses is allowed.
- Example: payer@saferpay.com + Example: ["merchant1@saferpay.com", "merchant2@saferpay.com"]
- SuccessNotifyUrl
+ PayerEmail
- - recommended, - - string + string 		-
Url to which Saferpay will send the asynchronous success notification for the transaction. Supported schemes are http and https. You also have to make sure to support the GET-method.
+
Email address to which a confirmation email will be sent to the payer after successful authorizations.
-Max length: 2000
- Example: https://merchanthost/notify/123 + Example: payer@saferpay.com
- FailNotifyUrl
+ SuccessNotifyUrl
recommended, @@ -3758,7 +3744,7 @@ Max length: 2000
 		-
Url to which Saferpay will send the asynchronous failure notification for the transaction. Supported schemes are http and https. You also have to make sure to support the GET-method.
+
Url to which Saferpay will send the asynchronous success notification for the transaction. Supported schemes are http and https. You also have to make sure to support the GET-method.
Max length: 2000
Example: https://merchanthost/notify/123 @@ -3794,205 +3780,205 @@ Max length: 2000
- Type
+ CategoryName
string 		-
Order item type
+
Category name
-Possible values: DIGITAL, PHYSICAL, SERVICE, GIFTCARD, DISCOUNT, SHIPPINGFEE, SALESTAX, SURCHARGE.
- +Utf8[1..100]
+ Example: knives +
- Id
+ Description
string 		-
Product id
+
Product description
-Utf8[1..100]
- Example: C123192 +Utf8[1..200]
+ Example: The well known swiss army knife
- VariantId
+ DiscountAmount
string 		-
Product variant id
+
Discount amount including tax
-Utf8[1..100]
- Example: C123192-red + Example: 92
- Name
+ Id
string 		-
Product name
+
Product id
-Utf8[1..200]
- Example: red swiss army knife +Utf8[1..100]
+ Example: C123192
- CategoryName
+ ImageUrl
string 		-
Category name
+
URL to an image showing the product
-Utf8[1..100]
- Example: knives +Max length: 2000
+ Example: https://merchanthost/product/1/image
- Description
+ IsPreOrder
- string + boolean 		-
Product description
+
Flag, which indicates that the order item is a pre order. Per default, it is not a pre order.
-Utf8[1..200]
- Example: The well known swiss army knife + Example: true
- Quantity
+ Name
- integer + string 		-
The quantity of the order item
+
Product name
- Example: 2 +Utf8[1..200]
+ Example: red swiss army knife
- UnitPrice
+ ProductUrl
string 		-
Price per single item in minor unit (CHF 15.50 ⇒ Value=1550). Only Integer values will be accepted!
+
URL to the product page
- Example: 1550 +Max length: 2000
+ Example: https://merchanthost/product/1
- IsPreOrder
+ Quantity
- boolean + integer 		-
Flag, which indicates that the order item is a pre order. Per default, it is not a pre order.
+
The quantity of the order item
- Example: true + Example: 2
- TaxRate
+ TaxAmount
string 		-
Tax rate of the item price in hundredth of a percent. e.g. value 1900 means 19.00%
Valid values are 0-99999
+
Total tax amount of the order item. This tax needs to be included in the UnitPrice and must take the Quantity of the order item into account.
-Range: inclusive between 0 and 99999
- Example: 1900 + Example: 480
- TaxAmount
+ TaxRate
string 		-
Total tax amount of the order item. This tax needs to be included in the UnitPrice and must take the Quantity of the order item into account.
+
Tax rate of the item price in hundredth of a percent. e.g. value 1900 means 19.00%
Valid values are 0-99999
- Example: 480 +Range: inclusive between 0 and 99999
+ Example: 1900
- DiscountAmount
+ Type
string 		-
Discount amount including tax
+
Order item type
- Example: 92 - +Possible values: DIGITAL, PHYSICAL, SERVICE, GIFTCARD, DISCOUNT, SHIPPINGFEE, SALESTAX, SURCHARGE.
+
- ProductUrl
+ UnitPrice
string 		-
URL to the product page
+
Price per single item in minor unit (CHF 15.50 ⇒ Value=1550). Only Integer values will be accepted!
-Max length: 2000
- Example: https://merchanthost/product/1 + Example: 1550
- ImageUrl
+ VariantId
string 		-
URL to an image showing the product
+
Product variant id
-Max length: 2000
- Example: https://merchanthost/product/1/image +Utf8[1..100]
+ Example: C123192-red
- OrderId
- - - recommended, - - string - -		 -
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
- -Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 - -
- PayerNote
+ Description
string 		-
Text which will be printed on payer's debit note. Supported by SIX Acquiring. No guarantee that it will show up on the payer's debit note, because his bank has to support it too.
Please note that maximum allowed characters are rarely supported. It's usually around 10-12.
+
A human readable description provided by the merchant that can be displayed in web sites.
-Utf8[1..50]
- Example: Payernote +Utf8[1..1000]
+ Example: Description of payment
- Description
+ Installment
- string + + object 		-
A human readable description provided by the merchant that can be displayed in web sites.
+
Installment options – cannot be combined with Recurring.
-Utf8[1..1000]
- Example: Description - +
- Recurring
+ OrderId
- - object - -		 -
Recurring options – cannot be combined with Installment.
+ + recommended, + + string + +		 +
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
- +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901 +
- Installment
+ PayerNote
+ + string + +		 +
Text which will be printed on payer's debit note. Supported by SIX Acquiring. No guarantee that it will show up on the payer's debit note, because his bank has to support it too.
Please note that maximum allowed characters are rarely supported. It's usually around 10-12.
+ +Utf8[1..50]
+ Example: Payernote + +
+ Recurring
- object + object 		-
Installment options – cannot be combined with Recurring.
+
Recurring options – cannot be combined with Installment.
+ BankAccount
+ + + object + +		 +
Bank account data for direct debit transactions.
+ + +
Brand
@@ -4162,6 +4162,20 @@ Id[1..35]
Brand information
+
+ Card
+ + + object + +		 +
Card data
+ +
- Wallet
+ PayPal
- string + + object 		-
Name of Wallet, if the transaction was done by a wallet
+
PayPal data
- Example: APPLEPAY - +
- Card
+ Wallet
- - object + string 		-
Card data
+
Name of Wallet, if the transaction was done by a wallet
- + Example: APPLEPAY +
+

Container "Payment_Models_Data_PayerInfo"

+ + - -
- BankAccount
+ BillingAddress
- object + object 		-
Bank account data for direct debit transactions.
+
- PayPal
+ DeliveryAddress
- object + object 		-
PayPal data
+
-

Container "Payment_Models_Data_PayerInfo"

- - + +
Id
@@ -4284,76 +4298,67 @@ PayerId[1..256]
+

Container "Payment_Models_Data_PayerProfile"

+ + - - - - - -
- DeliveryAddress
- - - object - -		 -
- - -
- BillingAddress
+ Company
- - object + string 		-
+
The payer's company
+Utf8[1..100]
-

Container "Payment_Models_Data_PayerProfile"

- - @@ -4372,45 +4377,43 @@ Utf8[1..100]
@@ -4430,32 +4433,29 @@ AlphaNumeric[10..10]
@@ -4475,16 +4475,16 @@ Possible values: MALE, FEMALE, DIVERSE, COMPANY.
@@ -4499,20 +4499,6 @@ Possible values: MALE, FEMALE, DIVERSE, COMPANY.
Example: payer_secondary@provider.com - - - - - @@ -4539,50 +4525,31 @@ Possible values: MALE, FEMALE, DIVERSE, COMPANY.
- - - - @@ -4616,28 +4583,47 @@ Id[1..35]
+ + + + @@ -4649,98 +4635,98 @@ Id[1..35]
@@ -4752,92 +4738,92 @@ Id[1..35]
@@ -4864,53 +4850,34 @@ Id[1..35]
- - - - @@ -4944,28 +4911,47 @@ Id[1..35]
+ + + + @@ -4977,54 +4963,60 @@ Id[1..35]
+ + + + @@ -5062,136 +5054,130 @@ Id[1..64]
- - - - @@ -5201,7 +5187,7 @@ Id[1..80]
@@ -5364,35 +5350,35 @@ Utf8[1..100]
@@ -5402,7 +5388,7 @@ Utf8[1..100]
@@ -5460,34 +5446,34 @@ Max length: 2000
@@ -5528,34 +5514,34 @@ Utf8[1..1000]
@@ -5566,14 +5552,14 @@ Utf8[1..1000]
@@ -5594,14 +5580,14 @@ Utf8[1..1000]
@@ -5627,54 +5613,60 @@ Utf8[1..1000]
+ + + + @@ -5712,136 +5704,130 @@ Id[1..64]
- - - - @@ -5851,34 +5837,34 @@ Id[1..80]
@@ -5904,29 +5890,29 @@ Range: inclusive between 1 and 1600
@@ -5937,30 +5923,28 @@ Range: inclusive between 1 and 1600
@@ -5981,14 +5965,16 @@ Range: inclusive between 1 and 1600
@@ -6037,15 +6023,15 @@ Possible values: EMAIL, SHOP, HOMEDELIVERY, PICKUP, HQ.
@@ -6064,15 +6050,15 @@ Possible values: EMAIL, SHOP, HOMEDELIVERY, PICKUP, HQ.
@@ -6105,18 +6091,29 @@ Id[1..40]
+ + + + @@ -6156,29 +6153,18 @@ Range: inclusive between 1 and 12
- - - - @@ -6306,19 +6292,16 @@ Possible values: RECURRING.
@@ -6338,16 +6321,19 @@ Possible values: RECURRING.
@@ -6358,54 +6344,60 @@ Possible values: STRONG_CUSTOMER_AUTHENTICATION, FRICTIONLESS, ATTEMPT, EXEMPTIO + + + + @@ -6443,136 +6435,130 @@ Id[1..64]
- - - - @@ -6601,31 +6587,31 @@ Id[1..80]
@@ -6696,7 +6682,7 @@ Range: inclusive between 1 and 1600
@@ -6887,205 +6873,205 @@ Possible values: BLACKLIST_IP, BLACKLIST_IP_ORIGIN, BLACKLIST_PAYMENT_MEANS, BLA @@ -7109,24 +7095,6 @@ Max length: 2000
Amount data (currency, value, etc.)
- - - - - @@ -7159,6 +7127,24 @@ Utf8[1..100]
Specific payment options
+ + + + + @@ -7185,7 +7171,7 @@ Utf8[1..100]
@@ -7249,7 +7235,7 @@ Possible values: RANDOM.
@@ -7288,7 +7274,7 @@ Possible values: RANDOM.
@@ -7327,39 +7313,39 @@ Possible values: RANDOM.
@@ -7371,55 +7357,55 @@ Possible values: RANDOM.
@@ -7444,26 +7430,26 @@ Possible values: ECOM, SPG, MPO.
diff --git a/texts/ErrorResponse.md b/texts/ErrorResponse.md index 5c962b1..156eeec 100644 --- a/texts/ErrorResponse.md +++ b/texts/ErrorResponse.md @@ -10,38 +10,37 @@ @@ -74,42 +72,39 @@ Possible values: DO_NOT_RETRY, OTHER_MEANS, RETRY, RETRY_LATER.
@@ -142,39 +137,44 @@ Possible values: DO_NOT_RETRY, OTHER_MEANS, RETRY, RETRY_LATER.
From 146c4b5af8890b04cf404a282a71cba9ffe2adb1 Mon Sep 17 00:00:00 2001 From: Martin Distler Date: Tue, 2 Jul 2024 11:02:43 +0200 Subject: [PATCH 2/2] Update changelog --- texts/Changelog.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/texts/Changelog.md b/texts/Changelog.md index 894c4c5..f19e3cf 100644 --- a/texts/Changelog.md +++ b/texts/Changelog.md @@ -1,6 +1,7 @@ # Changelog ## Table of Contents +- [Version 1.41](#v1.41.0.0.20240716) - [Version 1.40](#v1.40.0.0.20240521) - [Version 1.39](#v1.39.0.0.20240319) - [Version 1.38](#v1.38.0.0.20240123) @@ -39,6 +40,12 @@ - [Version 1.5](#v1.5.0.20170207) - [Version 1.4](#v1.4.0.20161015) +## Version 1.41 (released 2024-07-16) +- available on Sandbox: 2024-07-02 +- introduced version 1.41 +- added value `1.41` for _SpecVersion_ +- added additional info about the used ISO-standard and applied restrictions to field `LanguageCode` of the _Payer_ container and [SecureCardData/AliasInsert](index.html#Payment_v1_Alias_Insert) requests + ## Version 1.40 (released 2024-05-21) - available on Sandbox: 2024-05-07 - introduced version 1.40
- HasAccount
+ CreationDate
- boolean + date 		-
Does the payer have an account in the shop?
+
Date and Time (ISO 8601) when user account was created
- + Example: 2018-05-25T18:12:43Z + 2018-05-25T19:12:43+01:00 +
- HasPassword
+ DateOfBirth
- boolean + string 		-
Does the payer have a password?
+
The payer's date of birth (ISO 8601)
YYYY-MM-DD
- +AlphaNumeric[10..10]
+ Example: 1990-05-31 +
- PasswordForgotten
+ Email
- boolean + string 		-
Was the password reset by the payer using the "forgot my password" feature in the current session?
+
The payer's email address
- + Example: payer@provider.com +
- LastName
+ Gender
string 		-
The payer's last name
+
The payer's gender
-Utf8[1..100]
- +Possible values: MALE, FEMALE, DIVERSE, COMPANY.
+ Example: COMPANY +
- Company
+ HasAccount
- string + boolean 		-
The payer's company
+
Does the payer have an account in the shop?
-Utf8[1..100]
- DateOfBirth
+ HasPassword
- string + boolean 		-
The payer's date of birth (ISO 8601)
YYYY-MM-DD
+
Does the payer have a password?
-AlphaNumeric[10..10]
- Example: 1990-05-31 - +
- Gender
+ LastName
string 		-
The payer's gender
+
The payer's last name
-Possible values: MALE, FEMALE, DIVERSE, COMPANY.
- Example: COMPANY - +Utf8[1..100]
+
- CreationDate
+ PasswordForgotten
- date + boolean 		-
Date and Time (ISO 8601) when user account was created
+
Was the password reset by the payer using the "forgot my password" feature in the current session?
- Example: 2018-05-25T18:12:43Z - 2018-05-25T19:12:43+01:00 - +
- Email
+ Phone
- string + + object 		-
The payer's email address
+
The payer's phone numbers
- Example: payer@provider.com - +
- Phone
- - - object - -		 -
The payer's phone numbers
- -
- OrderId
- - - recommended, - - string - -		 -
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
- -Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 - -
- PayerNote
+ Description
string 		-
Text which will be printed on payer's debit note. Supported by SIX Acquiring. No guarantee that it will show up on the payer's debit note, because his bank has to support it too.
Please note that maximum allowed characters are rarely supported. It's usually around 10-12.
+
A human readable description provided by the merchant that can be displayed in web sites.
-Utf8[1..50]
- Example: Payernote +Utf8[1..1000]
+ Example: Description of payment
- Description
+ Installment
- string + + object 		-
A human readable description provided by the merchant that can be displayed in web sites.
+
Installment options – cannot be combined with Recurring.
-Utf8[1..1000]
- Example: Description - +
- Recurring
+ OrderId
- - object + + recommended, + + string 		-
Recurring options – cannot be combined with Installment.
+
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
- +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901 +
- Installment
+ PayerNote
+ + string + +		 +
Text which will be printed on payer's debit note. Supported by SIX Acquiring. No guarantee that it will show up on the payer's debit note, because his bank has to support it too.
Please note that maximum allowed characters are rarely supported. It's usually around 10-12.
+ +Utf8[1..50]
+ Example: Payernote + +
+ Recurring
- object + object 		-
Installment options – cannot be combined with Recurring.
+
Recurring options – cannot be combined with Installment.
- SaferpayFields
+ Alias
- object + object 		-
Payment means data collected with SaferpayFields.
+
Alias data if payment means was registered with Secure Card Data before.
- Card
+ ApplePay
- object + object 		-
Card data
+
Payment Data from ApplePay
- Alias
+ BankAccount
- object + object 		-
Alias data if payment means was registered with Secure Card Data before.
+
Bank account data for direct debit transaction
- SchemeToken
+ Card
- object + object 		-
Surrogate values that replace the primary account number (PAN) according to the EMV Payment Tokenization Specification.
Note: LiabilityShift is only possible with Transaction Initialize, AuthorizeDirect and RefundDirect.
Note: Scheme tokens MDES and VTS are only available for Worldline Acquiring.
+
Card data
- BankAccount
+ GooglePay
- object + object 		-
Bank account data for direct debit transaction
+
Payment Data from GooglePay
- GooglePay
+ SaferpayFields
- object + object 		-
Payment Data from GooglePay
+
Payment means data collected with SaferpayFields.
- ApplePay
+ SchemeToken
- object + object 		-
Payment Data from ApplePay
+
Surrogate values that replace the primary account number (PAN) according to the EMV Payment Tokenization Specification.
Note: LiabilityShift is only possible with Transaction Initialize, AuthorizeDirect and RefundDirect.
Note: Scheme tokens MDES and VTS are only available for Worldline Acquiring.
- Brand
+ BankAccount
- - mandatory, - - object + object 		-
Brand information
+
Bank account data for direct debit transactions.
- DisplayText
+ Brand
mandatory, - string + + object 		-
Means of payment formatted / masked for display purposes
+
Brand information
- Example: DisplayText - +
- Wallet
+ Card
- string + + object 		-
Name of Wallet, if the transaction was done by a wallet
+
Card data
- Example: APPLEPAY - +
- Card
+ DisplayText
- - object + + mandatory, + + string 		-
Card data
+
Means of payment formatted / masked for display purposes
- + Example: DisplayText +
- BankAccount
+ PayPal
- object + object 		-
Bank account data for direct debit transactions.
+
PayPal data
- PayPal
+ Wallet
- - object + string 		-
PayPal data
+
Name of Wallet, if the transaction was done by a wallet
- + Example: APPLEPAY +
- OrderId
+ Description
- - recommended, + + mandatory, - string - -		 -
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
- -Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 - -
- PayerNote
- string 		-
Text which will be printed on payer's debit note. Supported by SIX Acquiring. No guarantee that it will show up on the payer's debit note, because his bank has to support it too.
Please note that maximum allowed characters are rarely supported. It's usually around 10-12.
+
A human readable description provided by the merchant that will be displayed in Payment Page.
-Utf8[1..50]
- Example: Payernote +Utf8[1..1000]
+ Example: Description of payment
- Description
+ Installment
- - mandatory, - - string + + object 		-
A human readable description provided by the merchant that will be displayed in Payment Page.
+
Installment options – cannot be combined with Recurring.
-Utf8[1..1000]
- Example: Description of payment - +
- Recurring
+ OrderId
- - object + + recommended, + + string 		-
Recurring options – cannot be combined with Installment.
+
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
- +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901 +
- Installment
+ PayerNote
+ + string + +		 +
Text which will be printed on payer's debit note. Supported by SIX Acquiring. No guarantee that it will show up on the payer's debit note, because his bank has to support it too.
Please note that maximum allowed characters are rarely supported. It's usually around 10-12.
+ +Utf8[1..50]
+ Example: Payernote + +
+ Recurring
- object + object 		-
Installment options – cannot be combined with Recurring.
+
Recurring options – cannot be combined with Installment.
- Type
+ AcquirerName
- - mandatory, - string 		-
Type of transaction. One of 'PAYMENT'
+
Name of the acquirer
-Possible values: PAYMENT.
- Example: PAYMENT + Example: AcquirerName
- Status
+ AcquirerReference
- - mandatory, - string 		-
Current status of the transaction. One of 'AUTHORIZED','CANCELED', 'CAPTURED' or 'PENDING'
+
Reference id of the acquirer (if available)
-Possible values: AUTHORIZED, CANCELED, CAPTURED, PENDING.
- Example: AUTHORIZED + Example: AcquirerReference
- Id
+ Amount
mandatory, + + object + +		 +
Amount (currency, value, etc.) that has been authorized.
+ + +
+ ApprovalCode
+ string 		-
Unique Saferpay transaction id. Used to reference the transaction in any further step.
+
Approval id of the acquirer (if available)
- Example: K5OYS9Ad6Ex4rASU1IM1b3CEU8bb + Example: 109510
- Amount
+ DirectDebit
- - mandatory, - - object + object 		-
Amount (currency, value, etc.) that has been authorized.
+
Direct Debit information, if applicable
- + Example: AcquirerReference +
- OrderId
+ Id
+ + mandatory, + string 		-
OrderId given with request
+
Unique Saferpay transaction id. Used to reference the transaction in any further step.
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 + Example: K5OYS9Ad6Ex4rASU1IM1b3CEU8bb
- AcquirerName
+ Invoice
- string + + object 		-
Name of the acquirer
+
Invoice information, if applicable
- Example: AcquirerName - +
- AcquirerReference
+ IssuerReference
- string + + object 		-
Reference id of the acquirer (if available)
+
Issuer reference information, if applicable
- Example: AcquirerReference - +
- SixTransactionReference
+ OrderId
- - mandatory, - string 		-
Unique SIX transaction reference.
+
OrderId given with request
- Example: 0:0:3:K5OYS9Ad6Ex4rASU1IM1b3CEU8bb +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901
- ApprovalCode
+ SixTransactionReference
+ + mandatory, + string 		-
Approval id of the acquirer (if available)
+
Unique SIX transaction reference.
- Example: 109510 + Example: 0:0:3:K5OYS9Ad6Ex4rASU1IM1b3CEU8bb
- DirectDebit
+ Status
- - object + + mandatory, + + string 		-
Direct Debit information, if applicable
+
Current status of the transaction. One of 'AUTHORIZED','CANCELED', 'CAPTURED' or 'PENDING'
- Example: AcquirerReference +Possible values: AUTHORIZED, CANCELED, CAPTURED, PENDING.
+ Example: AUTHORIZED
- Invoice
- - - object - -		 -
Invoice information, if applicable
- - -
- IssuerReference
+ Type
- - object + + mandatory, + + string 		-
Issuer reference information, if applicable
+
Type of transaction. One of 'PAYMENT'
- +Possible values: PAYMENT.
+ Example: PAYMENT +
- PayerId
+ Email
mandatory, @@ -5210,15 +5196,14 @@ Id[1..80]
 		-
PayerId from PayPal
+
The email address used in PayPal
- Example: 5b9aefc5-9b48-4a95-ae47-cda20420d68e - +
- SellerProtectionStatus
+ PayerId
mandatory, @@ -5227,16 +5212,15 @@ Id[1..80]
 		-
Seller protection status from PayPal.
+
PayerId from PayPal
-Possible values: ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE.
- Example: ELIGIBLE + Example: 5b9aefc5-9b48-4a95-ae47-cda20420d68e
- Email
+ SellerProtectionStatus
mandatory, @@ -5245,9 +5229,11 @@ Possible values: ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE.
 		-
The email address used in PayPal
+
Seller protection status from PayPal.
- +Possible values: ELIGIBLE, PARTIALLY_ELIGIBLE, NOT_ELIGIBLE.
+ Example: ELIGIBLE +
- RedirectUrl
+ PaymentMeansRequired
mandatory, - string + boolean 		-
Redirect-URL. Used to either redirect the payer or let him enter his means of payment.
+
If 'true', the given URL must either be used as the target of a form (POST) containing card data entered by the card holder or to redirect the browser to (GET). If ‘false’, a GET redirect without additional data must be performed.
- Example: https://www.saferpay.com/VT2/api/... - +
- PaymentMeansRequired
+ RedirectUrl
mandatory, - boolean + string 		-
If 'true', the given URL must either be used as the target of a form (POST) containing card data entered by the card holder or to redirect the browser to (GET). If ‘false’, a GET redirect without additional data must be performed.
+
Redirect-URL. Used to either redirect the payer or let him enter his means of payment.
- + Example: https://www.saferpay.com/VT2/api/... +
- Success
+ Fail
mandatory, @@ -5411,16 +5397,16 @@ Utf8[1..100]
 		-
Notification url called when the payer has completed the redirect steps successfully and the transaction is ready to be authorized.
+
Notification url called when the payer redirect steps have failed. The transaction cannot be authorized.
Max length: 2000
- Example: https://merchanthost/success/123 + Example: https://merchanthost/fail/123
- Fail
+ Success
mandatory, @@ -5429,10 +5415,10 @@ Max length: 2000
 		-
Notification url called when the payer redirect steps have failed. The transaction cannot be authorized.
+
Notification url called when the payer has completed the redirect steps successfully and the transaction is ready to be authorized.
Max length: 2000
- Example: https://merchanthost/fail/123 + Example: https://merchanthost/success/123
- OrderId
+ Description
- - recommended, - - string + string 		-
Reference defined by the merchant.
+
Description provided by merchant
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 +Utf8[1..1000]
+ Example: Description
- Description
+ OrderId
- string + + recommended, + + string 		-
Description provided by merchant
+
Reference defined by the merchant.
-Utf8[1..1000]
- Example: Description +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901
- OrderId
+ Description
- - recommended, - - string + string 		-
Reference defined by the merchant.
+
Description provided by merchant
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 +Utf8[1..1000]
+ Example: Description
- Description
+ OrderId
- string + + recommended, + + string 		-
Description provided by merchant
+
Reference defined by the merchant.
-Utf8[1..1000]
- Example: Description +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901
- SaferpayFields
+ Alias
- object + object 		-
Payment means data collected with SaferpayFields.
+
Alias data if payment means was registered with Secure Card Data before.
- Alias
+ SaferpayFields
- object + object 		-
Alias data if payment means was registered with Secure Card Data before.
+
Payment means data collected with SaferpayFields.
- Type
+ AcquirerName
- - mandatory, - string 		-
Type of transaction. One of 'REFUND'
+
Name of the acquirer
-Possible values: REFUND.
- Example: REFUND + Example: AcquirerName
- Status
+ AcquirerReference
- - mandatory, - string 		-
Current status of the transaction. One of 'AUTHORIZED','CANCELED', 'CAPTURED' or 'PENDING'
+
Reference id of the acquirer (if available)
-Possible values: AUTHORIZED, CANCELED, CAPTURED, PENDING.
- Example: AUTHORIZED + Example: AcquirerReference
- Id
+ Amount
mandatory, + + object + +		 +
Amount (currency, value, etc.) that has been authorized.
+ + +
+ ApprovalCode
+ string 		-
Unique Saferpay transaction id. Used to reference the transaction in any further step.
+
Approval id of the acquirer (if available)
- Example: K5OYS9Ad6Ex4rASU1IM1b3CEU8bb + Example: 109510
- Amount
+ DirectDebit
- - mandatory, - - object + object 		-
Amount (currency, value, etc.) that has been authorized.
+
Direct Debit information, if applicable
- + Example: AcquirerReference +
- OrderId
+ Id
+ + mandatory, + string 		-
OrderId given with request
+
Unique Saferpay transaction id. Used to reference the transaction in any further step.
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 + Example: K5OYS9Ad6Ex4rASU1IM1b3CEU8bb
- AcquirerName
+ Invoice
- string + + object 		-
Name of the acquirer
+
Invoice information, if applicable
- Example: AcquirerName - +
- AcquirerReference
+ IssuerReference
- string + + object 		-
Reference id of the acquirer (if available)
+
Issuer reference information, if applicable
- Example: AcquirerReference - +
- SixTransactionReference
+ OrderId
- - mandatory, - string 		-
Unique SIX transaction reference.
+
OrderId given with request
- Example: 0:0:3:K5OYS9Ad6Ex4rASU1IM1b3CEU8bb +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901
- ApprovalCode
+ SixTransactionReference
+ + mandatory, + string 		-
Approval id of the acquirer (if available)
+
Unique SIX transaction reference.
- Example: 109510 + Example: 0:0:3:K5OYS9Ad6Ex4rASU1IM1b3CEU8bb
- DirectDebit
+ Status
- - object + + mandatory, + + string 		-
Direct Debit information, if applicable
+
Current status of the transaction. One of 'AUTHORIZED','CANCELED', 'CAPTURED' or 'PENDING'
- Example: AcquirerReference +Possible values: AUTHORIZED, CANCELED, CAPTURED, PENDING.
+ Example: AUTHORIZED
- Invoice
- - - object - -		 -
Invoice information, if applicable
- - -
- IssuerReference
+ Type
- - object + + mandatory, + + string 		-
Issuer reference information, if applicable
+
Type of transaction. One of 'REFUND'
- +Possible values: REFUND.
+ Example: REFUND +
- IdGenerator
+ Id
- - mandatory, - string 		-
Id generator to be used by Saferpay.
+
Alias id to be used for registration if not generated by Saferpay. Mandatory if IdGenerator is 'MANUAL'. This value is case-insensitive.
-Possible values: MANUAL, RANDOM, RANDOM_UNIQUE.
- Example: MANUAL +Id[1..40]
+ Example: alias35nfd9mkzfw0x57iwx
- Id
+ IdGenerator
+ + mandatory, + string 		-
Alias id to be used for registration if not generated by Saferpay. Mandatory if IdGenerator is 'MANUAL'. This value is case-insensitive.
+
Id generator to be used by Saferpay.
-Id[1..40]
- Example: alias35nfd9mkzfw0x57iwx +Possible values: MANUAL, RANDOM, RANDOM_UNIQUE.
+ Example: MANUAL
- ErrorName
+ ErrorMessage
string 		-
Name / id of the error.
+
Description of the error.
- Example: ErrorName + Example: ErrorMessage
- ErrorMessage
+ ErrorName
string 		-
Description of the error.
+
Name / id of the error.
- Example: ErrorMessage + Example: ErrorName
- Success
+ Alias
- - mandatory, - - boolean + + object 		-
Result of registration
+
If Success is 'true', information about the alias
- Alias
+ AuthenticationResult
- object + object 		-
If Success is 'true', information about the alias
+
contains information whether the alias is saved with the strong authentication details or not.
- AuthenticationResult
+ Success
- - object + + mandatory, + + boolean 		-
contains information whether the alias is saved with the strong authentication details or not.
+
Result of registration
- PayerProfile
+ DeviceFingerprintTransactionId
- - object + string 		-
Information on the payer executing the transaction, generally referring to his/her customer profile in the shop (if any).
+
The customer's Session ID (mastered by DFP Device Fingerprinting), or the event ID if the session is not available
+Max length: 1024
- DeviceFingerprintTransactionId
+ PayerProfile
- string + + object 		-
The customer's Session ID (mastered by DFP Device Fingerprinting), or the event ID if the session is not available
+
Information on the payer executing the transaction, generally referring to his/her customer profile in the shop (if any).
-Max length: 1024
- Number
+ AuthValue
- - mandatory, - string 		-
Token number
+
TAVV Cryptogram
+
+ Eci
+ + string + +		 +
Saferpay E-Commerce Indicator. This indicator is just informational.
+ + Example: 07 +
- AuthValue
+ Number
+ + mandatory, + string 		-
TAVV Cryptogram
+
Token number
-
- Eci
- - string - -		 -
Saferpay E-Commerce Indicator. This indicator is just informational.
- - Example: 07 -
- Xid
+ AuthenticationType
- - mandatory, - string 		-
Transaction Id, given by the MPI. References the 3D Secure process.
+
Determines how the card holder was authenticated. Some 3D Secure Versions allow a Frictionless authentication.
- Example: ARkvCgk5Y1t/BDFFXkUPGX9DUgs= for 3D Secure version 1 / - 1ef5b3db-3b97-47df-8272-320d0bd18ab5 for 3D Secure version 2 +Possible values: STRONG_CUSTOMER_AUTHENTICATION, FRICTIONLESS, ATTEMPT, EXEMPTION, NONE.
+ Example: StrongCustomerAuthentication
- AuthenticationType
+ Xid
+ + mandatory, + string 		-
Determines how the card holder was authenticated. Some 3D Secure Versions allow a Frictionless authentication.
+
Transaction Id, given by the MPI. References the 3D Secure process.
-Possible values: STRONG_CUSTOMER_AUTHENTICATION, FRICTIONLESS, ATTEMPT, EXEMPTION, NONE.
- Example: StrongCustomerAuthentication + Example: ARkvCgk5Y1t/BDFFXkUPGX9DUgs= for 3D Secure version 1 / + 1ef5b3db-3b97-47df-8272-320d0bd18ab5 for 3D Secure version 2
- Type
+ AcquirerName
- - mandatory, - string 		-
Type of transaction. One of 'PAYMENT', 'REFUND'
+
Name of the acquirer
-Possible values: PAYMENT, REFUND.
- Example: PAYMENT + Example: AcquirerName
- Status
+ AcquirerReference
- - mandatory, - string 		-
Current status of the transaction. One of 'AUTHORIZED','CANCELED', 'CAPTURED' or 'PENDING'
+
Reference id of the acquirer (if available)
-Possible values: AUTHORIZED, CANCELED, CAPTURED, PENDING.
- Example: AUTHORIZED + Example: AcquirerReference
- Id
+ Amount
mandatory, + + object + +		 +
Amount (currency, value, etc.) that has been authorized.
+ + +
+ ApprovalCode
+ string 		-
Unique Saferpay transaction id. Used to reference the transaction in any further step.
+
Approval id of the acquirer (if available)
- Example: K5OYS9Ad6Ex4rASU1IM1b3CEU8bb + Example: 109510
- Amount
+ DirectDebit
- - mandatory, - - object + object 		-
Amount (currency, value, etc.) that has been authorized.
+
Direct Debit information, if applicable
- + Example: AcquirerReference +
- OrderId
+ Id
+ + mandatory, + string 		-
OrderId given with request
+
Unique Saferpay transaction id. Used to reference the transaction in any further step.
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 + Example: K5OYS9Ad6Ex4rASU1IM1b3CEU8bb
- AcquirerName
+ Invoice
- string + + object 		-
Name of the acquirer
+
Invoice information, if applicable
- Example: AcquirerName - +
- AcquirerReference
+ IssuerReference
- string + + object 		-
Reference id of the acquirer (if available)
+
Issuer reference information, if applicable
- Example: AcquirerReference - +
- SixTransactionReference
+ OrderId
- - mandatory, - string 		-
Unique SIX transaction reference.
+
OrderId given with request
- Example: 0:0:3:K5OYS9Ad6Ex4rASU1IM1b3CEU8bb +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901
- ApprovalCode
+ SixTransactionReference
+ + mandatory, + string 		-
Approval id of the acquirer (if available)
+
Unique SIX transaction reference.
- Example: 109510 + Example: 0:0:3:K5OYS9Ad6Ex4rASU1IM1b3CEU8bb
- DirectDebit
+ Status
- - object + + mandatory, + + string 		-
Direct Debit information, if applicable
+
Current status of the transaction. One of 'AUTHORIZED','CANCELED', 'CAPTURED' or 'PENDING'
- Example: AcquirerReference +Possible values: AUTHORIZED, CANCELED, CAPTURED, PENDING.
+ Example: AUTHORIZED
- Invoice
- - - object - -		 -
Invoice information, if applicable
- - -
- IssuerReference
+ Type
- - object + + mandatory, + + string 		-
Issuer reference information, if applicable
+
Type of transaction. One of 'PAYMENT', 'REFUND'
- +Possible values: PAYMENT, REFUND.
+ Example: PAYMENT +
- TransactionId
+ OrderId
string 		-
Id of the referenced transaction.
+
Unambiguous OrderId of the referenced transaction.
-AlphaNumeric[1..64]
- Example: 723n4MAjMdhjSAhAKEUdA8jtl9jb +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901
- OrderId
+ TransactionId
string 		-
Unambiguous OrderId of the referenced transaction.
+
Id of the referenced transaction.
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 +AlphaNumeric[1..64]
+ Example: 723n4MAjMdhjSAhAKEUdA8jtl9jb
- ExpYear
+ ExpMonth
mandatory, @@ -6705,16 +6691,16 @@ Range: inclusive between 1 and 1600
 		-
Year of expiration
+
Month of expiration (eg 9 for September)
-Range: inclusive between 2000 and 9999
- Example: 2015 +Range: inclusive between 1 and 12
+ Example: 9
- ExpMonth
+ ExpYear
mandatory, @@ -6723,10 +6709,10 @@ Range: inclusive between 2000 and 9999
 		-
Month of expiration (eg 9 for September)
+
Year of expiration
-Range: inclusive between 1 and 12
- Example: 9 +Range: inclusive between 2000 and 9999
+ Example: 2015
- Type
+ CategoryName
string 		-
Order item type
+
Category name
-Possible values: DIGITAL, PHYSICAL, SERVICE, GIFTCARD, DISCOUNT, SHIPPINGFEE, SALESTAX, SURCHARGE.
- +Utf8[1..100]
+ Example: knives +
- Id
+ Description
string 		-
Product id
+
Product description
-Utf8[1..100]
- Example: C123192 +Utf8[1..200]
+ Example: The well known swiss army knife
- VariantId
+ DiscountAmount
string 		-
Product variant id
+
Discount amount including tax
-Utf8[1..100]
- Example: C123192-red + Example: 10
- Name
+ Id
string 		-
Product name
+
Product id
-Utf8[1..200]
- Example: red swiss army knife +Utf8[1..100]
+ Example: C123192
- CategoryName
+ ImageUrl
string 		-
Category name
+
URL to an image showing the product
-Utf8[1..100]
- Example: knives +Max length: 2000
+ Example: https://merchanthost/product/1/image
- Description
+ IsPreOrder
- string + boolean 		-
Product description
+
Flag, which indicates that the order item is a pre order. Per default, it is not a pre order.
-Utf8[1..200]
- Example: The well known swiss army knife + Example: true
- Quantity
+ Name
- integer + string 		-
The quantity of the order item
+
Product name
- Example: 3 +Utf8[1..200]
+ Example: red swiss army knife
- UnitPrice
+ ProductUrl
string 		-
Price per single item in minor unit (CHF 2.00 ⇒ Value=200). Only Integer values will be accepted!
+
URL to the product page
- Example: 200 +Max length: 2000
+ Example: https://merchanthost/product/1
- IsPreOrder
+ Quantity
- boolean + integer 		-
Flag, which indicates that the order item is a pre order. Per default, it is not a pre order.
+
The quantity of the order item
- Example: true + Example: 3
- TaxRate
+ TaxAmount
string 		-
Tax rate of the item price in hundredth of a percent. e.g. value 125 means 1.25%
Valid values are 0-99999
+
Tax amount which is included in the item price
-Range: inclusive between 0 and 99999
- Example: 2100 + Example: 42
- TaxAmount
+ TaxRate
string 		-
Tax amount which is included in the item price
+
Tax rate of the item price in hundredth of a percent. e.g. value 125 means 1.25%
Valid values are 0-99999
- Example: 42 +Range: inclusive between 0 and 99999
+ Example: 2100
- DiscountAmount
+ Type
string 		-
Discount amount including tax
+
Order item type
- Example: 10 - +Possible values: DIGITAL, PHYSICAL, SERVICE, GIFTCARD, DISCOUNT, SHIPPINGFEE, SALESTAX, SURCHARGE.
+
- ProductUrl
+ UnitPrice
string 		-
URL to the product page
+
Price per single item in minor unit (CHF 2.00 ⇒ Value=200). Only Integer values will be accepted!
-Max length: 2000
- Example: https://merchanthost/product/1 + Example: 200
- ImageUrl
+ VariantId
string 		-
URL to an image showing the product
+
Product variant id
-Max length: 2000
- Example: https://merchanthost/product/1/image +Utf8[1..100]
+ Example: C123192-red
- OrderId
- - - mandatory, - - string - -		 -
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
- -Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 -
+ OrderId
+ + + mandatory, + + string + +		 +
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
+ +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901 +
- OrderId
+ Description
mandatory, @@ -7194,16 +7180,16 @@ Utf8[1..100]
 		-
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
+
A human readable description provided by the merchant that will be displayed in Payment Page.
-Id[1..80]
- Example: c52ad18472354511ab2c33b59e796901 +Utf8[1..100]
+ Example: Description of payment
- Description
+ OrderId
mandatory, @@ -7212,10 +7198,10 @@ Id[1..80]
 		-
A human readable description provided by the merchant that will be displayed in Payment Page.
+
Unambiguous order identifier defined by the merchant / shop. This identifier might be used as reference later on.
-Utf8[1..100]
- Example: Description of payment +Id[1..80]
+ Example: c52ad18472354511ab2c33b59e796901
- Id
+ DisplayName
mandatory, @@ -7258,15 +7244,15 @@ Possible values: RANDOM.
 		-
Id of the feature
+
Display name of the feature
- Example: SAFERPAY_EXAMPLE + Example: Saferpay Example
- DisplayName
+ Id
mandatory, @@ -7275,9 +7261,9 @@ Possible values: RANDOM.
 		-
Display name of the feature
+
Id of the feature
- Example: Saferpay Example + Example: SAFERPAY_EXAMPLE
- Id
+ DisplayName
mandatory, @@ -7297,15 +7283,15 @@ Possible values: RANDOM.
 		-
Id of the package
+
Display name of the package
- Example: SAFERPAY_EXAMPLE + Example: Saferpay Example
- DisplayName
+ Id
mandatory, @@ -7314,9 +7300,9 @@ Possible values: RANDOM.
 		-
Display name of the package
+
Id of the package
- Example: Saferpay Example + Example: SAFERPAY_EXAMPLE
- PaymentMethod
+ Currencies
- string + array of strings 		-
Name of the payment method
+
Array of strings representing all the supported currencies for the payment method
- Currencies
+ LogoUrl
- array of strings + string 		-
Array of strings representing all the supported currencies for the payment method
+
The logo of the payment method as url
- LogoUrl
+ PaymentMethod
string 		-
The logo of the payment method as url
+
Name of the payment method
- TerminalId
+ Description
string 		-
The Id of the terminal
+
Description of the terminal
- Type
+ PaymentMethods
- string + + array of objects 		-
The type of the terminal
+
Array of payment methods that are available for the terminal
-Possible values: ECOM, SPG, MPO.
- Description
+ TerminalId
string 		-
Description of the terminal
+
The Id of the terminal
- PaymentMethods
+ Type
- - array of objects + string 		-
Array of payment methods that are available for the terminal
+
The type of the terminal
+Possible values: ECOM, SPG, MPO.
- WalletName
+ LogoUrl
string 		-
Name of the wallet
+
The logo of the wallet as url
- LogoUrl
+ WalletName
string 		-
The logo of the wallet as url
+
Name of the wallet
- ResponseHeader
+ Behavior
mandatory, - - object + string 		-
Contains general information about the response.
+
What can be done to resolve the error?
+Possible values: DO_NOT_RETRY, OTHER_MEANS, RETRY, RETRY_LATER.
- Risk
+ ErrorDetail
- - object + array of strings 		-
Contains additional risk related information for the transaction that is blocked by risk.
+
More details, if available. Contents may change at any time, so don’t parse it.
- Behavior
+ ErrorMessage
mandatory, @@ -50,9 +49,8 @@ 		-
What can be done to resolve the error?
+
Description of the error. The contents of this element might change without notice, so do not parse it.
-Possible values: DO_NOT_RETRY, OTHER_MEANS, RETRY, RETRY_LATER.
- ErrorMessage
+ OrderId
- - mandatory, - string 		-
Description of the error. The contents of this element might change without notice, so do not parse it.
+
OrderId of the failed transaction. This is only returned in the PaymentPage Assert Response and the Transaction Authorize Response.
- TransactionId
+ PayerMessage
string 		-
Id of the failed transaction, if available
+
A text message provided by the card issuer detailing the reason for a declined authorization. It is safe to display it to the payer.
- ErrorDetail
+ ProcessorMessage
- array of strings + string 		-
More details, if available. Contents may change at any time, so don’t parse it.
+
Message returned by acquirer or processor
- ProcessorMessage
+ ResponseHeader
- string + + mandatory, + + + object 		-
Message returned by acquirer or processor
+
Contains general information about the response.
- PayerMessage
+ Risk
- string + + object 		-
A text message provided by the card issuer detailing the reason for a declined authorization. It is safe to display it to the payer.
+
Contains additional risk related information for the transaction that is blocked by risk.
- OrderId
+ TransactionId
string 		-
OrderId of the failed transaction. This is only returned in the PaymentPage Assert Response and the Transaction Authorize Response.
+
Id of the failed transaction, if available