Query a payment status

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 eventDescription
initiatedTriggered when you create the payment link.
processingTriggered when a customer attempts the payment.
completedTriggered when a customer completes the payment.
cancelledTriggered when a customer cancels the payment.
expiredTriggered when the payment link expires.


The query payment object consists of the following attributes.

paymentIdCreating a new payment returns this ID.AN32
Authorization headerBearer tokens are Auth0 tokens that enable requests to authenticate using an access key. The token is a text string included in the request header.Bearer token

Example requests and responses

For sample requests and responses, see the interactive API playground and the Postman workspace.