Card Type

(API Version v10)

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?

GET CardType/
Retrieve all of the CardType objects.
GET CardType/Paged
Retrieve all of the CardType objects in a paged fashion.
GET CardType/{id}
Retrieve an instance of the CardType object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 8 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
paymentProviderId	"paymentProviderId": 13 Type: Number Unique identifier for the associated PaymentProvider object.
paymentProviderName	"paymentProviderName": "Sample Name" Type: String The name of the object associated with the paymentProviderId property.
paymentBaseTypeId	"paymentBaseTypeId": 2 Type: Number Unique identifier for the associated PaymentBaseType object.
paymentBaseTypeName	"paymentBaseTypeName": "Sample Name" Type: String The name of the object associated with the paymentBaseTypeId property.

End Points

Retrieve all of the CardType objects.

GET CardType/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Mastercard",
            "vendorCardName": "MC",
            "paymentProviderId": 18,
            "paymentProviderName": "Sample Text Data",
            "paymentBaseTypeId": 10,
            "paymentBaseTypeName": "Sample Text Data"
        }
    ]
}

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 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",
                "paymentProviderId": 19,
                "paymentProviderName": "Sample Text Data",
                "paymentBaseTypeId": 9,
                "paymentBaseTypeName": "Sample Text Data"
            }
        ]
    }
}

GET	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 CardType/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "Mastercard", "vendorCardName": "MC", "paymentProviderId": 12, "paymentProviderName": "Sample Text Data", "paymentBaseTypeId": 20, "paymentBaseTypeName": "Sample Text Data" } }