Update card details
PATCH
/v3/customers/{merchantCustomerId}/payments/card/{id}Updates only one saved customer's card. It is possible to update card data from customer's saved card list only. Customer has to initiate the card's data updating process. It is possible to update first name, last name, CVV and card's number.
Request
Path Params
merchantCustomerId
string <uuid>
required
An unique customer external identifier
Example:
3fa85f64-5717-4562-b3fc-2c963f66afa6
id
string <uuid>
required
An unique identifier
Example:
3fa85f64-5717-4562-b3fc-2c963f66afa6
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]+$
Body Params application/json
cardName
string | null
optional
<= 128 characters
cardHolderName
string | null
optional
<= 128 characters
addressLine1
string | null
optional
<= 128 characters
addressLine2
string | null
optional
<= 128 characters
addressCity
string | null
optional
<= 128 characters
addressCountry
string | null
optional
<= 32 characters
addressState
string | null
optional
<= 32 characters
addressZip
string | null
optional
<= 16 characters
expMonth
string
optional
>= 1 characters<= 2 characters
expYear
string
optional
>= 1 characters<= 4 characters
isDefault
boolean
optional
Example
{
"cardName": "string",
"cardHolderName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressCity": "string",
"addressCountry": "string",
"addressState": "string",
"addressZip": "string",
"expMonth": "st",
"expYear": "stri",
"isDefault": true
}
Request samples
Responses
OK(200)
Not Found(404)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
id
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
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
Example
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
"cardName": "string",
"cardHolderName": "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:22.123Z"
}
Modified at 10 days ago