Orders-orderId-account-paymentInfo:GET - Revision history

Mike.robski: 1 revision: Release 109

2015-07-24T18:12:22Z

1 revision: Release 109

Jerry.dimitrov: /* Response Body */

2015-06-12T12:21:31Z

Response Body

Mike.robski: 1 revision: Release 99

2014-10-14T15:06:56Z

1 revision: Release 99

Pa.dinh at 12:42, 1 October 2014

2014-10-01T12:42:24Z

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:32Z

1 revision: Release 98

Pa.dinh: /* Status Code */

2014-09-08T16:59:26Z

Status Code

Mike.robski: 1 revision: Release 85

2013-09-27T21:31:46Z

1 revision: Release 85

Charles.rydholm: /* Parameters */

2013-09-20T21:48:04Z

Parameters

Mike.robski: 1 revision

2013-02-17T06:58:59Z

1 revision

Mike.robski at 23:04, 15 February 2013

2013-02-15T23:04:12Z

New page

= GET /orders/''{orderId}''/account/paymentInfo =
Get the payment method information for a given order. Only a minimum amount of information will be returned to recognize the payment method.
__TOC__

== Request ==
<code>GET /orders/''{orderId}''/account/paymentInfo</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== Response ==

=== Status Code ===
;200 OK
: The operation was successfully completed.

;404 Not Found
: An account or payment method has not been added to the given order or the order does not exist.

=== Response Body ===
<nowiki>
{
"paymentInfoType": "credit_card",
"accountNumber": "************1111",
"creditCardType": "visa",
"expirationDate": "2012-08",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{order_id}/account/paymentInfo/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; paymentInfoType - ''string''
: The type of payment method. Possible value(s) are:
:: '''credit_card'''

; accountNumber - ''string''
: The credit card number. Only the last four digits will be revealed. Only applies for credit cards.

; creditCardType - ''string''
: The type of credit card such as visa, mastercard, discover, etc. Only applies for credit cards.

; expirationDate - ''string''
: The credit card expiration date in YYYY-MM format. Only applies for credit cards.

; links - ''list''
: [[Hypermedia]] for this resource. Links to self.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

@@ Line 70: / Line 70: @@
    "paymentReference": "123432429034",
    "sessionId": "23432434244",
    "links": [
      {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{order_id}/account/paymentInfo/", "rel": "self"}
@@ Line 81: / Line 91: @@
 :: '''credit_card'''
 :: '''vz_payment'''
 ; accountNumber - ''string''

@@ Line 31: / Line 31: @@
 | align="center" | -
 | No owner Id specified or the specified owner is not authorized to get payment info for this order.
 |-
 | rowspan="3" | 404 Not Found
@@ Line 40: / Line 44: @@
 |-
 | No payment info for the order was found.
 |}
@@ Line 131: / Line 139: @@
 Either you supplied the wrong credentials (e.g., bad password),
 or your browser does not understand how to supply the credentials required.</nowiki>
 === Order does not exist ===

@@ Line 18: / Line 18: @@
 === Status Code ===
-;200 OK
+{| class='wikitable'
-: The operation was successfully completed.
+|-
+! Status Code
-;404 Not Found
+! Error Message
-: An account or payment method has not been added to the given order or the order does not exist.
+! Description
 === Response Body ===
@@ Line 73: / Line 91: @@
 ; links - ''list''
 : [[Hypermedia]] for this resource. Links to self.
 == See also ==

@@ Line 25: / Line 25: @@
 === Response Body ===
   <nowiki>
+{
@@ Line 31: / Line 32: @@
    "creditCardType": "visa",
    "expirationDate": "2012-08",
    "links": [
      {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{order_id}/account/paymentInfo/", "rel": "self"}
@@ Line 41: / Line 54: @@
 : The type of payment method. Possible value(s) are:
 :: '''credit_card'''
 ; accountNumber - ''string''
@@ Line 50: / Line 64: @@
 ; expirationDate - ''string''
 : The credit card expiration date in YYYY-MM format. Only applies for credit cards.
 ; links - ''list''