Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
OrderPaymentInterface.php
Go to the documentation of this file.
1 <?php
6 namespace Magento\Sales\Api\Data;
7 
18 {
22  /*
23  * Entity ID.
24  */
25  const ENTITY_ID = 'entity_id';
26  /*
27  * Parent ID.
28  */
29  const PARENT_ID = 'parent_id';
30  /*
31  * Base shipping captured.
32  */
33  const BASE_SHIPPING_CAPTURED = 'base_shipping_captured';
34  /*
35  * Shipping captured.
36  */
37  const SHIPPING_CAPTURED = 'shipping_captured';
38  /*
39  * Amount refunded.
40  */
41  const AMOUNT_REFUNDED = 'amount_refunded';
42  /*
43  * Base amount paid.
44  */
45  const BASE_AMOUNT_PAID = 'base_amount_paid';
46  /*
47  * Amount canceled.
48  */
49  const AMOUNT_CANCELED = 'amount_canceled';
50  /*
51  * Base amount authorized.
52  */
53  const BASE_AMOUNT_AUTHORIZED = 'base_amount_authorized';
54  /*
55  * Base amount paid online.
56  */
57  const BASE_AMOUNT_PAID_ONLINE = 'base_amount_paid_online';
58  /*
59  * Base amount refunded online.
60  */
61  const BASE_AMOUNT_REFUNDED_ONLINE = 'base_amount_refunded_online';
62  /*
63  * Base shipping amount.
64  */
65  const BASE_SHIPPING_AMOUNT = 'base_shipping_amount';
66  /*
67  * Shipping amount.
68  */
69  const SHIPPING_AMOUNT = 'shipping_amount';
70  /*
71  * Amount paid.
72  */
73  const AMOUNT_PAID = 'amount_paid';
74  /*
75  * Amount authorized.
76  */
77  const AMOUNT_AUTHORIZED = 'amount_authorized';
78  /*
79  * Base amount ordered.
80  */
81  const BASE_AMOUNT_ORDERED = 'base_amount_ordered';
82  /*
83  * Base shipping refunded.
84  */
85  const BASE_SHIPPING_REFUNDED = 'base_shipping_refunded';
86  /*
87  * Shipping refunded.
88  */
89  const SHIPPING_REFUNDED = 'shipping_refunded';
90  /*
91  * Base amount refunded.
92  */
93  const BASE_AMOUNT_REFUNDED = 'base_amount_refunded';
94  /*
95  * Amount ordered.
96  */
97  const AMOUNT_ORDERED = 'amount_ordered';
98  /*
99  * Base amount canceled.
100  */
101  const BASE_AMOUNT_CANCELED = 'base_amount_canceled';
102  /*
103  * Quote payment ID.
104  */
105  const QUOTE_PAYMENT_ID = 'quote_payment_id';
106  /*
107  * Additional data.
108  */
109  const ADDITIONAL_DATA = 'additional_data';
110  /*
111  * Credit card expiration month.
112  */
113  const CC_EXP_MONTH = 'cc_exp_month';
114 
120  const CC_SS_START_YEAR = 'cc_ss_start_year';
121  /*
122  * eCheck bank name.
123  */
124  const ECHECK_BANK_NAME = 'echeck_bank_name';
125  /*
126  * Payment method.
127  */
128  const METHOD = 'method';
129  /*
130  * Credit card debug request body.
131  */
132  const CC_DEBUG_REQUEST_BODY = 'cc_debug_request_body';
133  /*
134  * Credit card secure verify.
135  */
136  const CC_SECURE_VERIFY = 'cc_secure_verify';
137  /*
138  * Protection eligibility.
139  */
140  const PROTECTION_ELIGIBILITY = 'protection_eligibility';
141  /*
142  * Credit card approval.
143  */
144  const CC_APPROVAL = 'cc_approval';
145  /*
146  * Last four digits of credit card number.
147  */
148  const CC_LAST_4 = 'cc_last_4';
149  /*
150  * Credit card status description.
151  */
152  const CC_STATUS_DESCRIPTION = 'cc_status_description';
153  /*
154  * eCheck type.
155  */
156  const ECHECK_TYPE = 'echeck_type';
157  /*
158  * Credit card debug response serialized.
159  */
160  const CC_DEBUG_RESPONSE_SERIALIZED = 'cc_debug_response_serialized';
161 
167  const CC_SS_START_MONTH = 'cc_ss_start_month';
168  /*
169  * eCheck account type.
170  */
171  const ECHECK_ACCOUNT_TYPE = 'echeck_account_type';
172  /*
173  * Last transaction ID.
174  */
175  const LAST_TRANS_ID = 'last_trans_id';
176  /*
177  * Credit card CID status.
178  */
179  const CC_CID_STATUS = 'cc_cid_status';
180  /*
181  * Credit card owner.
182  */
183  const CC_OWNER = 'cc_owner';
184  /*
185  * Credit card type.
186  */
187  const CC_TYPE = 'cc_type';
188  /*
189  * PO number.
190  */
191  const PO_NUMBER = 'po_number';
192  /*
193  * Credit card expiration year.
194  */
195  const CC_EXP_YEAR = 'cc_exp_year';
196  /*
197  * Credit card status.
198  */
199  const CC_STATUS = 'cc_status';
200  /*
201  * eCheck routing number.
202  */
203  const ECHECK_ROUTING_NUMBER = 'echeck_routing_number';
204  /*
205  * Account status.
206  */
207  const ACCOUNT_STATUS = 'account_status';
208  /*
209  * ANET transaction method.
210  */
211  const ANET_TRANS_METHOD = 'anet_trans_method';
212  /*
213  * Credit card debug response body.
214  */
215  const CC_DEBUG_RESPONSE_BODY = 'cc_debug_response_body';
216 
222  const CC_SS_ISSUE = 'cc_ss_issue';
223  /*
224  * eCheck account name.
225  */
226  const ECHECK_ACCOUNT_NAME = 'echeck_account_name';
227  /*
228  * Credit card AVS status.
229  */
230  const CC_AVS_STATUS = 'cc_avs_status';
231  /*
232  * Encrypted credit card number.
233  */
234  const CC_NUMBER_ENC = 'cc_number_enc';
235  /*
236  * Credit card transaction ID.
237  */
238  const CC_TRANS_ID = 'cc_trans_id';
239  /*
240  * Address status.
241  */
242  const ADDRESS_STATUS = 'address_status';
243  /*
244  * Additional information.
245  */
246  const ADDITIONAL_INFORMATION = 'additional_information';
247 
253  public function getAccountStatus();
254 
260  public function getAdditionalData();
261 
267  public function getAdditionalInformation();
268 
274  public function getAddressStatus();
275 
281  public function getAmountAuthorized();
282 
288  public function getAmountCanceled();
289 
295  public function getAmountOrdered();
296 
302  public function getAmountPaid();
303 
309  public function getAmountRefunded();
310 
316  public function getAnetTransMethod();
317 
323  public function getBaseAmountAuthorized();
324 
330  public function getBaseAmountCanceled();
331 
337  public function getBaseAmountOrdered();
338 
344  public function getBaseAmountPaid();
345 
351  public function getBaseAmountPaidOnline();
352 
358  public function getBaseAmountRefunded();
359 
365  public function getBaseAmountRefundedOnline();
366 
372  public function getBaseShippingAmount();
373 
379  public function getBaseShippingCaptured();
380 
386  public function getBaseShippingRefunded();
387 
393  public function getCcApproval();
394 
400  public function getCcAvsStatus();
401 
407  public function getCcCidStatus();
408 
414  public function getCcDebugRequestBody();
415 
421  public function getCcDebugResponseBody();
422 
428  public function getCcDebugResponseSerialized();
429 
435  public function getCcExpMonth();
436 
442  public function getCcExpYear();
443 
449  public function getCcLast4();
450 
456  public function getCcNumberEnc();
457 
463  public function getCcOwner();
464 
470  public function getCcSecureVerify();
471 
478  public function getCcSsIssue();
479 
486  public function getCcSsStartMonth();
487 
494  public function getCcSsStartYear();
495 
501  public function getCcStatus();
502 
508  public function getCcStatusDescription();
509 
515  public function getCcTransId();
516 
522  public function getCcType();
523 
529  public function getEcheckAccountName();
530 
536  public function getEcheckAccountType();
537 
543  public function getEcheckBankName();
544 
550  public function getEcheckRoutingNumber();
551 
557  public function getEcheckType();
558 
564  public function getEntityId();
565 
572  public function setEntityId($entityId);
573 
579  public function getLastTransId();
580 
586  public function getMethod();
587 
593  public function getParentId();
594 
600  public function getPoNumber();
601 
607  public function getProtectionEligibility();
608 
614  public function getQuotePaymentId();
615 
621  public function getShippingAmount();
622 
628  public function getShippingCaptured();
629 
635  public function getShippingRefunded();
636 
643  public function setParentId($id);
644 
651  public function setBaseShippingCaptured($baseShippingCaptured);
652 
659  public function setShippingCaptured($shippingCaptured);
660 
667  public function setAmountRefunded($amountRefunded);
668 
675  public function setBaseAmountPaid($baseAmountPaid);
676 
683  public function setAmountCanceled($amountCanceled);
684 
691  public function setBaseAmountAuthorized($baseAmountAuthorized);
692 
699  public function setBaseAmountPaidOnline($baseAmountPaidOnline);
700 
707  public function setBaseAmountRefundedOnline($baseAmountRefundedOnline);
708 
715  public function setBaseShippingAmount($amount);
716 
723  public function setShippingAmount($amount);
724 
731  public function setAmountPaid($amountPaid);
732 
739  public function setAmountAuthorized($amountAuthorized);
740 
747  public function setBaseAmountOrdered($baseAmountOrdered);
748 
755  public function setBaseShippingRefunded($baseShippingRefunded);
756 
763  public function setShippingRefunded($shippingRefunded);
764 
771  public function setBaseAmountRefunded($baseAmountRefunded);
772 
779  public function setAmountOrdered($amountOrdered);
780 
787  public function setBaseAmountCanceled($baseAmountCanceled);
788 
795  public function setQuotePaymentId($id);
796 
803  public function setAdditionalData($additionalData);
804 
811  public function setCcExpMonth($ccExpMonth);
812 
819  public function setCcSsStartYear($ccSsStartYear);
820 
827  public function setEcheckBankName($echeckBankName);
828 
835  public function setMethod($method);
836 
843  public function setCcDebugRequestBody($ccDebugRequestBody);
844 
851  public function setCcSecureVerify($ccSecureVerify);
852 
859  public function setProtectionEligibility($protectionEligibility);
860 
867  public function setCcApproval($ccApproval);
868 
875  public function setCcLast4($ccLast4);
876 
883  public function setCcStatusDescription($description);
884 
891  public function setEcheckType($echeckType);
892 
899  public function setCcDebugResponseSerialized($ccDebugResponseSerialized);
900 
907  public function setCcSsStartMonth($ccSsStartMonth);
908 
915  public function setEcheckAccountType($echeckAccountType);
916 
923  public function setLastTransId($id);
924 
931  public function setCcCidStatus($ccCidStatus);
932 
939  public function setCcOwner($ccOwner);
940 
947  public function setCcType($ccType);
948 
955  public function setPoNumber($poNumber);
956 
963  public function setCcExpYear($ccExpYear);
964 
971  public function setCcStatus($ccStatus);
972 
979  public function setEcheckRoutingNumber($echeckRoutingNumber);
980 
987  public function setAccountStatus($accountStatus);
988 
995  public function setAnetTransMethod($anetTransMethod);
996 
1003  public function setCcDebugResponseBody($ccDebugResponseBody);
1004 
1011  public function setCcSsIssue($ccSsIssue);
1012 
1019  public function setEcheckAccountName($echeckAccountName);
1020 
1027  public function setCcAvsStatus($ccAvsStatus);
1028 
1035  public function setCcNumberEnc($ccNumberEnc);
1036 
1043  public function setCcTransId($id);
1044 
1051  public function setAddressStatus($addressStatus);
1052 
1058  public function getExtensionAttributes();
1059 
1066  public function setExtensionAttributes(\Magento\Sales\Api\Data\OrderPaymentExtensionInterface $extensionAttributes);
1067 }
setBaseShippingRefunded($baseShippingRefunded)
setBaseShippingCaptured($baseShippingCaptured)
setBaseAmountRefundedOnline($baseAmountRefundedOnline)
$id
Definition: fieldset.phtml:14
$ccExpYear
Definition: info.phtml:18
$amount
Definition: order.php:14
setCcDebugResponseSerialized($ccDebugResponseSerialized)
$ccExpMonth
Definition: info.phtml:17
setProtectionEligibility($protectionEligibility)
$extensionAttributes
Definition: payment.php:22
setBaseAmountAuthorized($baseAmountAuthorized)
setExtensionAttributes(\Magento\Sales\Api\Data\OrderPaymentExtensionInterface $extensionAttributes)
$method
Definition: info.phtml:13
$ccType
Definition: info.phtml:16
setBaseAmountPaidOnline($baseAmountPaidOnline)