Retrieve information about a Checkout.
Returns information about a given Catch Checkout.
Path
GET https://<environment>.getcatch.com/v1/checkouts/<checkout_id>
| Variable name | Description | Possible values |
|---|---|---|
<environment> | The Catch environment in which you’re making the request. | See Authentication. |
<checkout_id> | The checkout ID that the merchant received in response to the POST Checkout request. | See POST Checkout where the id (string) gets created. |
Parameters
(none)
Success Response
Transaction identifiers
| Name | Format | Description |
|---|---|---|
id | string | The ID of the checkout that is being returned. |
merchant_checkout_id | string | The ID of this checkout in the merchant's system which Catch will store for shared accounting purposes. |
purchase_id | string | The ID of the purchase that was created from this checkout. Will be null if the checkout was never completed. |
Amounts object
| Name | Format | Descripton |
|---|---|---|
total | integer (in cents) | The total amount to charge the buyer after all promotions, discounts, and fees are applied. |
subtotal | integer (in cents) | The subtotal that should be displayed to the consumer. |
tax | integer (in cents) | The amount of tax on the order. |
shipping | integer (in cents) | The amount of shipping cost on the order. |
discount_total | integer (in cents) | The discount total that should be displayed to the consumer. Should be 0 if checkout does not have a discount amount. |
currency | string (in ISO_4217 format) | The currency in which the amounts are represented. |
{
"id": "ch-49b03b7d-6bfd-4286-9afb-7f51a8f39491",
"amounts":{
"total":121562,
"subtotal":120670,
"tax":585,
"shipping":307,
"discount_total":0,
"currency":"USD"
},
"merchant_checkout_id":"ex-62c9b1ca-16c1-4e35-965b-3a52fde2ae9b",
"purchase_id":"pur-7782f259-1f37-4e68-8336-124bf407b7ff"
}