Overview

After creating a payment link, you can query the status of the payment transaction. The query transaction status object takes the paymentId and the bearer token and returns the payment details and status.

Querying the payment can return one of the following statuses:

Webhook event	Description
`initiated`	Triggered when you create the payment link.
`processing`	Triggered when a customer attempts the payment.
`completed`	Triggered when a customer completes the payment.
`cancelled`	Triggered when a customer cancels the payment.
`expired`	Triggered when the payment link expires.

Flow

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

The query payment status flow works as follows:

The merchant queries the payment status by making a request to the /api/payments/{paymentId} endpoint.
The Payment Links API responds with the payment status.

Example requests and responses

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