requestCollection('get', '/v1/payment_intents', $params, $opts);
}
/**
* A PaymentIntent object can be canceled when it is in one of these statuses:
* requires_payment_method
, requires_capture
,
* requires_confirmation
, requires_action
, or
* processing
.
*
* Once canceled, no additional charges will be made by the PaymentIntent and any
* operations on the PaymentIntent will fail with an error. For PaymentIntents with
* status=’requires_capture’
, the remaining
* amount_capturable
will automatically be refunded.
*
* @param string $id
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\PaymentIntent
*/
public function cancel($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/payment_intents/%s/cancel', $id), $params, $opts);
}
/**
* Capture the funds of an existing uncaptured PaymentIntent when its status is
* requires_capture
.
*
* Uncaptured PaymentIntents will be canceled a set number of days after they are
* created (7 by default).
*
* Learn more about separate authorization
* and capture.
*
* @param string $id
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\PaymentIntent
*/
public function capture($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/payment_intents/%s/capture', $id), $params, $opts);
}
/**
* Confirm that your customer intends to pay with current or provided payment
* method. Upon confirmation, the PaymentIntent will attempt to initiate a payment.
*
* If the selected payment method requires additional authentication steps, the
* PaymentIntent will transition to the requires_action
status and
* suggest additional actions via next_action
. If payment fails, the
* PaymentIntent will transition to the requires_payment_method
* status. If payment succeeds, the PaymentIntent will transition to the
* succeeded
status (or requires_capture
, if
* capture_method
is set to manual
).
*
* If the confirmation_method
is automatic
, payment may
* be attempted using our client SDKs and
* the PaymentIntent’s client_secret. After
* next_action
s are handled by the client, no additional confirmation
* is required to complete the payment.
*
* If the confirmation_method
is manual
, all payment
* attempts must be initiated using a secret key. If any actions are required for
* the payment, the PaymentIntent will return to the
* requires_confirmation
state after those actions are completed. Your
* server needs to then explicitly re-confirm the PaymentIntent to initiate the
* next payment attempt. Read the expanded documentation to
* learn more about manual confirmation.
*
* @param string $id
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\PaymentIntent
*/
public function confirm($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/payment_intents/%s/confirm', $id), $params, $opts);
}
/**
* Creates a PaymentIntent object.
*
* After the PaymentIntent is created, attach a payment method and confirm to continue the payment.
* You can read more about the different payment flows available via the Payment
* Intents API here.
*
* When confirm=true
is used during creation, it is equivalent to
* creating and confirming the PaymentIntent in the same call. You may use any
* parameters available in the confirm
* API when confirm=true
is supplied.
*
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\PaymentIntent
*/
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/payment_intents', $params, $opts);
}
/**
* Retrieves the details of a PaymentIntent that has previously been created.
*
* Client-side retrieval using a publishable key is allowed when the
* client_secret
is provided in the query string.
*
* When retrieved with a publishable key, only a subset of properties will be
* returned. Please refer to the payment
* intent object reference for more details.
*
* @param string $id
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\PaymentIntent
*/
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/payment_intents/%s', $id), $params, $opts);
}
/**
* Updates properties on a PaymentIntent object without confirming.
*
* Depending on which properties you update, you may need to confirm the
* PaymentIntent again. For example, updating the payment_method
will
* always require you to confirm the PaymentIntent again. If you prefer to update
* and confirm at the same time, we recommend updating properties via the confirm API instead.
*
* @param string $id
* @param null|array $params
* @param null|array|\Stripe\Util\RequestOptions $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\PaymentIntent
*/
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/payment_intents/%s', $id), $params, $opts);
}
}