BootView WebApi

<back to all web services

CreateCustomerPaymentGateway

The following routes are available for this service:
POST/customers/{customerId}/paymentgatewaysCreates a new payment gateway entry for this Customer.
CreateCustomerPaymentGateway Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYesThe customer 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.
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
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 .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/CreateCustomerPaymentGateway HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	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
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

00000000000000000000000000000000