Checkout [Public]

Number of APIs: 7

The Checkout collection allows you to initiate a checkout, validate it, and query its status. There are two ways to implement Checkout:

• Embedded Checkout (v2)
• Hosted Checkout (v1)

API endpoints

The following are the API endpoints for the live and sandbox servers:

• Live: https://secure.peachpayments.com/checkout

• Sandbox: https://testsecure.peachpayments.com/checkout

Embedded Checkout also uses the following API endpoints for authentication:

• Live: https://dashboard.peachpayments.com

• Sandbox: https://sandbox-dashboard.peachpayments.com

Prerequisites

Retrieve the following credentials from the Checkout section of the Peach Payments Dashboard:

• entityId: It resembles 8ac7a4c9791c31ee01791f27b739110z.

• secret: It resembles 04ef51aba8b111eba6e102d14de18c0z.

• merchantWebsite: All URL domains that initiate the API POST request to Checkout require allowlisting for added security. You can add a list of URLs to the allowlist in the Peach Payments Dashboard.

Embedded Checkout also requires the following credentials:

• clientId: It resembles c3e5374856a3334f2dfe1451d36f3z.

• clientSecret: It resembles aonSYINF2PxLB0EUBeXPIR+xYRTNhYb17i762K4SUb5gBINz8GGwHvcYfZg29qtAAIHiniL/n7LrVGqdmNkrdz==.

• merchantId: It resembles 9f6ea39b121d11e89d9774d4352a31dz.

Fork the environment and collection

To fork the environment from the [Peach Payments workspace]

1. Navigate to Environments, click View more actions next to the Checkout-Public environment, and click Create a fork.
2. Enter a fork label, select the workspace to fork to, and click Fork Environment.

To fork the collection from the [Peach Payments workspace]

1. Navigate to Collections, click View more actions next to the Checkout [Public] collection, and click Create a fork.
2. Enter a fork label, select the workspace to fork to, ensure that Watch original collection is selected, and click Fork Collection.

Configure the environment

To get started:

1. In your workspace, navigate to Environments and click the forked Checkout-Public environment.
2. Enter the credentials from the Prerequisites section above into the CURRENT VALUE column.
3. Select the Checkout-Public option from the environment drop-down list in the upper right of the screen.
4. Click Save in the upper right of the screen.

1. v1 - Initiate Checkout POST {{baseUrl}}/checkout

2. v1 - Validate Checkout request POST {{baseUrl}}/checkout/validate

3. v1 - Initiate redirect-based Checkout POST {{baseUrl}}/checkout/initiate

4. v1 - Query Checkout status GET {{baseUrl}}/status?authentication.entityId={{entityId}}&merchantTransactionId={{merchantTransactionId}}&signature={{signature}}

5. v1 - Retrieve a list of payment methods for a currency POST {{baseUrl}}/merchant_specs

6. v2-auth - Merchant Access POST {{authUrl}}/api/oauth/token

7. v2 - Generate Checkout ID POST {{baseUrl}}/v2/checkout