GET | /payments/{id} | Gets a payment. If not found or no permission, throws exception. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | Guid | Yes | The Payment Id. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
TransactionNumber | form | int | No | |
OriginatingAttemptId | form | Guid? | No | |
BatchNumber | form | int | No | |
TotalAmount | form | decimal | No | |
PlacedDate | form | DateTime | No | |
IsSuccessful | form | bool | No | |
PaymentType | form | string | No | |
CreatedByUserId | form | Guid | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
Phone | form | string | No | |
form | string | No | ||
Address1 | form | string | No | |
Address2 | form | string | No | |
City | form | string | No | |
StateCode | form | string | No | |
PostalCode | form | string | No | |
CountryCode | form | string | No | |
PaymentNote | form | string | No | |
IsDeleted | form | bool | No | |
CustomerId | form | Guid | No | |
CustomerReceiptNumber | form | string | No | |
CustomerReceiptDate | form | DateTime? | No | |
TotalAllocated | form | decimal | No | |
CreatedByUserName | form | string | 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/{id} HTTP/1.1 Host: api.paylock.com Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {Unable to show example output for type 'Payment' using the custom 'csv' filter}Cannot create an abstract class.