Payments: Retrieve One

This documentation entry provides a clear and detailed guide on how to retrieve a specific payment transaction using the API, including the necessary parameters, headers, and expected response.

Endpoint

GET /api/payments/{payment_id}

Retrieve detailed information about a specific payment transaction by its unique identifier.

Request

HTTP Request

GET https://uptimekeep.com/api/payments/{payment_id}

Replace {payment_id} with the ID of the payment transaction you wish to retrieve.

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Example of a request:

curl --request GET \
--url 'https://uptimekeep.com/api/payments/{payment_id}' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object containing detailed information about the specified payment transaction.

Response Example

{
    "data": {
        "id": 1,
        "plan_id": 1,
        "processor": "stripe",
        "type": "one_time",
        "frequency": "monthly",
        "email": "[email protected]",
        "name": null,
        "total_amount": "4.99",
        "currency": "USD",
        "status": true,
        "date": "2021-03-25 15:08:58"
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the payment transaction.
plan_id	Integer	ID of the associated plan.
processor	String	Payment processor used for the transaction (e.g., "stripe").
type	String	Type of payment (e.g., "one_time").
frequency	String	Payment frequency (e.g., "monthly").
email	String	Email address associated with the payment.
name	String	Name associated with the payment, if available.
total_amount	String	Total amount of the transaction.
currency	String	Currency used in the transaction.
status	Boolean	Status of the payment (true for successful, false for failed).
date	String	Date and time of the transaction (in YYYY-MM-DD HH:MM:SS format).

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 404 Not Found if the payment ID does not exist.