* * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function all($params = null, $opts = null) { return $this->requestCollection('get', '/v1/charges', $params, $opts); } /** * Capture the payment of an existing, uncaptured charge that was created with the * capture option set to false. * * Uncaptured payments expire a set number of days after they are created (7 by default), after which they are * marked as refunded and capture attempts will fail. * * Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent. * * @param string $id * @param null|array{amount?: int, application_fee?: int, application_fee_amount?: int, expand?: string[], receipt_email?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int}, transfer_group?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @return \Stripe\Charge * * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function capture($id, $params = null, $opts = null) { return $this->request('post', $this->buildPath('/v1/charges/%s/capture', $id), $params, $opts); } /** * This method is no longer recommended—use the Payment Intents API to initiate a new * payment instead. Confirmation of the PaymentIntent creates the * Charge object used to request payment. * * @param null|array{amount?: int, application_fee?: int, application_fee_amount?: int, capture?: bool, currency?: string, customer?: string, description?: string, destination?: array{account: string, amount?: int}, expand?: string[], metadata?: null|array, on_behalf_of?: string, radar_options?: array{session?: string}, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, source?: string, statement_descriptor?: string, statement_descriptor_suffix?: string, transfer_data?: array{amount?: int, destination: string}, transfer_group?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @return \Stripe\Charge * * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function create($params = null, $opts = null) { return $this->request('post', '/v1/charges', $params, $opts); } /** * Retrieves the details of a charge that has previously been created. Supply the * unique charge ID that was returned from your previous request, and Stripe will * return the corresponding charge information. The same information is returned * when creating or refunding the charge. * * @param string $id * @param null|array{expand?: string[]} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @return \Stripe\Charge * * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function retrieve($id, $params = null, $opts = null) { return $this->request('get', $this->buildPath('/v1/charges/%s', $id), $params, $opts); } /** * Search for charges you’ve previously created using Stripe’s Search Query Language. Don’t use * search in read-after-write flows where strict consistency is necessary. Under * normal operating conditions, data is searchable in less than a minute. * Occasionally, propagation of new or updated data can be up to an hour behind * during outages. Search functionality is not available to merchants in India. * * @param null|array{expand?: string[], limit?: int, page?: string, query: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @return \Stripe\SearchResult<\Stripe\Charge> * * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function search($params = null, $opts = null) { return $this->requestSearchResult('get', '/v1/charges/search', $params, $opts); } /** * Updates the specified charge by setting the values of the parameters passed. Any * parameters not provided will be left unchanged. * * @param string $id * @param null|array{customer?: string, description?: string, expand?: string[], fraud_details?: array{user_report: null|string}, metadata?: null|array, receipt_email?: string, shipping?: array{address: array{city?: string, country?: string, line1?: string, line2?: string, postal_code?: string, state?: string}, carrier?: string, name: string, phone?: string, tracking_number?: string}, transfer_group?: string} $params * @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts * * @return \Stripe\Charge * * @throws \Stripe\Exception\ApiErrorException if the request fails */ public function update($id, $params = null, $opts = null) { return $this->request('post', $this->buildPath('/v1/charges/%s', $id), $params, $opts); } }