GET | /payments/alerts | Gets Pre-Payment Alerts for this Collection Attempt |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CollectionAttemptId | body | Guid | Yes | The Collection Attempt Id. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IsVehicleBeingTowed | form | bool | No | |
VehicleCancelledCheckOrChargebackAlerts | form | List<VehicleAlert> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
AlertTypeId | form | int | No | |
Note | form | string | No | |
AlertType | form | string | No | |
IsActive | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /payments/alerts HTTP/1.1 Host: api.paylock.com Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"isVehicleBeingTowed":false,"vehicleCancelledCheckOrChargebackAlerts":[{"id":"00000000000000000000000000000000","alertTypeId":0,"note":"String","alertType":"String","isActive":false}]}