Get payment status

Gets the payment status for a given order.

Example Request

curl -X GET \
  -H 'authorization: Bearer v4.public.eyJpc3MiOiJs...' \
  https://api.sandbox.ledyer.com/v1/orders/:orderId/paymentstatus \

Path parameters

orderId

The order ID string that was obtained when the order session was created.

Example Response

{
  "note": "Awaiting signature.",
  "status": "orderPending"
}

note

string

A text that provides further information, such as "Awaiting signature" for a status that has the value orderPending.

status

string

The status can have one of the following types:

• orderCancelled: The order has been cancelled.
• orderCaptured: The order has been captured.
• orderInitiated: The order has been initiated.
• orderPending: The order is pending.
• orderRefunded: The order has been refunded.
• paymentConfirmed: The payment has been confirmed.
• paymentPending: The payment for the order is pending.
• unknown: The payment status of the order is unknown.