Overview

Initiating checkout returns the checkoutId in the response and sends a webhook notification to the merchant that includes the checkoutId. The initial status is created.

Get the status of a checkout request using the checkoutId.

📘

See the webhooks section for descriptions of the checkout statuses.

Flow

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

The Checkout status flow works as follows:

1. The merchant queries the checkout status by making a request to the V2 Status endpoint.
2. The Checkout API responds with the status of the checkout.

curl --location 'https://testsecure.peachpayments.com/v2/checkout/948cc8dec52a11eb85290242ac130003/status' \
--header 'Accept: application/json'

Example requests and responses

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