ImportedPaymentMethodResource | ePay documentation

panstring

The masked account number of the paying card. If the transaction is token based, like ApplePay, this will instead contain the TAN (Token PAN).

Example:

"12345678XXXX1234"

expireMonthstring

The month the card expires in. A card expires at the end of the month.

Example:

"07"

expireYearstring

The year the card expires in.

Example:

"35"

parstring

Nullable

The "Primary Account Reference" is a unique non-sensitive reference to the specific card. This will have the same value for any payment made with the same card even across wallets such as ApplePay. This can be used for loyalty systems or fraud prevention systems which needs to uniquely identify cards. The value is not always available. Availability depends on the used acquirer.

Example:

"8F1B7C2QX4Z9N3V6M2R0K8YD5LJTPH"

Issuerstring

Nullable

The name of the card issuer (Bank)

Example:

"Danske Bank"

Schemestring

Nullable

The network scheme such as Visa and Mastercard of the card

The network scheme such as `Visa` and `Mastercard` of the card

Example:

"Visa"

Countrystring

Nullable

The alpha-2 code of the country the card was issued in

Example:

"DK"

Segmentstring

Nullable

The customer segment the card is issued to. This can be used to identify consumer vs business cards.

Possible values:

"consumer""business""payouts"

Example:

"consumer"

Fundingstring

Nullable

The type of funding behind payments made from the card. This can be used identify debit vs credit cards.

Possible values:

"debit""credit""prepaid"

Example:

"debit"

Details about an imported payment method.

idstring

Required

Unique identifier of the imported payment method.

Example:

"01929a94-5fce-7ccc-a7e4-7e9249133b38"

paymentMethodIdstring

Required

ID of the associated payment method.

Example:

"01924756-d1f6-738d-8040-90d76cedf01f"

referencestring

Required

External reference used when importing the payment method.

Example:

"reference-1"

createdAtstring

Required

Timestamp when the imported payment method was created.

Format:

date-time

Example:

"2024-10-17T15:07:03.290909169+02:00"

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"

ImportedPaymentMethodResource

{  "card": {    "pan": "12345678XXXX1234",    "expireMonth": "07",    "expireYear": "35",    "par": "8F1B7C2QX4Z9N3V6M2R0K8YD5LJTPH",    "Issuer": "Danske Bank",    "Scheme": "Visa",    "Country": "DK",    "Segment": "consumer",    "Funding": "debit"  },  "importedPaymentMethod": {    "id": "01929a94-5fce-7ccc-a7e4-7e9249133b38",    "paymentMethodId": "01924756-d1f6-738d-8040-90d76cedf01f",    "reference": "reference-1",    "createdAt": "2024-10-17T15:07:03.290909169+02:00"  },  "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"  }}