Quickstart

This walks through the shortest path to a working payment: a hosted checkout session in sandbox. It takes about five minutes.

Get a sandbox key

Create a secret key in your dashboard. Sandbox keys start with sk_sandbox_. The key decides which environment you are in — there is no separate base URL and no environment header.

Create a checkout session

Amounts on a payment are in major units: 50 means 50.00.

curl -X POST https://api.orqex.com/v1/payment/checkouts \
  -H "Authorization: Bearer sk_sandbox_..." \
  -H "Content-Type: application/json" \
  -H "X-Idempotency-Key: order-1042-checkout" \
  -d '{
    "amount": 50,
    "currency": "USD",
    "description": "Order #1042",
    "return_url": "https://example.com/orders/1042/return",
    "webhook_url": "https://example.com/webhooks/orqex",
    "customer": {
      "email": "[email protected]",
      "first_name": "Ada",
      "last_name": "Lovelace"
    }
  }'

use Orqex\Orchestrate\OrchestrateClient;

$orqex = new OrchestrateClient('sk_sandbox_...');

$checkout = $orqex->checkouts()->create([
    'amount'      => 50,
    'currency'    => 'USD',
    'description' => 'Order #1042',
    'return_url'  => 'https://example.com/orders/1042/return',
    'webhook_url' => 'https://example.com/webhooks/orqex',
    'customer'    => [
        'email'      => '[email protected]',
        'first_name' => 'Ada',
        'last_name'  => 'Lovelace',
    ],
]);

The response carries both the session and the payment intent it created:

{
  "message": "...",
  "data": {
    "checkout": {
      "id": "cs_...",
      "status": "open",
      "environment": "sandbox",
      "url": "https://pay.orqex.com/cs_...",
      "expires_at": "...",
      "created_at": "..."
    },
    "payment": {
      "id": "pi_...",
      "status": "pending",
      "amount": { "value": 50, "formatted": "$50.00", "short": "$50", "currency": "USD" }
    }
  }
}

Store payment.id against your order. That is the identifier you will see in every webhook.

Send the customer to the payment page

Redirect to checkout.url. Orchestrate renders the page, collects the payment details and handles whatever the payment method requires.In sandbox, pick the built-in test method and use a phone number ending in two digits that select the outcome you want to rehearse — see Testing.

Confirm the result

The customer returning to your return_url is not proof of payment. They may have closed the tab, and some methods settle after the redirect.Treat the webhook as the signal, and re-read the intent before you fulfil:

curl https://api.orqex.com/v1/payment/intents/pi_... \
  -H "Authorization: Bearer sk_sandbox_..."

Fulfil when data.status is completed.

Webhooks

The events Orchestrate sends, and how to verify them.

Direct API

Build your own payment interface instead of redirecting.

Testing

Reproduce every outcome in sandbox.

Go live

Swap the sandbox key for a live one. Nothing else changes.

Overview Authentication

⌘I

Get started

Payments

Payouts

Events

Utilities

MCP

Next

Webhooks

Direct API

Testing

Go live

​Next

Webhooks

Direct API

Testing

Go live

Next