User Tools

Site Tools


en:girocheckout:paypage:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

en:girocheckout:paypage:start [2019/11/27 16:39]
michaelheumann
en:girocheckout:paypage:start [2020/07/10 18:22] (current)
michaelheumann
Line 7: Line 7:
 **Example** **Example**
  
-{{:​en:​girocheckout:​paypage:​paypageen.png?600|Example Payment Page}}+{{:​en:​girocheckout:​paypage:​mustermann.png?800|Example Payment Page}}
  
 ===== Supported payment methods ===== ===== Supported payment methods =====
Line 22: Line 22:
 | Direct debit with lock file | 7 | | Direct debit with lock file | 7 |
 | Guaranteed direct debit | 8 | | Guaranteed direct debit | 8 |
 +| Bluecode | 26 |
 | Maestro | 33 | | Maestro | 33 |
 | PayPal | 14 | | PayPal | 14 |
Line 120: Line 121:
 |projectId ​     |Yes  |Integer ​    ​|Project ID of a Paypage project | |projectId ​     |Yes  |Integer ​    ​|Project ID of a Paypage project |
 |merchantTxId ​  ​|Yes ​ |String(255) |Merchant'​s unique transaction ID | |merchantTxId ​  ​|Yes ​ |String(255) |Merchant'​s unique transaction ID |
