Confirm a setup intent

Confirms a setup intent.

SecurityOAuth2
Request
path Parameters
id
required
string <uuid>

The identifier of the setup intent.

Request Body schema: application/json
paymentMethodId
string

The unique identifier of the payment method.

sessionSecret
required
string

A unique and randomized identifier for the setup intent.

Responses
200

Successful operation. Setup intent confirmed.

400

Bad request / Missing required fields.

403

Insufficient scopes.

404

Intent expired / Intent does not exist.

429

Too many requests.

500

Internal server error.

post/v1/setup-intents/{id}/confirm
Request samples
application/json
{
  • "paymentMethodId": "string",
  • "sessionSecret": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "sessionSecret": "string",
  • "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
  • "status": "REQUIRES_PAYMENT_METHOD",
  • "usage": "ON_SESSION",
  • "externalReferenceId": "string",
  • "standingInstructionType": "UNSCHEDULED",
  • "mandateId": "d4dbf0da-b5aa-43ae-b9db-c2aff331d3ad",
  • "paymentMethodTypes": [ ]
}