Get payment status (v0.0.1)

GET request that will return the payment status for a specific order, identified by its orderId.

Overview

The GetPaymentStatus message is a query used to retrieve the payment status for a specific order, identified by its orderId. This query returns the current status of the payment, such as whether it is pending, completed, failed, or refunded. It is used by systems that need to track the lifecycle of payments associated with orders, ensuring that the payment has been successfully processed or identifying if any issues occurred during the transaction.

This query is useful in scenarios such as order management, refund processing, or payment auditing, ensuring that users or systems have real-time visibility into the payment status for a given order.

JSON Schema

7 properties
orderId string
required

The unique identifier for the order.

paymentStatus string
required

The current payment status of the order.

Allowed values: pending completed failed refunded
amount number
required

The amount paid for the order.

currency string
required

The currency in which the payment was made (e.g., USD, EUR).

paymentMethod string
required

The payment method used for the transaction (e.g., Credit Card, PayPal).

transactionId string
required

The unique identifier for the payment transaction.

paymentDate string <date-time>
required

The date and time when the payment was processed.