SimplicityCollect Web Services API

<back to all web services

AddPayment

The following routes are available for this service:
All Verbs/accounts/payments/add
AddPayment Parameters:
NameParameterData TypeRequiredDescription
ApiTokenquerystringNo
AccountIdquerystringNo
AccountNumberquerystringNo
PaymentTypequerystringNo
PaymentAmountquerydoubleNo
AddPaymentResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
MessageformstringNo

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 /accounts/payments/add HTTP/1.1 
Host: app.simplicitycollect.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServiceHelper.Accounts.Payments">
  <AccountId>String</AccountId>
  <AccountNumber>String</AccountNumber>
  <ApiToken>String</ApiToken>
  <PaymentAmount>0</PaymentAmount>
  <PaymentType>String</PaymentType>
</AddPayment>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServiceHelper.Accounts.Payments">
  <Message>String</Message>
  <Status>String</Status>
</AddPaymentResponse>