ImportedPaymentMethodsListResponse

Cursor paginated imported payment methods ordered from newest to oldest.

currentOffsetstringrequired

Cursor used to generate the current page. Empty when the first page is requested.

Example: 019afe0a-3987-75e5-9704-c3a1dc2b092b

nextOffsetstringnullablerequired

Cursor to pass as offset when requesting the next page. Null when no more items exist.

Example: 01929a94-5fce-7ccc-a7e4-7e9249133b39

perPageintegerrequired

The maximum number of entries returned in each page.

Example: 25

hasMorebooleanrequired

Indicates whether another page can be requested.

Example: true

items object[]required

Imported payment methods returned for the current cursor window.

Array [

card objectnullable

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

parstringnullable

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

Issuerstringnullable

The name of the card issuer (Bank)

Example: Danske Bank

Schemestringnullable

The network scheme such as Visa and Mastercard of the card

Example: Visa

Countrystringnullable

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

Example: DK

Segmentstringnullable

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

Fundingstringnullable

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

importedPaymentMethod objectrequired

Details about an imported payment method.

idstringrequired

Unique identifier of the imported payment method.

Example: 01929a94-5fce-7ccc-a7e4-7e9249133b38

paymentMethodIdstringrequired

ID of the associated payment method.

Example: 01924756-d1f6-738d-8040-90d76cedf01f

referencestringrequired

External reference used when importing the payment method.

Example: reference-1

createdAtdate-timerequired

Timestamp when the imported payment method was created.

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

paymentMethod objectrequired

iduuid

The ID of the payment method

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

typePaymentMethodType (string)

The type of the payment method.

Possible values: [CARD, VIPPS_MOBILEPAY, MOBILEPAY_ONLINE, APPLE_PAY, GOOGLE_PAY, SWISH, VIABILL, ANYDAY]

Example: CARD

subTypestringnullable

The subtype of the payment method. For card based payments, this will contain the scheme of the card. Such as Visa or Mastercard

Example: Visa

customerIdstringnullable

The merchant customer id that created the payment method.

Example: User159

expirydatenullable

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.

Example: 2024-07-29

createdAtdate-time

The time of creation

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

]

ImportedPaymentMethodsListResponse

{
  "currentOffset": "019afe0a-3987-75e5-9704-c3a1dc2b092b",
  "nextOffset": "01929a94-5fce-7ccc-a7e4-7e9249133b39",
  "perPage": 25,
  "hasMore": true,
  "items": [
    {
      "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"
      }
    }
  ]
}