Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.payment-intents

Info: This ns is auto-generated from the Stripe OpenAPI spec.

Info: This ns is auto-generated from the Stripe OpenAPI spec.
raw docstring

create-payment-intentsclj

(create-payment-intents {:keys [body]})

Create a PaymentIntent

HTTP Method: POST Endpoint: /v1/payment_intents

Example Usage: (create-payment-intents {})

Create a PaymentIntent

HTTP Method: POST
Endpoint: /v1/payment_intents

Example Usage:
  (create-payment-intents {})
sourceraw docstring

list-all-payment-intentsclj

(list-all-payment-intents {:keys [query-params]})

List all PaymentIntents

HTTP Method: GET Endpoint: /v1/payment_intents

Query Parameters:

  • created (Unknown): A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
  • customer (String): Only return PaymentIntents for the customer that this customer ID specifies.
  • customer-account (String): Only return PaymentIntents for the account representing the customer that this ID specifies.
  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Example Usage: (list-all-payment-intents {:query-params {:limit 10}})

List all PaymentIntents

HTTP Method: GET
Endpoint: /v1/payment_intents

Query Parameters:
  - created (Unknown): A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
  - customer (String): Only return PaymentIntents for the customer that this customer ID specifies.
  - customer-account (String): Only return PaymentIntents for the account representing the customer that this ID specifies.
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Example Usage:
  (list-all-payment-intents {:query-params {:limit 10}})
sourceraw docstring

list-all-payment-intents-intent-amount-details-line-itemsclj

(list-all-payment-intents-intent-amount-details-line-items
  {:keys [payment-intent-id query-params]})

List all PaymentIntent LineItems

HTTP Method: GET Endpoint: /v1/payment_intents/{payment-intent-id}/amount_details_line_items

Path Parameters:

  • payment-intent-id (String): The payment-intent-id parameter. (required)

Query Parameters:

  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Example Usage: (list-all-payment-intents-intent-amount-details-line-items {:payment-intent-id example-payment-intent-id :query-params {:limit 10}})

List all PaymentIntent LineItems

HTTP Method: GET
Endpoint: /v1/payment_intents/{payment-intent-id}/amount_details_line_items

Path Parameters:
  - payment-intent-id (String): The payment-intent-id parameter. (required)

Query Parameters:
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Example Usage:
  (list-all-payment-intents-intent-amount-details-line-items {:payment-intent-id example-payment-intent-id :query-params {:limit 10}})
sourceraw docstring

(list-all-payment-intents-search {:keys [query-params]})

Search PaymentIntents

HTTP Method: GET Endpoint: /v1/payment_intents/search

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • page (String): A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
  • query (String): The search query string. See search query language and the list of supported query fields for payment intents. (required)

Example Usage: (list-all-payment-intents-search {:query-params {:limit 10}})

Search PaymentIntents

