listCreditCards

get

/ccadmin/v1/profiles/{id}/creditCards/

Gets the list of credit cards associated with the shopper and its organization.

Request

Supported Media Types
Path Parameters
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when the operation succeeds.
Body ()
Root Schema : listCreditCards_response
Type: object
Show Source
Nested Schema : items
Type: array
Credit card related properties
Show Source
Nested Schema : items
Type: object
Show Source
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.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top