SetupIntent

customerId
string <uuid>

The unique identifier for the customer record.

id
string <uuid>

The identifier of the setup intent.

paymentMethodId
string <uuid> (PaymentMethodId)

The unique identifier of the payment method.

sessionSecret
string

A unique and randomized identifier for the setup intent.

status
string (SetupIntentStatus)
Default: "REQUIRES_PAYMENT_METHOD"

Status of the setup intent.

Enum: "REQUIRES_PAYMENT_METHOD" "PROCESSING" "SUCCEEDED"
usage
string (Usage)
Default: "ON_SESSION"

The usage of the setup intent. Use ON_SESSION for payments made when customer are present and OFF_SESSION for payments made when customer are not present.

Enum: "ON_SESSION" "OFF_SESSION"
{
  • "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"
}