This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
en:girocheckout:paypal:start [2023/02/10 22:32] michaelheumann |
en:girocheckout:paypal:start [2023/05/08 04:17] michaelheumann |
||
---|---|---|---|
Line 4: | Line 4: | ||
===== Test data ===== | ===== Test data ===== | ||
{{page> | {{page> | ||
- | ===== workflow | + | |
+ | ===== Workflow | ||
<uml> | <uml> | ||
Line 57: | Line 58: | ||
===== API functions ===== | ===== API functions ===== | ||
- | ==== overview | + | ==== Overview |
As shown in the workflow there are different API calls during a PayPal transaction. | As shown in the workflow there are different API calls during a PayPal transaction. | ||
- | - initialize | + | - Initialize |
- | - payment | + | - Payment |
- | - buyer redirection to the merchant (triggered by buyer) | + | - Buyer redirection to the merchant (triggered by buyer) |
==== Initialize PayPal payment ==== | ==== Initialize PayPal payment ==== | ||
- | Torwards | + | Towards |
- | === request | + | === Request |
**URL:** https:// | **URL:** https:// | ||
**provided by:** GiroCheckout \\ | **provided by:** GiroCheckout \\ | ||
Line 76: | Line 77: | ||
== POST parameters == | == POST parameters == | ||
- | ^name ^mandatory | + | ^Name ^Mandatory |
|merchantId | |merchantId | ||
|projectId | |projectId | ||
Line 84: | Line 85: | ||
|purpose | |purpose | ||
|type | |type | ||
- | |urlRedirect | + | |urlRedirect |
- | |urlNotify | + | |urlNotify |
- | |kassenzeichen | + | |kassenzeichen |
- | |hash | + | |hash |
- | == example | + | == Example |
{{page> | {{page> | ||
- | === reply === | + | === Reply === |
The reply includes a JSON encoded string. The field rc contains the response code. If it is 0 the transaction was successfully initialized. The response also includes a transaction id and a redirect URL to the payment page. | The reply includes a JSON encoded string. The field rc contains the response code. If it is 0 the transaction was successfully initialized. The response also includes a transaction id and a redirect URL to the payment page. | ||
Line 101: | Line 102: | ||
^name | ^name | ||
|rc | |rc | ||
- | |msg |yes | + | |msg |yes |
- | |reference | + | |reference |
- | |redirect | + | |redirect |
^HEADER parameter^^^^ | ^HEADER parameter^^^^ | ||
- | |hash | + | |hash |
- | == example | + | == Example |
{{page> | {{page> | ||
- | == example | + | == Example |
{{page> | {{page> | ||
- | === SEPA compliant characters | + | ==== Notification |
- | {{page> | + | |
- | + | ||
- | ==== notification | + | |
The result of an initialized transaction will be submitted to the prior in the // | The result of an initialized transaction will be submitted to the prior in the // | ||
- | === request | + | === Request |
**URL:** notifyUrl of the prior init transaction call \\ | **URL:** notifyUrl of the prior init transaction call \\ | ||
**provided by:** merchant \\ | **provided by:** merchant \\ | ||
Line 128: | Line 126: | ||
== GET parameter == | == GET parameter == | ||
^name | ^name | ||
- | |gcReference | + | |gcReference |
- | |gcMerchantTxId | + | |gcMerchantTxId |
- | |gcBackendTxId | + | |gcBackendTxId |
|gcAmount | |gcAmount | ||
- | |gcCurrency | + | |gcCurrency |
|gcResultPayment | |gcResultPayment | ||
- | |gcHash | + | |gcHash |
- | === reply === | + | === Reply === |
As a reply to the GET request, one of the following HTTP status codes is expected. | As a reply to the GET request, one of the following HTTP status codes is expected. | ||
Line 144: | Line 142: | ||
|all others | |all others | ||
- | ==== redirection | + | ==== Redirection |
After completing the payment, the customer may return to the merchant through a link. This return is not done automatically. | After completing the payment, the customer may return to the merchant through a link. This return is not done automatically. | ||
- | === request | + | === Request |
**URL:** redirectUrl of the prior init transaction call \\ | **URL:** redirectUrl of the prior init transaction call \\ | ||
**provided by:** merchant \\ | **provided by:** merchant \\ | ||
Line 154: | Line 152: | ||
== GET parameter == | == GET parameter == | ||
^name | ^name | ||
- | |gcReference | + | |gcReference |
- | |gcMerchantTxId | + | |gcMerchantTxId |
- | |gcBackendTxId | + | |gcBackendTxId |
|gcAmount | |gcAmount | ||
- | |gcCurrency | + | |gcCurrency |
|gcResultPayment | |gcResultPayment | ||
- | |gcHash | + | |gcHash |
Line 209: | Line 207: | ||
|amount | |amount | ||
|currency | |currency | ||
- | |reference | + | |reference |
|purpose | |purpose | ||
- | |kassenzeichen | + | |kassenzeichen |
- | |hash | + | |hash |
== Example == | == Example == | ||
Line 223: | Line 221: | ||
^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 == |