Orders-orderId-account-paymentInfo:GET
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision) |
(→Parameters) |
||
| Line 25: | Line 25: | ||
=== Response Body === | === Response Body === | ||
| + | The following is the response body for credit cards. | ||
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 31: | Line 32: | ||
"creditCardType": "visa", | "creditCardType": "visa", | ||
"expirationDate": "2012-08", | "expirationDate": "2012-08", | ||
| + | "links": [ | ||
| + | {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{order_id}/account/paymentInfo/", "rel": "self"} | ||
| + | ] | ||
| + | } | ||
| + | </nowiki> | ||
| + | |||
| + | The following is the response for Verizon payment information. | ||
| + | <nowiki> | ||
| + | { | ||
| + | "paymentInfoType": "vz_payment", | ||
| + | "paymentReference": "123432429034", | ||
| + | "sessionId": "23432434244", | ||
"links": [ | "links": [ | ||
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{order_id}/account/paymentInfo/", "rel": "self"} | {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{order_id}/account/paymentInfo/", "rel": "self"} | ||
| Line 41: | Line 54: | ||
: The type of payment method. Possible value(s) are: | : The type of payment method. Possible value(s) are: | ||
:: '''credit_card''' | :: '''credit_card''' | ||
| + | :: '''vz_payment''' | ||
; accountNumber - ''string'' | ; accountNumber - ''string'' | ||
| Line 50: | Line 64: | ||
; expirationDate - ''string'' | ; expirationDate - ''string'' | ||
: The credit card expiration date in YYYY-MM format. Only applies for credit cards. | : The credit card expiration date in YYYY-MM format. Only applies for credit cards. | ||
| + | |||
| + | ; paymentReference - ''string'' | ||
| + | : Verizon payment reference id. Only applies for Verizon payment type. | ||
| + | |||
| + | ; sessionId - ''string'' | ||
| + | : Verizon payment session id. Only applies for Verizon payment type. | ||
; links - ''list'' | ; links - ''list'' | ||
Revision as of 16:48, 20 September 2013
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.
Contents |
Request
GET /orders/{orderId}/account/paymentInfo
Request Parameters
- orderId - string
- The unique order Id. The URI of the order is returned by the POST /orders call.
URI Parameters
None.
Request Headers
- Cookie
- A cookie named OwnerId to identify the client (for most browser clients, the browser will do this automatically, depending on the browser configuration). The value of the cookie would come from the response to the create order request in the Set-Cookie response header.
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
The following is the response body for credit cards.
{
"paymentInfoType": "credit_card",
"accountNumber": "************1111",
"creditCardType": "visa",
"expirationDate": "2012-08",
"links": [
{"href": "https://api.hostway.com/orders/{order_id}/account/paymentInfo/", "rel": "self"}
]
}
The following is the response for Verizon payment information.
{
"paymentInfoType": "vz_payment",
"paymentReference": "123432429034",
"sessionId": "23432434244",
"links": [
{"href": "https://api.hostway.com/orders/{order_id}/account/paymentInfo/", "rel": "self"}
]
}
Parameters
- paymentInfoType - string
- The type of payment method. Possible value(s) are:
- credit_card
- vz_payment
- 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.
- paymentReference - string
- Verizon payment reference id. Only applies for Verizon payment type.
- sessionId - string
- Verizon payment session id. Only applies for Verizon payment type.
- links - list
- Hypermedia for this resource. Links to self.
See also
