PaymentMethod | ePay documentation

idstring

The ID of the payment method

Format:

uuid

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

typePaymentMethodType

The type of the payment method.

Possible values:

"CARD""VIPPS_MOBILEPAY""MOBILEPAY_ONLINE""APPLE_PAY""GOOGLE_PAY""SWISH""VIABILL""ANYDAY""KLARNA"

Example:

"CARD"

subTypestring

Nullable

The sub type of the associated payment method. For card based payments, this will contain the name of the scheme, such as Visa or Mastercard. The card scheme name formatted with a uppercase starting character. For non-card based payments the field vary depending on the requirements of the payment method.

The sub type of the associated payment method. For card based payments, this will contain the name of the scheme, such as `Visa` or `Mastercard`. The card scheme name formatted with a uppercase starting character. For non-card based payments the field vary depending on the requirements of the payment method.

Possible values:

"Visa""Mastercard""Maestro""Dankort""VisaDankort""Discover""UnionPay""Electron""Amex""JCB"

Example:

"Visa"

customerIdstring

Nullable

The merchant customer id that created the payment method.

Example:

"User159"

expirystring

Nullable

The expiration date of the associated payment method.
Although payment cards are specified by a month and year (MM/YY), this value is returned as a full date (YYYY-MM-DD) representing the last day of the expiration month. Example: "2030-05-31" for a card expiring in May 2030.

The expiration date of the associated payment method. Although payment cards are specified by a month and year (MM/YY), this value is returned as a full date (YYYY-MM-DD) representing the **last day of the expiration month**. Example: `"2030-05-31"` for a card expiring in May 2030.

Format:

date

Example:

"2024-07-29"

createdAtstring

The time of creation

Format:

date-time

Example:

"2024-07-29T15:51:28.071Z"

displayTextstring

A cardholder friendly text to help the customer identify the card. For card based payments, this will contain a masked version of the card number.

Example:

"40000000XXXX0003"

PaymentMethod

{  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  "type": "CARD",  "subType": "Visa",  "customerId": "User159",  "expiry": "2024-07-29",  "createdAt": "2024-07-29T15:51:28.071Z",  "displayText": "40000000XXXX0003"}