TAG LINE
SMALL TITLE

Card Type

(API Version v4)


Card Types represent different types of payment cards. Such as "Visa" and "Mastercard" which then map up to payment gateway specific names for these cards.


What can you do with CardType?


Properties

Property Details
identity
READ-ONLY
"identity": 25
Type: Number
This is the unique numeric identifier for the CardType
name
READ-ONLY
"name": "Mastercard"
Type: String
The name for this Card Type.
vendorCardName
READ-ONLY
"vendorCardName": "MC"
Type: String
The payment gateway's card name for the payment method


End Points

GETapi/v4/CardType/
Retrieve all of the CardType objects.
Retrieve all of the CardType objects.
GET api/v4/CardType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Mastercard",
            "vendorCardName": "MC"
        }
    ]
}
GETapi/v4/CardType/Paged
Retrieve all of the CardType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the CardType objects in a paged fashion.
GET api/v4/CardType/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Mastercard",
                "vendorCardName": "MC"
            }
        ]
    }
}
GETapi/v4/CardType/{id}
Retrieve an instance of the CardType object by its ID.
{id}Unique identifier for the CardType object.
Retrieve an instance of the CardType object by its ID.
GET api/v4/CardType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Mastercard",
        "vendorCardName": "MC"
    }
}
POSTapi/v4/CardType/Search
Retreive a list of CardType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of CardType objects based on search criteria.
POST api/v4/CardType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Mastercard",
            "vendorCardName": "MC"
        }
    ]
}