POST /v1/terminal/readers/{reader}/collect_payment_method
Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
reader |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
payment_intent |
String | Yes |
PaymentIntent ID. |
collect_config |
Object | No |
Configuration overrides. |
collect_config.skip_tipping |
Boolean | No | |
collect_config.allow_redisplay |
String | No |
Possible values:
|
collect_config.enable_customer_cancellation |
Boolean | No | |
collect_config.tipping |
Object | No | |
collect_config.tipping.amount_eligible |
Integer | No | |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.