Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.transfers

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

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

createclj

(create {:keys [body]})

Create a transfer

HTTP Method: POST Endpoint: /v1/transfers

Example Usage: (create {})

Create a transfer

HTTP Method: POST
Endpoint: /v1/transfers

Example Usage:
  (create {})
sourceraw docstring

create-id-reversalsclj

(create-id-reversals {:keys [transfer-id body]})

Create a transfer reversal

HTTP Method: POST Endpoint: /v1/transfers/{transfer-id}/reversals

Path Parameters:

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

Example Usage: (create-id-reversals {:transfer-id example-transfer-id})

Create a transfer reversal

HTTP Method: POST
Endpoint: /v1/transfers/{transfer-id}/reversals

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

Example Usage:
  (create-id-reversals {:transfer-id example-transfer-id})
sourceraw docstring

list-allclj

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

List all transfers

HTTP Method: GET Endpoint: /v1/transfers

Query Parameters:

  • created (Unknown): Only return transfers that were created during the given date interval.
  • destination (String): Only return transfers for the destination specified by this account 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.
  • 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 transfers with the specified transfer group.

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

List all transfers

HTTP Method: GET
Endpoint: /v1/transfers

Query Parameters:
  - created (Unknown): Only return transfers that were created during the given date interval.
  - destination (String): Only return transfers for the destination specified by this account 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.
  - 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 transfers with the specified transfer group.

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

list-all-id-reversalsclj

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

List all reversals

HTTP Method: GET Endpoint: /v1/transfers/{transfer-id}/reversals

Path Parameters:

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

List all reversals

HTTP Method: GET
Endpoint: /v1/transfers/{transfer-id}/reversals

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

retrieve-transferclj

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

Retrieve a transfer

HTTP Method: GET Endpoint: /v1/transfers/{transfer-id}

Path Parameters:

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

Query Parameters:

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

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

Retrieve a transfer

HTTP Method: GET
Endpoint: /v1/transfers/{transfer-id}

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

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

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

retrieve-transfer-reversals-idclj

(retrieve-transfer-reversals-id {:keys [transfer-id reversal-id query-params]})

Retrieve a reversal

HTTP Method: GET Endpoint: /v1/transfers/{transfer-id}/reversals/{reversal-id}

Path Parameters:

  • transfer-id (String): The transfer-id parameter. (required)
  • reversal-id (String): The reversal-id parameter. (required)

Query Parameters:

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

Example Usage: (retrieve-transfer-reversals-id {:transfer-id example-transfer-id :reversal-id example-reversal-id :query-params {:limit 10}})

Retrieve a reversal

HTTP Method: GET
Endpoint: /v1/transfers/{transfer-id}/reversals/{reversal-id}

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

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

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

update-transferclj

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

Update a transfer

HTTP Method: POST Endpoint: /v1/transfers/{transfer-id}

Path Parameters:

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

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

Update a transfer

HTTP Method: POST
Endpoint: /v1/transfers/{transfer-id}

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

Example Usage:
  (update-transfer {:transfer-id example-transfer-id})
sourceraw docstring

update-transfer-reversals-idclj

(update-transfer-reversals-id {:keys [transfer-id reversal-id body]})

Update a reversal

HTTP Method: POST Endpoint: /v1/transfers/{transfer-id}/reversals/{reversal-id}

Path Parameters:

  • transfer-id (String): The transfer-id parameter. (required)
  • reversal-id (String): The reversal-id parameter. (required)

Example Usage: (update-transfer-reversals-id {:transfer-id example-transfer-id :reversal-id example-reversal-id})

Update a reversal

HTTP Method: POST
Endpoint: /v1/transfers/{transfer-id}/reversals/{reversal-id}

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

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