Jump to

• Request
• Response

addCreditCard

post

/ccstore/v1/profiles/current/creditCards

Add credit card for the shopper. The credit card data is tokenised and is stored against the profile.

Request

Supported Media Types

• application/json

Header Parameters

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

Body ()

Root Schema : addCreditCard_request

Type: object

Show Source

• billingAddress(optional): object billingAddress
  The billing address details.
• cardCVV(optional): string
  Card secret pin.
• cardNumber: string
  Card number to be be added.
• cardType: string
  Card type. e.g. visa.
• customProperties(optional): object customProperties
  Custom object with dynamic properties. This will be passed to the webhook request
• expiryMonth: integer
  Card expiry month.
• expiryYear: integer
  Card expiry year.
• nameOnCard: string
  Name on the card.
• 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":{
        "cardCVV":{
            "description":"Card secret pin.",
            "type":"string"
        },
        "customProperties":{
            "description":"Custom object with dynamic properties. This will be passed to the webhook request",
            "type":"object"
        },
        "nameOnCard":{
            "description":"Name on the card.",
            "type":"string"
        },
        "expiryMonth":{
            "description":"Card expiry month.",
            "type":"integer"
        },
        "cardType":{
            "description":"Card type. e.g. visa.",
            "type":"string"
        },
        "nickname":{
            "description":"The nick name for the credit card.",
            "type":"string"
        },
        "expiryYear":{
            "description":"Card expiry year.",
            "type":"integer"
        },
        "billingAddress":{
            "description":"The billing address details.",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name.",
                    "type":"string"
                },
                "country":{
                    "description":"Country.",
                    "type":"string"
                },
                "address3":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "address2":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "city":{
                    "description":"City.",
                    "type":"string"
                },
                "prefix":{
                    "description":"Name prefix.",
                    "type":"string"
                },
                "address1":{
                    "description":"Address snippet.",
                    "type":"string"
                },
                "postalCode":{
                    "description":"Postal code.",
                    "type":"string"
                },
                "jobTitle":{
                    "description":"Job title.",
                    "type":"string"
                },
                "companyName":{
                    "description":"Company name.",
                    "type":"string"
                },
                "county":{
                    "description":"County.",
                    "type":"string"
                },
                "suffix":{
                    "description":"Name suffix.",
                    "type":"string"
                },
                "selectedCountry":{
                    "description":"Country code.",
                    "type":"string"
                },
                "firstName":{
                    "description":"First name.",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone number.",
                    "type":"string"
                },
                "faxNumber":{
                    "description":"Fax number.",
                    "type":"string"
                },
                "alias":{
                    "description":"Address alias.",
                    "type":"string"
                },
                "middleName":{
                    "description":"Middle name.",
                    "type":"string"
                },
                "state":{
                    "description":"State.",
                    "type":"string"
                },
                "email":{
                    "description":"Email.",
                    "type":"string"
                },
                "selectedState":{
                    "description":"State code.",
                    "type":"string"
                },
                "state_ISOCode":{
                    "description":"State ISO code.",
                    "type":"string"
                }
            },
            "required":[
                "lastName",
                "country",
                "city",
                "address1",
                "postalCode",
                "selectedCountry",
                "firstName",
                "state",
                "selectedState",
                "state_ISOCode"
            ]
        },
        "cardNumber":{
            "description":"Card number to be be added.",
            "type":"string"
        },
        "setAsDefault":{
            "description":"The flag to determine whether the card needs to be set as default card for the profile.",
            "type":"boolean"
        }
    },
    "required":[
        "nameOnCard",
        "expiryMonth",
        "expiryYear",
        "cardType",
        "cardNumber"
    ],
    "example":{
        "cardCVV":"123",
        "customProperties":{
            "prop2":"value2",
            "prop1":"value1"
        },
        "nameOnCard":"card2",
        "expiryMonth":"03",
        "cardType":"visa",
        "nickname":"visa - 1111",
        "expiryYear":"2021",
        "billingAddress":{
            "lastName":"Anderson",
            "country":"US",
            "address2":"",
            "city":"Syracuse",
            "address1":"21 Cedar Ave",
            "postalCode":"13202",
            "county":"",
            "selectedCountry":"US",
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "state":"New York",
            "selectedState":"NY",
            "email":"[e-mail]",
            "state_ISOCode":"US-NY"
        },
        "cardNumber":"4123567812341111",
        "setAsDefault":true
    }
}

Example:

