v1
latestOpenAPI 3.0.02026-07-265892227.1 KBRetrieve a PaymentIntent status
This endpoint allows you to fetch the status of an existing payment intent from our database. You must either provide the "id" or the "token" for us to find that payment intent. Retrieving using the "token" is the fastest way and uses a more permissive rate limit (10 requests per 5 seconds).
Path parameters
Identifier of the payment intent to retrieve.
Query parameters
You can also use this token parameter to retrieve a payment intent. This is especially useful for a client-side application when you don't want your api key to be disclosed in.
Headers
Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.
Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.
Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.
Response
Example response
{
"id": "pi_QW2d6JnqiatcH8KhK0mD1",
"status": "successful"
}