Checkouts & Payment Links API

The Checkouts API allows consumer services to create provider-neutral payment checkout sessions for one-off charges. APICenter handles checkout generation, routes to the enabled payment methods, and reconciles provider webhooks.

For a Node.js backend, create a checkout with api.payments.checkouts.create(...) from the APICenter SDK. The REST example below is for other runtimes.

Service Specifications

Base Route: /api/v1/payments/checkouts
HTTP Method: POST
Required Scope: payments:checkout:write or a broader payment write scope
Requires Header: Idempotency-Key

Quickstart Code Example

Request (cURL)

curl -X POST https://api.apicenter.itsandbox.site/api/v1/payments/checkouts \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: chk-idem-20260729-001" \
  -d '{
    "referenceId": "ORDER-991204",
    "amount": {
      "amountMinor": 49900,
      "currency": "PHP"
    },
    "successUrl": "https://app.example.com/checkout/success",
    "cancelUrl": "https://app.example.com/checkout/cancel",
    "metadata": {
      "customerId": "cust_12345",
      "tier": "pro"
    }
  }'

Response Payload (`201 Created`)

{
  "success": true,
  "data": {
    "checkoutId": "chk_8f1a2b3c4d",
    "referenceId": "ORDER-991204",
    "status": "pending",
    "amount": {
      "amountMinor": 49900,
      "currency": "PHP"
    },
    "checkoutUrl": "https://checkout.example.test/chk_8f1a2b3c4d",
    "aggregateVersion": 1
  }
}

Fetch Checkout Status

Endpoint: GET /api/v1/payments/checkouts/{checkoutId}
Required Scope: payments:checkout:read or a broader payment read scope

curl -s https://api.apicenter.itsandbox.site/api/v1/payments/checkouts/chk_8f1a2b3c4d \
  -H "Authorization: Bearer $ACCESS_TOKEN"