BootView WebApi

<back to all web services

GetCollectionAttemptPayments

The following routes are available for this service:
GET/collectionattempts/{attemptId}/paymentsGet all the payments related to this attempt--either directly linked (via one or more payments it's allocated to) or where the payment orginated from the attempt. See the link property for attempt associations.
GetCollectionAttemptPayments Parameters:
NameParameterData TypeRequiredDescription
AttemptIdpathGuidYesThe collection attempt id for which we want all the payments.

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/GetCollectionAttemptPayments HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetCollectionAttemptPayments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <AttemptId>00000000-0000-0000-0000-000000000000</AttemptId>
</GetCollectionAttemptPayments>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCollectionAttemptPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CollectionAttemptPayment i:nil="true" />
</ArrayOfCollectionAttemptPayment>