This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
en:girocheckout:paypage:start [2023/03/24 20:49] michaelheumann |
en:girocheckout:paypage:start [2023/06/20 15:55] (current) michaelheumann |
||
---|---|---|---|
Line 46: | Line 46: | ||
<WRAP center round info> | <WRAP center round info> | ||
==== Indication regarding the purpose field ==== | ==== Indication regarding the purpose field ==== | ||
- | Depending on the payment method that is selected by the buyer, not all characters in the purpose fields may be passed on, because the maximum lengths differ | + | Depending on the payment method that is selected by the buyer, not all characters in the purpose fields may be passed on, because the maximum lengths differ |
The final purpose text may be adapted by the payment page to fit the requirements, | The final purpose text may be adapted by the payment page to fit the requirements, | ||
Line 141: | Line 141: | ||
|merchantId | |merchantId | ||
|projectId | |projectId | ||
- | |hash | + | |hash |
== Example == | == Example == | ||
Line 152: | Line 152: | ||
^Name | ^Name | ||
|rc | |rc | ||
- | |msg |Yes | + | |msg |Yes |
|projects | |projects | ||
^HEADER Parameters^^^^ | ^HEADER Parameters^^^^ | ||
- | |hash | + | |hash |
== Example == | == Example == | ||
Line 172: | Line 172: | ||
|amount | |amount | ||
|currency | |currency | ||
- | |purpose | + | |purpose |
|description | |description | ||
|pagetype | |pagetype | ||
Line 184: | Line 184: | ||
|organization | |organization | ||
|freeamount | |freeamount | ||
- | |fixedvalues | + | |fixedvalues |
|minamount | |minamount | ||
|maxamount | |maxamount | ||
|orderid | |orderid | ||
- | |projectlist | + | |projectlist |
- | |pkn |Optional |String | + | |pkn |Optional |String(50) |This field allows the initialization of a new transaction without having to input the credit card or direct debit data again (recurring payments). \\ create = generate new pseudo card number for the payment data (credit card or bank data) used in this transaction. | |
|test | |test | ||
|certdata | |certdata | ||
- | |otherpayments | + | |otherpayments |
- | |paydirektShoppingCartType |Optional | String | + | |paydirektShoppingCartType |Optional | String(19) |Type of the shopping cart for giropay and paydirekt payments (only new giropay-payments). The following values are allowed: \\ PHYSICAL = All goods in the cart are of a physical nature, \\ DIGITAL = All goods in the cart are of a digital nature (require no shipping), \\ MIXED = The cart contains both physical and digital goods (this is the default value should the parameter not be given), \\ ANONYMOUS_DONATION = This is an anonymous donation and not a commercial transaction (no address data necessary), \\ AUTHORITIES_PAYMENT = This is a payment for local authorities (no address data necessary). \\ If this parameter is not specified during initialization, |
- | |paydirektShippingFirstName |Optional | + | |paydirektShippingFirstName |Optional |
- | |paydirektShippingLastName | + | |paydirektShippingLastName |
- | |paydirektShippingCompany | + | |paydirektShippingCompany |
- | |paydirektShippingAdditionalAddressInformation |Optional | + | |paydirektShippingAdditionalAddressInformation |Optional |
- | |paydirektShippingStreet | + | |paydirektShippingStreet |
- | |paydirektShippingStreetNumber |Optional | + | |paydirektShippingStreetNumber |Optional |
- | |paydirektShippingZipCode | + | |paydirektShippingZipCode |
- | |paydirektShippingCity | + | |paydirektShippingCity |
- | |paydirektShippingCountry | + | |paydirektShippingCountry |
- | |paydirektShippingEmail | + | |paydirektShippingEmail |
|paydirektMerchantOrderReferenceNumber | |paydirektMerchantOrderReferenceNumber | ||
|paydirektCart | |paydirektCart | ||
- | |paydirektDeliveryType |Optional | String | + | |paydirektDeliveryType |Optional | String(12) | Only for giropay payments. The destination of a shipment. The default value is STANDARD. Possible values: \\ STANDARD: The goods are delivered to an ordinary postal address. \\ PACKSTATION: |
- | |successUrl | + | |successUrl |
- | |backUrl | + | |backUrl |
- | |failUrl | + | |failUrl |
- | |notifyUrl | + | |notifyUrl |
- | |tds2Address |optional |String | For 3D Secure 2.0: Main address line (usually street and number) of the card holder' | + | |tds2Address |optional |String(50) | For 3D Secure 2.0: Main address line (usually street and number) of the card holder' |
- | |tds2Postcode |optional |String | For 3D Secure 2.0: Postal code of the card holder' | + | |tds2Postcode |optional |String(10) | For 3D Secure 2.0: Postal code of the card holder' |
- | |tds2City |optional |String | For 3D Secure 2.0: City of the card holder' | + | |tds2City |optional |String(50) | For 3D Secure 2.0: City of the card holder' |
- | |tds2Country |optional |String | For 3D Secure 2.0: Country of the card holder' | + | |tds2Country |optional |String(2) | For 3D Secure 2.0: Country of the card holder' |
- | |tds2Optional |optional |String | For 3D Secure 2.0: JSON-String that contains further optional fields. A complete list of the available fields can be found underneath this table under [[en: | + | |tds2Optional |optional |JSON String | For 3D Secure 2.0: JSON-String that contains further optional fields. A complete list of the available fields can be found underneath this table under [[en: |
|mandateReference | optional |String(35) | |mandateReference | optional |String(35) | ||
numbers: 0 – 9 | numbers: 0 – 9 | ||
Line 231: | Line 231: | ||
|kassenzeichen | |kassenzeichen | ||
|qrcodeReturn | |qrcodeReturn | ||
- | |hash | + | |hash |
=== SEPA compliant characters === | === SEPA compliant characters === | ||
Line 260: | Line 260: | ||
^Name | ^Name | ||
- | |email |String | The card holder' | + | |email |String(255) | The card holder' |
|addressesMatch |Boolean | |addressesMatch |Boolean | ||
^**// | ^**// | ||
- | |billingAddress.line2 |String | Second line of the billing address. Format A-Z, a-z, 0-9, Blank, [-/ | + | |billingAddress.line2 |String(50) | Second line of the billing address. Format A-Z, a-z, 0-9, Blank, [-/ |
- | |billingAddress.line3 |String | Third line of the billing address. Format A-Z, a-z, 0-9, Blank, [-/ | + | |billingAddress.line3 |String(50) | Third line of the billing address. Format A-Z, a-z, 0-9, Blank, [-/ |
- | |billingAddress.state |String | Subdivision (state, province or the like) of a country according to ISO 3166-2. Format A-Z, max. 3. | | + | |billingAddress.state |String(3) | Subdivision (state, province or the like) of a country according to ISO 3166-2. Format A-Z, max. 3. | |
^**// | ^**// | ||
- | |shippingAddress.line1 |String | First line of the shipping address. Format A-Z, a-z, 0-9, Blank, [-/ | + | |shippingAddress.line1 |String(50) | First line of the shipping address. Format A-Z, a-z, 0-9, Blank, [-/ |
- | |shippingAddress.line2 |String | Second line of the shipping address. Format A-Z, a-z, 0-9, Blank, [-/ | + | |shippingAddress.line2 |String(50) | Second line of the shipping address. Format A-Z, a-z, 0-9, Blank, [-/ |
- | |shippingAddress.line3 |String | Third line of the shipping address. Format A-Z, a-z, 0-9, Blank, [-/ | + | |shippingAddress.line3 |String(50) | Third line of the shipping address. Format A-Z, a-z, 0-9, Blank, [-/ |
- | |shippingAddress.postcode |String |Postal code of the shipping address, Format A-Z, a-z, 0-9, Blank, [-], max. 11 | | + | |shippingAddress.postcode |String(10) |Postal code of the shipping address, Format A-Z, a-z, 0-9, Blank, [-], max. 11 | |
- | |shippingAddress.city |String | City of the shipping address, Format A-Z, a-z, 0-9, Blank, [-/ | + | |shippingAddress.city |String(50) | City of the shipping address, Format A-Z, a-z, 0-9, Blank, [-/ |
- | |shippingAddress.state |String | Subdivision (state, province or the like) of a country according to ISO 3166-2. Format A-Z, max. 3 | | + | |shippingAddress.state |String(50) | Subdivision (state, province or the like) of a country according to ISO 3166-2. Format A-Z, max. 3 | |
- | |shippingAddress.country |String | Country of the shipping address, Format A-Z, max. 2. Two-letter country code according to the currently applicable standard ISO 3166. | | + | |shippingAddress.country |String(2) | Country of the shipping address, Format A-Z, max. 2. Two-letter country code according to the currently applicable standard ISO 3166. | |
^**// | ^**// | ||
|homePhoneNumber.country |Integer | Country code of the telephone number without leading zeroes. Format 0-9, max. 3. e.g. 49 for Germany. | | |homePhoneNumber.country |Integer | Country code of the telephone number without leading zeroes. Format 0-9, max. 3. e.g. 49 for Germany. | | ||
- | |homePhoneNumber.regional |String | Telephone number without country code and without leading 0 (area code and local number). Format 0-9, max. 15, e.g. 73482984938. | | + | |homePhoneNumber.regional |String(15) | Telephone number without country code and without leading 0 (area code and local number). Format 0-9, max. 15, e.g. 73482984938. | |
^**// | ^**// | ||
|mobilePhoneNumber.country |Integer | Country code of the mobile phone number without leading zeroes. Format 0-9, max. 3. e.g. 49 for Germany. | | |mobilePhoneNumber.country |Integer | Country code of the mobile phone number without leading zeroes. Format 0-9, max. 3. e.g. 49 for Germany. | | ||
- | |mobilePhoneNumber.regional |String | Telephone number without country code and without leading 0 (area code and local number). Format 0-9, max. 15, e.g. 73482984938. | | + | |mobilePhoneNumber.regional |String(15) | Telephone number without country code and without leading 0 (area code and local number). Format 0-9, max. 15, e.g. 73482984938. | |
^**// | ^**// | ||
|workPhoneNumber.country |Integer | Country code of the work phone number without leading zeroes. Format 0-9, max. 3. e.g. 49 for Germany. | | |workPhoneNumber.country |Integer | Country code of the work phone number without leading zeroes. Format 0-9, max. 3. e.g. 49 for Germany. | | ||
- | |workPhoneNumber.regional |String | Telephone number without country code and without leading 0 (area code and local number). Format 0-9, max. 15, e.g. 73482984938. | | + | |workPhoneNumber.regional |String(15) | Telephone number without country code and without leading 0 (area code and local number). Format 0-9, max. 15, e.g. 73482984938. | |
^**// | ^**// | ||
- | |cardholderAccountInfo.accountAgeIndicator |String | Indicates when the customer' | + | |cardholderAccountInfo.accountAgeIndicator |String(12) | Indicates when the customer' |
- | |cardholderAccountInfo.passwordChangeIndicator |String | Indicates when the password of the customer account was changed the last time. Possible values: " | + | |cardholderAccountInfo.passwordChangeIndicator |String(12) | Indicates when the password of the customer account was changed the last time. Possible values: " |
- | |cardholderAccountInfo.paymentAccountAgeIndicator |String | Indicates when the customer' | + | |cardholderAccountInfo.paymentAccountAgeIndicator |String(12) | Indicates when the customer' |
- | |cardholderAccountInfo.accountChange |String | Indicates when the customer account in the shop was last modified, e.g. address change or new payment data. Possible values: " | + | |cardholderAccountInfo.accountChange |String(12) | Indicates when the customer account in the shop was last modified, e.g. address change or new payment data. Possible values: " |
- | |cardholderAccountInfo.shippingAddressAgeIndicator |String | Indicates when the customer first used the current shipping address. Possible values: " | + | |cardholderAccountInfo.shippingAddressAgeIndicator |String(12) | Indicates when the customer first used the current shipping address. Possible values: " |
- | |cardholderAccountInfo.shippingNameIndicator |String | Specifies if the card holder' | + | |cardholderAccountInfo.shippingNameIndicator |String(9) | Specifies if the card holder' |
|cardholderAccountInfo.suspiciousAccountActivity |Boolean | Indicates if the shop experienced suspicious activities of the card holder (true) or not (false). | | |cardholderAccountInfo.suspiciousAccountActivity |Boolean | Indicates if the shop experienced suspicious activities of the card holder (true) or not (false). | | ||
|cardholderAccountInfo.provisioningDayCount |Integer | Number of "add card" attempts within the last 24 hours. Format 0-9, max. 3. | | |cardholderAccountInfo.provisioningDayCount |Integer | Number of "add card" attempts within the last 24 hours. Format 0-9, max. 3. | | ||
^**// | ^**// | ||
- | |tdsMerchantRiskIndicators.deliveryTimeframe |String | Indicates when the customer will receive the merchandise. Possible values: " | + | |tdsMerchantRiskIndicators.deliveryTimeframe |String(14) | Indicates when the customer will receive the merchandise. Possible values: " |
- | |tdsMerchantRiskIndicators.deliveryEmailAddress |String | Delivery email address of the customer in case of an electronic delivery. Format A-Z, a-z, 0-9, [_.+-@], max. 254. | | + | |tdsMerchantRiskIndicators.deliveryEmailAddress |String(254) | Delivery email address of the customer in case of an electronic delivery. Format A-Z, a-z, 0-9, [_.+-@], max. 254. | |
|tdsMerchantRiskIndicators.giftCardAmount |Integer | Amount of a gift card in major currency unit, e.g. 123,45 EUR is 123. Format 0-9, max. 10. | | |tdsMerchantRiskIndicators.giftCardAmount |Integer | Amount of a gift card in major currency unit, e.g. 123,45 EUR is 123. Format 0-9, max. 10. | | ||
|tdsMerchantRiskIndicators.giftCardCount |Integer | Total count of gift cards purchased. Format 0-9, max. 2. | | |tdsMerchantRiskIndicators.giftCardCount |Integer | Total count of gift cards purchased. Format 0-9, max. 2. | | ||
|tdsMerchantRiskIndicators.giftCardCurrency |Integer | Currency code of a gift card according to ISO 4217. Format A-Z, max. 3. | | |tdsMerchantRiskIndicators.giftCardCurrency |Integer | Currency code of a gift card according to ISO 4217. Format A-Z, max. 3. | | ||
|tdsMerchantRiskIndicators.preOrderDate |Date | In the case of a pre-ordered purchase: date when the merchandise is expected to be available. | | |tdsMerchantRiskIndicators.preOrderDate |Date | In the case of a pre-ordered purchase: date when the merchandise is expected to be available. | | ||
- | |tdsMerchantRiskIndicators.preOrderPurchaseIndicator |String | Possible values: " | + | |tdsMerchantRiskIndicators.preOrderPurchaseIndicator |String(9) | Possible values: " |
- | |tdsMerchantRiskIndicators.reorderItemsIndicator |String | Indicates if the customer is reordering previously purchased merchandise: | + | |tdsMerchantRiskIndicators.reorderItemsIndicator |String(9) | Indicates if the customer is reordering previously purchased merchandise: |
- | |tdsMerchantRiskIndicators.shippingIndicator |String | Specifies where the merchandise is delivered to. Possible values: " | + | |tdsMerchantRiskIndicators.shippingIndicator |String(16) | Specifies where the merchandise is delivered to. Possible values: " |
^**// | ^**// | ||
- | |tdsRequestorAuthenticationInformation.authenticationData |String | Authentication data of the customer. Format A-Z, a-z, 0-9 [!"# | + | |tdsRequestorAuthenticationInformation.authenticationData |String(2048) |
|tdsRequestorAuthenticationInformation.authenticationTimestamp |DateTime | Date and time when the customer authenticated in the shop. Format JJJJ-MM-TTTHH: | |tdsRequestorAuthenticationInformation.authenticationTimestamp |DateTime | Date and time when the customer authenticated in the shop. Format JJJJ-MM-TTTHH: | ||
- | |tdsRequestorAuthenticationInformation.authenticationMethod |String | Specifies how the customer authenticated to the shop. Possile values: " | + | |tdsRequestorAuthenticationInformation.authenticationMethod |String(17) | Specifies how the customer authenticated to the shop. Possile values: " |
^**// | ^**// | ||
|tdsTransactionAttributes.purchaseInstalmentData |Integer | Maximum number of authorisations permitted for instalment payments. Format 0-9, max. 3, Wert muss > 1 sein. | | |tdsTransactionAttributes.purchaseInstalmentData |Integer | Maximum number of authorisations permitted for instalment payments. Format 0-9, max. 3, Wert muss > 1 sein. | | ||
|tdsTransactionAttributes.recurringExpiry |Date | Date after which no further authorisations shall be carried out. Format YYYY-MM-DD. | | |tdsTransactionAttributes.recurringExpiry |Date | Date after which no further authorisations shall be carried out. Format YYYY-MM-DD. | | ||
|tdsTransactionAttributes.recurringFrequency |Integer | Minimum number of days between authorisations. Format 0-9, max. 4. | | |tdsTransactionAttributes.recurringFrequency |Integer | Minimum number of days between authorisations. Format 0-9, max. 4. | | ||
- | |tdsTransactionAttributes.type |String | Type of 3-D Secure 2.0 payment. Possible values: " | + | |tdsTransactionAttributes.type |String(17) | Type of 3-D Secure 2.0 payment. Possible values: " |
== Example of a tds2Optional string (formatted for demonstration purposes, should normally be specified in one line) == | == Example of a tds2Optional string (formatted for demonstration purposes, should normally be specified in one line) == | ||
Line 386: | Line 386: | ||
^Name | ^Name | ||
|rc | |rc | ||
- | |msg |Yes | + | |msg |Yes |
- | |reference | + | |reference |
- | |url |Optional | + | |url |Optional |
|qrcode | |qrcode | ||
^HEADER Parameters^^^^ | ^HEADER Parameters^^^^ | ||
- | |hash | + | |hash |
== Example in case of success == | == Example in case of success == | ||
Line 403: | Line 403: | ||
^Name | ^Name | ||
- | |name | + | |name |
- | |ean |Optional | + | |ean |Optional |
- | |quantity | + | |quantity |
|grossAmount | |grossAmount | ||
Line 438: | Line 438: | ||
^Name | ^Name | ||
|gcPaymethod | |gcPaymethod | ||
- | |gcType | + | |gcType |
- | |gcProjectId | + | |gcProjectId |
- | |gcReference | + | |gcReference |
- | |gcMerchantTxId | + | |gcMerchantTxId |
- | |gcBackendTxId | + | |gcBackendTxId |
|gcAmount | |gcAmount | ||
- | |gcCurrency | + | |gcCurrency |
|gcResultPayment | |gcResultPayment | ||
- | |gcPkn | + | |gcPkn |
- | |gcCardnumber | + | |gcCardnumber |
- | |gcCardExpDate | + | |gcCardExpDate |
- | |gcAccountHolder | + | |gcAccountHolder |
- | |gcIban | + | |gcIban |
- | |gcHash | + | |gcHash |
=== Redirect === | === Redirect === | ||
Line 517: | Line 517: | ||
|amount | |amount | ||
|currency | |currency | ||
- | |reference | + | |reference |
|purpose | |purpose | ||
- | |hash | + | |hash |
== Example == | == Example == | ||
Line 530: | Line 530: | ||
^Name | ^Name | ||
|rc | |rc | ||
- | |msg |yes | + | |msg |yes |
- | |reference | + | |reference |
- | |merchantTxId | + | |merchantTxId |
- | |backendTxId | + | |backendTxId |
|amount | |amount | ||
- | |currency | + | |currency |
|resultPayment | |resultPayment | ||
^HEADER parameter^^^^ | ^HEADER parameter^^^^ | ||
- | |hash | + | |hash |
== Example in case of success == | == Example in case of success == |