Accounts-accountId-paymentInfo:GET - Revision history

Mike.robski: 1 revision: Release 92

2014-04-08T17:20:47Z

1 revision: Release 92

Dinh.anh: /* Parameters */

2014-04-01T11:11:49Z

Parameters

Mike.robski: 1 revision: Release 91

2014-03-11T16:57:41Z

1 revision: Release 91

Dragomir.penev: Created page with "= GET /accounts/''{accountId}''/paymentInfo = Retrieves a list of all active payment methods. TOC == Request == `GET /accounts/''{accountId}''/paymentInfo` ===..."

2014-02-24T15:35:44Z

Created page with "= GET /accounts/''{accountId}''/paymentInfo = Retrieves a list of all active payment methods. __TOC__ == Request == <code>GET /accounts/''{accountId}''/paymentInfo</code> ===..."

New page

= GET /accounts/''{accountId}''/paymentInfo =
Retrieves a list of all active payment methods.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/paymentInfo</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}

== 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 ===
<nowiki>
{
"list": [{
"paymentType": "directDebit",
"routingNumber": "564738291",
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/paymentInfo/dd-100062441", "rel": "self"}],
"accountNumber": "XXXXXXXXXXXX2332"
}, {
"links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/paymentInfo/cc-100069155", "rel": "self"}],
"paymentType": "creditCard",
"cardType": "visa",
"cardNumber": "XXXXXXXXXXXX1111",
"expirationDate": "2017-04"
}],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/paymentInfo/", "rel": "self"}
]
}
</nowiki>

==== 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 ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

@@ Line 20: / Line 20: @@
 ;200 OK
 : Success
 ;404 Not Found
 : The account Id was not found.
 === Response Body ===
@@ Line 31: / Line 31: @@
+{
    "list": [{
-     "paymentType": "directDebit",
+     "paymentInfoType": "direct_debit",
      "routingNumber": "564738291",
      "links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/paymentInfo/dd-100062441", "rel": "self"}],
-     "accountNumber": "XXXXXXXXXXXX2332"
+     "accountNumber": "XXXXXXXXXXXX2332",
    }, {
      "links": [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/paymentInfo/cc-100069155", "rel": "self"}],
-     "paymentType": "creditCard",
+     "paymentInfoType": "credit_card",
-     "cardType": "visa",
+     "creditCardType": "visa",
-     "cardNumber": "XXXXXXXXXXXX1111",
+     "accountNumber": "XXXXXXXXXXXX1111",
-     "expirationDate": "2017-04"
+     "expirationDate": "2017-04",
    }],
    "links": [
      {"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/paymentInfo/", "rel": "self"}
@@ Line 52: / Line 55: @@
 : A collection of dictionaries containing information about specific products
-:; paymentType - ''string''
+:; paymentInfoType- ''string''
-:: Describes whether the type of the payment method. Valid values are '''directDebit''' or '''creditCard'''
+:: Describes whether the type of the payment method. Valid values are '''direct_debit''' or '''credit_card'''
 :; routingNumber - ''string''
@@ Line 59: / Line 68: @@
 :: Only available for direct debit. Contains the routing number of the payment method
-:; accountNumber - ''integer''
+:; creditCardType - ''string''
-:: ''(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
 :; expirationDate - ''string''

Accounts-accountId-paymentInfo:GET - Revision history

Mike.robski: 1 revision: Release 92

Dinh.anh: /* Parameters */

Mike.robski: 1 revision: Release 91

Dragomir.penev: Created page with "= GET /accounts/''{accountId}''/paymentInfo = Retrieves a list of all active payment methods. __TOC__ == Request == GET /accounts/''{accountId}''/paymentInfo ===..."

Dragomir.penev: Created page with "= GET /accounts/''{accountId}''/paymentInfo = Retrieves a list of all active payment methods. TOC == Request == `GET /accounts/''{accountId}''/paymentInfo` ===..."