TAG LINE
SMALL TITLE

Gateway Type

(API Version v4)


This internal entity represents a Payment Gateway used to process payments.


What can you do with GatewayType?


Properties

Property Details
identity
READ-ONLY
"identity": 4
Type: Number
This is the unique numeric identifier for the GatewayType
name
READ-ONLY
"name": "Authorize.net"
Type: String
The system defined Gateway Type name.
vendorGatewayTypeName
READ-ONLY
"vendorGatewayTypeName": "authorize_net"
Type: String
System key used to specify the gateway routing.


End Points

GETapi/v4/GatewayType/
Retrieve all of the GatewayType objects.
Retrieve all of the GatewayType objects.
GET api/v4/GatewayType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Authorize.net",
            "vendorGatewayTypeName": "authorize_net"
        }
    ]
}
GETapi/v4/GatewayType/Details/{id}
Retrieve deep detail of the GatewayType object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the GatewayType object.
Retrieve deep detail of the GatewayType object by its ID.
GET api/v4/GatewayType/Details/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Authorize.net",
        "vendorGatewayTypeName": "authorize_net",
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
GETapi/v4/GatewayType/Paged
Retrieve all of the GatewayType 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 GatewayType objects in a paged fashion.
GET api/v4/GatewayType/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": "Authorize.net",
                "vendorGatewayTypeName": "authorize_net"
            }
        ]
    }
}
GETapi/v4/GatewayType/{id}
Retrieve an instance of the GatewayType object by its ID.
{id}Unique identifier for the GatewayType object.
Retrieve an instance of the GatewayType object by its ID.
GET api/v4/GatewayType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Authorize.net",
        "vendorGatewayTypeName": "authorize_net"
    }
}
POSTapi/v4/GatewayType/Search
Retreive a list of GatewayType 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 GatewayType objects based on search criteria.
POST api/v4/GatewayType/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": "Authorize.net",
            "vendorGatewayTypeName": "authorize_net"
        }
    ]
}