Jump to

• Request
• Response

getCreditCard

get

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

Gets the credit card for the id, passed in as query parameter, by searching the credit cards associated with the given shopper profile and its organization

Request

Supported Media Types

• application/json

Path Parameters

• cardId(required): string
  The id of the credit card, that needs to be searched, in the shopper profile and its organization.
• id(required): string
  User profile id

Header Parameters

• X-CCAsset-Language: string
  The asset language of the request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when the operation succeeds.

Body ()

Root Schema : getCreditCard_response

Type: object

Show Source

• 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.

{
    "properties":{
        "savedCardId":{
            "description":"The card id for the saved credit card.",
            "type":"string"
        },
        "hasExpired":{
            "description":"The flag that indicates if the card can be used or has it expired.",
            "type":"boolean"
        },
        "isDefault":{
            "description":"The flag that indicates if the card is the default card of the shopper.",
            "type":"boolean"
        },
        "nameOnCard":{
            "description":"The name on the card.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository id for the card.",
            "type":"string"
        },
        "expiryMonth":{
            "description":"The expiry month for the card. Value lies between 01-12.",
            "type":"string"
        },
        "cardType":{
            "description":"The type of the card.",
            "type":"string"
        },
        "nickname":{
            "description":"The nick name for the card.",
            "type":"string"
        },
        "additionalInfo":{
            "description":"This field is a custom property which stores any pretext specific to the card.",
            "type":"string"
        },
        "expiryYear":{
            "description":"The expiry year for the card.",
            "type":"string"
        },
        "cardNumber":{
            "description":"The masked card number.",
            "type":"string"
        },
        "iin":{
            "description":"The issuer identification number for the card.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "expiryMonth":"03",
    "cardType":"visa",
    "expiryYear":"2021",
    "iin":"411111",
    "savedCardId":"usercc10002",
    "hasExpired":false,
    "isDefault":true,
    "nameOnCard":"card2",
    "repositoryId":"usercc10002",
    "nickname":"visa - 1111##0",
    "additionalInfo":"Card has been synced with id 10001",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/profiles/{id}}/creditCards/usercc10002"
        }
    ],
    "cardNumber":"xxxxxxxxxxxx1111"
}

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| |------------------|------------------| |28388|Unable to find credit card for the card id {cardId}.| |28389|Unable to retrieve the credit card for the card id {cardId}| |28391|An error occurred while processing the credit card.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top