CreatePaymentRequest.php — WooCommerce Square 2.2.5

woocommerce-square / vendor / square / connect / lib / Model / CreatePaymentRequest.php

woocommerce-square / vendor / square / connect / lib / Model Last commit date

CreatePaymentRequest.php

642 lines

1	<?php
2	/**
3	* NOTE: This class is auto generated by the swagger code generator program.
4	* https://github.com/swagger-api/swagger-codegen
5	* Do not edit the class manually.
6	*/
7
8	namespace SquareConnect\Model;
9
10	use \ArrayAccess;
11	/**
12	* CreatePaymentRequest Class Doc Comment
13	*
14	* @category Class
15	* @package SquareConnect
16	* @author Square Inc.
17	* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License v2
18	* @link https://squareup.com/developers
19	*/
20	class CreatePaymentRequest implements ArrayAccess
21	{
22	/**
23	* Array of property to type mappings. Used for (de)serialization
24	* @var string[]
25	*/
26	static $swaggerTypes = array(
27	'source_id' => 'string',
28	'idempotency_key' => 'string',
29	'amount_money' => '\SquareConnect\Model\Money',
30	'tip_money' => '\SquareConnect\Model\Money',
31	'app_fee_money' => '\SquareConnect\Model\Money',
32	'autocomplete' => 'bool',
33	'order_id' => 'string',
34	'customer_id' => 'string',
35	'location_id' => 'string',
36	'reference_id' => 'string',
37	'verification_token' => 'string',
38	'accept_partial_authorization' => 'bool',
39	'buyer_email_address' => 'string',
40	'billing_address' => '\SquareConnect\Model\Address',
41	'shipping_address' => '\SquareConnect\Model\Address',
42	'note' => 'string'
43	);
44
45	/**
46	* Array of attributes where the key is the local name, and the value is the original name
47	* @var string[]
48	*/
49	static $attributeMap = array(
50	'source_id' => 'source_id',
51	'idempotency_key' => 'idempotency_key',
52	'amount_money' => 'amount_money',
53	'tip_money' => 'tip_money',
54	'app_fee_money' => 'app_fee_money',
55	'autocomplete' => 'autocomplete',
56	'order_id' => 'order_id',
57	'customer_id' => 'customer_id',
58	'location_id' => 'location_id',
59	'reference_id' => 'reference_id',
60	'verification_token' => 'verification_token',
61	'accept_partial_authorization' => 'accept_partial_authorization',
62	'buyer_email_address' => 'buyer_email_address',
63	'billing_address' => 'billing_address',
64	'shipping_address' => 'shipping_address',
65	'note' => 'note'
66	);
67
68	/**
69	* Array of attributes to setter functions (for deserialization of responses)
70	* @var string[]
71	*/
72	static $setters = array(
73	'source_id' => 'setSourceId',
74	'idempotency_key' => 'setIdempotencyKey',
75	'amount_money' => 'setAmountMoney',
76	'tip_money' => 'setTipMoney',
77	'app_fee_money' => 'setAppFeeMoney',
78	'autocomplete' => 'setAutocomplete',
79	'order_id' => 'setOrderId',
80	'customer_id' => 'setCustomerId',
81	'location_id' => 'setLocationId',
82	'reference_id' => 'setReferenceId',
83	'verification_token' => 'setVerificationToken',
84	'accept_partial_authorization' => 'setAcceptPartialAuthorization',
85	'buyer_email_address' => 'setBuyerEmailAddress',
86	'billing_address' => 'setBillingAddress',
87	'shipping_address' => 'setShippingAddress',
88	'note' => 'setNote'
89	);
90
91	/**
92	* Array of attributes to getter functions (for serialization of requests)
93	* @var string[]
94	*/
95	static $getters = array(
96	'source_id' => 'getSourceId',
97	'idempotency_key' => 'getIdempotencyKey',
98	'amount_money' => 'getAmountMoney',
99	'tip_money' => 'getTipMoney',
100	'app_fee_money' => 'getAppFeeMoney',
101	'autocomplete' => 'getAutocomplete',
102	'order_id' => 'getOrderId',
103	'customer_id' => 'getCustomerId',
104	'location_id' => 'getLocationId',
105	'reference_id' => 'getReferenceId',
106	'verification_token' => 'getVerificationToken',
107	'accept_partial_authorization' => 'getAcceptPartialAuthorization',
108	'buyer_email_address' => 'getBuyerEmailAddress',
109	'billing_address' => 'getBillingAddress',
110	'shipping_address' => 'getShippingAddress',
111	'note' => 'getNote'
112	);
113
114	/**
115	* $source_id The ID for the source of funds for this payment. This can be a nonce generated by the Payment Form or a card on file made with the Customers API.
116	* @var string
117	*/
118	protected $source_id;
119	/**
120	* $idempotency_key A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](/basics/api101/idempotency) for more information.
121	* @var string
122	*/
123	protected $idempotency_key;
124	/**
125	* $amount_money The amount of money to accept for this payment, not including `tip_money`. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment.
126	* @var \SquareConnect\Model\Money
127	*/
128	protected $amount_money;
129	/**
130	* $tip_money The amount designated as a tip, in addition to `amount_money` Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment.
131	* @var \SquareConnect\Model\Money
132	*/
133	protected $tip_money;
134	/**
135	* $app_fee_money The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](/payments-api/take-payments-and-collect-fees).
136	* @var \SquareConnect\Model\Money
137	*/
138	protected $app_fee_money;
139	/**
140	* $autocomplete If set to `true`, this payment will be completed when possible. If set to `false`, this payment will be held in an approved state until either explicitly completed or canceled. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). Default: true
141	* @var bool
142	*/
143	protected $autocomplete;
144	/**
145	* $order_id Associate a previously created order with this payment
146	* @var string
147	*/
148	protected $order_id;
149	/**
150	* $customer_id The ID of the customer associated with the payment. Required if the `source_id` refers to a card on file created using the Customers API.
151	* @var string
152	*/
153	protected $customer_id;
154	/**
155	* $location_id The location ID to associate with the payment. If not specified, the default location is used.
156	* @var string
157	*/
158	protected $location_id;
159	/**
160	* $reference_id A user-defined ID to associate with the payment. You can use this field to associate the payment to an entity in an external system. For example, you might specify an order ID that is generated by a third-party shopping cart. Limit 40 characters.
161	* @var string
162	*/
163	protected $reference_id;
164	/**
165	* $verification_token An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](/sca-overview) for more.
166	* @var string
167	*/
168	protected $verification_token;
169	/**
170	* $accept_partial_authorization If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true For more information, see [Partial amount with Square gift cards](/payments-api/take-payments#partial-payment-gift-card). Default: false
171	* @var bool
172	*/
173	protected $accept_partial_authorization;
174	/**
175	* $buyer_email_address The buyer's e-mail address
176	* @var string
177	*/
178	protected $buyer_email_address;
179	/**
180	* $billing_address The buyer's billing address.
181	* @var \SquareConnect\Model\Address
182	*/
183	protected $billing_address;
184	/**
185	* $shipping_address The buyer's shipping address.
186	* @var \SquareConnect\Model\Address
187	*/
188	protected $shipping_address;
189	/**
190	* $note An optional note to be entered by the developer when creating a payment Limit 500 characters.
191	* @var string
192	*/
193	protected $note;
194
195	/**
196	* Constructor
197	* @param mixed[] $data Associated array of property value initializing the model
198	*/
199	public function __construct(array $data = null)
200	{
201	if ($data != null) {
202	if (isset($data["source_id"])) {
203	$this->source_id = $data["source_id"];
204	} else {
205	$this->source_id = null;
206	}
207	if (isset($data["idempotency_key"])) {
208	$this->idempotency_key = $data["idempotency_key"];
209	} else {
210	$this->idempotency_key = null;
211	}
212	if (isset($data["amount_money"])) {
213	$this->amount_money = $data["amount_money"];
214	} else {
215	$this->amount_money = null;
216	}
217	if (isset($data["tip_money"])) {
218	$this->tip_money = $data["tip_money"];
219	} else {
220	$this->tip_money = null;
221	}
222	if (isset($data["app_fee_money"])) {
223	$this->app_fee_money = $data["app_fee_money"];
224	} else {
225	$this->app_fee_money = null;
226	}
227	if (isset($data["autocomplete"])) {
228	$this->autocomplete = $data["autocomplete"];
229	} else {
230	$this->autocomplete = null;
231	}
232	if (isset($data["order_id"])) {
233	$this->order_id = $data["order_id"];
234	} else {
235	$this->order_id = null;
236	}
237	if (isset($data["customer_id"])) {
238	$this->customer_id = $data["customer_id"];
239	} else {
240	$this->customer_id = null;
241	}
242	if (isset($data["location_id"])) {
243	$this->location_id = $data["location_id"];
244	} else {
245	$this->location_id = null;
246	}
247	if (isset($data["reference_id"])) {
248	$this->reference_id = $data["reference_id"];
249	} else {
250	$this->reference_id = null;
251	}
252	if (isset($data["verification_token"])) {
253	$this->verification_token = $data["verification_token"];
254	} else {
255	$this->verification_token = null;
256	}
257	if (isset($data["accept_partial_authorization"])) {
258	$this->accept_partial_authorization = $data["accept_partial_authorization"];
259	} else {
260	$this->accept_partial_authorization = null;
261	}
262	if (isset($data["buyer_email_address"])) {
263	$this->buyer_email_address = $data["buyer_email_address"];
264	} else {
265	$this->buyer_email_address = null;
266	}
267	if (isset($data["billing_address"])) {
268	$this->billing_address = $data["billing_address"];
269	} else {
270	$this->billing_address = null;
271	}
272	if (isset($data["shipping_address"])) {
273	$this->shipping_address = $data["shipping_address"];
274	} else {
275	$this->shipping_address = null;
276	}
277	if (isset($data["note"])) {
278	$this->note = $data["note"];
279	} else {
280	$this->note = null;
281	}
282	}
283	}
284	/**
285	* Gets source_id
286	* @return string
287	*/
288	public function getSourceId()
289	{
290	return $this->source_id;
291	}
292
293	/**
294	* Sets source_id
295	* @param string $source_id The ID for the source of funds for this payment. This can be a nonce generated by the Payment Form or a card on file made with the Customers API.
296	* @return $this
297	*/
298	public function setSourceId($source_id)
299	{
300	$this->source_id = $source_id;
301	return $this;
302	}
303	/**
304	* Gets idempotency_key
305	* @return string
306	*/
307	public function getIdempotencyKey()
308	{
309	return $this->idempotency_key;
310	}
311
312	/**
313	* Sets idempotency_key
314	* @param string $idempotency_key A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request. Max: 45 characters See [Idempotency keys](/basics/api101/idempotency) for more information.
315	* @return $this
316	*/
317	public function setIdempotencyKey($idempotency_key)
318	{
319	$this->idempotency_key = $idempotency_key;
320	return $this;
321	}
322	/**
323	* Gets amount_money
324	* @return \SquareConnect\Model\Money
325	*/
326	public function getAmountMoney()
327	{
328	return $this->amount_money;
329	}
330
331	/**
332	* Sets amount_money
333	* @param \SquareConnect\Model\Money $amount_money The amount of money to accept for this payment, not including `tip_money`. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment.
334	* @return $this
335	*/
336	public function setAmountMoney($amount_money)
337	{
338	$this->amount_money = $amount_money;
339	return $this;
340	}
341	/**
342	* Gets tip_money
343	* @return \SquareConnect\Model\Money
344	*/
345	public function getTipMoney()
346	{
347	return $this->tip_money;
348	}
349
350	/**
351	* Sets tip_money
352	* @param \SquareConnect\Model\Money $tip_money The amount designated as a tip, in addition to `amount_money` Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment.
353	* @return $this
354	*/
355	public function setTipMoney($tip_money)
356	{
357	$this->tip_money = $tip_money;
358	return $this;
359	}
360	/**
361	* Gets app_fee_money
362	* @return \SquareConnect\Model\Money
363	*/
364	public function getAppFeeMoney()
365	{
366	return $this->app_fee_money;
367	}
368
369	/**
370	* Sets app_fee_money
371	* @param \SquareConnect\Model\Money $app_fee_money The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Cannot be more than 90% of the total amount of the Payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is accepting the payment. For more information about the application fee scenario, see [Collect Fees](/payments-api/take-payments-and-collect-fees).
372	* @return $this
373	*/
374	public function setAppFeeMoney($app_fee_money)
375	{
376	$this->app_fee_money = $app_fee_money;
377	return $this;
378	}
379	/**
380	* Gets autocomplete
381	* @return bool
382	*/
383	public function getAutocomplete()
384	{
385	return $this->autocomplete;
386	}
387
388	/**
389	* Sets autocomplete
390	* @param bool $autocomplete If set to `true`, this payment will be completed when possible. If set to `false`, this payment will be held in an approved state until either explicitly completed or canceled. For more information, see [Delayed Payments](/payments-api/take-payments#delayed-payments). Default: true
391	* @return $this
392	*/
393	public function setAutocomplete($autocomplete)
394	{
395	$this->autocomplete = $autocomplete;
396	return $this;
397	}
398	/**
399	* Gets order_id
400	* @return string
401	*/
402	public function getOrderId()
403	{
404	return $this->order_id;
405	}
406
407	/**
408	* Sets order_id
409	* @param string $order_id Associate a previously created order with this payment
410	* @return $this
411	*/
412	public function setOrderId($order_id)
413	{
414	$this->order_id = $order_id;
415	return $this;
416	}
417	/**
418	* Gets customer_id
419	* @return string
420	*/
421	public function getCustomerId()
422	{
423	return $this->customer_id;
424	}
425
426	/**
427	* Sets customer_id
428	* @param string $customer_id The ID of the customer associated with the payment. Required if the `source_id` refers to a card on file created using the Customers API.
429	* @return $this
430	*/
431	public function setCustomerId($customer_id)
432	{
433	$this->customer_id = $customer_id;
434	return $this;
435	}
436	/**
437	* Gets location_id
438	* @return string
439	*/
440	public function getLocationId()
441	{
442	return $this->location_id;
443	}
444
445	/**
446	* Sets location_id
447	* @param string $location_id The location ID to associate with the payment. If not specified, the default location is used.
448	* @return $this
449	*/
450	public function setLocationId($location_id)
451	{
452	$this->location_id = $location_id;
453	return $this;
454	}
455	/**
456	* Gets reference_id
457	* @return string
458	*/
459	public function getReferenceId()
460	{
461	return $this->reference_id;
462	}
463
464	/**
465	* Sets reference_id
466	* @param string $reference_id A user-defined ID to associate with the payment. You can use this field to associate the payment to an entity in an external system. For example, you might specify an order ID that is generated by a third-party shopping cart. Limit 40 characters.
467	* @return $this
468	*/
469	public function setReferenceId($reference_id)
470	{
471	$this->reference_id = $reference_id;
472	return $this;
473	}
474	/**
475	* Gets verification_token
476	* @return string
477	*/
478	public function getVerificationToken()
479	{
480	return $this->verification_token;
481	}
482
483	/**
484	* Sets verification_token
485	* @param string $verification_token An identifying token generated by `SqPaymentForm.verifyBuyer()`. Verification tokens encapsulate customer device information and 3-D Secure challenge results to indicate that Square has verified the buyer identity. See the [SCA Overview](/sca-overview) for more.
486	* @return $this
487	*/
488	public function setVerificationToken($verification_token)
489	{
490	$this->verification_token = $verification_token;
491	return $this;
492	}
493	/**
494	* Gets accept_partial_authorization
495	* @return bool
496	*/
497	public function getAcceptPartialAuthorization()
498	{
499	return $this->accept_partial_authorization;
500	}
501
502	/**
503	* Sets accept_partial_authorization
504	* @param bool $accept_partial_authorization If set to true and charging a Square Gift Card, a payment may be returned with amount_money equal to less than what was requested. Example, a request for $20 when charging a Square Gift Card with balance of $5 wil result in an APPROVED payment of $5. You may choose to prompt the buyer for an additional payment to cover the remainder, or cancel the gift card payment. Cannot be `true` when `autocomplete = true For more information, see [Partial amount with Square gift cards](/payments-api/take-payments#partial-payment-gift-card). Default: false
505	* @return $this
506	*/
507	public function setAcceptPartialAuthorization($accept_partial_authorization)
508	{
509	$this->accept_partial_authorization = $accept_partial_authorization;
510	return $this;
511	}
512	/**
513	* Gets buyer_email_address
514	* @return string
515	*/
516	public function getBuyerEmailAddress()
517	{
518	return $this->buyer_email_address;
519	}
520
521	/**
522	* Sets buyer_email_address
523	* @param string $buyer_email_address The buyer's e-mail address
524	* @return $this
525	*/
526	public function setBuyerEmailAddress($buyer_email_address)
527	{
528	$this->buyer_email_address = $buyer_email_address;
529	return $this;
530	}
531	/**
532	* Gets billing_address
533	* @return \SquareConnect\Model\Address
534	*/
535	public function getBillingAddress()
536	{
537	return $this->billing_address;
538	}
539
540	/**
541	* Sets billing_address
542	* @param \SquareConnect\Model\Address $billing_address The buyer's billing address.
543	* @return $this
544	*/
545	public function setBillingAddress($billing_address)
546	{
547	$this->billing_address = $billing_address;
548	return $this;
549	}
550	/**
551	* Gets shipping_address
552	* @return \SquareConnect\Model\Address
553	*/
554	public function getShippingAddress()
555	{
556	return $this->shipping_address;
557	}
558
559	/**
560	* Sets shipping_address
561	* @param \SquareConnect\Model\Address $shipping_address The buyer's shipping address.
562	* @return $this
563	*/
564	public function setShippingAddress($shipping_address)
565	{
566	$this->shipping_address = $shipping_address;
567	return $this;
568	}
569	/**
570	* Gets note
571	* @return string
572	*/
573	public function getNote()
574	{
575	return $this->note;
576	}
577
578	/**
579	* Sets note
580	* @param string $note An optional note to be entered by the developer when creating a payment Limit 500 characters.
581	* @return $this
582	*/
583	public function setNote($note)
584	{
585	$this->note = $note;
586	return $this;
587	}
588	/**
589	* Returns true if offset exists. False otherwise.
590	* @param integer $offset Offset
591	* @return boolean
592	*/
593	public function offsetExists($offset)
594	{
595	return isset($this->$offset);
596	}
597
598	/**
599	* Gets offset.
600	* @param integer $offset Offset
601	* @return mixed
602	*/
603	public function offsetGet($offset)
604	{
605	return $this->$offset;
606	}
607
608	/**
609	* Sets value based on offset.
610	* @param integer $offset Offset
611	* @param mixed $value Value to be set
612	* @return void
613	*/
614	public function offsetSet($offset, $value)
615	{
616	$this->$offset = $value;
617	}
618
619	/**
620	* Unsets offset.
621	* @param integer $offset Offset
622	* @return void
623	*/
624	public function offsetUnset($offset)
625	{
626	unset($this->$offset);
627	}
628
629	/**
630	* Gets the string presentation of the object
631	* @return string
632	*/
633	public function __toString()
634	{
635	if (defined('JSON_PRETTY_PRINT')) {
636	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT);
637	} else {
638	return json_encode(\SquareConnect\ObjectSerializer::sanitizeForSerialization($this));
639	}
640	}
641	}
642