Zola Suite Client Portal API

<back to all web services

PostAPXDepositRequest

Requires Authentication
The following routes are available for this service:
POST/api2/deposits/APX
PostAPXDepositRequest Parameters:
NameParameterData TypeRequiredDescription
PayablesKeysbodyIEnumerable<PayableKey>No
DepositbodyDepositDtoNo
PayableKey Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
AmountformdecimalNo
SharedObjectTypeformstringNo
IsTrustformboolNo
IsSurchargeTransferEnabledformboolNo
DepositDto Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AmountformdecimalNo
CreditCardInfoformClientCardNo
payNowTokenIdformstringNo
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
ResponseWithStatus Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

{
	deposit: 
	{
		amount: 0,
		creditCardInfo: 
		{
			amountInCent: 0,
			name: String,
			number: String,
			expMonth: 0,
			expYear: 0,
			address: String,
			city: String,
			state: String,
			cvv: String,
			postalCode: String,
			secretKey: String,
			lawPayToken: String,
			notStoredLawPayToken: String,
			saveCardEnabled: False,
			clientId: 0,
			clientType: 0,
			cardType: String,
			isDefault: False,
			dateAdded: 0001-01-01,
			cardId: 0,
			paymentToken: String,
			firmId: 0,
			userId: 0,
			email: String
		},
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		payNowTokenId: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}