Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Payments

Retrieve the status payment object

get/payments/{id}/status

Path parameters

idstring required

Identifier of the payment intent to retrieve.

Headers

ApiKeystring required

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.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

idstring required

Unique identifier for the Payment

status'created' | 'failed' | 'pending' | 'successful' required

Current status of this Payment

isDelegatedboolean

Whether this payment was created via delegation

Example response

{
  "id": "pay_QW2d6JnqiatcH8KhK0mD1",
  "status": "successful"
}