Developer guide
API reference
  • API reference
    • Nothing Found
    Prerelease - hosted checkout API reference
    Authentication
    Customers
      Data definitions
        schema
        CustomerResponse
        schema
        ErrorMessage
        schema
        CreateCustomerRequest
        schema
        CustomerPaymentMethodsResponse
        schema
        CustomerByExternalReferenceIdResponse
        schema
        PaymentMethodData
        schema
        SetDefaultPaymentMethodRequest
        schema
        DefaultPaymentMethodResponse
      post
      Create a customer record
      get
      Get a customer's payment methods
      post
      Set a default payment method for a customer
      get
      Get the default payment method for a customer
      delete
      Delete the default payment method for a customer
    Payment intents
    Payment methods
    Setup intents

SetDefaultPaymentMethodRequest

Request to set a payment method as the default for a customer.

contextName
required
string

The unique integration provided context name that the payment method should be set as the default for.

paymentMethodId
required
string <uuid>

The unique identifier of the payment method.

{
  • "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011",
  • "contextName": "string"
}