Skip to main content
GET
/
api
/
canary
/
payment-intents
/
{id}
Checks the status of a specific server-to-server charge.

​
Path Parameters

​
id
string
required
The unique identifier of the payment intent

​
Response

​
Success
​
id
string
Unique identifier for the payment intent
​
merchantId
string
The merchant’s unique identifier
​
customerId
string
The customer’s unique identifier
​
paymentMethodId
string
The payment method’s unique identifier
​
amount
number
The charge amount
​
currency
string
The currency code
​
description
string
Description of the charge
​
status
string
Payment status (processing, succeeded, failed)
​
metadata
object
Custom metadata attached to the payment intent
​
createdAt
string
ISO 8601 timestamp when the intent was created
​
updatedAt
string
ISO 8601 timestamp when the intent was last updated

​
Example Response

{
  "id": "pi_001",
  "merchantId": "merchant_456",
  "customerId": "customer_789",
  "paymentMethodId": "pm_001",
  "amount": 5000,
  "currency": "ZAR",
  "description": "Subscription payment",
  "status": "succeeded",
  "metadata": {
    "subscriptionId": "sub_123"
  },
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:05.000Z"
}

​
Status Meanings

processing

Payment is being processed

succeeded

Payment was successful

failed

Payment failed

​
Error Responses

​
Unauthorized
Invalid or missing authentication token
​
Not Found
Payment intent not found
​
Internal Server Error
An unexpected error occurred on the server

​
Authentication

This endpoint requires Bearer token authentication.