BootView WebApi

<back to all web services

GetCustomerPaymentGateways

The following routes are available for this service:
GET/customers/{customerId}/paymentgatewaysGets a list of the given customer's payment gateways. Only returns the list if this user has access to this customer.
GetCustomerPaymentGateways Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer id
ApplicationNamequeryStringNoThe application 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/GetCustomerPaymentGateways HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

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

<ArrayOfCustomerPaymentGateway xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerPaymentGateway>
    <AllowToken>false</AllowToken>
    <Applications>
      <PaymentGatewayApplication>
        <ApplicationId>00000000-0000-0000-0000-000000000000</ApplicationId>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <IsActive>false</IsActive>
        <PaymentGatewayId>00000000-0000-0000-0000-000000000000</PaymentGatewayId>
        <PrimaryPaymentVenue>false</PrimaryPaymentVenue>
      </PaymentGatewayApplication>
    </Applications>
    <BillTypes>
      <PaymentGatewayBillType>
        <ApplyConvenienceFee>false</ApplyConvenienceFee>
        <BillTypeId>0</BillTypeId>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <PaymentGatewayId>00000000-0000-0000-0000-000000000000</PaymentGatewayId>
      </PaymentGatewayBillType>
    </BillTypes>
    <ConvenienceFees>
      <ConvenienceFee>
        <ApplyAtPaymentOfBoot>false</ApplyAtPaymentOfBoot>
        <ApplyAtPaymentOfNotice>false</ApplyAtPaymentOfNotice>
        <ApplyAtPaymentOfTow>false</ApplyAtPaymentOfTow>
        <ApplyConvenienceFee>false</ApplyConvenienceFee>
        <FeeAmount>0</FeeAmount>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <MaxRange>0</MaxRange>
        <MinRange>0</MinRange>
        <PaymentGatewayId>00000000-0000-0000-0000-000000000000</PaymentGatewayId>
        <PaymentType>String</PaymentType>
        <TotalPaymentAmount>0</TotalPaymentAmount>
      </ConvenienceFee>
    </ConvenienceFees>
    <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
    <DisplayName>String</DisplayName>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <MaxPaymentAmount>0</MaxPaymentAmount>
    <MerchantId>String</MerchantId>
    <MerchantKey>String</MerchantKey>
    <MerchantPin>String</MerchantPin>
    <MinPaymentAmount>0</MinPaymentAmount>
    <PaymentTypes>
      <PaymentGatewayPaymentType>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <PaymentGatewayId>00000000-0000-0000-0000-000000000000</PaymentGatewayId>
        <PaymentType>String</PaymentType>
      </PaymentGatewayPaymentType>
    </PaymentTypes>
    <TestMode>0</TestMode>
  </CustomerPaymentGateway>
</ArrayOfCustomerPaymentGateway>