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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"operationalId":"String","email":"String","otherAmountToPay":0,"currentBalanceToPay":0,"percentToPay":0,"paymentType":"CurrentBalance","accountName":"String","accountNumber":"String","routingNumber":"String","hasSavedAccount":false,"saveAccount":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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