Gets a list of payment types.
Name | Description | Usage |
---|---|---|
isActive | This will filter the request by the is active flag. | GET paymenttypes?filter=isactive~{operator}~{value} |
name | This will filter the request by name. | GET paymenttypes?filter=name~{operator}~{value} |
Name | Description | Usage |
---|---|---|
name | This will sort the response by name. | GET paymenttypes?sort=name |
paymentTypeId | This will sort the response by payment type ID. | GET paymenttypes?sort=paymenttypeid |
Name | Description | Usage |
---|---|---|
index | The index to retrieve when requesting paged results. | GET paymenttypes?page=index~{value} |
size | The size of the page when retrieving paged results. | GET paymenttypes?page=size~{value} |
If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.
{
"PaymentTypes": [
{
"Description": "Google Checkout",
"IsActive": true,
"Name": "Google Checkout",
"PaymentTypeId": 3
}
],
"PageIndex": null,
"PageSize": null,
"TotalPages": null,
"TotalResults": null,
"ErrorCode": null,
"ErrorMessage": null,
"StackTrace": null,
"AllowHtmlResponse": false,
"HasError": false,
"StringResponse": null
}