Response [200 Ok]

Uri /api/v2/cart/billing!ccdetails
UriDescription BillingCardDetails
EndpointType BillingCardDetails
Locator BillingCardDetails
LocatorType Object

BillingCardDetails [1 of 1]
/api/v2/cart/billing!ccdetails

Uri /api/v2/cart/billing!ccdetails
UriDescription BillingCardDetails
CardType empty string
CardTypeName empty string
ExpirationMonth empty string
ExpirationYear empty string
LastFive empty string

Timing

Total

cycles 1
objects 0
time 0.02106

Request

Uri /api/v2/cart/billing!ccdetails
Method GET
Version v2

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

PATCH

Permissions
  • Modify

DELETE

Permissions
  • Modify

Parameters

PATCH

numeric string representing card auth code
string representing credit card number
integer between 1 & 12
2 digit integer between current year and current year + 20

DELETE

Output Fields

CardType text
CardTypeName text
ExpirationMonth text
ExpirationYear text
LastFive text

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/cart/billing!ccdetails"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "PATCH": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "PATCH",
            "DELETE"
        ],
        "ParameterDescription": {
            "CreditCard": "Variable length string of digits and spaces representing a credit card number",
            "Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive",
            "Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "PATCH": [
                {
                    "Name": "CardNumber",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "string representing credit card number",
                    "Type": "CreditCard",
                    "MIN_CHARS": 10,
                    "MAX_CHARS": 20
                },
                {
                    "Name": "ExpirationMonth",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "integer between 1 & 12",
                    "Type": "Integer",
                    "MIN_VALUE": 1,
                    "MAX_VALUE": 12
                },
                {
                    "Name": "ExpirationYear",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "2 digit integer between current year and current year + 20",
                    "Type": "Integer",
                    "MIN_VALUE": 25,
                    "MAX_VALUE": 45
                },
                {
                    "Name": "AuthCode",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "numeric string representing card auth code",
                    "Type": "Varchar",
                    "MIN_CHARS": 2,
                    "MAX_CHARS": 5
                }
            ],
            "DELETE": []
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "CardType",
                "Type": "Varchar",
                "MIN_CHARS": 2,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "CardTypeName",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 255
            },
            {
                "Name": "LastFive",
                "Type": "Varchar",
                "MIN_CHARS": 5,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "ExpirationMonth",
                "Type": "Varchar",
                "MIN_CHARS": 2,
                "MAX_CHARS": 2
            },
            {
                "Name": "ExpirationYear",
                "Type": "Varchar",
                "MIN_CHARS": 2,
                "MAX_CHARS": 2
            }
        ],
        "Deprecated": {
            "Alternative": "/api/v2/cart/billing!paymentmethod"
        }
    },
    "Response": {
        "Uri": "/api/v2/cart/billing!ccdetails",
        "Locator": "BillingCardDetails",
        "LocatorType": "Object",
        "BillingCardDetails": {
            "CardType": "",
            "CardTypeName": "",
            "LastFive": "",
            "ExpirationMonth": "",
            "ExpirationYear": "",
            "Uri": "/api/v2/cart/billing!ccdetails",
            "UriDescription": "BillingCardDetails"
        },
        "UriDescription": "BillingCardDetails",
        "EndpointType": "BillingCardDetails",
        "Timing": {
            "Total": {
                "time": 0.02106,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}