Skip to main content

​
Overview

Payments endpoints help you track whether a commerce order has been paid and to reconcile status across many orders.

​
Authentication

Requires x-commerce-api-key.

​
Request

​
Payment status by order

const status = await pepay.commerce.payments.status('order_123');

​
Bulk status

const bulk = await pepay.commerce.payments.bulkStatus({ orderIds: ['order_1', 'order_2'] });

​
Linked invoice status

const invoiceStatus = await pepay.commerce.merchantInvoices.status('inv_123');

​
Response

Example payment status response (truncated): 
{
  "success": true,
  "data": {
    "orderId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "paid",
    "invoiceId": "550e8400-e29b-41d4-a716-446655440111"
  }
}

​
Errors

  • 401 missing/invalid commerce API key
  • 404 order not found

​
Examples

  • For reconciliation jobs, use bulkStatus to reduce request volume and to keep state consistent across many orders. Next: Addresses