Overview

Initiating a Checkout session sends a webhook notification to the merchant that includes the checkoutId. The initial status is created.

You can get the status of a checkout request by using the checkoutId or the merchantTransactionId. Using the merchantTransactionId returns the latest Checkout associated with that value. If you are not maintaining unique merchantTransactionIds, multiple associations between this parameter and Checkout sessions could exist.

📘
Merchants should use unique merchantTransactionIds for each checkout request that they execute.

Status descriptions

Status	Description
`pending`	The merchant initiated a Checkout payment and is awaiting customer completion. Payments can have a future state depending on the customer's action.
`successful`	The customer completed a Checkout payment. This is a final state of a payment attempt.
`cancelled`	The customer cancelled a Checkout payment. This is a final state of a payment attempt.
`expired`	A Checkout payment has timed out by the end customer. The customer might not have completed their payment in the allotted time (30 minutes) or could have closed the payment window on their device. This is a final state of a payment attempt.

Flow

To learn more about the required and optional parameters, see the API reference section.

The Checkout status flow works as follows:

The merchant queries the checkout status by making a request to the /status endpoint.
The Checkout API responds with the status of the checkout. If the merchant used merchantTransactionId and is not using unique transaction IDs, the Checkout API returns the latest Checkout associated with the merchantTransactionId.

📘
All GET status requests require a signature using the secret token as the key and the API signs all responses with a signature using the secret token as the key.

curl -G https://testsecure.peachpayments.com/status \
   -d authentication.entityId=8ac7a4ca86c2c24d0168c2caab2e0025 \
   -dmerchantTransactionId=Test1234\
   -d signature=79b450ed255e306332f6325c99732cc84fca8cc2cf3fdc2bfd1f3e2465f55'

Example requests and responses

For sample requests and responses, see the interactive API playground or use the Peach Payments Postman collection: