TAG LINE
TAG LINE
SMALL TITLE

Payment Status Type

(API Version v9)


Defined Payment Status Types usded with in the system.


What can you do with PaymentStatusType?


Properties

Property Details
identity
READ-ONLY
"identity": 12
Type: Number
This is the unique numeric identifier for the PaymentStatusType
name
"name": "Authorized"
Type: String
User defined name for the Payment Status Type.


End Points

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