YardPay Docs

YardPay for Ecwid

Accept payments on your Ecwid store by installing YardPay from the Ecwid App Market.

Installation

  1. In your Ecwid control panel, go to Apps → App Market
  2. Search for "YardPay" and click Install
  3. Authorize the app to access your store (OAuth consent screen)
  4. Navigate to Payment → Payment methods and enable YardPay

OAuth scopes

YardPay requests read_orders,update_orders, andread_payments. These are required to sync payment status back to the Ecwid order.

How It Works

  1. Customer clicks Place Order in Ecwid checkout
  2. Ecwid POSTs the order payload to /api/v1/integrations/ecwid/payment
  3. YardPay creates a checkout session and redirects the customer to the hosted payment page
  4. After payment, the customer returns to the Ecwid order confirmation page
  5. YardPay calls the Ecwid REST API to update the order to Paid or Failed

Endpoints

EndpointPurpose
GET /api/v1/integrations/ecwid/installStarts the OAuth install flow from the Ecwid App Market.
GET /api/v1/integrations/ecwid/callbackOAuth callback. Exchanges the authorization code for an access token and links the store to your YardPay merchant.
POST /api/v1/integrations/ecwid/paymentReceives the order from Ecwid, creates a checkout session, and redirects to the hosted page.
POST /api/v1/integrations/ecwid/statusWebhook receiver that syncs the final payment result back to the Ecwid order.

Store Linking

Each installed Ecwid store is mapped to a YardPay merchant by storeId. The OAuth callback stores the Ecwid access token so YardPaycan update orders on the merchant's behalf.

Order status sync
PUT https://app.ecwid.com/api/v3/{storeId}/orders/{orderId}
Authorization: Bearer {ecwid_access_token}
Content-Type: application/json

{
  "paymentStatus": "PAID",
  "externalTransactionId": "ch_..."
}

Requirements

  • Active Ecwid store on a plan that allows custom payment apps
  • YardPay merchant account with production API keys
  • Public HTTPS URL for the YardPay gateway (required by Ecwid OAuth)