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), QueryParam::init('is_offline_payment', $isOfflinePayment), QueryParam::init('offline_begin_time', $offlineBeginTime), QueryParam::init('offline_end_time', $offlineEndTime), QueryParam::init('updated_at_begin_time', $updatedAtBeginTime), QueryParam::init('updated_at_end_time', $updatedAtEndTime), QueryParam::init('sort_field', $sortField)); $_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); } }