Fetch card list

Fetch saved card list of all cards belonging to the customer. It is possible to fetch card list of one customer at a time.
Customer is able to save a card data during purchase process in the Merchant's service. Then the customer do not need to enter card details during subsequent purchases.

Request

Path Params

merchantCustomerId

string <uuid>

required

An unique customer external identifier

Example:

3fa85f64-5717-4562-b3fc-2c963f66afa6

Query Params

itemsPerPage

string

optional

Limit of results

Default:

Match pattern:

^[1-9][0-9]*$

page

string

optional

Page of results

Default:

Match pattern:

^[1-9][0-9]*$

direction

enum<string>

optional

Direction of order

Allowed values:

ascdesc

Default:

asc

sortBy

enum<string>

optional

column sorting

Allowed value:

createdAt

Default:

createdAt

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

Responses

🟢200OK

application/json

Body

data

array[object (CardV2) {27}]

required

string <uuid>

required

customerId

string <uuid>

optional

<= 64 characters

firstTransactionId

string <uuid>

optional

>= 1 characters<= 128 characters

cardName

string

optional

<= 128 characters

cardHolderName

string

optional

<= 128 characters

cardHolder

object

optional

Cardholder data

addressLine1

string

optional

<= 128 characters

addressLine2

string

optional

<= 128 characters

addressCity

string

optional

<= 128 characters

addressCountry

string

optional

<= 32 characters

addressState

string

optional

<= 32 characters

addressZip

string

optional

<= 16 characters

organization

string

required

>= 1 characters<= 32 characters

brand

string

optional

<= 32 characters

bank

string

optional

<= 128 characters

country

string

optional

<= 3 characters

tokenizationMethod

enum<string>

optional

<= 32 characters

Allowed values:

apple_paygoogle_payinternal

last4

string

required

>= 1 characters<= 4 characters

expMonth

string

required

>= 1 characters<= 2 characters

expYear

string

required

>= 1 characters<= 4 characters

verificationStatus

string

optional

<= 2 characters

verificationDate

string

optional

<= 2 characters

status

enum<string>

optional

>= 1 characters

Allowed values:

verifiedunverifiedexpiredinvalidpending

isDefault

boolean

required

eea

boolean

optional

commercial

boolean

optional

createdAt

string <date-time>

required

Meta

required

itemsPerPage

string

optional

Default:

Match pattern:

^[1-9][0-9]*$

page

string

optional

Default:

Match pattern:

^[1-9][0-9]*$

direction

enum<string>

optional

Allowed values:

ascdesc

Default:

asc

sortBy

enum<string>

optional

Allowed value:

createdAt

Default:

createdAt

Example

{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
            "firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
            "cardName": "string",
            "cardHolderName": "string",
            "cardHolder": {
                "firstName": "string",
                "middleName": "string",
                "lastName": "string",
                "birthDate": "string"
            },
            "addressLine1": "string",
            "addressLine2": "string",
            "addressCity": "string",
            "addressCountry": "string",
            "addressState": "string",
            "addressZip": "string",
            "organization": "string",
            "brand": "string",
            "bank": "string",
            "country": "str",
            "tokenizationMethod": "apple_pay",
            "last4": "stri",
            "expMonth": "st",
            "expYear": "stri",
            "verificationStatus": "st",
            "verificationDate": "st",
            "status": "verified",
            "isDefault": true,
            "eea": true,
            "commercial": true,
            "createdAt": "2019-08-24T14:15:22Z"
        }
    ],
    "meta": {
        "itemsPerPage": "10",
        "page": "1",
        "direction": "asc",
        "sortBy": "createdAt"
    }
}

🟠404Record Not Found

Request

Request samples

Responses