| Note: This is the latest documentation. The previous version of this page is identical — only the left nav differs. |
Google Checkout uses the Notification API to inform you of a new order or to send you information about an existing order. The Notification API lets you integrate Google Checkout with your internal order fulfillment systems by allowing those systems to receive order information from Google. Typically, merchants choose to simultaneously integrate the Notification API and the Order Processing API, which allows you to send Google updated information about an order's financial state or its fulfillment state.
Each Google Checkout notification is a series of name=value pairs that Google sends in an HTTP POST request. To implement the Notification API, you must build and operate a web service that receives Google Checkout notifications and then communicates the details of those notifications to your internal order processing systems.
This document explains the process for receiving and processing notifications. This document also explains how you should respond to notifications to indicate whether you handled each notification successfully. This document proceeds to explain the different types of notifications that Google Checkout sends, including an HTML example for each type. Finally, this document defines the HTTP POST parameters used in all of the different types of notifications.
The following list identifies the different types of notifications that the API supports. Each item in the list links to a section that describes the notification and provides a sample notification.
New Order Notifications inform you of new orders that have been submitted through Google Checkout.
Risk Information Notifications provide financial information about a transaction to help you ensure that an order is not fraudulent.
Order State Change Notifications signal an update to an order's financial status or its fulfillment status.
Amount Notifications inform you that a charge, refund, chargeback or credit card authorization has been processed for an order. These notifications also identify the amount of the transaction.
To implement the Notification API, you must establish a web service that receives and processes Google Checkout notifications. Your web service must be secured by SSL v3 or TLS and must use a valid SSL certificate. The API callback URL that you use for your production account must use port 443, which is the default port for HTTPS. The API callback URL that you use for your Sandbox account may use either port 443 or port 80.
The following instructions explain how to format HTTP request headers to use HTTP Basic Authentication. You will need to follow these steps to send server-to-server requests to Google, including server-to-server Checkout API requests and Order Processing API requests.
Please note that Google also uses HTTP Basic Authentication to send Notification API requests to you. As such, when you receive a notification from Google, you can base64-decode the authorization header to confirm that the notification is valid.
Create a properly formatted HTML file for the command being executed. The Google Checkout HTML schema defines an HTML structure for each type of API request.
Follow these steps to create the HTTPS header for your request:
Create the Authorization header for your request.
Append a colon to your Google Checkout Merchant ID. Then append your Google Checkout Merchant Key to this value. (The value has the format MERCHANT_ID:MERCHANT_KEY.)
Base64-encode the value you produced in the previous step to generate your authorization key.
Provide the Authorization header for your request using the following format. Replace the text Authorization_Key in this header with your authorization key:
Include the Content-Type header with the value application/xml; charset=UTF-8
Include the Accept header with the value application/xml; charset=UTF-8
For example, if your Merchant ID is 1234567890 and your Merchant Key is HsYXFoZfHAqyLcCRYeH8qQ, you would base64-encode the value 1234567890:HsYXFoZfHAqyLcCRYeH8qQ. The example below shows how the base64-encoded value would appear in your request header:
Post the HTML structure created in step 1 to Google Checkout. This URL is constructed using your Google-assigned Merchant ID.
Note: You must replace the string MERCHANT_ID with your Google Checkout Merchant ID.
You must also secure Notification and Order Processing API requests with an SSL certificate.
When your web service receives a request, the service should verify that the request is authenticated with your Merchant ID and Merchant Key. As noted above, the notification will be a series of name=value pairs sent in an HTTP POST request. Your service should not process a notification unless your service can authenticate the notification.
After establishing your web service, log in to your Merchant Center account, click on the Settings tab and then click on the Integration link in the menu on the left side of the page. Enter the URL for your web service in the API callback URL field. (You need to enter your API callback URL in both your sandbox account and your production account.) You must also indicate whether you would like to receive notifications in XML format or HTML format. Please note that this document explains the HTML notification format.
When your web application receives a notification from Google, the application should attempt to parse and process the notification. Google allows you to choose one of the following processes for responding to notifications. Google recommends that you select the second method because it enables Google to more reliably confirm that you successfully processed a notification.
The following list explains Google Checkout's default policy for notification responses:
If your application parses and processes the notification successfully, the application needs to return an HTTP 200 response code, which indicates that the notification was received and processed successfully. Google will not resend a notification after receiving an HTTP 200 response code.
If your application is unable to parse or process the notification, the application needs to return either a 4xx or 5xx HTTP response code (500, 501, etc.). These response codes indicate that your server has experienced an error or is incapable of performing the request. Your application must not return an HTTP 200 response code.
If you return an error response code, Google will try resending the notification, according to our retry policy, for up to 30 days. Your application should return an error response code even in cases when you know the notification will continue to fail. If Google is unable to successfully send a new order notification to your API callback URL, Google will send you an email to notify you of the new order.
The following guidelines explain how to respond to notifications using a process that enables Google to more reliably confirm that you successfully processed a notification. This feature is only available on an opt-in basis because it may not be backward-compatible with Google Checkout integrations completed before October 2007. Instructions for opting in to this feature follow the guidelines below.
If your application parses and processes a notification successfully, the application needs to return an HTTP 200 response code as well as the serial number of the notification. You can parse this value from the notification's serial-number. Together, the response code and the serial number signify that you received the notification and processed it successfully. Google will not resend a notification after receiving this type of response.
To return the serial number in your HTTP response, send a notification-acknowledgment response. In that response, set the value of the serial-number parameter to the serial number of the notification.
The following examples demonstrate how to identify and return the serial number for a notification. Example 1 shows how the serial number would be conveyed in a new order notification. (All other types of notifications use the serial-number attribute in the same way.) Example 2 shows a notification-acknowledgment with the same serial number. In both examples, the serial number is shown in bold text.
Example 1: _type=new-order-notification &serial-number=85f54628-538a-44fc-8605-ae62364f6c71 ... /new-order-notification Example 2: _type=notification-acknowledgment &serial-number=85f54628-538a-44fc-8605-ae62364f6c71
If your application is unable to parse or process the notification, the application should return either a 4xx or 5xx response code (500, 501, etc.). These response codes indicate that your server has experienced an error or is incapable of performing the request. Please note that your application should return an error response code even in cases when you know the notification will continue to fail.
If you opt to use this feature, then you must return an HTTP 200 response code and the serial number for a successfully processed notification. Otherwise, Google will try to resend the notification, in accordance with our retry policy, for up to 30 days. Specifically, Google will resend a notification if you send any of the following responses to a notification:
An HTTP 4xx or 5xx response code. (Google recommends this response for a notification that is not handled successfully.)
An HTTP 200 response code that does not include the serial number of the processed notification. Please note that this policy represents a significant change from option 1, which describes Google's original policy for notification responses. Under that policy, Google will interpret any HTTP 200 response code as an indication that a notification was successfully processed.
Any other HTTP 2xx or 3xx response code.
The following instructions explain how to enable this feature for your account. Please note that you must complete these steps for your sandbox and production accounts:
Google sends a new order notification when a buyer places an order through Google Checkout. This notification contains the following information:
The shopping cart appears exactly as you sent it to Google in the Checkout API request for the order. The shopping cart contains the list of items in the buyer's order as well as the expiration date for the shopping cart if you provided one.
Information about the shipping method that the buyer selected and the shipping cost. The notification also contains the taxes charged to the customer as well as information about any coupons applied to the order.
The billing and shipping addresses for the order, respectively.
The order-total element specifies the amount that the buyer will be charged for the order. Google determines the order total by adding the price of the items, shipping charges and taxes, and then subtracting adjustments for coupons.
The buyer-id element contains an ID that Google uses to uniquely identify a user. The email-allowed element indicates whether the buyer would like to receive marketing emails from you.
Before shipping the items in an order, you should wait until you have also received the risk information notification for that order as well as the order state change notification informing you that the order's financial state has been updated to CHARGEABLE.
The following request shows a sample new order notification. Please note that you must modify the settings in your merchant account if you want to receive the buyer's billing phone number, ship-to phone number, or parsed first and last name. Please see the definitions of the phone, first-name and last-name elements for more information about enabling these features.
_type=new-order-notification &serial-number=85f54628-538a-44fc-8605-ae62364f6c71 &google-order-number=841171949013218 &buyer-shipping-address.contact-name=Will%20Shipp-Toomey &buyer-shipping-address.email=willstoomey%40example.com &buyer-shipping-address.address1=10%20Example%20Road &buyer-shipping-address.city=Sampleville &buyer-shipping-address.region=CA &buyer-shipping-address.postal-code=94141 &buyer-shipping-address.country-code=US &buyer-shipping-address.phone=5555551234 &buyer-shipping-address.structured-name.first-name=Will &buyer-shipping-address.structured-name.last-name=Shipp-Toomey &buyer-billing-address.contact-name=Bill%20Hu &buyer-billing-address.email=billhu%40example.com &buyer-billing-address.address1=99%20Credit%20Lane &buyer-billing-address.city=Mountain%20View &buyer-billing-address.region=CA &buyer-billing-address.postal-code=94043 &buyer-billing-address.country-code=US &buyer-billing-address.phone=5555557890 &buyer-billing-address.structured-name.first-name=Bill &buyer-billing-address.structured-name.last-name=Hu &buyer-id=294873009217523 &fulfillment-order-state=NEW &financial-order-state=REVIEWING &shopping-cart.cart-expiration.good-until-date=2007-12-31T23%3A59%3A59-05%3A00 &shopping-cart.items.item-1.merchant-item-id=GGLAA1453 &shopping-cart.items.item-1.item-name=Dry%20Food%20Pack &shopping-cart.items.item-1.item-description=One%20pack%20of%20nutritious%20dried%emergency%20food. &shopping-cart.items.item-1.quantity=1 &shopping-cart.items.item-1.tax-table-selector=food &shopping-cart.items.item-1.unit-price=4.99 &shopping-cart.items.item-1.unit-price.currency=USD &shopping-cart.items.item-2.merchant-item-id=GGLAA1453 &shopping-cart.items.item-2.item-name=Megasound%202GB%20MP3%20Player &shopping-cart.items.item-2.item-description=Portable%20player%20holds%20500%20songs. &shopping-cart.items.item-2.quantity=1 &shopping-cart.items.item-2.tax-table-selector=food &shopping-cart.items.item-2.unit-price=179.99 &shopping-cart.items.item-2.unit-price.currency=USD &shopping-cart.items.item-2.merchant-private-item-data=merchant-product-id%3D1234567890 &order-adjustment.total-tax=11.05 &order-adjustment.total-tax.currency=USD &order-adjustment.shipping.flat-rate-shipping-adjustment.shipping-name=SuperShip &order-adjustment.shipping.flat-rate-shipping-adjustment.shipping-cost=9.95 &order-adjustment.shipping.flat-rate-shipping-adjustment.shipping-cost.currency=USD &order-total=190.98 &order-total.currency=USD &buyer-marketing-preferences.email-allowed=false ×tamp=2007-03-19T15%3A06%3A26.051Z
Google Checkout sends a risk information notification after completing its risk analysis on a new order. A risk-information-notification includes financial information such as the customer's billing address, a partial credit card number and other values that help you verify that an order is not fraudulent.
Note: Before shipping the items in the order, you should wait until you have also received the new order notification for the order and the order state change notification informing you that the order's financial state has been updated to CHARGEABLE.
The following request shows a sample risk information notification.
_type=risk-information-notification &serial-number=0b95f758-0332-45d5-aced-5da64c8fc5b9 &google-order-number=841171949013218 &risk-information.eligible-for-protection=true &risk-information.billing-address.contact-name=John%20Smith &risk-information.billing-address.email=johnsmith%40example.com &risk-information.billing-address.address1=10%20Example%20Road &risk-information.billing-address.city=Sampleville &risk-information.billing-address.region=CA &risk-information.billing-address.postal-code=94141 &risk-information.billing-address.country-code=US &risk-information.avs-response=Y &risk-information.cvn-response=M &risk-information.partial-cc-number=3719 &risk-information.ip-address=10.11.12.13 &risk-information.buyer-account-age=6 ×tamp=2007-03-19T15%3A06%3A26.051Z
Google sends an order state change notification to notify you that an order's financial status or its fulfillment status has changed. The notification identifies the new financial and fulfillment statuses for the order as well as the previous statuses for that order.
These status changes can be triggered by Order Processing API commands that you send to Google Checkout. For example, if you send Google Checkout a cancel-order request, Google will respond through the Notification API to inform you that it changed the order's status to CANCELLED.
The following HTTP POST request parameters show a sample order state change notification:
_type=order-state-change-notification &serial-number=c821426e-7caa-4d51-9b2e-48ef7ecd6423 &google-order-number=841171949013218 &new-financial-order-state=CHARGING &new-fulfillment-order-state=NEW &previous-financial-order-state=CHARGEABLE &previous-fulfillment-order-state=NEW ×tamp=2007-03-19T15:06:29.051Z
Google defines a set of notifications that report information about financial transactions for an order. These notifications inform you when an order is charged, refunded, charged back, or authorized to be charged. The following subsections contain information about each of these notifications:
Google Checkout sends a <charge-amount-notification> after successfully charging a customer for an order.
The following HTTP POST request parameters show a sample charge amount notification:
_type=charge-amount-notification &serial-number=bea6bc1b-e1e2-44fe-80ff-2391b25c2510 &google-order-number=841171949013218 &latest-charge-amount=226.06 &latest-charge-amount.currency=USD &total-charge-amount=226.06 &total-charge-amount.currency=USD ×tamp=2007-03-19T15:06:26.051Z
Google Checkout sends a refund-amount-notification after successfully executing a refund-order order processing command. You should not assume that Google has granted a refund until you receive this notification. Typically, this notification is sent within seconds of the corresponding refund-order request.
The following HTTP POST request parameters show a sample refund amount notification:
_type=refund-amount-notification &serial-number=bea6bc1b-e1e2-44fe-80ff-2391b25c2510 &google-order-number=841171949013218 &latest-refund-amount=226.06 &latest-refund-amount.currency=USD &total-refund-amount=226.06 &total-refund-amount.currency=USD ×tamp=2007-03-19T15:06:26.051Z
Google Checkout sends a <chargeback-amount-notification> when a customer initiates a chargeback against an order and Google approves the chargeback.
The following HTTP POST request parameters show a sample chargeback amount notification:
_type=chargeback-amount-notification &serial-number=bea6bc1b-e1e2-44fe-80ff-2391b25c2510 &google-order-number=841171949013218 &latest-chargeback-amount=226.06 &latest-chargeback-amount.currency=USD &total-chargeback-amount=226.06 &total-chargeback-amount.currency=USD ×tamp=2007-03-19T15:06:26.051Z
Google Checkout sends an <authorization-amount-notification> in response to a successful request for an explicit credit card reauthorization.
You can also modify your Checkout API request so that Google sends an <authorization-amount-notification> after Google authorizes the buyer's credit card for a new order. Include the following HTTP POST request parameter in your Checkout API request so that you receive an authorization amount notification for the initial credit card authorization:
_type=checkout-shopping-cart &order-processing-support.request-initial-auth-details=true
The following HTTP POST request parameters show a sample authorization amount notification:
_type=authorization-amount-notification &serial-number=bea6bc1b-e1e2-44fe-80ff-2391b25c2510 &google-order-number=841171949013218 &authorization-amount=226.06 &authorization-amount.currency=USD &authorization-expiration-date=2007-03-26T15:06:26.000Z &avs-response=Y &cvn-response=Y ×tamp=2007-03-19T15:06:26.051Z
| address1 |
The address1 parameter identifies the first line of the address to which an order is being shipped. API commands Content format for parameter value String
Sample use(s) risk-information.
|
| address2 |
The address2 parameter identifies the second line of the address to which an order is being shipped. API commands Content format for parameter value String
Sample use(s) risk-information.
|
| adjustment-total |
The adjustment-total parameter contains the total adjustment to an order total based on tax, shipping, gift certificates and coupon codes. API commands Content format for parameter value Decimal
Sample use(s) order-adjustment.
|
| applied-amount |
The applied-amount parameter contains the amount of a coupon or gift certificate that was applied to an order total. Associated recurring elements The applied-amount parameter must contain either the coupon-adjustment or the gift-certificate-adjustment element, and that element must be numbered.
API commands Content format for parameter value Decimal
Sample use(s) order-adjustment.
|
| buyer-id |
The buyer-id parameter contains an ID that uniquely identifies the user to Google. API commands Content format for parameter value Long
Sample use(s) buyer-id=294873009217523
|
| calculated-amount |
The calculated-amount parameter contains the calculated amount of a coupon or gift certificate. Associated recurring elements The calculated-amount parameter will contain either the coupon-adjustment or the gift-certificate-adjustment element, and that element will be numbered.
API commands Content format for parameter value Decimal
Sample use(s) order-adjustment.
|
| city |
The city parameter identifies the city associated with an order's billing or shipping address. API commands Content format for parameter value String
Sample use(s) In a carrier-calculated-shipping option in a Checkout API request:
<input type="hidden" name="checkout-flow-support. In a new order notification: [buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| code |
The code parameter contains the code for a coupon or gift certificate that a customer would like to apply to an order or that was applied to an order. Associated recurring elements In a new order notification, the code parameter will contain either the coupon-adjustment or the gift-certificate-adjustment element, and that element will be numbered.
API commands Content format for parameter value String
Sample use(s) In a new order notification:
order-adjustment. |
| company-name |
The company-name parameter identifies the company to which an order is being shipped. Please note that Google does not currently request this information from customers but may do so in the future. However, until then, this parameter will contain an empty value. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| contact-name |
The contact-name parameter identifies the person to whom an order is being shipped. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| country-code |
As a subtag of postal-area, the country-code parameter specifies a country associated with a tax areashipping restriction or address filter. In all other contexts, the country-code parameter identifies the country code associated with an order's billing address or shipping address. The value of this parameter must be a two-letter ISO 3166 country code. Associated recurring elements When the country-code parameter appears in a carrier-calculated shipping option in a Checkout API request, the shipping-package element must be numbered. In addition, the carrier-calculated-shipping element must be numbered with a value of 1.
API commands Content format for parameter value String
Sample use(s) In a carrier-calculated-shipping option in a Checkout API request:
<input type="hidden" name="checkout-flow-support. In a new order notification: [buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| currency |
| The currency parameter identifies the unit of currency associated with a price, shipping cost or other monetary value. Every monetary value in a Google Checkout API request must specify the currency associated with that value. The value of the currency parameter must be a three-letter ISO 4217 currency code.
Associated recurring elements The currency parameter includes recurring elements any time the monetary value associated with the currency also contains a recurring element. For example, in a Checkout API request, the unit-price parameter identifies the price of an item and contains the recurring item element. As such, the currency associated with the unit-price parameter value will also contain the repeating price parameter.
API commands Checkout, Charge Order, Refund Order, New Order Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) In a Checkout API request:
item type="hidden" name="shopping-cart.items.item-1.unit-price" value="12.99" item type="hidden" name="shopping-cart.items.item-1.unit-price.currency" value="USD" In a new order notification: order-adjustment.total-tax=1.38&order-adjustment.total-tax.currency=USD In a refund order request: amount=12.99&amount.currency=USD |
| description |
As a subtag of digital-content, the description parameter contains instructions for downloading a digital content item. Please use the item-description parameter to provide the description of the item being purchased. Note: This field has a maximum length of 1024 characters and may contain HTML tags. (HTML tags must be XML-escaped as described in the Google Checkout Developer's Guide.) As a subtag of promotion, the description parameter contains information about a promotion that Google applied to an order. Associated recurring elements The item element, which must be numbered, associates this parameter with a specific item in an order.
Content format for parameter value String
Sample use(s)
<input type="hidden" name="shopping-cart.items.item-#.digital-content.description" value="Please go to <a href="http://supersoft.example.com">our website</a>, and enter your access key so that you can download our software."/>
|
The email parameter identifies an email address that could be used to contact the person to be billed for an order or the order recipient. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| email-allowed |
The email-allowed parameter indicates whether the customer is willing to receive marketing emails from the merchant. API commands Content format for parameter value Boolean
Sample use(s) buyer-marketing-preferences.
|
| fax |
The fax parameter identifies a fax number that can be used to contact the person to be billed for an order or the order recipient. Please note that Google does not currently request this information from customers but may do so in the future. However, until then, this parameter will contain an empty value. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| financial-order-state |
The financial-order-state parameter identifies the financial status of an order. Valid values for this parameter are: REVIEWING - Google Checkout is reviewing the order. CHARGEABLE - The order is ready to be charged. CHARGING - The order is being charged; you may not refund or cancel an order until is the charge is completed. CHARGED - The order has been successfully charged; if the order was only partially charged, the buyer's account page will reflect the partial charge. PAYMENT_DECLINED - The charge attempt failed. CANCELLED - Either the buyer or the seller canceled the order. An order's financial state cannot be changed after the order is canceled. Learn more about when an order may be canceled. CANCELLED_BY_GOOGLE - Google canceled the order. Google may cancel orders due to a failed charge without a replacement credit card being provided within a set period of time or due to a failed risk check. If Google cancels an order, you will be notified of the reason the order was canceled in the reason parameter of an order-state-change-notification. Please see the Financial Commands in the Order Processing API document for more information about these states. API commands Content format for parameter value String
Sample use(s) financial-order-state=REVIEWING
|
| first-name |
The first-name parameter contains the first name of the buyer or recipient of an order. Please see the Matching Names in Notifications to Names in Your Database section for details about Google Checkout's name-splitting algorithm. Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| fulfillment-order-state |
The fulfillment-order-state parameter indicates the status of an order in the order handling process. Valid values for this parameter are: NEW - The order has been received but not prepared for shipping.
PROCESSING - The order is being prepared for shipping. DELIVERED - The seller has shipped the order. WILL_NOT_DELIVER - The seller will not ship the order; this status is used for canceled orders. API commands Content format for parameter value String
Sample use(s) fulfillment-order-state=NEW
|
| good-until-date |
The good-until-date parameter identifies the date that the order in a Checkout API request expires. The date must be specified using the ISO 8601 Date and Time Format. The time must include the time-zone designator for UTC (Coordinated Universal Time), which is "Z", or you may specify a local time along with a time-zone offset in hours and minutes. A time zone offset of "+hh:mm" indicates that the date/time uses a local time zone which is "hh" hours and "mm" minutes ahead of UTC. A time zone offset of "-hh:mm" indicates that the date/time uses a local time zone which is "hh" hours and "mm" minutes behind UTC. The examples show dates formatted using the UTC time-zone designator and using time-zone offsets. Note: If you specify a value for this element, Google Checkout will reject the shopping cart if the user submits the cart after the specified date. API commands Content format for parameter value Date/Time
Sample use(s)
<input type="hidden" name="shopping-cart.
Sample use(s) In a Checkout API request:
<input type="hidden" name="shopping-cart. In a new order notification: shopping-cart.cart-expiration.good-until-date=2007-12-31T11%3A59%3A59-05%3A00 |
| google-order-number |
The google-order-number parameter contains an ID, which Google generates, that uniquely identifies an order. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification, Charge Order, Refund Order, Cancel Order, Authorize Order, Process Order, Deliver Order, Add Tracking Data, Send Buyer Message, Archive Order, Unarchive Order, Add Merchant Order Number, Ship Items, Reset Items Shipping Information, Cancel Items, Return Items, Backorder Items
Content format for parameter value String
Sample use(s) google-order-number=6014423719
|
| id |
When the id parameter is used in a Checkout API request, it specifies a value that uniquely identifies the address from which a package will be shipped for carrier-calculated shipping. When it appears in a new order notification, the id parameter specifies a value that uniquely identifies a Google Checkout promotion. Associated recurring elements In a Checkout API request, the carrier-calculated-shipping element must be numbered with a value of 1 and the shipping-package element must also be numbered. In a new order notification, the promotion element will be numbered so that the promotion ID can be associated with a specific promotion.
API commands Content format for parameter value String
Sample use(s) promotions.
|
| item-description |
The item-description parameter contains a description of an item. Associated recurring elements The item element, which must be numbered, associates this parameter with a specific item in an order.
API commands Content format for parameter value String
Sample use(s)
<input type="hidden" name="shopping-cart.
<input type="hidden" name="item_description_#" value="Easy to use MP3 Player"/> |
| item-name |
The item-name parameter identifies the name of an item. Associated recurring elements The item element, which must be numbered, associates this parameter with a specific item in an order.
API commands Content format for parameter value String
Sample use(s)
<input type="hidden" name="shopping-cart.
|
| last-name |
The last-name parameter contains the last name of the buyer or recipient of an order. Please see the Matching Names in Notifications to Names in Your Database section for details about Google Checkout's name-splitting algorithm. Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| merchant-item-id |
The merchant-item-id parameter contains a value, such as a stock keeping unit (SKU), that you use to uniquely identify an item. Google Checkout will include this value in the new order notification for the order. This value also appears in the order information displayed in the Merchant Center. Note: To use the merchant-item-id to modify the shipping information for an item in an order, you must have provided the same merchant-item-id for that item in the Checkout API request for the order. Associated recurring elements The item element, which must be numbered, associates this parameter with a specific item in an order.
API commands Content format for parameter value String
Sample use(s)
<input type="hidden" name="shopping-cart.
|
| message |
The message parameter contains a message associated with a coupon or, when used in a send-buyer-message request, a message that you want to communicate to a buyer about a specific order. The maximum accepted length for the parameter value is 255 characters. When associated with a demo-failure response, the message parameter contains a short note that Google Checkout will return in an error message. In this context, the message parameter has a maximum length of 25 characters. Associated recurring elements In a new order notification, the message parameter must contain the coupon-adjustment element, and that element must be numbered.
API commands Content format for parameter value String
Sample use(s) In a send-buyer-message request:
message=Your+order+has+shipped. In a demo-failure command: message=test+error+handling |
| order-total |
The order-total parameter contains the total cost of an order, including taxes and shipping costs as well as discounts from coupons and gift certificates. API commands Content format for parameter value Decimal
Sample use(s) order-total=114.54
|
| phone |
The phone parameter identifies a phone number that can be used to contact the person to be billed for an order or the order recipient. To receive either the phone number for the buyer or the order recipient, you must set a preference in your Google Checkout merchant account. To set this preference, log in to your merchant account and click the Settings tab. Then click the Integration link on the left side of the page. Expand the list of advanced settings and, depending on your preferences, check the box next to either or both of the following preferences:
Then click the Save button to update your settings. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| postal-code |
The postal-code parameter identifies the zip code or postal code associated with either a billing address or a shipping address. Associated recurring elements When the postal-code parameter appears in a carrier-calculated shipping option in a Checkout API request, the shipping-package element must be numbered. In addition, the carrier-calculated-shipping element must be numbered with a value of 1.
API commands Content format for parameter value String
Sample use(s) In a carrier-calculated-shipping option in a Checkout API request:
<input type="hidden" name="checkout-flow-support. In a new order notification: [buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| price |
The price parameter contains the cost to ship an order using a particular shipping method. Associated recurring elements The parameter name must contain either the flat-rate-shipping or pickup elements, and that element must be numbered to associate the price with a particular shipping method.
API commands Content format for parameter value Decimal
Sample use(s)
<input type="hidden" name="checkout-flow-support.
<input type="hidden" name="checkout-flow-support. |
| quantity |
The quantity parameter identifies how many units of a particular item are included in the customer's shopping cart. Associated recurring elements The item element, which must be numbered, associates this parameter with a specific item in an order.
API commands Content format for parameter value Integer
Sample use(s)
<input type="hidden" name="shopping-cart.
|
| region |
The region parameter identifies the state or province associated with a billing address or shipping address. Associated recurring elements When the region parameter appears in a carrier-calculated shipping option in a Checkout API request, the shipping-package element must be numbered. In addition, the carrier-calculated-shipping element must be numbered with a value of 1.
API commands Content format for parameter value String
Sample use(s) In a carrier-calculated-shipping option in a Checkout API request:
<input type="hidden" name="checkout-flow-support. In a new order notification: [buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| serial-number |
| The serial-number parameter contains an ID that uniquely identifies a Google Checkout notification.
API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) serial-number=dc66f8c7
|
| shipping-cost |
The shipping-cost parameter identifies the shipping and handling amount that has been added to an order total. API commands Content format for parameter value Decimal
Sample use(s) order-adjustment.shipping.
|
| shipping-name |
The shipping-name parameter contains the name of the shipping method that the buyer selected for an order. API commands Content format for parameter value String
Sample use(s) order-adjustment.shipping.
|
| timestamp |
The timestamp parameter contains a date and time in ISO 8601 format. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value Date
Sample use(s) timestamp=2006-03-18T17%3A32%3A11
|
| total-amount |
The total-amount parameter specifies the amount that Google contributed to the cost of an order as a part of an ongoing promotion. Associated recurring elements The promotion element will be numbered so that the promotion amount can be associated with a specific promotion.
Content format for parameter value Decimal
Sample use(s) promotions.
|
| total-tax |
The total-tax parameter contains the total tax amount for an order. API commands Content format for parameter value Decimal
Sample use(s)
<input type="hidden" name="order-adjustment.total-tax" value=""/>
Sample use(s) order-adjustment.
|
| unit-price |
The unit-price parameter identifies the cost of the item. Associated recurring elements The item element, which must be numbered, associates this parameter with a specific item in an order.
API commands Content format for parameter value Decimal
Sample use(s)
<input type="hidden" name="shopping-cart.
|
| address1 |
The address1 parameter identifies the first line of the address to which an order is being shipped. API commands Content format for parameter value String
Sample use(s) risk-information.
|
| address2 |
The address2 parameter identifies the second line of the address to which an order is being shipped. API commands Content format for parameter value String
Sample use(s) risk-information.
|
| avs-response |
The avs-response parameter contains an Address Verification System (AVS) response. Possible values for this parameter are: Y - Full AVS match (address and postal code)
P - Partial AVS match (postal code only) A - Partial AVS match (address only) N - no AVS match U - AVS not supported by issuer API commands Content format for parameter value String
Sample use(s) risk-information.
|
| buyer-account-age |
The buyer-account-age parameter identifies the age, in days, of the buyer's Google Checkout account. API commands Content format for parameter value Integer
Sample use(s) risk-information.buyer-account-age=6
|
| city |
The city parameter identifies the city associated with an order's billing or shipping address. API commands Content format for parameter value String
Sample use(s) In a carrier-calculated-shipping option in a Checkout API request:
<input type="hidden" name="checkout-flow-support. In a new order notification: [buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| company-name |
The company-name parameter identifies the company to which an order is being shipped. Please note that Google does not currently request this information from customers but may do so in the future. However, until then, this parameter will contain an empty value. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| contact-name |
The contact-name parameter identifies the person to whom an order is being shipped. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| country-code |
As a subtag of postal-area, the country-code parameter specifies a country associated with a tax areashipping restriction or address filter. In all other contexts, the country-code parameter identifies the country code associated with an order's billing address or shipping address. The value of this parameter must be a two-letter ISO 3166 country code. Associated recurring elements When the country-code parameter appears in a carrier-calculated shipping option in a Checkout API request, the shipping-package element must be numbered. In addition, the carrier-calculated-shipping element must be numbered with a value of 1.
API commands Content format for parameter value String
Sample use(s) In a carrier-calculated-shipping option in a Checkout API request:
<input type="hidden" name="checkout-flow-support. In a new order notification: [buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| cvn-response |
The cvn-response parameter contains a credit verification value for the order. Possible values for this parameter are: M - CVN match
N - No CVN match U - CVN not available E - CVN error API commands Content format for parameter value String
Sample use(s) cvn-response=Mrisk-information.cvn-response=M
|
| eligible-for-protection |
The eligible-for-protection parameter indicates whether an order is eligible for Google Checkout's payment guarantee policy. API commands Content format for parameter value Boolean
Sample use(s) risk-information.eligible-for-protection=true
|
The email parameter identifies an email address that could be used to contact the person to be billed for an order or the order recipient. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| fax |
The fax parameter identifies a fax number that can be used to contact the person to be billed for an order or the order recipient. Please note that Google does not currently request this information from customers but may do so in the future. However, until then, this parameter will contain an empty value. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| google-order-number |
The google-order-number parameter contains an ID, which Google generates, that uniquely identifies an order. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification, Charge Order, Refund Order, Cancel Order, Authorize Order, Process Order, Deliver Order, Add Tracking Data, Send Buyer Message, Archive Order, Unarchive Order, Add Merchant Order Number, Ship Items, Reset Items Shipping Information, Cancel Items, Return Items, Backorder Items
Content format for parameter value String
Sample use(s) google-order-number=6014423719
|
| ip-address |
The ip-address parameter contains the buyer's IP address, which Google uses to assess the risk that the order is fraudulent. API commands Content format for parameter value String
Sample use(s) risk-information.ip-address=10.10.10.10
|
| partial-cc-number |
The partial-cc-number parameter contains the last four digits of the buyer's credit card number. API commands Content format for parameter value String
Sample use(s) risk-information.partial-cc-number=1234
|
| phone |
The phone parameter identifies a phone number that can be used to contact the person to be billed for an order or the order recipient. To receive either the phone number for the buyer or the order recipient, you must set a preference in your Google Checkout merchant account. To set this preference, log in to your merchant account and click the Settings tab. Then click the Integration link on the left side of the page. Expand the list of advanced settings and, depending on your preferences, check the box next to either or both of the following preferences:
Then click the Save button to update your settings. API commands Content format for parameter value String
Sample use(s) In a new order notification:
[buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| postal-code |
The postal-code parameter identifies the zip code or postal code associated with either a billing address or a shipping address. Associated recurring elements When the postal-code parameter appears in a carrier-calculated shipping option in a Checkout API request, the shipping-package element must be numbered. In addition, the carrier-calculated-shipping element must be numbered with a value of 1.
API commands Content format for parameter value String
Sample use(s) In a carrier-calculated-shipping option in a Checkout API request:
<input type="hidden" name="checkout-flow-support. In a new order notification: [buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| region |
The region parameter identifies the state or province associated with a billing address or shipping address. Associated recurring elements When the region parameter appears in a carrier-calculated shipping option in a Checkout API request, the shipping-package element must be numbered. In addition, the carrier-calculated-shipping element must be numbered with a value of 1.
API commands Content format for parameter value String
Sample use(s) In a carrier-calculated-shipping option in a Checkout API request:
<input type="hidden" name="checkout-flow-support. In a new order notification: [buyer-billing-address | buyer-shipping-address]. In a risk information notification: billing-address. |
| serial-number |
| The serial-number parameter contains an ID that uniquely identifies a Google Checkout notification.
API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) serial-number=dc66f8c7
|
| timestamp |
The timestamp parameter contains a date and time in ISO 8601 format. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value Date
Sample use(s) timestamp=2006-03-18T17%3A32%3A11
|
| google-order-number |
The google-order-number parameter contains an ID, which Google generates, that uniquely identifies an order. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification, Charge Order, Refund Order, Cancel Order, Authorize Order, Process Order, Deliver Order, Add Tracking Data, Send Buyer Message, Archive Order, Unarchive Order, Add Merchant Order Number, Ship Items, Reset Items Shipping Information, Cancel Items, Return Items, Backorder Items
Content format for parameter value String
Sample use(s) google-order-number=6014423719
|
| new-financial-order-state |
The new-financial-order-state parameter identifies the financial-order-state for an order following a status change. The new-financial-order-state parameter is included in an order state change notification along with a previous-financial-order-state, which identifies the financial-order-state for the order prior to the status change. Please see the Financial Commands in the Order Processing API document or the financial-order-state element definition for a complete list of valid values for this parameter. API commands Content format for parameter value String
Sample use(s) new-financial-order-state=CHARGED
|
| new-fulfillment-order-state |
The new-fulfillment-order-state parameter identifies the fulfillment-order-state for an order following a status change. The new-fulfillment-order-state parameter is included in an order-state-change-notification along with a previous-fulfillment-order-state, which identifies the fulfillment-order-state for the order prior to the status change. Please see the fulfillment-order-state element definition for a complete list of valid values for this parameter. API commands Content format for parameter value String
Sample use(s) new-fulfillment-order-state=PROCESSING
|
| previous-financial-order-state |
The previous-financial-order-state parameter identifies the financial-order-state for an order prior to a status change. The previous-financial-order-state parameter is included in an order-state-change-notification along with a new-financial-order-state, which identifies the financial-order-state for the order following the status change. Please see the Financial Commands in the Order Processing API document or the financial-order-state element definition for a complete list of valid values for this parameter. API commands Content format for parameter value String
Sample use(s) previous-financial-order-state=CHARGING
|
| previous-fulfillment-order-state |
The previous-fulfillment-order-state parameter identifies the fulfillment-order-state for an order prior to a status change. The previous-fulfillment-order-state parameter is included in an order-state-change-notification along with a new-fulfillment-order-state, which identifies the fulfillment-order-state for the order following the status change. Please see the fulfillment-order-state element definition for a complete list of valid values for this parameter. API commands Content format for parameter value String
Sample use(s) previous-fulfillment-order-state=NEW
|
| reason |
As a subtag of cancel-order or refund-order, the reason parameter contains the reason that you are canceling or refunding an order. As a subtag of order-state-change-notification, the reason parameter, if provided, will contain a description of the reason that Google canceled a particular order. For example, Google would cancel an order if the buyer's credit card authorization failed and the buyer did not provide updated credit card information within 168 hours (7 days). This element may be included in an order-state-change notification when an order's financial state is changed to CANCELLED_BY_GOOGLE. Note: The maximum accepted length for the parameter value is 140 characters. API commands Content format for parameter value String
Sample use(s) reason=Failed%20risk%20check
|
| serial-number |
| The serial-number parameter contains an ID that uniquely identifies a Google Checkout notification.
API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) serial-number=dc66f8c7
|
| timestamp |
The timestamp parameter contains a date and time in ISO 8601 format. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value Date
Sample use(s) timestamp=2006-03-18T17%3A32%3A11
|
| currency |
| The currency parameter identifies the unit of currency associated with a price, shipping cost or other monetary value. Every monetary value in a Google Checkout API request must specify the currency associated with that value. The value of the currency parameter must be a three-letter ISO 4217 currency code.
Associated recurring elements The currency parameter includes recurring elements any time the monetary value associated with the currency also contains a recurring element. For example, in a Checkout API request, the unit-price parameter identifies the price of an item and contains the recurring item element. As such, the currency associated with the unit-price parameter value will also contain the repeating price parameter.
API commands Checkout, Charge Order, Refund Order, New Order Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) In a Checkout API request:
item type="hidden" name="shopping-cart.items.item-1.unit-price" value="12.99" item type="hidden" name="shopping-cart.items.item-1.unit-price.currency" value="USD" In a new order notification: order-adjustment.total-tax=1.38&order-adjustment.total-tax.currency=USD In a refund order request: amount=12.99&amount.currency=USD |
| flat |
The flat parameter contains the flat fee amount that applies to a particular order. API commands Content format for parameter value Decimal
Sample use(s) latest-charge-fee.flat=0.30
|
| google-order-number |
The google-order-number parameter contains an ID, which Google generates, that uniquely identifies an order. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification, Charge Order, Refund Order, Cancel Order, Authorize Order, Process Order, Deliver Order, Add Tracking Data, Send Buyer Message, Archive Order, Unarchive Order, Add Merchant Order Number, Ship Items, Reset Items Shipping Information, Cancel Items, Return Items, Backorder Items
Content format for parameter value String
Sample use(s) google-order-number=6014423719
|
| latest-charge-amount |
The latest-charge-amount parameter contains the amount most recently charged for a particular order. API commands Content format for parameter value Decimal
Sample use(s) latest-charge-amount=50.00
|
| latest-promotion-charge-amount |
The latest-promotion-charge-amount parameter indicates how much Google contributed to the latest charge amount as a part of an ongoing promotion. For example, suppose Google offered a promotion in which a buyer who completed an order through Google Checkout received $10 off any purchase of $100 or more. If a merchant charged the customer the full amount of a $100 order, then the latest-charge-amount value would be $100 and the latest-promotion-charge-amount would be $10. Content format for parameter value Decimal
Sample use(s) latest-promotion-charge-amount=10.00
|
| percentage |
The percentage parameter contains the percentage fee rate that applies to a particular order. API commands Content format for parameter value Decimal
Sample use(s) latest-charge-fee.percentage=2.90
|
| serial-number |
| The serial-number parameter contains an ID that uniquely identifies a Google Checkout notification.
API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) serial-number=dc66f8c7
|
| timestamp |
The timestamp parameter contains a date and time in ISO 8601 format. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value Date
Sample use(s) timestamp=2006-03-18T17%3A32%3A11
|
| total |
The total parameter contains the total fee amount that applies to a particular order. API commands Content format for parameter value Decimal
Sample use(s) latest-charge-fee.total=4.60
|
| total-charge-amount |
The total-charge-amount parameter contains the total amount charged for a particular order. API commands Content format for parameter value Decimal
Sample use(s) total-charge-amount=99.99
|
| currency |
| The currency parameter identifies the unit of currency associated with a price, shipping cost or other monetary value. Every monetary value in a Google Checkout API request must specify the currency associated with that value. The value of the currency parameter must be a three-letter ISO 4217 currency code.
Associated recurring elements The currency parameter includes recurring elements any time the monetary value associated with the currency also contains a recurring element. For example, in a Checkout API request, the unit-price parameter identifies the price of an item and contains the recurring item element. As such, the currency associated with the unit-price parameter value will also contain the repeating price parameter.
API commands Checkout, Charge Order, Refund Order, New Order Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) In a Checkout API request:
item type="hidden" name="shopping-cart.items.item-1.unit-price" value="12.99" item type="hidden" name="shopping-cart.items.item-1.unit-price.currency" value="USD" In a new order notification: order-adjustment.total-tax=1.38&order-adjustment.total-tax.currency=USD In a refund order request: amount=12.99&amount.currency=USD |
| google-order-number |
The google-order-number parameter contains an ID, which Google generates, that uniquely identifies an order. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification, Charge Order, Refund Order, Cancel Order, Authorize Order, Process Order, Deliver Order, Add Tracking Data, Send Buyer Message, Archive Order, Unarchive Order, Add Merchant Order Number, Ship Items, Reset Items Shipping Information, Cancel Items, Return Items, Backorder Items
Content format for parameter value String
Sample use(s) google-order-number=6014423719
|
| latest-fee-refund-amount |
The latest-fee-refund-amount parameter contains the amount of the transaction fee that has been refunded to the merchant for a particular order. API commands Content format for parameter value Decimal
Sample use(s) latest-fee-refund-amount=4.30
|
| latest-promotion-refund-amount |
The latest-promotion-refund-amount parameter indicates that a portion of the latest refund amount was originally paid by Google as a part of a promotion and is therefore being refunded to Google rather than to the customer. For example, suppose Google offered a promotion in which a buyer who completed an order through Google Checkout received $10 off any purchase of $100 or more. If a merchant refunded the customer the full amount of a $100 order, then the latest-refund-amount value would be $100 and the latest-promotion-refund-amount would be $10. Accordingly, the buyer would receive a $90 refund ($100 - $10). Content format for parameter value Decimal
Sample use(s) latest-promotion-refund-amount=10.00
|
| latest-refund-amount |
The latest-refund-amount parameter contains the most recent refund amount for a particular order. API commands Content format for parameter value Decimal
Sample use(s) latest-refund-amount=50.00
|
| serial-number |
| The serial-number parameter contains an ID that uniquely identifies a Google Checkout notification.
API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) serial-number=dc66f8c7
|
| timestamp |
The timestamp parameter contains a date and time in ISO 8601 format. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value Date
Sample use(s) timestamp=2006-03-18T17%3A32%3A11
|
| total-refund-amount |
The total-refund-amount parameter contains the total refund amount for a particular order. API commands Content format for parameter value Decimal
Sample use(s) total-refund-amount=99.99
|
| currency |
| The currency parameter identifies the unit of currency associated with a price, shipping cost or other monetary value. Every monetary value in a Google Checkout API request must specify the currency associated with that value. The value of the currency parameter must be a three-letter ISO 4217 currency code.
Associated recurring elements The currency parameter includes recurring elements any time the monetary value associated with the currency also contains a recurring element. For example, in a Checkout API request, the unit-price parameter identifies the price of an item and contains the recurring item element. As such, the currency associated with the unit-price parameter value will also contain the repeating price parameter.
API commands Checkout, Charge Order, Refund Order, New Order Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) In a Checkout API request:
item type="hidden" name="shopping-cart.items.item-1.unit-price" value="12.99" item type="hidden" name="shopping-cart.items.item-1.unit-price.currency" value="USD" In a new order notification: order-adjustment.total-tax=1.38&order-adjustment.total-tax.currency=USD In a refund order request: amount=12.99&amount.currency=USD |
| google-order-number |
The google-order-number parameter contains an ID, which Google generates, that uniquely identifies an order. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification, Charge Order, Refund Order, Cancel Order, Authorize Order, Process Order, Deliver Order, Add Tracking Data, Send Buyer Message, Archive Order, Unarchive Order, Add Merchant Order Number, Ship Items, Reset Items Shipping Information, Cancel Items, Return Items, Backorder Items
Content format for parameter value String
Sample use(s) google-order-number=6014423719
|
| latest-chargeback-amount |
The latest-chargeback-amount parameter contains the amount most recently charged back against a particular order. API commands Content format for parameter value Decimal
Sample use(s) latest-chargeback-amount=50.00
|
| latest-chargeback-fee-amount |
The latest-chargeback-fee-amount parameter contains the amount of the chargeback fee that applies to a particular order. API commands Content format for parameter value Decimal
Sample use(s) latest-chargeback-fee-amount=10.00
|
| latest-fee-refund-amount |
The latest-fee-refund-amount parameter contains the amount of the transaction fee that has been refunded to the merchant for a particular order. API commands Content format for parameter value Decimal
Sample use(s) latest-fee-refund-amount=4.30
|
| latest-promotion-chargeback-amount |
The latest-promotion-chargeback-amount parameter indicates that a portion of the latest chargeback amount was originally paid by Google as a part of a promotion and is therefore being recouped by Google rather than by the customer. For example, suppose Google offered a promotion in which a buyer who completed an order through Google Checkout received $10 off any purchase of $100 or more. If a buyer had completed a $100 order, then the buyer would have paid $90 and Google would have paid $10 of the order total. If the buyer then disputed the charge, then the latest-chargeback-amount value would be $100 and the latest-promotion-chargeback-amount would be $10. Content format for parameter value Decimal
Sample use(s) latest-promotion-chargeback-amount=10.00
|
| serial-number |
| The serial-number parameter contains an ID that uniquely identifies a Google Checkout notification.
API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) serial-number=dc66f8c7
|
| timestamp |
The timestamp parameter contains a date and time in ISO 8601 format. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value Date
Sample use(s) timestamp=2006-03-18T17%3A32%3A11
|
| total-chargeback-amount |
The total-chargeback-amount parameter contains the total amount charged back against a particular order. API commands Content format for parameter value Decimal
Sample use(s) total-chargeback-amount=99.99
|
| authorization-amount |
The authorization-amount parameter contains the amount that was reauthorized to be charged to the customer's credit card. Google guarantees that these funds will be available for seven days – 168 hours – from the time that the reauthorization takes place. API commands Content format for parameter value Decimal
Sample use(s) authorization-amount=50.00
|
| authorization-expiration-date |
The authorization-expiration-date parameter identifies the time that a credit card authorization for an order expires. API commands Content format for parameter value Date/Time
Sample use(s) authorization-expiration-date=2007-03-26T15%3A06%3A26.000Z
|
| avs-response |
The avs-response parameter contains an Address Verification System (AVS) response. Possible values for this parameter are: Y - Full AVS match (address and postal code)
P - Partial AVS match (postal code only) A - Partial AVS match (address only) N - no AVS match U - AVS not supported by issuer API commands Content format for parameter value String
Sample use(s) risk-information.
|
| currency |
| The currency parameter identifies the unit of currency associated with a price, shipping cost or other monetary value. Every monetary value in a Google Checkout API request must specify the currency associated with that value. The value of the currency parameter must be a three-letter ISO 4217 currency code.
Associated recurring elements The currency parameter includes recurring elements any time the monetary value associated with the currency also contains a recurring element. For example, in a Checkout API request, the unit-price parameter identifies the price of an item and contains the recurring item element. As such, the currency associated with the unit-price parameter value will also contain the repeating price parameter.
API commands Checkout, Charge Order, Refund Order, New Order Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) In a Checkout API request:
item type="hidden" name="shopping-cart.items.item-1.unit-price" value="12.99" item type="hidden" name="shopping-cart.items.item-1.unit-price.currency" value="USD" In a new order notification: order-adjustment.total-tax=1.38&order-adjustment.total-tax.currency=USD In a refund order request: amount=12.99&amount.currency=USD |
| cvn-response |
The cvn-response parameter contains a credit verification value for the order. Possible values for this parameter are: M - CVN match
N - No CVN match U - CVN not available E - CVN error API commands Content format for parameter value String
Sample use(s) cvn-response=Mrisk-information.cvn-response=M
|
| google-order-number |
The google-order-number parameter contains an ID, which Google generates, that uniquely identifies an order. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification, Charge Order, Refund Order, Cancel Order, Authorize Order, Process Order, Deliver Order, Add Tracking Data, Send Buyer Message, Archive Order, Unarchive Order, Add Merchant Order Number, Ship Items, Reset Items Shipping Information, Cancel Items, Return Items, Backorder Items
Content format for parameter value String
Sample use(s) google-order-number=6014423719
|
| serial-number |
| The serial-number parameter contains an ID that uniquely identifies a Google Checkout notification.
API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) serial-number=dc66f8c7
|
| timestamp |
The timestamp parameter contains a date and time in ISO 8601 format. API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value Date
Sample use(s) timestamp=2006-03-18T17%3A32%3A11
|
| serial-number |
| The serial-number parameter contains an ID that uniquely identifies a Google Checkout notification.
API commands New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification
Content format for parameter value String
Sample use(s) serial-number=dc66f8c7
|
|
