Skip to main content
PATCH
/
me
/
paymentMethods
/
{paymentMethodId}
Update a payment method
curl --request PATCH \
  --url https://api.guile.app/me/paymentMethods/{paymentMethodId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "isDefault": true,
  "nickname": "<string>"
}
'
{
  "type": "card",
  "isDefault": false,
  "nickname": "<string>"
}

Path Parameters

​
paymentMethodId
string<uuid>
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Body

application/merge-patch+json
​
isDefault
boolean | null

Indicates if this card is the default card in a customer's saved payment methods.

​
nickname
string | null

An optional nickname for the payment method to help identify it.

Maximum string length: 50

Response

Ok. The operation succeeded.

Representation of a payment method for a customer

​
type
enum<string>
required

Indicator of the payment method type.

Available options:
card,
digitalWallet
​
isDefault
boolean
default:false
required

Indicates if this card is the default card in a customer's saved payment methods.

​
card
object

A representation of the customer's credit or debit card. This property is required when the payment method type is card.

​
digitalWallet
object

A representation of the customer's digital wallet, such as Apple Pay. This property is required when the payment method type is digitalWallet.

​
nickname
string

An optional nickname for the payment method to help identify it.

Maximum string length: 50