Zola Suite Client Portal API

<back to all web services

PostDepositRequest

Requires Authentication
The following routes are available for this service:
POST/api2/deposits/
PostDepositRequest Parameters:
NameParameterData TypeRequiredDescription
PayablesKeysbodyIEnumerable<PayableKey>No
CreditCardInfobodyClientCardNo
DepositbodyDepositDtoNo
PayableKey Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
AmountformdecimalNo
SharedObjectTypeformstringNo
IsTrustformboolNo
IsSurchargeTransferEnabledformboolNo
ClientCard Parameters:
NameParameterData TypeRequiredDescription
amountInCentformintNo
nameformstringNo
numberformstringNo
expMonthformintNo
expYearformintNo
addressformstringNo
cityformstringNo
stateformstringNo
cvvformstringNo
postalCodeformstringNo
secretKeyformstringNo
LawPayTokenformstringNo
NotStoredLawPayTokenformstringNo
SaveCardEnabledformboolNo
ClientIdformint?No
ClientTypeformint?No
CardTypeformstringNo
IsDefaultformboolNo
DateAddedformDateTimeNo
CardIdformintNo
PaymentTokenformstringNo
FirmIdformintNo
UserIdformintNo
EmailformstringNo
DepositDto Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AmountformdecimalNo
CreditCardInfoformClientCardNo
payNowTokenIdformstringNo
ResponseWithStatus Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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 /api2/deposits/ HTTP/1.1 
Host: zolacaseway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostDepositRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClientPortalService.Deposits.Routes">
  <CreditCardInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Omnizant_BL.LawPay">
    <d2p1:CardId>0</d2p1:CardId>
    <d2p1:CardType>String</d2p1:CardType>
    <d2p1:ClientId>0</d2p1:ClientId>
    <d2p1:ClientType>0</d2p1:ClientType>
    <d2p1:DateAdded>0001-01-01T00:00:00</d2p1:DateAdded>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FirmId>0</d2p1:FirmId>
    <d2p1:IsDefault>false</d2p1:IsDefault>
    <d2p1:LawPayToken>String</d2p1:LawPayToken>
    <d2p1:NotStoredLawPayToken>String</d2p1:NotStoredLawPayToken>
    <d2p1:PaymentToken>String</d2p1:PaymentToken>
    <d2p1:SaveCardEnabled>false</d2p1:SaveCardEnabled>
    <d2p1:UserId>0</d2p1:UserId>
    <d2p1:address>String</d2p1:address>
    <d2p1:amountInCent>0</d2p1:amountInCent>
    <d2p1:city>String</d2p1:city>
    <d2p1:cvv>String</d2p1:cvv>
    <d2p1:expMonth>0</d2p1:expMonth>
    <d2p1:expYear>0</d2p1:expYear>
    <d2p1:name>String</d2p1:name>
    <d2p1:number>String</d2p1:number>
    <d2p1:postalCode>String</d2p1:postalCode>
    <d2p1:secretKey>String</d2p1:secretKey>
    <d2p1:state>String</d2p1:state>
  </CreditCardInfo>
  <Deposit xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClientPortalService.Common">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:CreditCardInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/Omnizant_BL.LawPay">
      <d3p1:CardId>0</d3p1:CardId>
      <d3p1:CardType>String</d3p1:CardType>
      <d3p1:ClientId>0</d3p1:ClientId>
      <d3p1:ClientType>0</d3p1:ClientType>
      <d3p1:DateAdded>0001-01-01T00:00:00</d3p1:DateAdded>
      <d3p1:Email>String</d3p1:Email>
      <d3p1:FirmId>0</d3p1:FirmId>
      <d3p1:IsDefault>false</d3p1:IsDefault>
      <d3p1:LawPayToken>String</d3p1:LawPayToken>
      <d3p1:NotStoredLawPayToken>String</d3p1:NotStoredLawPayToken>
      <d3p1:PaymentToken>String</d3p1:PaymentToken>
      <d3p1:SaveCardEnabled>false</d3p1:SaveCardEnabled>
      <d3p1:UserId>0</d3p1:UserId>
      <d3p1:address>String</d3p1:address>
      <d3p1:amountInCent>0</d3p1:amountInCent>
      <d3p1:city>String</d3p1:city>
      <d3p1:cvv>String</d3p1:cvv>
      <d3p1:expMonth>0</d3p1:expMonth>
      <d3p1:expYear>0</d3p1:expYear>
      <d3p1:name>String</d3p1:name>
      <d3p1:number>String</d3p1:number>
      <d3p1:postalCode>String</d3p1:postalCode>
      <d3p1:secretKey>String</d3p1:secretKey>
      <d3p1:state>String</d3p1:state>
    </d2p1:CreditCardInfo>
    <d2p1:ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </d2p1:ResponseStatus>
    <d2p1:payNowTokenId>String</d2p1:payNowTokenId>
  </Deposit>
  <PayablesKeys xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClientPortalService.Common" i:nil="true" />
</PostDepositRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseWithStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClientPortalService.Deposits.Routes">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ResponseWithStatus>