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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/GetCustomerPaymentGateways HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	customerId: 00000000000000000000000000000000,
	applicationName: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
			}
		]
	}
]