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

{
	isRefund: False,
	paymentMethod: String,
	collectionAttemptId: 00000000000000000000000000000000,
	paymentId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		gatewayName: String,
		gatewayNameWithAmount: String,
		applyConvenienceFee: False,
		totalPaymentAmount: 0,
		convenienceFee: 0,
		maxPaymentAmount: 0,
		minPaymentAmount: 0,
		defaultDisplay: False,
		netDue: 0,
		totalDue: 0,
		totalPaid: 0
	}
]