getPaymentTypes
get
/ccadmin/v1/merchant/paymentTypes
Get Payment Types. Get all payment types.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
The number of items per block
-
offset(optional): integer
startingIndex the index of the first item to return
-
sort(optional): string
Sort Option id: Sort order
-
totalResults(optional): boolean
flag to include total count of items
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPaymentTypes_response
Type:
Show Source
object
-
items(optional):
array items
List of enabled payment types
Nested Schema : items
Type:
Show Source
object
-
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 id of the payment type item.
-
startDateRequired(optional):
string
Whether the the start date of the credit card is required for this payment type.
-
type(optional):
string
The payment type. E.g.: card,check,etc.
-
value(optional):
string
The value for the payment type.
Nested Schema : img
Type:
object
Payment type image URL.
Show Source
-
name(optional):
string
The name of the image file.
-
path(optional):
string
The relative URL for the image.
-
repositoryId(optional):
string
The id of the media external image file.
-
url(optional):
string
The derived URL for the image.
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"
}
]
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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