BootView WebApi

<back to all web services

GetConvenienceFee

The following routes are available for this service:
GET/payments/{id}/conveniencefeeGets all gateway responses for payment. If not found or no permission, throws exception.
GetConvenienceFee Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe CollectionAttempt Id.
PaymentMethodbodystringYesThe Payment Method: CC, DC, EC, CP, OTHER
PaymentAmountbodydecimalYesThe amount being paid.
PaymentGatewayNamebodystringYesThe payment gateway name.

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

HTTP + XML

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

POST /xml/reply/GetConvenienceFee HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetConvenienceFee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <PaymentAmount>0</PaymentAmount>
  <PaymentGatewayName>String</PaymentGatewayName>
  <PaymentMethod>String</PaymentMethod>
</GetConvenienceFee>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfGetConvenienceFeeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <GetConvenienceFeeResult>
    <ConvenienceFee>0</ConvenienceFee>
  </GetConvenienceFeeResult>
</ArrayOfGetConvenienceFeeResult>