Info: This ns is auto-generated from the Stripe OpenAPI spec.
Info: This ns is auto-generated from the Stripe OpenAPI spec.
(create-configurations {:keys [body]})Create a Configuration
HTTP Method: POST Endpoint: /v1/terminal/configurations
Example Usage: (create-configurations {})
Create a Configuration
HTTP Method: POST
Endpoint: /v1/terminal/configurations
Example Usage:
(create-configurations {})(create-connection-tokens {:keys [body]})Create a Connection Token
HTTP Method: POST Endpoint: /v1/terminal/connection_tokens
Example Usage: (create-connection-tokens {})
Create a Connection Token
HTTP Method: POST
Endpoint: /v1/terminal/connection_tokens
Example Usage:
(create-connection-tokens {})(create-locations {:keys [body]})Create a Location
HTTP Method: POST Endpoint: /v1/terminal/locations
Example Usage: (create-locations {})
Create a Location
HTTP Method: POST
Endpoint: /v1/terminal/locations
Example Usage:
(create-locations {})(create-onboarding-links {:keys [body]})Create an Onboarding Link
HTTP Method: POST Endpoint: /v1/terminal/onboarding_links
Example Usage: (create-onboarding-links {})
Create an Onboarding Link
HTTP Method: POST
Endpoint: /v1/terminal/onboarding_links
Example Usage:
(create-onboarding-links {})(create-readers {:keys [body]})Create a Reader
HTTP Method: POST Endpoint: /v1/terminal/readers
Example Usage: (create-readers {})
Create a Reader
HTTP Method: POST
Endpoint: /v1/terminal/readers
Example Usage:
(create-readers {})(delete-configurations-configuration {:keys [configuration-id]})Delete a Configuration
HTTP Method: DELETE Endpoint: /v1/terminal/configurations/{configuration-id}
Path Parameters:
Example Usage: (delete-configurations-configuration {:configuration-id example-configuration-id})
Delete a Configuration
HTTP Method: DELETE
Endpoint: /v1/terminal/configurations/{configuration-id}
Path Parameters:
- configuration-id (String): The configuration-id parameter. (required)
Example Usage:
(delete-configurations-configuration {:configuration-id example-configuration-id})(delete-locations-location {:keys [location-id]})Delete a Location
HTTP Method: DELETE Endpoint: /v1/terminal/locations/{location-id}
Path Parameters:
Example Usage: (delete-locations-location {:location-id example-location-id})
Delete a Location
HTTP Method: DELETE
Endpoint: /v1/terminal/locations/{location-id}
Path Parameters:
- location-id (String): The location-id parameter. (required)
Example Usage:
(delete-locations-location {:location-id example-location-id})(delete-readers-reader {:keys [reader-id]})Delete a Reader
HTTP Method: DELETE Endpoint: /v1/terminal/readers/{reader-id}
Path Parameters:
Example Usage: (delete-readers-reader {:reader-id example-reader-id})
Delete a Reader
HTTP Method: DELETE
Endpoint: /v1/terminal/readers/{reader-id}
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(delete-readers-reader {:reader-id example-reader-id})(list-all-configurations {:keys [query-params]})List all Configurations
HTTP Method: GET Endpoint: /v1/terminal/configurations
Query Parameters:
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.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-configurations {:query-params {:limit 10}})
List all Configurations
HTTP Method: GET
Endpoint: /v1/terminal/configurations
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.
- is-account-default (Boolean): if present, only return the account default or non-default configurations.
- 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-configurations {:query-params {:limit 10}})(list-all-locations {:keys [query-params]})List all Locations
HTTP Method: GET Endpoint: /v1/terminal/locations
Query Parameters:
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.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-locations {:query-params {:limit 10}})
List all Locations
HTTP Method: GET
Endpoint: /v1/terminal/locations
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-locations {:query-params {:limit 10}})(list-all-readers {:keys [query-params]})List all Readers
HTTP Method: GET Endpoint: /v1/terminal/readers
Query Parameters:
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.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-readers {:query-params {:limit 10}})
List all Readers
HTTP Method: GET
Endpoint: /v1/terminal/readers
Query Parameters:
- device-type (String): Filters readers by device type
- 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.
- location (String): A location ID to filter the response list to only readers at the specific location
- serial-number (String): Filters readers by serial number
- 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): A status filter to filter readers to only offline or online readers
Example Usage:
(list-all-readers {:query-params {:limit 10}})(post-readers-reader-cancel-action {:keys [reader-id body]})Cancel the current reader action
HTTP Method: POST Endpoint: /v1/terminal/readers/{reader-id}/cancel_action
Path Parameters:
Example Usage: (post-readers-reader-cancel-action {:reader-id example-reader-id})
Cancel the current reader action
HTTP Method: POST
Endpoint: /v1/terminal/readers/{reader-id}/cancel_action
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(post-readers-reader-cancel-action {:reader-id example-reader-id})(post-readers-reader-collect-inputs {:keys [reader-id body]})Collect inputs using a Reader
HTTP Method: POST Endpoint: /v1/terminal/readers/{reader-id}/collect_inputs
Path Parameters:
Example Usage: (post-readers-reader-collect-inputs {:reader-id example-reader-id})
Collect inputs using a Reader
HTTP Method: POST
Endpoint: /v1/terminal/readers/{reader-id}/collect_inputs
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(post-readers-reader-collect-inputs {:reader-id example-reader-id})(post-readers-reader-collect-payment-method {:keys [reader-id body]})Hand off a PaymentIntent to a Reader and collect card details
HTTP Method: POST Endpoint: /v1/terminal/readers/{reader-id}/collect_payment_method
Path Parameters:
Example Usage: (post-readers-reader-collect-payment-method {:reader-id example-reader-id})
Hand off a PaymentIntent to a Reader and collect card details
HTTP Method: POST
Endpoint: /v1/terminal/readers/{reader-id}/collect_payment_method
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(post-readers-reader-collect-payment-method {:reader-id example-reader-id})(post-readers-reader-confirm-payment-intent {:keys [reader-id body]})Confirm a PaymentIntent on the Reader
HTTP Method: POST Endpoint: /v1/terminal/readers/{reader-id}/confirm_payment_intent
Path Parameters:
Example Usage: (post-readers-reader-confirm-payment-intent {:reader-id example-reader-id})
Confirm a PaymentIntent on the Reader
HTTP Method: POST
Endpoint: /v1/terminal/readers/{reader-id}/confirm_payment_intent
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(post-readers-reader-confirm-payment-intent {:reader-id example-reader-id})(post-readers-reader-process-payment-intent {:keys [reader-id body]})Hand-off a PaymentIntent to a Reader
HTTP Method: POST Endpoint: /v1/terminal/readers/{reader-id}/process_payment_intent
Path Parameters:
Example Usage: (post-readers-reader-process-payment-intent {:reader-id example-reader-id})
Hand-off a PaymentIntent to a Reader
HTTP Method: POST
Endpoint: /v1/terminal/readers/{reader-id}/process_payment_intent
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(post-readers-reader-process-payment-intent {:reader-id example-reader-id})(post-readers-reader-process-setup-intent {:keys [reader-id body]})Hand-off a SetupIntent to a Reader
HTTP Method: POST Endpoint: /v1/terminal/readers/{reader-id}/process_setup_intent
Path Parameters:
Example Usage: (post-readers-reader-process-setup-intent {:reader-id example-reader-id})
Hand-off a SetupIntent to a Reader
HTTP Method: POST
Endpoint: /v1/terminal/readers/{reader-id}/process_setup_intent
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(post-readers-reader-process-setup-intent {:reader-id example-reader-id})(post-readers-reader-refund-payment {:keys [reader-id body]})Refund a Charge or a PaymentIntent in-person
HTTP Method: POST Endpoint: /v1/terminal/readers/{reader-id}/refund_payment
Path Parameters:
Example Usage: (post-readers-reader-refund-payment {:reader-id example-reader-id})
Refund a Charge or a PaymentIntent in-person
HTTP Method: POST
Endpoint: /v1/terminal/readers/{reader-id}/refund_payment
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(post-readers-reader-refund-payment {:reader-id example-reader-id})(post-readers-reader-set-reader-display {:keys [reader-id body]})Set reader display
HTTP Method: POST Endpoint: /v1/terminal/readers/{reader-id}/set_reader_display
Path Parameters:
Example Usage: (post-readers-reader-set-reader-display {:reader-id example-reader-id})
Set reader display
HTTP Method: POST
Endpoint: /v1/terminal/readers/{reader-id}/set_reader_display
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(post-readers-reader-set-reader-display {:reader-id example-reader-id})(retrieve-configurations-configuration {:keys [configuration-id query-params]})Retrieve a Configuration
HTTP Method: GET Endpoint: /v1/terminal/configurations/{configuration-id}
Path Parameters:
Query Parameters:
Example Usage: (retrieve-configurations-configuration {:configuration-id example-configuration-id :query-params {:limit 10}})
Retrieve a Configuration
HTTP Method: GET
Endpoint: /v1/terminal/configurations/{configuration-id}
Path Parameters:
- configuration-id (String): The configuration-id parameter. (required)
Query Parameters:
- expand (Array): Specifies which fields in the response should be expanded.
Example Usage:
(retrieve-configurations-configuration {:configuration-id example-configuration-id :query-params {:limit 10}})(retrieve-locations-location {:keys [location-id query-params]})Retrieve a Location
HTTP Method: GET Endpoint: /v1/terminal/locations/{location-id}
Path Parameters:
Query Parameters:
Example Usage: (retrieve-locations-location {:location-id example-location-id :query-params {:limit 10}})
Retrieve a Location
HTTP Method: GET
Endpoint: /v1/terminal/locations/{location-id}
Path Parameters:
- location-id (String): The location-id parameter. (required)
Query Parameters:
- expand (Array): Specifies which fields in the response should be expanded.
Example Usage:
(retrieve-locations-location {:location-id example-location-id :query-params {:limit 10}})(retrieve-readers-reader {:keys [reader-id query-params]})Retrieve a Reader
HTTP Method: GET Endpoint: /v1/terminal/readers/{reader-id}
Path Parameters:
Query Parameters:
Example Usage: (retrieve-readers-reader {:reader-id example-reader-id :query-params {:limit 10}})
Retrieve a Reader
HTTP Method: GET
Endpoint: /v1/terminal/readers/{reader-id}
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Query Parameters:
- expand (Array): Specifies which fields in the response should be expanded.
Example Usage:
(retrieve-readers-reader {:reader-id example-reader-id :query-params {:limit 10}})(update-configurations-configuration {:keys [configuration-id body]})Update a Configuration
HTTP Method: POST Endpoint: /v1/terminal/configurations/{configuration-id}
Path Parameters:
Example Usage: (update-configurations-configuration {:configuration-id example-configuration-id})
Update a Configuration
HTTP Method: POST
Endpoint: /v1/terminal/configurations/{configuration-id}
Path Parameters:
- configuration-id (String): The configuration-id parameter. (required)
Example Usage:
(update-configurations-configuration {:configuration-id example-configuration-id})(update-locations-location {:keys [location-id body]})Update a Location
HTTP Method: POST Endpoint: /v1/terminal/locations/{location-id}
Path Parameters:
Example Usage: (update-locations-location {:location-id example-location-id})
Update a Location
HTTP Method: POST
Endpoint: /v1/terminal/locations/{location-id}
Path Parameters:
- location-id (String): The location-id parameter. (required)
Example Usage:
(update-locations-location {:location-id example-location-id})(update-readers-reader {:keys [reader-id body]})Update a Reader
HTTP Method: POST Endpoint: /v1/terminal/readers/{reader-id}
Path Parameters:
Example Usage: (update-readers-reader {:reader-id example-reader-id})
Update a Reader
HTTP Method: POST
Endpoint: /v1/terminal/readers/{reader-id}
Path Parameters:
- reader-id (String): The reader-id parameter. (required)
Example Usage:
(update-readers-reader {:reader-id example-reader-id})cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |