BootView WebApi

<back to all web services

GetPaymentById

The following routes are available for this service:
GET/payments/{id}Gets a payment. If not found or no permission, throws exception.
GetPaymentById Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe Payment Id.
Payment Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TransactionNumberformintNo
OriginatingAttemptIdformGuid?No
BatchNumberformintNo
TotalAmountformdecimalNo
PlacedDateformDateTimeNo
IsSuccessfulformboolNo
PaymentTypeformstringNo
CreatedByUserIdformGuidNo
FirstNameformstringNo
LastNameformstringNo
PhoneformstringNo
EmailformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateCodeformstringNo
PostalCodeformstringNo
CountryCodeformstringNo
PaymentNoteformstringNo
IsDeletedformboolNo
CustomerIdformGuidNo
CustomerReceiptNumberformstringNo
CustomerReceiptDateformDateTime?No
TotalAllocatedformdecimalNo
CreatedByUserNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /x-msgpack/reply/GetPaymentById HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/x-msgpack
Content-Length: length

{"id":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{Unable to show example output for type 'Payment' using the custom 'x-msgpack' filter}Cannot create an abstract class.