BootView WebApi

<back to all web services

EmailPaymentReceipt

The following routes are available for this service:
POST/collectionAttempts/{id}/receipts/messagesemails a receipt for any payments found on the collection attempt
EmailPaymentReceipt Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe Collection Attempt Id.
EmailsbodystringYesemail addresses
EmailPaymentReceiptResponse Parameters:
NameParameterData TypeRequiredDescription
QueuedformboolNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsformList<string>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 /collectionAttempts/{id}/receipts/messages HTTP/1.1 
Host: api.paylock.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 00000000000000000000000000000000,
	emails: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	queued: False,
	errors: 
	[
		String
	]
}