Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.proxyjam.com/llms.txt

Use this file to discover all available pages before exploring further.

Network failures can leave you unsure whether a request succeeded. ProxyJam supports idempotency on create operations so you can retry safely.

How it works

Include a unique idempotency_key (UUID) in your request body. If you send the same key again, the API returns the original response instead of creating a new resource.
{
  "offer_id": 42,
  "idempotency_key": "550e8400-e29b-41d4-a716-446655440000",
  ...
}

Endpoints that support idempotency keys

EndpointField
POST /ordersidempotency_key in request body
POST /orders/guestidempotency_key in request body

Payment intents

For POST /payments/payment-intents, pass the idempotency key as an HTTP header:
Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000
The Idempotency-Key header is required for payment intents. The request will be rejected without it.

Best practices

  • Generate a new UUID for each unique operation. Never reuse a key for a different operation.
  • Store the key before making the request so you can resend it on retry.
  • Keys are scoped per user — the same key used by two different users creates two separate resources.