Error handling

Every failure your integration will meet falls into one of three groups, and each group needs a different response:

• Request errors (4xx): the request is wrong, or your key cannot do what it is asking. Fix the request. Retrying it unchanged returns the same error.
• Transient errors (429 and 5xx): the request was fine, the moment was not. Retry with backoff and an idempotency key.
• Payment outcomes: declined cards, failed refunds, failed payouts. These are not HTTP errors at all. They arrive as resource state and webhook events, and your product handles them as normal business outcomes.

Read the error envelope, branch on types and codes, retry without double-charging, and listen for asynchronous payment failures.

The error envelope#

Every failing request returns the same JSON shape. Trigger one right now: this request omits the line item's required name.

curl -X POST https://api.withflintpay.com/v1/orders \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "line_items": [
      { "quantity": 1, "unit_price_money": { "amount": 400, "currency": "USD" } }
    ]
  }'

{
  "error": {
    "type": "validation_error",
    "code": "LINE_ITEM_NAME_REQUIRED",
    "message": "Line item 0: name is required",
    "param": "line_items[0].name",
    "request_id": "97879286-b522-4c73-9021-31c18e8d77f3",
    "doc_url": "https://developers.withflintpay.com/docs/errors",
    "request_log_url": "/v1/developer/request-logs?request_id=97879286-b522-4c73-9021-31c18e8d77f3",
    "error_source": "merchant",
    "remediation": {
      "retryable": false,
      "next_steps": "Provide the field identified by param and retry."
    }
  }
}

Error types#

The HTTP status determines type. Every Flint error envelope with the same status has the same type.

The type field is a closed set. If you ever see a value outside this table, treat it as a contract violation: log the request_id, fall back to the HTTP status class, and contact support.

Error codes to handle by name#

The full catalog, with a retryable flag and a recommended fix for every code, lives at Error Codes. Endpoint-specific validation codes such as LINE_ITEM_NAME_REQUIRED are self-describing and rarely need their own branch; the codes below are the ones worth explicit handling in most integrations:

New codes ship as the API grows, so always keep a default branch keyed on type and status.

Remediation hints#

Every error includes a remediation object derived from the same catalog as the error reference. It tells your code, not just your logs, what to do next:

{
  "error": {
    "type": "authentication_error",
    "code": "SANDBOX_SELECTION_REQUIRED",
    "message": "Test mode API keys must be sandbox-bound before they can authenticate public API requests.",
    "request_id": "f81d4fae-7dec-4b1d-a765-00a0c91e6bf6",
    "doc_url": "https://developers.withflintpay.com/docs/errors",
    "request_log_url": "/v1/developer/request-logs?request_id=f81d4fae-7dec-4b1d-a765-00a0c91e6bf6",
    "error_source": "merchant",
    "remediation": {
      "retryable": false,
      "next_steps": "Create or use a sandbox-bound test key for the sandbox this request should target.",
      "next_actions": [
        {
          "action_type": "issue_developer_sandbox_test_key",
          "reason_code": "SANDBOX_BOUND_TEST_KEY_REQUIRED",
          "reason_message": "Create or use a sandbox-bound test key for the sandbox this request should target.",
          "required_fields": ["sandbox_id"]
        }
      ]
    }
  }
}

Remediation is designed to be machine-actionable, which makes it especially useful for agent-driven integrations: an agent can read next_actions and recover without a human interpreting log output. See AI agents.

Response headers#

Flint does not send X-RateLimit-* quota headers. Size your steady-state throughput against the published limits in Rate limits instead of probing for remaining quota.

Write one error handler#

Centralize parsing so the rest of your code works with typed errors instead of raw responses:

class FlintApiError extends Error {
  constructor(status, headers, body) {
    const e = body?.error ?? {};
    super(e.message ?? `Flint API error (HTTP ${status})`);
    this.name = "FlintApiError";
    this.status = status;
    this.type = e.type ?? "internal_error";
    this.code = e.code ?? "UNKNOWN";
    this.param = e.param;
    this.details = e.details ?? [];
    this.remediation = e.remediation;
    this.requestId = e.request_id ?? headers.get("X-Request-Id");
    this.docUrl = e.doc_url;
    this.requestLogUrl = e.request_log_url;
    this.errorSource = e.error_source;
    this.retryAfterMs = headers.has("Retry-After")
      ? Number(headers.get("Retry-After")) * 1000
      : undefined;
    // Trust the server's hint when present; fall back to status class.
    this.retryable =
      e.remediation?.retryable ?? (status === 429 || status >= 500);
  }
}

