CreateSetupIntentRequest

customerId
required
string <uuid>

The unique identifier for the customer record.

externalReferenceId
string

The unique identifier for the setup intent generated by the integration partner.

usage
required
string (Usage)
Default: "ON_SESSION"

Field used to determine what type of transaction the saved card will be set up for.

  • ON_SESSION - Set up and save a payment method to the customer’s profile for customer-initiated transactions.
  • OFF_SESSION - Set up a payment method for merchant-initiated transactions. The payment method can also be set up and saved to the customer’s profile for customer-initiated transactions.
Enum: "ON_SESSION" "OFF_SESSION"
{
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "usage": "ON_SESSION",
  • "externalReferenceId": "string"
}