ShopEazydevelopers
API referenceMerchant API BetaOrders

The link a customer pays an order at

Beta
Credentials
  • OAuth access token
Scopes
orders:write
GET
/v1/merchant/stores/{storeId}/orders/{orderId}/payment-link

route is shop (the shop's own pay page, payUrl), provider (only the card partner's hosted link can be made, which needs the order page) or null (nothing can take this payment online yet). A paid order has paid: true and no link.

Access: OAuth scope orders:write; not write-gated.

Authorization

merchantOAuth orders:write
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: orders:write

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

orderId*string

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/orders/<orderId>/payment-link' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "paid": false,    "balanceDue": {      "amount": 32900,      "currency": "ZAR"    },    "awaitingEft": false,    "route": null,    "payUrl": "https://jabus-plant-shop.shopeazy.co/checkout/riEhGrBxE2kF04RzXyaz/pay",    "provider": null  }}