AvalonAccess API

<back to all web services

CreditCardPaymentRequest

The following routes are available for this service:
POST/payment/creditcard
CreditCardPaymentRequest Parameters:
NameParameterData TypeRequiredDescription
OnlineCreditCardPaymentIdbodystringYes
CreditCardPaymentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ErrorCodeformstringNo
HttpCodeformintNo
MesAuthCodeformstringNo
MesAvsResultformstringNo
MesCvvResultformstringNo
MesDurationformstringNo
MesResponseTextformstringNo
MesTransactionIdformstringNo
IsApprovedformboolNo
CheckNumberformstringNo
PropertyManagementIdformstringNo
PersonIdformstringNo
LeaseIdformstringNo
CommunityCodeformstringNo
SubCommunityCodeformstringNo

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 /payment/creditcard HTTP/1.1 
Host: avalonaccessapi.avalonbay.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	onlineCreditCardPaymentId: 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
		}
	},
	errorCode: String,
	httpCode: 0,
	mesAuthCode: String,
	mesAvsResult: String,
	mesCvvResult: String,
	mesDuration: String,
	mesResponseText: String,
	mesTransactionId: String,
	isApproved: False,
	checkNumber: String,
	propertyManagementId: String,
	personId: String,
	leaseId: String,
	communityCode: String,
	subCommunityCode: String
}