Overview

You can retrieve or export all payment links by querying merchant transactions. The query for all merchant transactions endpoint takes the bearer token and returns all payment links and their statuses, either as JSON or as a CSV.

Flow

📘

To export to CSV, change the request header's Accept value to text/csv.

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

The retrieve payment links flow works as follows:

1. The merchant initiates the payment link retrieval by making a request to the /api/payments endpoint.
2. The Payment Links API responds with a list of the payment links.

Example requests and responses

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