-|amount ​        ​|Yes ​ |Integer ​    |For currencies with decimals, specify the amount in the smallest currency unit, such as Cent, Penny |+|amount ​        ​|Yes ​ |Integer ​    |For currencies with decimals, specify the amount in the smallest currency unit, such as Cent, Penny, without decimals. This parameter is MANDATORY, except for donation pages with free amount entry or with at least one fixed amount (meaning it is optional if pagetype == 2 and (freeamount=1 or fixedvalues not empty)). ​|
 |currency ​      ​|Yes ​ |String(3) ​  ​|Currency of the transaction,​ according to [[http://​de.wikipedia.org/​wiki/​ISO_4217#​Aktuell_g.C3.BCltige_W.C3.A4hrungen|ISO 4217]].\\ EUR = Euro | |currency ​      ​|Yes ​ |String(3) ​  ​|Currency of the transaction,​ according to [[http://​de.wikipedia.org/​wiki/​ISO_4217#​Aktuell_g.C3.BCltige_W.C3.A4hrungen|ISO 4217]].\\ EUR = Euro |
 |purpose ​       |Yes  |String(27) ​ |Purpose of the transaction. This information is displayed on the card settlement or bank statement. Only SEPA compliant characters are allowed (see [[en:​girocheckout:​paypage:​start#​sepa_compliant_characters|SEPA compliant characters]]). If pagetype=2 and projectlist is not empty, the placeholder {SPENDENPROJEKT} may be used, which is then filled with the name of the user-selected project. \\ The content of this field (first 20 characters) is also used to fill the orderid in case of the payment method Paydirekt, if it is not explicitly specified (see parameter orderid). | |purpose ​       |Yes  |String(27) ​ |Purpose of the transaction. This information is displayed on the card settlement or bank statement. Only SEPA compliant characters are allowed (see [[en:​girocheckout:​paypage:​start#​sepa_compliant_characters|SEPA compliant characters]]). If pagetype=2 and projectlist is not empty, the placeholder {SPENDENPROJEKT} may be used, which is then filled with the name of the user-selected project. \\ The content of this field (first 20 characters) is also used to fill the orderid in case of the payment method Paydirekt, if it is not explicitly specified (see parameter orderid). |
Line 134: Line 135:
 |freeamount ​    ​|Optional |Integer ​  ​|Defines whether the payment page user may freely enter an amount (=1) or not (=0, default). | |freeamount ​    ​|Optional |Integer ​  ​|Defines whether the payment page user may freely enter an amount (=1) or not (=0, default). |
 |fixedvalues ​   |Optional |String ​   |JSON-encoded string that contains an array of all the amounts among which the user may select the one to be paid/​donated,​ e.g. '​["​10000","​20000","​50050"​]',​ all amounts are to be specified in cents. ​ If this field is empty, the content of the amount field is used as a only possible value. If this field contains values, the amount field is ignored! | |fixedvalues ​   |Optional |String ​   |JSON-encoded string that contains an array of all the amounts among which the user may select the one to be paid/​donated,​ e.g. '​["​10000","​20000","​50050"​]',​ all amounts are to be specified in cents. ​ If this field is empty, the content of the amount field is used as a only possible value. If this field contains values, the amount field is ignored! |
-|minamount ​     |Optional |Integer ​  ​|Minimum accepted value if free amount entry is allowed, i.e. freeamount=1. If this value is omitted, the default is 100 (meaning 1,00). Amount specified in cents. | +|minamount ​     |Optional |Integer ​  ​|Minimum accepted value if free amount entry is allowed, i.e. freeamount=1. Specify the amount in the smallest currency unit, such as Cent, Penny, thus, without decimals. If this value is omitted, the default is 100 (meaning 1,00). | 
-|maxamount ​     |Optional |Integer ​  ​|Maximum accepted value if free amount entry is allowed, i.e. freeamount=1. |+|maxamount ​     |Optional |Integer ​  ​|Maximum accepted value if free amount entry is allowed, i.e. freeamount=1. Specify the amount in the smallest currency unit, such as Cent, Penny, thus, without decimals. |
 |orderid ​       |Optional |String(20) |Only used when payment method is Paydirekt. If empty, the orderid is generated from the purpose field. Only sepa-compliant characters are allowed (see [[girocheckout:​paypage:​start#​sepa_compliant_characters|SEPA-compliant characters]]) | |orderid ​       |Optional |String(20) |Only used when payment method is Paydirekt. If empty, the orderid is generated from the purpose field. Only sepa-compliant characters are allowed (see [[girocheckout:​paypage:​start#​sepa_compliant_characters|SEPA-compliant characters]]) |
 |projectlist ​   |Optional |String ​   |JSON-encoded string, that contains an array of projects (strings=project names), for which the donation page accepts donations. Only makes sense if pagetype=2. | |projectlist ​   |Optional |String ​   |JSON-encoded string, that contains an array of projects (strings=project names), for which the donation page accepts donations. Only makes sense if pagetype=2. |
Line 141: Line 142:
 |test           ​|Yes ​ |Integer ​    |1 = Display payment methods that are in test mode \\ 0 = Display payment methods that are in Live mode | |test           ​|Yes ​ |Integer ​    |1 = Display payment methods that are in test mode \\ 0 = Display payment methods that are in Live mode |
 |certdata ​      ​|Optional ​ | Integer | 1 = Offer form for entering donation certificate data \\ 0 = Do not offer the form (default) | |certdata ​      ​|Optional ​ | Integer | 1 = Offer form for entering donation certificate data \\ 0 = Do not offer the form (default) |
 +|otherpayments ​ |Optional ​ | String ​ | JSON-formatted array of objects, that allows for the integration of external payment methods into the payment page. Clicking on this payment method within the payment page, will redirect to the specified link directly, instead of being processed via the GiroCheckout gateway as in the case of the rest of the methods. Currently, only payment methods listed in the list of already supported payment methods are allowed here (see [[en:​girocheckout:​paypage:​start#​supported_payment_methods|Payment methods]]). \\ **Fields of the objects:** \\ **id**: Number of the payment method according to the list mentioned above. \\ **url**: Link to which the browser will be redirected on click. This link must contain everything that is required on behalf of the external payment provider (such as PayPal), so that the payment can be processed. The payment page does not carry out any string replacements or so. \\ **position**:​ Position that the new payment method will have within the full list of available payment methods on the page (>=1) \\ **Example (PayPal and credit card):** \\ <​nowiki>​[{"​id":​14,​ "​url":​ "​https://​www.paypal.de/​process/​123456&​param1=48399",​ "​position":​1},​ {"​id":​11,​ "​url":"​https://​www.visa.com/​whatever",​ "​position":​2}]</​nowiki>​ |
 |paydirektShippingFirstName |Optional ​ | String(100) ​ | First name for shipping address (only paydirekt PHYSICAL orders) |  |paydirektShippingFirstName |Optional ​ | String(100) ​ | First name for shipping address (only paydirekt PHYSICAL orders) | 
 |paydirektShippingLastName ​ |Optional ​ | String(100) ​ | Last name for shipping address (only paydirekt PHYSICAL orders) | |paydirektShippingLastName ​ |Optional ​ | String(100) ​ | Last name for shipping address (only paydirekt PHYSICAL orders) |
Line 220: Line 222:
 The second communication path is the redirection of the buyer within his/her browser to one of the three redirection URLs specified during initialization:​ The second communication path is the redirection of the buyer within his/her browser to one of the three redirection URLs specified during initialization:​
  
-  * successUrl: ​For successful payments. +  * successUrl: ​Is redirected to after successful payments. 
-  * failUrl: ​For failed payments+  * failUrl: ​Is redirected to when the payment was not successful or the customer clicked the cancel button on the page of the payment provider (bank, credit card processor etc.)
-  * backUrl: ​When the buyer has chosen not to go through with the payment and has clicked the cancel ​button on the payment ​information ​page instead.+  * backUrl: ​Is redirected to when the buyer has chosen not to go through with the payment and has clicked the back button on the payment page (please don't confuse this button with the cancel button of the payment method in the form displayed AFTER payment method selection, because that cancellation would then be a transaction abort that will be redirected to the failUrl).
  
-All 3 URLs are called ​using the POST method and contain ​the same parameters ​described above for the notification ​call. +The success and fail URL are called ​via the POST method and obtain ​the same parameters ​specified ​for the notification ​above. ​ In case of the backUrl no payment method has been chosen yet and no transaction has been initialized,​ so in case of this URL it is only a regular browser redirect without further parameters.
- +
en/girocheckout/paypage/start.1574869169.txt.gz · Last modified: 2019/11/27 16:39 by michaelheumann