### Site Tools

en:girocheckout:paypage:start

# Differences

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

en:girocheckout:paypage:start [2020/05/07 19:07]
michaelheumann
en:girocheckout:paypage:start [2020/11/18 09:24] (current)
thorstenmarx [Supported payment methods]
Line 21: Line 21:
| Direct debit | 6 | | Direct debit | 6 |
| Direct debit with lock file | 7 | | Direct debit with lock file | 7 |
-| Guaranteed direct debit | 8 |
| Bluecode | 26 | | Bluecode | 26 |
| Maestro | 33 | | Maestro | 33 |
Line 121: Line 120:
|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. 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)). |+|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). |
|description ​   |Optional |String(120) ​  ​|Description for the payment. Is only displayed on the payment page. Allowed characters see [[en:​girocheckout:​paypage:​start#​allowed_description_characters|Allowed description characters]]| |description ​   |Optional |String(120) ​  ​|Description for the payment. Is only displayed on the payment page. Allowed characters see [[en:​girocheckout:​paypage:​start#​allowed_description_characters|Allowed description characters]]|
|pagetype ​      ​|Optional |Integer |Type of the payment page to be generated: 0=normal API-Paypage (compatible to previous paymnent pages, default), 1=Payment page, 2=Donation page | |pagetype ​      ​|Optional |Integer |Type of the payment page to be generated: 0=normal API-Paypage (compatible to previous paymnent pages, default), 1=Payment page, 2=Donation page |
-|expirydate ​    ​|Optional |String(10) | Expiration date: Empty=payment page is always valid, YYYY-MM-DD=Date in format Year-Month-Day,​ payment page will be valid up to this date. \\ The option '​once'​ is **deprecated** and shouldn'​t be used anymore because it will not be available in a future API version. ​ Please use single=2 instead.| +|expirydate ​    ​|Optional |String(10) | Expiration date: Empty=payment page is always valid, YYYY-MM-DD=Date in format Year-Month-Day,​ payment page will be valid up to this date. \\ Only works for pagetype 1 or 2. \\ The option '​once'​ is **deprecated** and shouldn'​t be used anymore because it will not be available in a future API version. ​ Please use single=2 instead.|
-|single ​        ​|Optional |Integer ​  | Controls, whether and how the link may be reused. \\ 0 = Link may be used as often as needed (default) \\ 1 = Allows only one payment attempt for this payment link, no matter if successful or not \\ 2 = Payment page may only be used for one successful payment, afterwards it will be invalidated | +|single ​        ​|Optional |Integer ​  | Controls, whether and how the link may be reused. \\ 0 = Link may be used as often as needed (default) \\ 1 = Allows only one payment attempt for this payment link, no matter if successful or not \\ 2 = Payment page may only be used for one successful payment, afterwards it will be invalidated ​
+|timeout ​       |Optional | Integer | (Available from API v. 2.1.33) Allows to specify a timeout for the selection of a payment method on the payment page. The timeout is specified in seconds and becomes active, as soon as the page is loaded. It is displayed to the user as a countdown and forwards to an error page when it expires. ​ Reloading the page does NOT reset the timer, this can only be archieved by deleting the cookies. If the payment page was initialized with the parameter single=1, the link will be invalidated upon timeout expiration. ​ For certain payment methods (direct debit, Paypal, credit card), the timer is hidden as soon as the tile for that method is selected. In the background, it continues running, though, and becomes visible again if the user selects another payment method. For the mentioned 3 payment methods, there are separate timeout values that may be configured for each method through GiroCockpit (administrative users of GS only). ​|
|type           ​|Optional |String(4) |Transaction type (see [[en:​girocheckout:​transactiontypes:​start]]) \\ SALE = Immediate payment (default) \\ AUTH = Amount reservation (not available for all payment methods)| |type           ​|Optional |String(4) |Transaction type (see [[en:​girocheckout:​transactiontypes:​start]]) \\ SALE = Immediate payment (default) \\ AUTH = Amount reservation (not available for all payment methods)|
|locale ​        ​|Optional |String(4) ​  ​|Language of the payment page \\ de = German (default) \\ en = English | |locale ​        ​|Optional |String(4) ​  ​|Language of the payment page \\ de = German (default) \\ en = English |
Line 135: 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. |