POST /v1/terminal/readers/{reader}/process_payment_intent

Initiates a payment flow on a Reader. See process the payment for more details.

Servers

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
process_config Object No

Configuration overrides for this transaction, such as tipping and customer cancellation settings.

process_config.skip_tipping Boolean No
process_config.allow_redisplay String No

Valid values:

  • "limited"
  • "unspecified"
  • "always"
process_config.enable_customer_cancellation Boolean No
process_config.return_url String No
process_config.tipping Object No
process_config.tipping.amount_eligible Integer No
payment_intent String Yes

The ID of the PaymentIntent to process on the reader.

expand[] Array No

Specifies which fields in the response should be expanded.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.