SetupIntent

customerId
string <uuid>

The unique identifier for the customer record.

externalReferenceId
string

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

id
string <uuid>

The identifier of the setup intent.

mandateId
string <uuid>

The unique identifier for the mandate associated with the setup intent.

paymentMethodId
string <uuid> (PaymentMethodId)

The unique identifier of the payment method.

paymentMethodTypes
Array of arrays

List of payment method types enabled for the setup intent.

sessionSecret
string

A unique and randomized identifier for the setup intent.

standingInstructionType
string (StandingInstructionType)

The standing instruction type to be used by the merchant and sent to the processor.

Enum: "UNSCHEDULED" "INSTALLMENT" "RECURRING"
status
string (SetupIntentStatus)
Default: "REQUIRES_PAYMENT_METHOD"

Status of the setup intent.

  • REQUIRES_PAYMENT_METHOD - The initial status of the setup intent. A payment method must be associated with the setup intent before the payment method can be saved.
  • PROCESSING - The setup intent is being updated or performing an action.
  • SUCCEEDED - The setup intent has been successfully confirmed. The payment method can be used for future transactions and payments.

For more information, see Setup intent statuses.

Enum: "REQUIRES_PAYMENT_METHOD" "PROCESSING" "SUCCEEDED"
usage
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"
{
  • "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": [ ]
}