payment-template/src/Spryker/Client/PaymentTemplate/PaymentTemplateClientInterface.php at e29c5456841c4c752888f03484c86ce27233b3dd · spryker-community/payment-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<?php

/**
 * MIT License
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

namespace Spryker\Client\PaymentTemplate;

use Generated\Shared\Transfer\PaymentTemplateAuthorizeRequestTransfer;
use Generated\Shared\Transfer\PaymentTemplateAuthorizeResponseTransfer;
use Generated\Shared\Transfer\PaymentTemplateCancelRequestTransfer;
use Generated\Shared\Transfer\PaymentTemplateCancelResponseTransfer;
use Generated\Shared\Transfer\PaymentTemplateCaptureRequestTransfer;
use Generated\Shared\Transfer\PaymentTemplateCaptureResponseTransfer;
use Generated\Shared\Transfer\PaymentTemplatePaymentMethodsRequestTransfer;
use Generated\Shared\Transfer\PaymentTemplatePaymentMethodsResponseTransfer;
use Generated\Shared\Transfer\PaymentTemplateRefundRequestTransfer;
use Generated\Shared\Transfer\PaymentTemplateRefundResponseTransfer;
use Generated\Shared\Transfer\PaymentTemplateWebhookPayloadTransfer;
use Generated\Shared\Transfer\PaymentTemplateWebhookProcessResponseTransfer;

interface PaymentTemplateClientInterface
{
    /**
     * Specification:
     * - Sends authorization request to payment provider.
     * - Maps request data to provider-specific format.
     * - Returns authorization response.
     * - Logs the request, response and error.
     *
     * @api
     *
     * @param \Generated\Shared\Transfer\PaymentTemplateAuthorizeRequestTransfer $paymentTemplateAuthorizeRequestTransfer
     *
     * @return \Generated\Shared\Transfer\PaymentTemplateAuthorizeResponseTransfer
     */
    public function authorize(PaymentTemplateAuthorizeRequestTransfer $paymentTemplateAuthorizeRequestTransfer): PaymentTemplateAuthorizeResponseTransfer;

    /**
     * Specification:
     * - Sends capture request to payment provider to capture authorized amount.
     * - Maps request data to provider-specific format.
     * - Returns capture response.
     * - Logs the request, response and error.
     *
     * @api
     *
     * @param \Generated\Shared\Transfer\PaymentTemplateCaptureRequestTransfer $paymentTemplateCaptureRequestTransfer
     *
     * @return \Generated\Shared\Transfer\PaymentTemplateCaptureResponseTransfer
     */
    public function capture(PaymentTemplateCaptureRequestTransfer $paymentTemplateCaptureRequestTransfer): PaymentTemplateCaptureResponseTransfer;

    /**
     * Specification:
     * - Sends capture request to payment provider to capture authorized amount.
     * - Maps request data to provider-specific format.
     * - Returns capture response.
     * - Logs the request, response and error.
     *
     * @api
     *
     * @param \Generated\Shared\Transfer\PaymentTemplateRefundRequestTransfer $paymentTemplateRefundRequestTransfer
     *
     * @return \Generated\Shared\Transfer\PaymentTemplateRefundResponseTransfer
     */
    public function refund(PaymentTemplateRefundRequestTransfer $paymentTemplateRefundRequestTransfer): PaymentTemplateRefundResponseTransfer;

    /**
     * Specification:
     * - Sends cancel request to payment provider to cancel authorized payment.
     * - Maps request data to provider-specific format.
     * - Returns cancellation response.
     * - Logs the request, response and error.
     *
     * @api
     *
     * @param \Generated\Shared\Transfer\PaymentTemplateCancelRequestTransfer $paymentTemplateCancelRequestTransfer
     *
     * @return \Generated\Shared\Transfer\PaymentTemplateCancelResponseTransfer
     */
    public function cancel(PaymentTemplateCancelRequestTransfer $paymentTemplateCancelRequestTransfer): PaymentTemplateCancelResponseTransfer;

    /**
     * Specification:
     * - Retrieves available payment methods from payment provider.
     * - Maps request data to provider-specific format.
     * - Returns list of available payment methods for current context.
     * - Logs the request, response and error.
     *
     * @api
     *
     * @param \Generated\Shared\Transfer\PaymentTemplatePaymentMethodsRequestTransfer $paymentTemplatePaymentMethodsRequestTransfer
     *
     * @return \Generated\Shared\Transfer\PaymentTemplatePaymentMethodsResponseTransfer
     */
    public function getPaymentMethods(
        PaymentTemplatePaymentMethodsRequestTransfer $paymentTemplatePaymentMethodsRequestTransfer,
    ): PaymentTemplatePaymentMethodsResponseTransfer;

    /**
     * Specification:
     * - Sends webhook payload to Zed for processing.
     * - Zed will save webhook to database and update payment status.
     * - Returns webhook processing response.
     *
     * @api
     *
     * @param \Generated\Shared\Transfer\PaymentTemplateWebhookPayloadTransfer $webhookPayloadTransfer
     *
     * @return \Generated\Shared\Transfer\PaymentTemplateWebhookProcessResponseTransfer
     */
    public function processWebhook(
        PaymentTemplateWebhookPayloadTransfer $webhookPayloadTransfer,
    ): PaymentTemplateWebhookProcessResponseTransfer;
}