Zum Hauptinhalt springen
PUT
/
customers
/
{customerId}
/
payment-method
cURL
curl -X PUT \
 /customers/{customerId}/payment-method \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "paymentMethodId": ""
}'
{
  "id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
  "customer": "ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a",
  "gatewayName": "stripe",
  "type": "card",
  "referenceId": "pm_1J5J2n2eZvKYlo2C",
  "default": true,
  "status": "active",
  "source": "api",
  "enabled": true,
  "name": "Visa (4242)",
  "data": [],
  "creationDate": "2024-01-15T10:30:00+00:00",
  "expirationDate": "2026-12-31T23:59:59+00:00",
  "expirationInDays": 1082,
  "sepaMandate": null,
  "card": {
    "brand": "Visa",
    "last4": "4242",
    "expMonth": 12,
    "expYear": 2026,
    "cardHolder": "Max Mustermann"
  },
  "sepaDebit": null,
  "paypal": null
}

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

​
customerId
string
erforderlich

PaymentMethod identifier

Body

The updated PaymentMethod resource

Request body for setting the default payment method of a customer.

​
paymentMethodId
string
erforderlich

The new default payment method which should be used for new invoices, subscriptions and other offers.

Antwort

PaymentMethod resource updated

Payment method details returned when reading a payment method.

​
id
string

Unique identifier of the payment method

Beispiel:

"c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b"

​
customer
string<uuid>

The ID of the customer that owns this payment method

Beispiel:

"ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a"

​
gatewayName
enum<string>

The payment gateway used to process the payment method

Verfügbare Optionen:
wallet,
sepa_debit,
stripe,
fake_provider,
paypal,
bank_transfer,
go_cardless,
testing
​
type
enum<string> | null

The type of the payment method

Verfügbare Optionen:
sepa_debit,
card,
paypal,
bank_transfer,
wallet,
fake_provider,
null
​
referenceId
string | null

The reference ID of the payment method at the payment gateway

​
default
boolean

Whether this is the default payment method for the customer

Beispiel:

true

​
status
enum<string>
Standard:active

The current status of the payment method

Verfügbare Optionen:
active,
action_required,
expired,
revoked,
gateway_unconfigured
Beispiel:

"active"

​
source
enum<string>
Standard:api

The source where the payment method was created

Verfügbare Optionen:
checkout,
customerfront,
api,
add_link
Beispiel:

"api"

​
enabled
boolean

Whether the payment method is enabled for use

Beispiel:

true

​
name
string | null

Display name of the payment method

Beispiel:

"Visa (4242)"

​
data
string[]

Additional data associated with the payment method

​
creationDate
string<date-time>

The date when the payment method was created

Beispiel:

"2024-01-15T10:30:00+00:00"

​
expirationDate
string<date-time> | null

The expiration date of the payment method, if applicable

Beispiel:

"2026-12-31T23:59:59+00:00"

​
sepaMandate
object

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

​
card
object

The card data of the payment method, if the type is "card"

​
sepaDebit
object

The sepa mandate data of the payment method, if the type is "sepa_debit"

​
paypal
object

The paypal data of the payment method, if the type is "paypal"

​
expirationInDays
integer | null

Number of days until the payment method expires. Null if no expiration.

Beispiel:

365