TAG LINE
TAG LINE
SMALL TITLE
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.
identity READ-ONLY | "identity": 12 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 |
GET | CardType/ |
Retrieve all of the CardType objects. | |
Retrieve all of the CardType objects. GET CardType/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "name": "Mastercard", "vendorCardName": "MC" } ] } |
GET | 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 CardType/Paged 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" } ] } } |
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} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "Mastercard", "vendorCardName": "MC" } } |