Accounts-accountId-paymentInfo:GET
From Hostway API Documentation
Revision as of 10:57, 11 March 2014 by Mike.robski (Talk | contribs)
GET /accounts/{accountId}/paymentInfo
Retrieves a list of all active payment methods.
Contents |
Request
GET /accounts/{accountId}/paymentInfo
Parameters
- accountId - string
- The Id of the account.
URI Parameters
None.
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Response
Status Code
- 200 OK
- Success
- 404 Not Found
- The account Id was not found.
- 403 Forbidden
- The user lacks the necessary permissions to access the resource
Response Body
{
"list": [{
"paymentType": "directDebit",
"routingNumber": "564738291",
"links": [{"href": "https://api.hostway.com/accounts/{accountId}/paymentInfo/dd-100062441", "rel": "self"}],
"accountNumber": "XXXXXXXXXXXX2332"
}, {
"links": [{"href": "https://api.hostway.com/accounts/{accountId}/paymentInfo/cc-100069155", "rel": "self"}],
"paymentType": "creditCard",
"cardType": "visa",
"cardNumber": "XXXXXXXXXXXX1111",
"expirationDate": "2017-04"
}],
"links": [
{"href": "https://api.hostway.com/accounts/{accountId}/paymentInfo/", "rel": "self"}
]
}
Parameters
- list - list
- A collection of dictionaries containing information about specific products
- paymentType - string
- Describes whether the type of the payment method. Valid values are directDebit or creditCard
- routingNumber - string
- (OPTIONAL)
- Only available for direct debit. Contains the routing number of the payment method
- accountNumber - integer
- (OPTIONAL)
- Only available for direct debit. Contains the masked account number associated with the payment method
- cardType - string
- (OPTIONAL)
- Only available for credit card. Describes the type of the card
- cardNumber - string
- (OPTIONAL)
- Only available for credit card. Contains the masked number of the credit card
- expirationDate - string
- (OPTIONAL)
- Only available for credit card. Contains the expiration date of the card
- links - list
- Hypermedia for the individual payment method
- links - list
- Hypermedia for this resource. Links to self
See also
