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

{"customerId":"00000000000000000000000000000000","applicationName":"String"}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

[{"id":"00000000000000000000000000000000","customerId":"00000000000000000000000000000000","merchantId":"String","merchantKey":"String","merchantPin":"String","displayName":"String","testMode":0,"allowToken":false,"maxPaymentAmount":0,"minPaymentAmount":0,"billTypes":[{"id":"00000000000000000000000000000000","paymentGatewayId":"00000000000000000000000000000000","billTypeId":0,"applyConvenienceFee":false}],"paymentTypes":[{"id":"00000000000000000000000000000000","paymentGatewayId":"00000000000000000000000000000000","paymentType":"String"}],"convenienceFees":[{"id":"00000000000000000000000000000000","paymentGatewayId":"00000000000000000000000000000000","paymentType":"String","minRange":0,"maxRange":0,"feeAmount":0,"applyAtPaymentOfBoot":false,"applyAtPaymentOfNotice":false,"applyAtPaymentOfTow":false,"totalPaymentAmount":0,"applyConvenienceFee":false}],"applications":[{"id":"00000000000000000000000000000000","paymentGatewayId":"00000000000000000000000000000000","applicationId":"00000000000000000000000000000000","isActive":false,"primaryPaymentVenue":false}]}]