TAG LINE
SMALL TITLE

Payment Base Type

(API Version v2)


System defined types of payment types such as Credit Card, ACH or Cash.


What can you do with PaymentBaseType?


Properties

Property Details
identity
READ-ONLY
"identity": 8
Type: Number
This is the unique numeric identifier for the PaymentBaseType
name
READ-ONLY
"name": "ACH"
Type: String
System defined name for the Payment Base Type.
vendorPaymentType
READ-ONLY
"vendorPaymentType": "credit_card"
Type: String
Payment Gateway friendly system definition for the payment type.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • vendorPaymentType

End Points

GETapi/v2/Payment/BaseType/
Retrieve all of the PaymentBaseType objects.
Retrieve all of the PaymentBaseType objects.
GET api/v2/Payment/BaseType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "ACH",
            "vendorPaymentType": "credit_card"
        }
    ]
}
GETapi/v2/Payment/BaseType/Paged
Retrieve all of the PaymentBaseType 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 PaymentBaseType objects in a paged fashion.
GET api/v2/Payment/BaseType/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": "ACH",
                "vendorPaymentType": "credit_card"
            }
        ]
    }
}
GETapi/v2/Payment/BaseType/{id}
Retrieve an instance of the PaymentBaseType object by its ID.
{id}Unique identifier for the PaymentBaseType object.
Retrieve an instance of the PaymentBaseType object by its ID.
GET api/v2/Payment/BaseType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "ACH",
        "vendorPaymentType": "credit_card"
    }
}