Introduction

The Payments API allows you to do a custom integration with Peach Payments and thereby support multiple payment methods.

Using the Payments API, you can:

  • Initiate a transaction.
  • Check a transaction's status.
  • Refund a transaction.

Supported payment methods and payment types

📘

For details on which payment methods are supported by Checkout, see the Payment methods section.

API endpoints

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

  • Live: <https://api-v2.peachpayments.com>
  • Sandbox: <https://testapi-v2.peachpayments.com>

Retrieve your API credentials from the Peach Payments Console

Access your API credentials as follows:

  1. Log in to the Peach Payments Console.
  2. In the left-hand navigation, click Merchants, then click your merchant name.
  3. In the left-hand navigation, click Development.
  4. Select the API Credentials tab.
  5. Take note of the credentials that you require.

Test and go live procedure

While integrating, a sandbox account is made available to you during user acceptance testing. This account can be used to test fake payments to verify your integration.

For more information on testing, go live, and test cards and credentials, see the Test and go live procedure section.

Quick links

📝 API playground

Detailed reference to all the Payments API endpoints and mock calls.

API reference
🚀 Postman workspace

Use our sample Payments API calls in Postman. See the workspace description for more information.

Postman workspace