stream.clojure.stripe.api.payouts — stream.clojure/stripe-clojure 1.0.0-beta.1

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

create clj

(create {:keys [body]})

Create a payout

HTTP Method: POST Endpoint: /v1/payouts

Example Usage: (create {})

list-all clj

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

List all payouts

HTTP Method: GET Endpoint: /v1/payouts

Query Parameters:

• arrival-date (Unknown): Only return payouts that are expected to arrive during the given date interval.
• created (Unknown): Only return payouts that were created during the given date interval.
• destination (String): The ID of an external account - only return payouts sent to this external account.
• 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.
• status (String): Only return payouts that have the given status: pending, paid, failed, or canceled.

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

post-payout-cancel clj

(post-payout-cancel {:keys [payout-id body]})

Cancel a payout

HTTP Method: POST Endpoint: /v1/payouts/{payout-id}/cancel

Path Parameters:

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

Example Usage: (post-payout-cancel {:payout-id example-payout-id})

post-payout-reverse clj

(post-payout-reverse {:keys [payout-id body]})

Reverse a payout

HTTP Method: POST Endpoint: /v1/payouts/{payout-id}/reverse

Path Parameters:

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

Example Usage: (post-payout-reverse {:payout-id example-payout-id})

retrieve-payout clj

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

Retrieve a payout

HTTP Method: GET Endpoint: /v1/payouts/{payout-id}

Path Parameters:

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

Query Parameters:

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

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

update-payout clj

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

Update a payout

HTTP Method: POST Endpoint: /v1/payouts/{payout-id}

Path Parameters:

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

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