{
    "cardCVV":"123",
    "customProperties":{
        "prop2":"value2",
        "prop1":"value1"
    },
    "nameOnCard":"card2",
    "expiryMonth":"03",
    "cardType":"visa",
    "nickname":"visa - 1111",
    "expiryYear":"2021",
    "billingAddress":{
        "lastName":"Anderson",
        "country":"US",
        "address2":"",
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "county":"",
        "selectedCountry":"US",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "state":"New York",
        "selectedState":"NY",
        "email":"[e-mail]",
        "state_ISOCode":"US-NY"
    },
    "cardNumber":"4123567812341111",
    "setAsDefault":true
}

Nested Schema : billingAddress

Type: object

The billing address details.

Show Source

• address1: string
  Address snippet.
• address2(optional): string
  Address snippet.
• address3(optional): string
  Address snippet.
• alias(optional): string
  Address alias.
• city: string
  City.
• companyName(optional): string
  Company name.
• country: string
  Country.
• county(optional): string
  County.
• email(optional): string
  Email.
• faxNumber(optional): string
  Fax number.
• firstName: string
  First name.
• jobTitle(optional): string
  Job title.
• lastName: string
  Last name.
• middleName(optional): string
  Middle name.
• phoneNumber(optional): string
  Phone number.
• postalCode: string
  Postal code.
• prefix(optional): string
  Name prefix.
• selectedCountry: string
  Country code.
• selectedState: string
  State code.
• state: string
  State.
• state_ISOCode: string
  State ISO code.
• suffix(optional): string
  Name suffix.

{
    "description":"The billing address details.",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name.",
            "type":"string"
        },
        "country":{
            "description":"Country.",
            "type":"string"
        },
        "address3":{
            "description":"Address snippet.",
            "type":"string"
        },
        "address2":{
            "description":"Address snippet.",
            "type":"string"
        },
        "city":{
            "description":"City.",
            "type":"string"
        },
        "prefix":{
            "description":"Name prefix.",
            "type":"string"
        },
        "address1":{
            "description":"Address snippet.",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal code.",
            "type":"string"
        },
        "jobTitle":{
            "description":"Job title.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name.",
            "type":"string"
        },
        "county":{
            "description":"County.",
            "type":"string"
        },
        "suffix":{
            "description":"Name suffix.",
            "type":"string"
        },
        "selectedCountry":{
            "description":"Country code.",
            "type":"string"
        },
        "firstName":{
            "description":"First name.",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone number.",
            "type":"string"
        },
        "faxNumber":{
            "description":"Fax number.",
            "type":"string"
        },
        "alias":{
            "description":"Address alias.",
            "type":"string"
        },
        "middleName":{
            "description":"Middle name.",
            "type":"string"
        },
        "state":{
            "description":"State.",
            "type":"string"
        },
        "email":{
            "description":"Email.",
            "type":"string"
        },
        "selectedState":{
            "description":"State code.",
            "type":"string"
        },
        "state_ISOCode":{
            "description":"State ISO code.",
            "type":"string"
        }
    },
    "required":[
        "lastName",
        "country",
        "city",
        "address1",
        "postalCode",
        "selectedCountry",
        "firstName",
        "state",
        "selectedState",
        "state_ISOCode"
    ]
}

Nested Schema : customProperties

Type: object

Custom object with dynamic properties. This will be passed to the webhook request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when the operation succeeds.

Body ()

Root Schema : addCreditCard_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.
• customPaymentProperties(optional): object customPaymentProperties
  The set of properties returned by the generic payment webhook.
• 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 for the current user.
• nameOnCard(optional): string
  The name on the card.
• nickname(optional): string
  The nick name 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 for the current user.",
            "type":"boolean"
        },
        "customPaymentProperties":{
            "description":"The set of properties returned by the generic payment webhook.",
            "type":"object"
        },
        "nameOnCard":{
            "description":"The name on 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"
        }
    }
}

Nested Schema : customPaymentProperties

Type: object

The set of properties returned by the generic payment webhook.

Example Response (application/json)

{
    "expiryMonth":"03",
    "cardType":"visa",
    "expiryYear":"2021",
    "iin":"411111",
    "savedCardId":"usercc10002",
    "hasExpired":false,
    "isDefault":true,
    "customPaymentProperties":{
        "addl-prop4":"addl-prop4",
        "addl-prop3":"addl-prop3",
        "addl-prop1":"addl-prop1",
        "decision":null,
        "reasonCode":null
    },
    "nameOnCard":"card2",
    "nickname":"Home Card 2",
    "additionalInfo":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/profiles/current/creditCards"
        }
    ],
    "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 Commerce Cloud: |Error Code|Description| |------------------|------------------| |28396|Provided card details are incorrect.| |28397|An error occured while trying to add the credit card.| |28398|Tokenisation declined by payment gateway. Error message sent by the gateway will be returned.| |28399|Adding credit card is not supported on this site.

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