Jump to

• Request
• Response

updateCreditCard

put

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

Updates the credit card information for the id, passed in as query parameter, by searching the credit cards associated with the given shopper profile and its organization. Currently, only setAsDefault and nickname fields are allowed to be updated for the saved cards.

Request

Supported Media Types

• application/json

Path Parameters

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

Header Parameters

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

Body ()

Root Schema : updateCreditCard_request

Type: object

Show Source

• additionalInfo(optional): string
  This field is a custom property which stores any pretext specific to the card. The length of this property must be less than or equal to 2000 characters
• nickname(optional): string
  The nick name for the credit card.
• setAsDefault(optional): boolean
  The flag to determine whether the card needs to be set as default card for the profile.

{
    "properties":{
        "nickname":{
            "description":"The nick name for the credit card.",
            "type":"string"
        },
        "additionalInfo":{
            "description":"This field is a custom property which stores any pretext specific to the card. The length of this property must be less than or equal to 2000 characters",
            "type":"string"
        },
        "setAsDefault":{
            "description":"The flag to determine whether the card needs to be set as default card for the profile.",
            "type":"boolean"
        }
    },
    "example":{
        "nickname":"Home Card 2",
        "additionalInfo":"Card has been synced with id 10001",
        "setAsDefault":true
    }
}

Example:

{
    "nickname":"Home Card 2",
    "additionalInfo":"Card has been synced with id 10001",
    "setAsDefault":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when the operation succeeds.

Body ()

Root Schema : updateCreditCard_response

Type: object

Show Source

• additionalInfo(optional): string
  This field is a custom property which stores any pretext specific to the card.
• cardNumber(optional): string
  The masked card number.
• cardType(optional): string
  The type of the card.
• expiryMonth(optional): string
  The expiry month for the card. Value lies between 01-12.
• expiryYear(optional): string
  The expiry year for the card.
• hasExpired(optional): boolean
  The flag that indicates if the card can be used or has it expired.
• iin(optional): string
  The issuer identification number for the card.
• isDefault(optional): boolean
  The flag that indicates if the card is the default card of the shopper.
• nameOnCard(optional): string
  The name on the card.
• nickname(optional): string
  The nick name for the card.
• repositoryId(optional): string
  The repository id for the card.
• savedCardId(optional): 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)

{
    "savedCardId":"usercc10002",
    "hasExpired":false,
    "isDefault":true,
    "nameOnCard":"card2",
    "repositoryId":"usercc10002",
    "expiryMonth":"03",
    "cardType":"visa",
    "nickname":"Home Card 2",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/profiles/{id}/creditCards/usercc10002"
        }
    ],
    "expiryYear":"2021",
    "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| |------------------|------------------| |28388|Unable to find credit card for the card id {cardId}.| |28395|User is not authorized to update the credit card with card id {cardId}.| |28392|An error occured while trying to update the credit card with card id {cardId}.| |28391|An error occurred while processing the credit card.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): 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(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): 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