Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.charges

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-charge-refundclj

(create-charge-refund {:keys [charge-id body]})

Create a refund

HTTP Method: POST Endpoint: /v1/charges/{charge-id}/refund

Path Parameters:

  • charge-id (String): The identifier of the charge to refund.

Example Usage: (create-charge-refund {:charge-id example-charge-id})

Create a refund

HTTP Method: POST
Endpoint: /v1/charges/{charge-id}/refund

Path Parameters:
  - charge-id (String): The identifier of the charge to refund.

Example Usage:
  (create-charge-refund {:charge-id example-charge-id})
sourceraw docstring

create-charge-refundsclj

(create-charge-refunds {:keys [charge-id body]})

Create customer balance refund

HTTP Method: POST Endpoint: /v1/charges/{charge-id}/refunds

Path Parameters:

  • charge-id (String): The identifier of the charge to refund.

Example Usage: (create-charge-refunds {:charge-id example-charge-id})

Create customer balance refund

HTTP Method: POST
Endpoint: /v1/charges/{charge-id}/refunds

Path Parameters:
  - charge-id (String): The identifier of the charge to refund.

Example Usage:
  (create-charge-refunds {:charge-id example-charge-id})
sourceraw docstring

list-allclj

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

List all charges

HTTP Method: GET Endpoint: /v1/charges

Query Parameters:

  • created (Unknown): Only return charges that were created during the given date interval.
  • customer (String): Only return charges for the customer specified by this customer ID.
  • 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.
  • payment-intent (String): Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
  • 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.
  • transfer-group (String): Only return charges for this transfer group, limited to 100.

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

List all charges

HTTP Method: GET
Endpoint: /v1/charges

Query Parameters:
  - created (Unknown): Only return charges that were created during the given date interval.
  - customer (String): Only return charges for the customer specified by this customer ID.
  - 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.
  - payment-intent (String): Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
  - 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.
  - transfer-group (String): Only return charges for this transfer group, limited to 100.

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

list-all-charge-disputeclj

(list-all-charge-dispute {:keys [charge-id query-params]})

No description available.

HTTP Method: GET Endpoint: /v1/charges/{charge-id}/dispute

Path Parameters:

  • charge-id (String): The charge-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (list-all-charge-dispute {:charge-id example-charge-id :query-params {:limit 10}})

No description available.

HTTP Method: GET
Endpoint: /v1/charges/{charge-id}/dispute

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

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (list-all-charge-dispute {:charge-id example-charge-id :query-params {:limit 10}})
sourceraw docstring

list-all-charge-refundsclj

(list-all-charge-refunds {:keys [charge-id query-params]})

List all refunds

HTTP Method: GET Endpoint: /v1/charges/{charge-id}/refunds

Path Parameters:

  • charge-id (String): The charge-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-charge-refunds {:charge-id example-charge-id :query-params {:limit 10}})

List all refunds

HTTP Method: GET
Endpoint: /v1/charges/{charge-id}/refunds

Path Parameters:
  - charge-id (String): The charge-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-charge-refunds {:charge-id example-charge-id :query-params {:limit 10}})
sourceraw docstring

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

Search charges

HTTP Method: GET Endpoint: /v1/charges/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 charges. (required)

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

Search charges