HTTP Method: GET
Endpoint: /v1/payment_intents/search

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - page (String): A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
  - query (String): The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for payment intents](https://docs.stripe.com/search#query-fields-for-payment-intents). (required)

Example Usage:
  (list-all-payment-intents-search {:query-params {:limit 10}})
sourceraw docstring

post-payment-intents-intent-apply-customer-balanceclj

(post-payment-intents-intent-apply-customer-balance {:keys [payment-intent-id
                                                            body]})

Reconcile a customer_balance PaymentIntent

HTTP Method: POST Endpoint: /v1/payment_intents/{payment-intent-id}/apply_customer_balance

Path Parameters:

  • payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage: (post-payment-intents-intent-apply-customer-balance {:payment-intent-id example-payment-intent-id})

Reconcile a customer_balance PaymentIntent

HTTP Method: POST
Endpoint: /v1/payment_intents/{payment-intent-id}/apply_customer_balance

Path Parameters:
  - payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage:
  (post-payment-intents-intent-apply-customer-balance {:payment-intent-id example-payment-intent-id})
sourceraw docstring

post-payment-intents-intent-cancelclj

(post-payment-intents-intent-cancel {:keys [payment-intent-id body]})

Cancel a PaymentIntent

HTTP Method: POST Endpoint: /v1/payment_intents/{payment-intent-id}/cancel

Path Parameters:

  • payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage: (post-payment-intents-intent-cancel {:payment-intent-id example-payment-intent-id})

Cancel a PaymentIntent

HTTP Method: POST
Endpoint: /v1/payment_intents/{payment-intent-id}/cancel

Path Parameters:
  - payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage:
  (post-payment-intents-intent-cancel {:payment-intent-id example-payment-intent-id})
sourceraw docstring

post-payment-intents-intent-captureclj

(post-payment-intents-intent-capture {:keys [payment-intent-id body]})

Capture a PaymentIntent

HTTP Method: POST Endpoint: /v1/payment_intents/{payment-intent-id}/capture

Path Parameters:

  • payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage: (post-payment-intents-intent-capture {:payment-intent-id example-payment-intent-id})

Capture a PaymentIntent

HTTP Method: POST
Endpoint: /v1/payment_intents/{payment-intent-id}/capture

Path Parameters:
  - payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage:
  (post-payment-intents-intent-capture {:payment-intent-id example-payment-intent-id})
sourceraw docstring

post-payment-intents-intent-confirmclj

(post-payment-intents-intent-confirm {:keys [payment-intent-id body]})

Confirm a PaymentIntent

HTTP Method: POST Endpoint: /v1/payment_intents/{payment-intent-id}/confirm

Path Parameters:

  • payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage: (post-payment-intents-intent-confirm {:payment-intent-id example-payment-intent-id})

Confirm a PaymentIntent

HTTP Method: POST
Endpoint: /v1/payment_intents/{payment-intent-id}/confirm

Path Parameters:
  - payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage:
  (post-payment-intents-intent-confirm {:payment-intent-id example-payment-intent-id})
sourceraw docstring

post-payment-intents-intent-increment-authorizationclj

(post-payment-intents-intent-increment-authorization {:keys [payment-intent-id
                                                             body]})

Increment an authorization

HTTP Method: POST Endpoint: /v1/payment_intents/{payment-intent-id}/increment_authorization

Path Parameters:

  • payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage: (post-payment-intents-intent-increment-authorization {:payment-intent-id example-payment-intent-id})

Increment an authorization

HTTP Method: POST
Endpoint: /v1/payment_intents/{payment-intent-id}/increment_authorization

Path Parameters:
  - payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage:
  (post-payment-intents-intent-increment-authorization {:payment-intent-id example-payment-intent-id})
sourceraw docstring

post-payment-intents-intent-verify-microdepositsclj

(post-payment-intents-intent-verify-microdeposits {:keys [payment-intent-id
                                                          body]})

Verify microdeposits on a PaymentIntent

HTTP Method: POST Endpoint: /v1/payment_intents/{payment-intent-id}/verify_microdeposits

Path Parameters:

  • payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage: (post-payment-intents-intent-verify-microdeposits {:payment-intent-id example-payment-intent-id})

Verify microdeposits on a PaymentIntent

HTTP Method: POST
Endpoint: /v1/payment_intents/{payment-intent-id}/verify_microdeposits

Path Parameters:
  - payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage:
  (post-payment-intents-intent-verify-microdeposits {:payment-intent-id example-payment-intent-id})
sourceraw docstring

retrieve-payment-intents-intentclj

(retrieve-payment-intents-intent {:keys [payment-intent-id query-params]})

Retrieve a PaymentIntent

HTTP Method: GET Endpoint: /v1/payment_intents/{payment-intent-id}

Path Parameters:

  • payment-intent-id (String): The payment-intent-id parameter. (required)

Query Parameters:

  • client-secret (String): The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.
  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-payment-intents-intent {:payment-intent-id example-payment-intent-id :query-params {:limit 10}})

Retrieve a PaymentIntent

HTTP Method: GET
Endpoint: /v1/payment_intents/{payment-intent-id}

Path Parameters:
  - payment-intent-id (String): The payment-intent-id parameter. (required)

Query Parameters:
  - client-secret (String): The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-payment-intents-intent {:payment-intent-id example-payment-intent-id :query-params {:limit 10}})
sourceraw docstring

update-payment-intents-intentclj

(update-payment-intents-intent {:keys [payment-intent-id body]})

Update a PaymentIntent

HTTP Method: POST Endpoint: /v1/payment_intents/{payment-intent-id}

Path Parameters:

  • payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage: (update-payment-intents-intent {:payment-intent-id example-payment-intent-id})

Update a PaymentIntent

HTTP Method: POST
Endpoint: /v1/payment_intents/{payment-intent-id}

Path Parameters:
  - payment-intent-id (String): The payment-intent-id parameter. (required)

Example Usage:
  (update-payment-intents-intent {:payment-intent-id example-payment-intent-id})
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close