Logo
Peach Payments Public API Documentation

Recon [Public]

Number of APIs: 2


The Reconciliation API enables you to list transactions that you can use in your reconciliation process.

API endpoints

The API endpoints for the live servers are:

  • Authentication API: https://dashboard.peachpayments.com

  • Reconciliation API: https://reconciliation.peachpayments.com

Prerequisites

To use the Reconciliation API, you need the following credentials:

  • clientId: It resembles c3e5374856a3334f2dfe1451d36f3z.

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

  • merchantId: It resembles 9f6ea39b121d11e89d9774d4352a31dz.

If you've integrated with Peach Payments using Embedded Checkout, Payment Links, Magento, or WooCommerce you can retrieve your credentials from the relevant page on the Peach Payments Dashboard. If you aren't using any of these products or can't find the credentials, contact support to request them.

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 Recon-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 Recon [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 Recon-Public environment.

  2. Enter the credentials from the Prerequisites section above into the CURRENT VALUE column.

  3. Select the Recon-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. auth - Merchant Access

POST {{authUrl}}/api/oauth/token



2. api-merchants - List merchant transactions recon

GET {{baseUrl}}/api/merchants/:merchantId/transactions-recon?startDate=2024-02-02T00:00:00.000Z&endDate=2024-02-03T00:00:00.000Z&isSuccessful=true&paymentMethod=card



ENDPOINTS