BootView WebApi

<back to all web services

GetPaymentGateways

The following routes are available for this service:
GET/payments/gatewaysGets a collection attempt's available payment gateways
GetPaymentGateways Parameters:
NameParameterData TypeRequiredDescription
IsRefundbodyboolYesWhether or not we are dealing with a refund
PaymentMethodbodystringYesThe Payment Method
CollectionAttemptIdbodyGuidYesThe Collection Attempt Id.
PaymentIdbodyGuidNoThe payment id if exists Attempt Id.

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/GetPaymentGateways HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetPaymentGateways xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
  <IsRefund>false</IsRefund>
  <PaymentId>00000000-0000-0000-0000-000000000000</PaymentId>
  <PaymentMethod>String</PaymentMethod>
</GetPaymentGateways>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfPaymentGatewayforCid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <PaymentGatewayforCid>
    <AcceptedPaymentTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <ApplyConvenienceFee>false</ApplyConvenienceFee>
    <ConvenienceFee>0</ConvenienceFee>
    <DefaultDisplay>false</DefaultDisplay>
    <GatewayName>String</GatewayName>
    <GatewayNameWithAmount>String</GatewayNameWithAmount>
    <MaxPaymentAmount>0</MaxPaymentAmount>
    <MinPaymentAmount>0</MinPaymentAmount>
    <NetDue>0</NetDue>
    <TotalDue>0</TotalDue>
    <TotalPaid>0</TotalPaid>
    <TotalPaymentAmount>0</TotalPaymentAmount>
  </PaymentGatewayforCid>
</ArrayOfPaymentGatewayforCid>