AvalonAccess API

<back to all web services

PaymentRequest

The following routes are available for this service:
POST/payment
PaymentRequest Parameters:
NameParameterData TypeRequiredDescription
OperationalIdbodystringNo
EmailbodystringNo
OtherAmountToPaybodydecimalNo
CurrentBalanceToPaybodydecimalNo
PercentToPaybodyshortNo
PaymentTypebodyPaymentTypeNo
AccountNamebodystringNo
AccountNumberbodystringNo
RoutingNumberbodystringNo
HasSavedAccountbodyboolNo
SaveAccountbodyboolNo
PaymentType Enum:
CurrentBalance
Percentage
OtherAmount
PaymentResponse Parameters:
NameParameterData TypeRequiredDescription
CheckNumberformstringNo
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 /payment HTTP/1.1 
Host: avalonaccessapi.avalonbay.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Request">
  <AccountName>String</AccountName>
  <AccountNumber>String</AccountNumber>
  <CurrentBalanceToPay>0</CurrentBalanceToPay>
  <Email>String</Email>
  <HasSavedAccount>false</HasSavedAccount>
  <OperationalId>String</OperationalId>
  <OtherAmountToPay>0</OtherAmountToPay>
  <PaymentType>CurrentBalance</PaymentType>
  <PercentToPay>0</PercentToPay>
  <RoutingNumber>String</RoutingNumber>
  <SaveAccount>false</SaveAccount>
</PaymentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Response">
  <CheckNumber>String</CheckNumber>
  <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>
</PaymentResponse>