BootView WebApi

<back to all web services

UpdateCustomerPaymentGateway

The following routes are available for this service:
PUT/customers/{customerId}/paymentgateways/{id}Updates an existing payment gateway. Fails if the payment gateway doesn't exist.
UpdateCustomerPaymentGateway Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer Id.
IdpathGuidYesThe payment gateway Id.
MerchantIdbodystringNoThe merchant id for this customer payment gateway.
MerchantKeybodystringNoThe merchant key for this customer payment gateway.
MerchantPinbodystringNoThe merchant pin for this customer payment gateway.
DisplayNamebodystringYesThe display name for this customer payment gateway.
TestModebodyintNoWhether or not this payment gateway is in test mode.
AllowTokenbodyboolNoWhether or not this payment gateway should allow token.
MaxPaymentAmountbodydecimalNoThe maximum payment amount for this payment gateway.
MinPaymentAmountbodydecimalNoThe minimum payment amount for this payment gateway.
BillTypesbodyList<PaymentGatewayBillType>NoA list of bill types associated with this payment gateway.
ApplicationsbodyList<Application>NoA list of applications associated with this payment gateway.
PaymentTypesbodyList<PaymentGatewayPaymentType>NoA list of payment types associated with this payment gateway.
ConvenienceFeesbodyList<ConvenienceFee>NoA list of convenience fees associated with this payment gateway.
PaymentGatewayBillType Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
PaymentGatewayIdformGuid?No
BillTypeIdformintNo
ApplyConvenienceFeeformboolNo
PaymentGatewayApplication Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
PaymentGatewayIdformGuid?No
ApplicationIdformGuidNo
IsActiveformboolNo
PrimaryPaymentVenueformboolNo
PaymentGatewayPaymentType Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
PaymentGatewayIdformGuid?No
PaymentTypeformstringNo
ConvenienceFee Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
PaymentGatewayIdformGuid?No
PaymentTypeformstringNo
MinRangeformdecimal?No
MaxRangeformdecimal?No
FeeAmountformdecimal?No
ApplyAtPaymentOfBootformbool?No
ApplyAtPaymentOfNoticeformbool?No
ApplyAtPaymentOfTowformbool?No
TotalPaymentAmountformdecimal?No
ApplyConvenienceFeeformbool?No

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.

PUT /customers/{customerId}/paymentgateways/{id} HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateCustomerPaymentGateway xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <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>
</UpdateCustomerPaymentGateway>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">00000000-0000-0000-0000-000000000000</guid>