REST API for Oracle Commerce Cloud December 2017

getPaymentTypes

get

/ccadmin/v1/merchant/paymentTypes

Get Payment Types. Get all payment types.

Request

Supported Media Types

application/json

Query Parameters

limit: Type: integer

The number of items per block
offset: Type: integer

startingIndex the index of the first item to return
sort: Type: string

Sort Option id: Sort order
totalResults: Type: boolean

flag to include total count of items

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getPaymentTypes_response

Properties

items: Type: array items

Additional Properties Allowed:

List of payment types.

Nested Schema : items

Type: array

List of payment types.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

code: Type: string

The payment gateway specific code for the payment type.
cvvLength: Type: integer

Valid cvv length.
iin: Type: string

Issuer identification number for the payment type.
img: Type: object img

Additional Properties Allowed:

Payment type image URL.
length: Type: string

Valid card number length.
name: Type: string

The internal name for the payment type.
repositoryId: Type: string

The repository ID of the payment type item.
startDateRequired: Type: boolean

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

Kind of payment type.For e.g.: card,check,etc.
value: Type: string

The value for the payment type.

Nested Schema : img

Type: object

Payment type image URL.

Properties

name: Type: string

Name of the image.
path: Type: string

Relative path of the image.
repositoryId: Type: string

The id of the media external image file.
url: Type: string

The derived URL for the image.

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

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

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