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 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. |
Request
The query payment object consists of the following attributes.
Parameter | Description | Format |
---|---|---|
paymentId | Creating a new payment returns this ID. | AN32 [a-f0-9]{32} |
Authorization header | Bearer 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.
Updated 22 days ago