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

HTTP + XML

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

POST /xml/reply/EmailPaymentReceipt HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<EmailPaymentReceipt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Emails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Emails>
  <Id>00000000-0000-0000-0000-000000000000</Id>
</EmailPaymentReceipt>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EmailPaymentReceiptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Errors>
  <Queued>false</Queued>
</EmailPaymentReceiptResponse>