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 query 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.

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

Query parameters

Use one of the following:

sessionId string
The session ID string that was obtained when the session was created.
orderId string
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 string
The status can have one of the following types:
  • orderInitiated: The order has been initiated.
  • orderPending: The order is pending.
  • paymentPending: The payment for the order is pending.
  • paymentConfirmed: The payment has been confirmed (the order is ready to be captured).
  • orderCaptured: The order has been captured.
  • orderRefunded: The order has been refunded.
  • orderCancelled: The order has been cancelled.
  • unknown: The payment status of the order is unknown.