Payments API overview


The Payments API allows you to do a custom integration with Peach Payments and support multiple payment methods, without redirecting customers from your website. You can also use the Payments API to integrate payments processing into mobile apps.

Using the Payments API, you can:

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

Supported payment methods and payment types


For details on which payment methods the Payments API and Checkout support, see the Payment methods section.

API endpoints

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

  • Live:
  • Sandbox:

Find your credentials

Follow these steps to find your credentials:

  1. Log in to the Peach Payments Dashboard.
  2. In the left navigation menu, click Payments API.
  3. The API keys section enables you to view and copy your entity ID, username, and password.


If you can't find your credentials, contact support.

Payments API credentials.

Payments API credentials.


To retrieve your sandbox credentials, switch to the sandbox Dashboard and follow the instructions above.

Test and go live procedure

While integrating, you have access to a sandbox account during user acceptance testing. Use this account 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 collection

Use the sample Payments API calls in Postman. See the collection overview for more information.

Run in Postman