HTTP Method: GET
Endpoint: /v1/charges/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 charges](https://docs.stripe.com/search#query-fields-for-charges). (required)

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

postclj

(post {:keys [body]})

No description available.

HTTP Method: POST Endpoint: /v1/charges

Example Usage: (post {})

No description available.

HTTP Method: POST
Endpoint: /v1/charges

Example Usage:
  (post {})
sourceraw docstring

post-charge-captureclj

(post-charge-capture {:keys [charge-id body]})

Capture a payment

HTTP Method: POST Endpoint: /v1/charges/{charge-id}/capture

Path Parameters:

  • charge-id (String): The charge-id parameter. (required)

Example Usage: (post-charge-capture {:charge-id example-charge-id})

Capture a payment

HTTP Method: POST
Endpoint: /v1/charges/{charge-id}/capture

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

Example Usage:
  (post-charge-capture {:charge-id example-charge-id})
sourceraw docstring

post-charge-disputeclj

(post-charge-dispute {:keys [charge-id body]})

No description available.

HTTP Method: POST Endpoint: /v1/charges/{charge-id}/dispute

Path Parameters:

  • charge-id (String): The charge-id parameter. (required)

Example Usage: (post-charge-dispute {:charge-id example-charge-id})

No description available.

HTTP Method: POST
Endpoint: /v1/charges/{charge-id}/dispute

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

Example Usage:
  (post-charge-dispute {:charge-id example-charge-id})
sourceraw docstring

post-charge-dispute-closeclj

(post-charge-dispute-close {:keys [charge-id body]})

No description available.

HTTP Method: POST Endpoint: /v1/charges/{charge-id}/dispute/close

Path Parameters:

  • charge-id (String): The charge-id parameter. (required)

Example Usage: (post-charge-dispute-close {:charge-id example-charge-id})

No description available.

HTTP Method: POST
Endpoint: /v1/charges/{charge-id}/dispute/close

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

Example Usage:
  (post-charge-dispute-close {:charge-id example-charge-id})
sourceraw docstring

post-charge-refunds-refundclj

(post-charge-refunds-refund {:keys [charge-id refund-id body]})

No description available.

HTTP Method: POST Endpoint: /v1/charges/{charge-id}/refunds/{refund-id}

Path Parameters:

  • charge-id (String): The charge-id parameter. (required)
  • refund-id (String): The refund-id parameter. (required)

Example Usage: (post-charge-refunds-refund {:charge-id example-charge-id :refund-id example-refund-id})

No description available.

HTTP Method: POST
Endpoint: /v1/charges/{charge-id}/refunds/{refund-id}

Path Parameters:
  - charge-id (String): The charge-id parameter. (required)
  - refund-id (String): The refund-id parameter. (required)

Example Usage:
  (post-charge-refunds-refund {:charge-id example-charge-id :refund-id example-refund-id})
sourceraw docstring

retrieve-chargeclj

(retrieve-charge {:keys [charge-id query-params]})

Retrieve a charge

HTTP Method: GET Endpoint: /v1/charges/{charge-id}

Path Parameters:

  • charge-id (String): The charge-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-charge {:charge-id example-charge-id :query-params {:limit 10}})

Retrieve a charge

HTTP Method: GET
Endpoint: /v1/charges/{charge-id}

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

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

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

retrieve-charge-refunds-refundclj

(retrieve-charge-refunds-refund {:keys [charge-id refund-id query-params]})

No description available.

HTTP Method: GET Endpoint: /v1/charges/{charge-id}/refunds/{refund-id}

Path Parameters:

  • charge-id (String): The charge-id parameter. (required)
  • refund-id (String): The refund-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-charge-refunds-refund {:charge-id example-charge-id :refund-id example-refund-id :query-params {:limit 10}})

No description available.

HTTP Method: GET
Endpoint: /v1/charges/{charge-id}/refunds/{refund-id}

Path Parameters:
  - charge-id (String): The charge-id parameter. (required)
  - refund-id (String): The refund-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-charge-refunds-refund {:charge-id example-charge-id :refund-id example-refund-id :query-params {:limit 10}})
sourceraw docstring

update-chargeclj

(update-charge {:keys [charge-id body]})

Update a charge

HTTP Method: POST Endpoint: /v1/charges/{charge-id}

Path Parameters:

  • charge-id (String): The charge-id parameter. (required)

Example Usage: (update-charge {:charge-id example-charge-id})

Update a charge

HTTP Method: POST
Endpoint: /v1/charges/{charge-id}

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

Example Usage:
  (update-charge {:charge-id example-charge-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