whoami7 - Manager
:
/
home
/
qbizpnmr
/
arif.umairtax.com
/
vendor
/
square
/
square
/
src
/
Apis
/
Upload File:
files >> /home/qbizpnmr/arif.umairtax.com/vendor/square/square/src/Apis/PaymentsApi.php
<?php declare(strict_types=1); namespace Square\Apis; use Core\Request\Parameters\BodyParam; use Core\Request\Parameters\HeaderParam; use Core\Request\Parameters\QueryParam; use Core\Request\Parameters\TemplateParam; use CoreInterfaces\Core\Request\RequestMethod; use Square\Http\ApiResponse; use Square\Models\CancelPaymentByIdempotencyKeyRequest; use Square\Models\CancelPaymentByIdempotencyKeyResponse; use Square\Models\CancelPaymentResponse; use Square\Models\CompletePaymentRequest; use Square\Models\CompletePaymentResponse; use Square\Models\CreatePaymentRequest; use Square\Models\CreatePaymentResponse; use Square\Models\GetPaymentResponse; use Square\Models\ListPaymentsResponse; use Square\Models\UpdatePaymentRequest; use Square\Models\UpdatePaymentResponse; class PaymentsApi extends BaseApi { /** * Retrieves a list of payments taken by the account making the request. * * Results are eventually consistent, and new payments or changes to payments might take several * seconds to appear. * * The maximum results per page is 100. * * @param string|null $beginTime Indicates the start of the time range to retrieve payments for, * in RFC 3339 format. * The range is determined using the `created_at` field for each Payment. * Inclusive. Default: The current time minus one year. * @param string|null $endTime Indicates the end of the time range to retrieve payments for, in * RFC 3339 format. The * range is determined using the `created_at` field for each Payment. * * Default: The current time. * @param string|null $sortOrder The order in which results are listed by `Payment.created_at`: * - `ASC` - Oldest to newest. * - `DESC` - Newest to oldest (default). * @param string|null $cursor A pagination cursor returned by a previous call to this endpoint. * Provide this cursor to retrieve the next set of results for the original query. * * For more information, see [Pagination](https://developer.squareup.com/docs/build- * basics/common-api-patterns/pagination). * @param string|null $locationId Limit results to the location supplied. By default, results * are returned * for the default (main) location associated with the seller. * @param int|null $total The exact amount in the `total_money` for a payment. * @param string|null $last4 The last four digits of a payment card. * @param string|null $cardBrand The brand of the payment card (for example, VISA). * @param int|null $limit The maximum number of results to be returned in a single page. It is * possible to receive fewer results than the specified limit on a given page. * * The default value of 100 is also the maximum allowed value. If the provided value is * greater than 100, it is ignored and the default value is used instead. * * Default: `100` * * @return ApiResponse Response from the API call */ public function listPayments( ?string $beginTime = null, ?string $endTime = null, ?string $sortOrder = null, ?string $cursor = null, ?string $locationId = null, ?int $total = null, ?string $last4 = null, ?string $cardBrand = null, ?int $limit = null ): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments') ->auth('global') ->parameters( QueryParam::init('begin_time', $beginTime), QueryParam::init('end_time', $endTime), QueryParam::init('sort_order', $sortOrder), QueryParam::init('cursor', $cursor), QueryParam::init('location_id', $locationId), QueryParam::init('total', $total), QueryParam::init('last_4', $last4), QueryParam::init('card_brand', $cardBrand), QueryParam::init('limit', $limit) ); $_resHandler = $this->responseHandler()->type(ListPaymentsResponse::class)->returnApiResponse(); return $this->execute($_reqBuilder, $_resHandler); } /** * Creates a payment using the provided source. You can use this endpoint * to charge a card (credit/debit card or * Square gift card) or record a payment that the seller received outside of Square * (cash payment from a buyer or a payment that an external entity * processed on behalf of the seller). * * The endpoint creates a * `Payment` object and returns it in the response. * * @param CreatePaymentRequest $body An object containing the fields to POST for the request. * See the corresponding object definition for field details. * * @return ApiResponse Response from the API call */ public function createPayment(CreatePaymentRequest $body): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/payments') ->auth('global') ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body)); $_resHandler = $this->responseHandler()->type(CreatePaymentResponse::class)->returnApiResponse(); return $this->execute($_reqBuilder, $_resHandler); } /** * Cancels (voids) a payment identified by the idempotency key that is specified in the * request. * * Use this method when the status of a `CreatePayment` request is unknown (for example, after you send * a * `CreatePayment` request, a network error occurs and you do not get a response). In this case, you * can * direct Square to cancel the payment using this endpoint. In the request, you provide the same * idempotency key that you provided in your `CreatePayment` request that you want to cancel. After * canceling the payment, you can submit your `CreatePayment` request again. * * Note that if no payment with the specified idempotency key is found, no action is taken and the * endpoint * returns successfully. * * @param CancelPaymentByIdempotencyKeyRequest $body An object containing the fields to POST for * the request. * * See the corresponding object definition for field details. * * @return ApiResponse Response from the API call */ public function cancelPaymentByIdempotencyKey(CancelPaymentByIdempotencyKeyRequest $body): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/payments/cancel') ->auth('global') ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body)); $_resHandler = $this->responseHandler() ->type(CancelPaymentByIdempotencyKeyResponse::class) ->returnApiResponse(); return $this->execute($_reqBuilder, $_resHandler); } /** * Retrieves details for a specific payment. * * @param string $paymentId A unique ID for the desired payment. * * @return ApiResponse Response from the API call */ public function getPayment(string $paymentId): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/{payment_id}') ->auth('global') ->parameters(TemplateParam::init('payment_id', $paymentId)); $_resHandler = $this->responseHandler()->type(GetPaymentResponse::class)->returnApiResponse(); return $this->execute($_reqBuilder, $_resHandler); } /** * Updates a payment with the APPROVED status. * You can update the `amount_money` and `tip_money` using this endpoint. * * @param string $paymentId The ID of the payment to update. * @param UpdatePaymentRequest $body An object containing the fields to POST for the request. * See the corresponding object definition for field details. * * @return ApiResponse Response from the API call */ public function updatePayment(string $paymentId, UpdatePaymentRequest $body): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/payments/{payment_id}') ->auth('global') ->parameters( TemplateParam::init('payment_id', $paymentId), HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body) ); $_resHandler = $this->responseHandler()->type(UpdatePaymentResponse::class)->returnApiResponse(); return $this->execute($_reqBuilder, $_resHandler); } /** * Cancels (voids) a payment. You can use this endpoint to cancel a payment with * the APPROVED `status`. * * @param string $paymentId The ID of the payment to cancel. * * @return ApiResponse Response from the API call */ public function cancelPayment(string $paymentId): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/payments/{payment_id}/cancel') ->auth('global') ->parameters(TemplateParam::init('payment_id', $paymentId)); $_resHandler = $this->responseHandler()->type(CancelPaymentResponse::class)->returnApiResponse(); return $this->execute($_reqBuilder, $_resHandler); } /** * Completes (captures) a payment. * By default, payments are set to complete immediately after they are created. * * You can use this endpoint to complete a payment with the APPROVED `status`. * * @param string $paymentId The unique ID identifying the payment to be completed. * @param CompletePaymentRequest $body An object containing the fields to POST for the request. * See the corresponding object definition for field details. * * @return ApiResponse Response from the API call */ public function completePayment(string $paymentId, CompletePaymentRequest $body): ApiResponse { $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/payments/{payment_id}/complete') ->auth('global') ->parameters( TemplateParam::init('payment_id', $paymentId), HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body) ); $_resHandler = $this->responseHandler()->type(CompletePaymentResponse::class)->returnApiResponse(); return $this->execute($_reqBuilder, $_resHandler); } }
Copyright ©2021 || Defacer Indonesia