async function flintFetch(path, options = {}) {
  const res = await fetch(`https://api.withflintpay.com${path}`, {
    ...options,
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${process.env.FLINT_API_KEY}`,
      ...options.headers,
    },
  });
  const body = res.status === 204 ? null : await res.json();
  if (!res.ok) throw new FlintApiError(res.status, res.headers, body);
  return body;
}

Validation errors deserve their own branch, because they map to user-visible form fields. Remember the two shapes: a single issue arrives in the top-level code and param, multiple issues arrive in details:

try {
  await flintFetch("/v1/orders", {
    method: "POST",
    body: JSON.stringify(payload),
  });
} catch (err) {
  if (err instanceof FlintApiError && err.type === "validation_error") {
    const issues = err.details.length
      ? err.details
      : [{ code: err.code, param: err.param, message: err.message }];
    for (const issue of issues) {
      showFieldError(issue.param, issue.message);
    }
    return;
  }
  throw err;
}

Retry without Double-Charging#

Four rules make retries safe:

1. Retry only 429, 5xx, and network failures where no response arrived. Never retry a 4xx unchanged; the one exception is IDEMPOTENCY_KEY_IN_PROGRESS, which succeeds once the original request finishes.
2. Honor Retry-After when present. Otherwise use exponential backoff with jitter, and cap total attempts.
3. Send an Idempotency-Key on every write you might retry. A timeout does not mean the write failed; the key guarantees a retry replays the original result instead of executing twice.
4. Treat conflict_error as a signal to re-read state, not to resend. The resource moved; find out where it is now.

async function withRetries(request, { attempts = 4 } = {}) {
  let delayMs = 500;
  for (let attempt = 1; ; attempt++) {
    try {
      return await request();
    } catch (err) {
      const retryable =
        err instanceof FlintApiError
          ? err.retryable || err.code === "IDEMPOTENCY_KEY_IN_PROGRESS"
          : true; // network failure: no response, safe with an idempotency key
      if (!retryable || attempt === attempts) throw err;
      const waitMs = err.retryAfterMs ?? delayMs + Math.random() * delayMs;
      await new Promise((resolve) => setTimeout(resolve, waitMs));
      delayMs = Math.min(delayMs * 2, 30_000);
    }
  }
}

await withRetries(() =>
  flintFetch("/v1/orders", {
    method: "POST",
    headers: { "Idempotency-Key": "order-create-2098" },
    body: JSON.stringify(payload),
  }),
);

For endpoints that replay results, an identical retry with a key Flint has in progress or on record either replays the original response or receives IDEMPOTENCY_KEY_IN_PROGRESS. A changed body fails with IDEMPOTENCY_KEY_REUSED. Use a new key for a corrected request. Key generation, per-endpoint support, and the replay window are covered in Idempotency.

A declined card is not an error#

A declined card produces no error on your server, no exception, and no failing HTTP status. The buyer sees the decline in the checkout UI and can try another card; on your side, the order simply stays open with paid_money at 0 until a payment succeeds. If you only handle thrown errors, declines are invisible to you.

Payment outcomes arrive through two channels:

• Webhook events, the source of truth for money movement. Subscribe to the failure events for every flow you run, not just the success events: payment_intent.payment_failed, order.paid, refund.failed, payout.failed, and subscription.payment_failed. See Webhooks for reliable processing.
• Resource state, when you re-fetch. An order reports paid_money and balance_money; a failed refund reports status: "failed" with a failure_reason.

Three rules follow:

1. Never treat a 2xx from a create call as payment success. Creating a checkout session, an invoice, or a payment intent starts a payment; only events and resource state finish one.
2. Mark orders paid from the order.paid event, not from a redirect or a create response.
3. Show buyers your own retry-friendly message on failure. Decline reasons exist for your logs and dashboards, not for buyer-facing copy.

If you drive the order payment flow directly (rather than through Flint-hosted checkout), the decline detail also comes back inline on the POST /v1/orders/{order_id}/pay response: the payment attempt's per-leg last_payment_error names the normalized reason, and is_resumable tells you whether the same attempt can continue. Do not read is_resumable: false as "start over": an attempt that is finalizing has already taken the buyer's money and is waiting on Flint, not on you. See Declines and payment attempts for the full recovery model, including finalizing and recovering a lost response.

To exercise these paths before launch, force declines and authentication challenges with test cards: see Testing.

Production checklist#

• Log request_id, type, code, and param on every non-2xx response.
• Alert on your 5xx and 429 rates, and on 401/403 spikes, which usually mean a rotated or misconfigured key rather than a Flint incident.
• Cap retry attempts and use jitter, so an outage does not turn your workers into a thundering herd.
• Keep a default branch for unknown type and code values, keyed on HTTP status class.
• Subscribe to failure webhook events for every payment flow you run, and test each handler.
• Quote the request_id when contacting support, and use Debugging to trace it yourself first.

Next steps#

• Error Codes: the full catalog with a recommended fix for every code.
• Card decline codes: what each issuer decline means, whether to retry, and what to tell the customer.
• Idempotency: key mechanics, replay window, and which endpoints accept keys.
• Rate limits: route classes, current limits, and planning throughput.
• Webhooks: signature verification and processing events reliably.
• Testing: trigger declines and test-mode errors on purpose.
• Debugging: turn a request_id into a diagnosis.
• CLI: the same failure classes as stable exit codes, so a script can branch on them without parsing stderr.