PaymentMethodRequest

Request to create a payment method.

object
object (Card)
type
string

The type of payment method.

  • CARD - Payment card, including Apple Pay and Google Pay digital wallets. Use card.wallet.type to indicate the wallet type.
  • CARD_PRESENT - This is reserved for future use.
  • GIFT_CARD - This is reserved for future use.
  • GIFT_CARD_PRESENT - This is reserved for future use.
Enum: "CARD" "CARD_PRESENT" "GIFT_CARD" "GIFT_CARD_PRESENT"
usage
string or null

Field used to determine if the logged-in customer will save the payment method for future usage. The value is ON_SESSION for cards saved during checkout. The value is NULL if the card will not be saved for future usage.

  • ON_SESSION - Saves the payment method for future customer-initiated transactions.

  • OFF_SESSION - Saves the payment method for future merchant-initiated transactions.

  • ON_AND_OFF_SESSION - Saves the payment method for future customer or merchant-initiated transactions.

Enum: "ON_SESSION" "OFF_SESSION" "ON_AND_OFF_SESSION"
{
  • "type": "CARD",
  • "card": {
    },
  • "billingDetails": {
    },
  • "usage": "ON_SESSION"
}