PaymentMethod

The PaymentMethod object

idId (string)

Unique identifier for the object.

customerIdstring

The ID of the Customer to which this PaymentMethod is saved.

paymentGatewayIdstring

The ID of the PaymentGateway through which this PaymentMethod is processed.

externalIdstring

The ID of the PaymentMethod as registered in the external PaymentGateway system. Used to reference the method in operations with the provider.

holderEmailstring

Email address associated with the PaymentMethod holder. This may differ from the Customer's email.

holderNamestring

Full name of the individual or entity that owns the PaymentMethod. This may differ from the Customer's registered name.

creditCard object

If this is a card PaymentMethod, this contains the user’s card details.

brandstring

Card brand

panstring

Card masked PAN

expirationstring

expirationMonthint32

Two-digit number representing the card’s expiration month.

expirationYearint32

Four-digit number representing the card’s expiration year.

productstring

directDebit object

If this is a sepa_debit PaymentMethod, this contains the user’s card details.

accountIdstring

ID of the bank account.

accountBicstring

BIC of the bank account.

accountIbanstring

IBAN of the bank account.

additionalInformation1stringnullable

additionalInformation2stringnullable

additionalInformation3stringnullable

PaymentMethod

{
  "id": "string",
  "customerId": "string",
  "paymentGatewayId": "string",
  "externalId": "string",
  "holderEmail": "string",
  "holderName": "string",
  "creditCard": {
    "brand": "string",
    "pan": "string",
    "expiration": "string",
    "expirationMonth": 0,
    "expirationYear": 0,
    "product": "string"
  },
  "directDebit": {
    "accountId": "string",
    "accountBic": "string",
    "accountIban": "string"
  },
  "additionalInformation1": "string",
  "additionalInformation2": "string",
  "additionalInformation3": "string"
}