Flux Pay / DEVELOPER GUIDEDEVELOPER GUIDE

Collect payments. Distribute funds.

Pay-in APIs for hosted checkout and Payout APIs for transfers from available merchant balance.

CREATE → REDIRECT → VERIFY

Connect once.
Keep control.

  1. Create on your server

    Send an authenticated POST with an amount, unique order_id and payer_email to the payments/create endpoint.

  2. Redirect your customer

    Use the returned payment.checkout_url. The checkout session lasts ten minutes.

  3. Verify before fulfilment

    Confirm the result using authenticated payment status or a verified signed webhook. A return URL alone does not prove payment.

Open complete API reference
create-payment.http
POST /api/v1/payments/create
Authorization: Bearer $FLUX_SECRET_KEY
Content-Type: application/json
Idempotency-Key: order-1024-create

{
  "amount": 2500,
  "order_id": "ORDER-1024",
  "payer_email": "buyer@example.com",
  "return_url": "https://example.com/thanks"
}

// Returned: payment.checkout_url
// Secrets must remain server-side.
Reference example · No live credential
PAYOUT API · 2.5% PUBLISHED CHARGE

Distribute your available balance.

Send a server-authenticated request to the existing Payout API with an amount and an active payout_method_id from your merchant account. Use an idempotency key to keep retries tied to the same request.

POST /api/v1/payouts/create
Authorization: Bearer $FLUX_SECRET_KEY
Content-Type: application/json
Idempotency-Key: vendor-transfer-1024

{
  "amount": 10000,
  "payout_method_id": 123
}

Illustrative destination ID. Replace it with your own active payout destination. Required permissions, available balance and payout limits are checked by the platform.

Query GET /api/v1/payouts/status?payout_id=YOUR_PAYOUT_ID or verify signed payout webhook updates. Requested and processing statuses are not completed transfers.

RELIABLE PAYMENT UPDATES

Verify every update.

Configure your webhook endpoint in the merchant portal. Validate the signature against your server-held webhook secret, handle repeated events safely and reconcile uncertain states using payment status.

Use the existing API reference for exact signature headers, payload fields and response structures for payments and payouts. Keep test and live credentials separate.

Read API & webhook documentation

Safe retries

Use an idempotency key for payment creation and keep your internal order reference consistent across retries.

Protect your credentials

Keep API keys, webhook secrets and provider credentials on your server. Never add them to frontend code.

Handle uncertainty

A timeout is not a verified failure. Check the existing payment before creating another customer payment.

START WITH FLUX

Your next payment.
A better experience.

Create your account, submit your business for review, and connect the payment methods your customers already know.

Hosted checkout Three local methods One workspace