REST API for Oracle Commerce Cloud 22A

updatePaymentTypes

put

/ccadmin/v1/merchant/paymentTypes

Update Payment Types. Update payment types based on request parameters.

Request

Supported Media Types

application/json

Root Schema : updatePaymentTypes_request

Type: object

Show Source

paymentTypes: array paymentTypes

Array of payment types to enable.

{
    "properties":{
        "paymentTypes":{
            "description":"Array of payment types to enable.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "paymentTypes"
    ],
    "example":{
        "paymentTypes":[
            "visa"
        ]
    }
}

Example:

{
    "paymentTypes":[
        "visa"
    ]
}

Nested Schema : paymentTypes

Type: array

Array of payment types to enable.

Show Source

Array of: string

{
    "description":"Array of payment types to enable.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : updatePaymentTypes_response

Type: object

Show Source

items(optional): array items

List of payment types.

{
    "properties":{
        "items":{
            "description":"List of payment types.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "img":{
                        "description":"Payment type image URL.",
                        "type":"object",
                        "properties":{
                            "path":{
                                "description":"Relative path of the image.",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"The id of the media external image file.",
                                "type":"string"
                            },
                            "name":{
                                "description":"Name of the image.",
                                "type":"string"
                            },
                            "url":{
                                "description":"The derived URL for the image.",
                                "type":"string"
                            }
                        }
                    },
                    "code":{
                        "description":"The payment gateway specific code for the payment type.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The repository ID of the payment type item.",
                        "type":"string"
                    },
                    "name":{
                        "description":"The internal name for the payment type.",
                        "type":"string"
                    },
                    "startDateRequired":{
                        "description":"Whether the the start date of the credit card is required for this payment type.",
                        "type":"boolean"
                    },
                    "length":{
                        "description":"Valid card number length.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Kind of payment type.For e.g.: card,check,etc.",
                        "type":"string"
                    },
                    "value":{
                        "description":"The value for the payment type.",
                        "type":"string"
                    },
                    "cvvLength":{
                        "description":"Valid cvv length.",
                        "type":"string"
                    },
                    "iin":{
                        "description":"Issuer identification number for the payment type.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of payment types.

Show Source

Array of: object items

{
    "description":"List of payment types.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "img":{
                "description":"Payment type image URL.",
                "type":"object",
                "properties":{
                    "path":{
                        "description":"Relative path of the image.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The id of the media external image file.",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the image.",
                        "type":"string"
                    },
                    "url":{
                        "description":"The derived URL for the image.",
                        "type":"string"
                    }
                }
            },
            "code":{
                "description":"The payment gateway specific code for the payment type.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The repository ID of the payment type item.",
                "type":"string"
            },
            "name":{
                "description":"The internal name for the payment type.",
                "type":"string"
            },
            "startDateRequired":{
                "description":"Whether the the start date of the credit card is required for this payment type.",
                "type":"boolean"
            },
            "length":{
                "description":"Valid card number length.",
                "type":"string"
            },
            "type":{
                "description":"Kind of payment type.For e.g.: card,check,etc.",
                "type":"string"
            },
            "value":{
                "description":"The value for the payment type.",
                "type":"string"
            },
            "cvvLength":{
                "description":"Valid cvv length.",
                "type":"string"
            },
            "iin":{
                "description":"Issuer identification number for the payment type.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

code(optional): string

The payment gateway specific code for the payment type.
cvvLength(optional): string

Valid cvv length.
iin(optional): string

Issuer identification number for the payment type.
img(optional): object img

Payment type image URL.
length(optional): string

Valid card number length.
name(optional): string

The internal name for the payment type.
repositoryId(optional): string

The repository ID of the payment type item.
startDateRequired(optional): boolean

Whether the the start date of the credit card is required for this payment type.
type(optional): string

Kind of payment type.For e.g.: card,check,etc.
value(optional): string

The value for the payment type.

{
    "type":"object",
    "properties":{
        "img":{
            "description":"Payment type image URL.",
            "type":"object",
            "properties":{
                "path":{
                    "description":"Relative path of the image.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The id of the media external image file.",
                    "type":"string"
                },
                "name":{
                    "description":"Name of the image.",
                    "type":"string"
                },
                "url":{
                    "description":"The derived URL for the image.",
                    "type":"string"
                }
            }
        },
        "code":{
            "description":"The payment gateway specific code for the payment type.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository ID of the payment type item.",
            "type":"string"
        },
        "name":{
            "description":"The internal name for the payment type.",
            "type":"string"
        },
        "startDateRequired":{
            "description":"Whether the the start date of the credit card is required for this payment type.",
            "type":"boolean"
        },
        "length":{
            "description":"Valid card number length.",
            "type":"string"
        },
        "type":{
            "description":"Kind of payment type.For e.g.: card,check,etc.",
            "type":"string"
        },
        "value":{
            "description":"The value for the payment type.",
            "type":"string"
        },
        "cvvLength":{
            "description":"Valid cvv length.",
            "type":"string"
        },
        "iin":{
            "description":"Issuer identification number for the payment type.",
            "type":"string"
        }
    }
}

Nested Schema : img

Type: object

Payment type image URL.

Show Source

name(optional): string

Name of the image.
path(optional): string

Relative path of the image.
repositoryId(optional): string

The id of the media external image file.
url(optional): string

The derived URL for the image.

{
    "description":"Payment type image URL.",
    "type":"object",
    "properties":{
        "path":{
            "description":"Relative path of the image.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The id of the media external image file.",
            "type":"string"
        },
        "name":{
            "description":"Name of the image.",
            "type":"string"
        },
        "url":{
            "description":"The derived URL for the image.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "items":[
        {
            "img":{
                "path":"/ccimg/visa_straight.png",
                "name":"Visa",
                "repositoryId":"imgVisa",
                "url":"http://localhost:9080/file/ccimg/visa_straight.png"
            },
            "code":"001",
            "name":"Visa",
            "startDateRequired":false,
            "length":"13|16",
            "repositoryId":"visa",
            "type":"card",
            "value":"visa",
            "cvvLength":3,
            "iin":"4"
        },
        {
            "img":{
                "path":"/ccimg/mastercard.png",
                "name":"Mastercard",
                "repositoryId":"imgMastercard",
                "url":"http://localhost:9080/file/ccimg/mastercard.png"
            },
            "code":"002",
            "name":"Mastercard",
            "startDateRequired":false,
            "length":"16",
            "repositoryId":"mastercard",
            "type":"card",
            "value":"mastercard",
            "cvvLength":3,
            "iin":"5[0-5]"
        },
        {
            "img":{
                "path":"/ccimg/amex.png",
                "name":"American Express",
                "repositoryId":"imgAmex",
                "url":"http://localhost:9080/file/ccimg/amex.png"
            },
            "code":"003",
            "name":"American Express",
            "startDateRequired":false,
            "length":"15",
            "repositoryId":"amex",
            "type":"card",
            "value":"amex",
            "cvvLength":4,
            "iin":"3[47]"
        }
    ]
}

Default Response

The error response

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"
        }
    }
}