Get payment status

This endpoint provides the status of an order and is particularly useful when responding to notifications or other events. Use the order ID as a path parameter to retrieve the status. If the order ID is not available, you can alternatively use the session ID to obtain the payment status of the order.

Example Request
Example Response

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

Path parameters

Use one of the following:

sessionId

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

orderId

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

{
  "note": "Awaiting signature",
  "paymentMethod": {
    "provider": "ledyer",
    "type": "invoice"
  },
  "status": "orderPending"
}

note

string

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

status