This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
en:girocheckout:paypal:start [2014/08/16 11:56] jeromejung [notification about the payment result] |
en:girocheckout:paypal:start [2023/02/10 22:34] michaelheumann |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== PayPal ====== | ====== PayPal ====== | ||
- | Information about PayPal payment can be found under https:// | ||
- | ===== test data ===== | + | |
+ | ===== Test data ===== | ||
{{page> | {{page> | ||
- | ===== workflow | + | |
+ | ===== Workflow | ||
<uml> | <uml> | ||
Line 38: | Line 39: | ||
- buyer chooses PayPal payment method | - buyer chooses PayPal payment method | ||
- | - merchant | + | - merchant |
- | - GiroCheckout | + | - GiroCheckout |
- PayPal submits response to GiroCheckout | - PayPal submits response to GiroCheckout | ||
- | - merchant gets response about initialisation | + | - merchant gets response about initialization |
- merchant sends redirect URL to buyer | - merchant sends redirect URL to buyer | ||
- the buyer' | - the buyer' | ||
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. | ||
- | - initialise | + | - Initialize |
- | - payment | + | - Payment |
- | - buyer redirection to the merchant (triggered by buyer) | + | - Buyer redirection to the merchant (triggered by buyer) |
- | ==== initialise | + | ==== Initialize |
- | 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 | ||
- | |merchantTxId | + | |merchantTxId |
|amount | |amount | ||
|currency | |currency | ||
|purpose | |purpose | ||
+ | |type | ||
|urlRedirect | |urlRedirect | ||
|urlNotify | |urlNotify | ||
+ | |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 | + | The reply includes a JSON encoded string. The field rc contains the response code. If it is 0 the transaction was successfully |
Line 105: | Line 108: | ||
|hash | |hash | ||
- | == example | + | == Example |
{{page> | {{page> | ||
- | == example | + | == Example |
{{page> | {{page> | ||
+ | === SEPA compliant characters === | ||
+ | {{page> | ||
- | ==== notification | + | ==== Notification |
- | The result of an initialised | + | The result of an initialized |
- | === 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 129: | Line 134: | ||
|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 140: | Line 145: | ||
|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 155: | Line 160: | ||
|gcAmount | |gcAmount | ||
|gcCurrency | |gcCurrency | ||
- | |gcResultPayment | + | |gcResultPayment |
|gcHash | |gcHash | ||
+ | |||
+ | |||
+ | ===== Other transaction types ===== | ||
+ | These transactions reference a previous transaction. | ||
+ | |||
+ | **Provided by:** GiroCheckout \\ | ||
+ | **Called by:** Merchant \\ | ||
+ | |||
+ | ==== Workflow ==== | ||
+ | |||
+ | <uml> | ||
+ | hide footbox | ||
+ | |||
+ | participant " | ||
+ | participant " | ||
+ | participant " | ||
+ | |||
+ | autonumber | ||
+ | |||
+ | shop -> girocheckout: | ||
+ | girocheckout -> cc: | ||
+ | cc -> girocheckout: | ||
+ | girocheckout -> shop: | ||
+ | |||
+ | center footer (c)2016 by GiroSolution AG | ||
+ | </ | ||
+ | |||
+ | - Shop sends reference to previous credit card transaction | ||
+ | - GiroCheckout sends transaction to credit card processor | ||
+ | - credit card processor transmits result to GiroCheckout | ||
+ | - Shop receives reply on transaction outcome ([[en: | ||
+ | |||
+ | ==== Capture ==== | ||
+ | {{page> | ||
+ | |||
+ | ==== Refund ==== | ||
+ | {{page> | ||
+ | |||
+ | === POST Parameters === | ||
+ | URL CAPTURE: https:// | ||
+ | URL REFUND: https:// | ||
+ | |||
+ | ^Name | ||
+ | |merchantId | ||
+ | |projectId | ||
+ | |merchantTxId | ||
+ | |amount | ||
+ | |currency | ||
+ | |reference | ||
+ | |purpose | ||
+ | |kassenzeichen | ||
+ | |hash | ||
+ | |||
+ | == Example == | ||
+ | {{page> | ||
+ | |||
+ | === Reply === | ||
+ | The reply is 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 other information about the transaction. | ||
+ | |||
+ | == Parameters == | ||
+ | ^Name | ||
+ | |rc | ||
+ | |msg |yes | ||
+ | |reference | ||
+ | |merchantTxId | ||
+ | |backendTxId | ||
+ | |amount | ||
+ | |currency | ||
+ | |resultPayment | ||
+ | ^HEADER parameter^^^^ | ||
+ | |hash | ||
+ | |||
+ | == Example in case of success == | ||
+ | {{page> | ||
+ | |||
+ | == Example in case of error == | ||
+ | {{page> | ||