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

<CreditCardPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Request">
  <OnlineCreditCardPaymentId>String</OnlineCreditCardPaymentId>
</CreditCardPaymentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreditCardPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Response">
  <CheckNumber>String</CheckNumber>
  <CommunityCode>String</CommunityCode>
  <ErrorCode>String</ErrorCode>
  <HttpCode>0</HttpCode>
  <IsApproved>false</IsApproved>
  <LeaseId>String</LeaseId>
  <MesAuthCode>String</MesAuthCode>
  <MesAvsResult>String</MesAvsResult>
  <MesCvvResult>String</MesCvvResult>
  <MesDuration>String</MesDuration>
  <MesResponseText>String</MesResponseText>
  <MesTransactionId>String</MesTransactionId>
  <PersonId>String</PersonId>
  <PropertyManagementId>String</PropertyManagementId>
  <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>
  <SubCommunityCode>String</SubCommunityCode>
</CreditCardPaymentResponse>