NAV

<back to all web services

Paydown

The following routes are available for this service:
POST/paydown
Paydown Parameters:
NameParameterData TypeRequiredDescription
BeeNumberbodydecimalNo
TransactionDatebodyDateTimeNo
PaymentsbodyList<PaydownPayment>No
FeesbodyList<PaydownPaymentFee>No
PaydownPayment Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringNo
PaymentAmountformdecimalNo
PaydownPaymentFee Parameters:
NameParameterData TypeRequiredDescription
FeeSystemKeywordformstringNo
FeeAmountformdecimal?No
PaydownResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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 /paydown HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	beeNumber: 0,
	transactionDate: 0001-01-01T00:00:00,
	payments: 
	[
		{
			paymentType: String,
			paymentAmount: 0
		}
	],
	fees: 
	[
		{
			feeSystemKeyword: String,
			feeAmount: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}