listCreditCards
get
/ccadmin/v1/profiles/{id}/creditCards/
Gets the list of credit cards associated with the shopper and its organization.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
User profile id
Query Parameters
-
additionalInfo: string
If this value is provided, the cards will be filtered with exact match of this string.
-
allCards: boolean
This value is set to true, if inactive cards are also expected in the response.
-
allGateways: boolean
This value is set to true, if the cards from disabled gateways are also expected in the response.
-
allSites: boolean
This value is set to true, if the cards from non-current site are also expected in the response.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when the operation succeeds.
Root Schema : listCreditCards_response
Type:
Show Source
object
-
items:
array items
Credit card related properties
-
limit:
integer
The batch size of the records to be fetched together.
-
offset:
integer
The start index of the list of records to be fetched
-
total:
integer
The total results fetched.
-
totalResults:
integer
The total results fetched.
Nested Schema : items
Type:
Show Source
object
-
additionalInfo:
string
This field is a custom property which stores any pretext specific to the card.
-
cardNumber:
string
The masked card number.
-
cardType:
string
The type of the card.
-
expiryMonth:
string
The expiry month for the card. Value lies between 01-12.
-
expiryYear:
string
The expiry year for the card.
-
hasExpired:
boolean
The flag that indicates if the card can be used or has it expired.
-
iin:
string
The issuer identification number for the card.
-
isDefault:
boolean
The flag that indicates if the card is the default card of the shopper.
-
nameOnCard:
string
The name on the card.
-
nickname:
string
The nick name for the card.
-
repositoryId:
string
The repository id for the card.
-
savedCardId:
string
The card id for the saved credit card.
Example Response (application/json)
{
"total":"3",
"totalResults":"3",
"offset":"0",
"limit":"250",
"links":[
{
"rel":"self",
"href":"http://localhost:8080/admin/v1/profiles/{id}/creditCards?allCards=true&allGateways=true&allSites=true"
}
],
"items":[
{
"savedCardId":"usercc10001",
"hasExpired":false,
"isDefault":false,
"nameOnCard":"card1",
"repositoryId":"usercc10001",
"expiryMonth":"04",
"cardType":"visa",
"nickname":"visa - 1111",
"additionalInfo":"Card has been synced with id 10001",
"expiryYear":"2021",
"cardNumber":"xxxxxxxxxxxx1111",
"iin":"411111"
},
{
"savedCardId":"usercc10002",
"hasExpired":false,
"isDefault":false,
"nameOnCard":"card2",
"repositoryId":"usercc10002",
"expiryMonth":"03",
"cardType":"visa",
"nickname":"visa - 1111##0",
"additionalInfo":"Card has been synced with id 10002",
"expiryYear":"2021",
"cardNumber":"xxxxxxxxxxxx1111",
"iin":"411111"
},
{
"savedCardId":"usercc10003",
"hasExpired":false,
"isDefault":true,
"nameOnCard":"card3",
"repositoryId":"usercc10003",
"expiryMonth":"02",
"cardType":"visa",
"nickname":"visa - 1111##1",
"additionalInfo":null,
"expiryYear":"2020",
"cardNumber":"xxxxxxxxxxxx1111",
"iin":"411111"
}
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commercer Cloud:
|Error Code|Description|
|------------------|------------------|
|28386|An error occurred while retrieving the credit card list.|
|28387|An error occurred while processing the credit card list.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code