Balance Residential order via website delivery queue
POST
/account/api/v1/residential/orders/createConfirm the operation deliberately
This operation may change a record, balance or service configuration. Read its scope and notes first. After an uncertain result, query the same operation rather than starting another.
Authorization
| Authorization | Bearer YOUR_ARNPROXY_API_KEY |
|---|---|
| Required permission | purchases |
| Accept | application/json |
| Content-Type | application/json |
| Idempotency-Key | 16–100 letters, digits, _ or -. Persist and reuse the same value for the same operation. |
Parameters
| Name | Type | Description |
|---|---|---|
Idempotency-Key | string | 16–100 letters/digits/_/-. Keep the same value for the operation/status; do not reuse with a different body. |
mode | string | new creates a package; topup adds GB to an owned package. |
time_id | integer | Period/GB-plan ID from the matching catalog/options, not a day/GB count. |
location_id | integer | Required for mode=new only; forbidden for topup. |
package_id | integer | Required for mode=topup only; forbidden for new. |
promo_code | string | Optional promo, up to 100 bytes. Keep it identical between quote and purchase/renewal. Default: "" |
currency | string | TRY or USD from the same quote; must match the account currency. |
expected_total_minor | integer | total_minor from the same quote, as an integer; never decimal money or a string. At least 1. |
expected_selection_hash | string | selection_hash from the same quote: 64 lowercase hexadecimal characters. |
terms | boolean | Must be the JSON boolean true for explicit approval, not the string "true". |
Request body
Replace YOUR_/FROM_ placeholders with values from the relevant catalog, quote or scope. Examples leave consent false; only approve a real operation intentionally.
{
"mode": "topup",
"package_id": "YOUR_PACKAGE_ID",
"time_id": "FROM_RESIDENTIAL_CATALOG",
"promo_code": "",
"currency": "FROM_QUOTE",
"expected_total_minor": "FROM_QUOTE_TOTAL_MINOR",
"expected_selection_hash": "FROM_QUOTE_SELECTION_HASH",
"terms": false
}Additional usage examples
IDs and prices are illustrative; use real values from the catalog and the same quote. JSON IDs and expected_total_minor must be numbers. Examples deliberately keep terms=false; submit terms=true only after explicit customer approval for the real paid operation.
Residential: new package versus GB top-up · mode=new
Customers do not select a purpose for Residential orders. For a new package, the server automatically assigns the same fixed purpose as the website checkout; do not send purpose_id, subpurpose_id or other_purpose. A top-up preserves the existing package purpose.
{
"mode": "new",
"location_id": 20,
"time_id": 201,
"promo_code": "",
"currency": "TRY",
"expected_total_minor": 1000,
"expected_selection_hash": "0000000000000000000000000000000000000000000000000000000000000000",
"terms": false
}Residential: new package versus GB top-up · mode=topup
Customers do not select a purpose for Residential orders. For a new package, the server automatically assigns the same fixed purpose as the website checkout; do not send purpose_id, subpurpose_id or other_purpose. A top-up preserves the existing package purpose.
{
"mode": "topup",
"package_id": 10001,
"time_id": 201,
"promo_code": "",
"currency": "TRY",
"expected_total_minor": 1000,
"expected_selection_hash": "0000000000000000000000000000000000000000000000000000000000000000",
"terms": false
}Request example
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
curl --silent --show-error --header @- \
--header 'Accept: application/json' \
--connect-timeout 10 --max-time 30 \
--header 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY' \
--request POST --header 'Content-Type: application/json' \
--data-binary @request.json \
'https://www.arnproxy.com/account/api/v1/residential/orders/create'Examples are not executed on this page. Keep the API key in a server-side environment variable; do not put real keys in URLs or browser code. Prepare request.json for POST examples.
{"curl":"printf \u0027Authorization: Bearer %s\\n\u0027 \u0022$ARNPROXY_API_KEY\u0022 |\n curl --silent --show-error --header @- \\\n --header \u0027Accept: application\/json\u0027 \\\n --connect-timeout 10 --max-time 30 \\\n --header \u0027Idempotency-Key: YOUR_SAVED_OPERATION_KEY\u0027 \\\n --request POST --header \u0027Content-Type: application\/json\u0027 \\\n --data-binary @request.json \\\n \u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/create\u0027","python":"import os, requests\n\nheaders = {\u0022Authorization\u0022: \u0022Bearer \u0022 + os.environ[\u0022ARNPROXY_API_KEY\u0022]}\nheaders[\u0022Idempotency-Key\u0022] = \u0022YOUR_SAVED_OPERATION_KEY\u0022\nimport json\nwith open(\u0022request.json\u0022, encoding=\u0022utf-8\u0022) as f:\n payload = json.load(f)\nresponse = requests.post(\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/create\u0022,\n headers=headers, json=payload,\n timeout=(10, 30), allow_redirects=False\n)\nprint(response.status_code, response.text)\n# No automatic write retry.","javascript":"const headers = { Authorization: `Bearer ${process.env.ARNPROXY_API_KEY}` };\nheaders[\u0027Idempotency-Key\u0027] = \u0027YOUR_SAVED_OPERATION_KEY\u0027;\nconst { readFile } = await import(\u0027node:fs\/promises\u0027);\nheaders[\u0027Content-Type\u0027] = \u0027application\/json\u0027;\nconst body = await readFile(\u0027request.json\u0027, \u0027utf8\u0027);\nconst response = await fetch(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/create\u0022, {\n method: \u0027POST\u0027, headers, redirect: \u0027error\u0027,\n signal: AbortSignal.timeout(30000), body\n});\nconsole.log(response.status, await response.text());\n\/\/ A write timeout is ambiguous; query its saved operation.","php":"\u003C?php\n$headers = [\u0027Accept: application\/json\u0027,\n \u0027Authorization: Bearer \u0027.getenv(\u0027ARNPROXY_API_KEY\u0027)];\n$headers[] = \u0027Idempotency-Key: YOUR_SAVED_OPERATION_KEY\u0027;\n$headers[] = \u0027Content-Type: application\/json\u0027;\n$ch = curl_init(\u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/create\u0027);\ncurl_setopt_array($ch, [\n CURLOPT_RETURNTRANSFER =\u003E true,\n CURLOPT_HTTPHEADER =\u003E $headers,\n CURLOPT_FOLLOWLOCATION =\u003E false,\n CURLOPT_SSL_VERIFYPEER =\u003E true, CURLOPT_SSL_VERIFYHOST =\u003E 2,\n CURLOPT_CONNECTTIMEOUT =\u003E 10, CURLOPT_TIMEOUT =\u003E 30,\n CURLOPT_POST =\u003E true,\n CURLOPT_POSTFIELDS =\u003E file_get_contents(\u0027request.json\u0027),\n]);\n$result = curl_exec($ch);\nif ($result === false) {\n \/\/ Do not repeat a write; use the original operation key.\n throw new RuntimeException(\u0027Transport result unknown\u0027);\n}\necho curl_getinfo($ch, CURLINFO_HTTP_CODE).PHP_EOL.$result;\ncurl_close($ch);","go":"package main\n\nimport (\n \u0022fmt\u0022\n \u0022io\u0022\n \u0022net\/http\u0022\n \u0022os\u0022\n \u0022time\u0022\n)\n\nfunc main() {\n client := \u0026http.Client{Timeout: 30*time.Second,\n CheckRedirect: func(req *http.Request, via []*http.Request) error {\n return http.ErrUseLastResponse\n }}\n var body io.Reader\n file, err := os.Open(\u0022request.json\u0022); if err != nil { panic(err) }\n defer file.Close(); body = file\n req, err := http.NewRequest(\u0022POST\u0022, \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/create\u0022, body)\n if err != nil { panic(err) }\n req.Header.Set(\u0022Authorization\u0022, \u0022Bearer \u0022+os.Getenv(\u0022ARNPROXY_API_KEY\u0022))\n req.Header.Set(\u0022Idempotency-Key\u0022, \u0022YOUR_SAVED_OPERATION_KEY\u0022)\n req.Header.Set(\u0022Content-Type\u0022, \u0022application\/json\u0022)\n res, err := client.Do(req); if err != nil { panic(err) }\n defer res.Body.Close()\n data, err := io.ReadAll(res.Body); if err != nil { panic(err) }\n fmt.Println(res.StatusCode, string(data))\n}","csharp":"using System;\nusing System.IO;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Text;\n\nusing var handler = new HttpClientHandler { AllowAutoRedirect = false };\nusing var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };\nusing var request = new HttpRequestMessage(HttpMethod.Post,\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/create\u0022);\nrequest.Headers.Authorization = new AuthenticationHeaderValue(\n \u0022Bearer\u0022, Environment.GetEnvironmentVariable(\u0022ARNPROXY_API_KEY\u0022));\nrequest.Headers.Add(\u0022Idempotency-Key\u0022, \u0022YOUR_SAVED_OPERATION_KEY\u0022);\nrequest.Content = new StringContent(\n await File.ReadAllTextAsync(\u0022request.json\u0022), Encoding.UTF8, \u0022application\/json\u0022);\nusing var response = await client.SendAsync(request);\nConsole.WriteLine((int)response.StatusCode);\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n\/\/ Never automatically retry an ambiguous write.","java":"import java.net.URI;\nimport java.net.http.*;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.*;\n\n\/\/ Inside your application method:\nvar client = HttpClient.newHttpClient();\nvar request = HttpRequest.newBuilder(URI.create(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/orders\/create\u0022))\n .header(\u0022Authorization\u0022, \u0022Bearer \u0022 + System.getenv(\u0022ARNPROXY_API_KEY\u0022))\n .header(\u0022Accept\u0022, \u0022application\/json\u0022)\n .header(\u0022Idempotency-Key\u0022, System.getenv(\u0022ARNPROXY_OPERATION_KEY\u0022))\n .header(\u0022Content-Type\u0022, \u0022application\/json\u0022)\n .POST(HttpRequest.BodyPublishers.ofString(\n Files.readString(Path.of(\u0022request.json\u0022), StandardCharsets.UTF_8)))\n .build();\nvar response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode());"}Responses
201Success response
{
"ok": true,
"data": {
"state": "accepted",
"mode": "topup",
"delivery_state_at_acceptance": "queued",
"currency": "TRY",
"total": "15.00",
"total_minor": 1500,
"gb": 1,
"days": 30,
"target_package_id": 20001,
"order": {
"id": 20002,
"number": "1000020002",
"location_id": 20,
"time_id": 201,
"last_service_date": "2030-02-01"
},
"accepted_at": "2030-01-01T12:00:00+00:00",
"automatic_renewal": false,
"source": "existing_website_residential_delivery",
"replayed": false
},
"meta": {
"request_id": "000000000000000000000001",
"phase": "public_v1",
"source": "arnproxy_records"
}
}Response fields and types
| Name | Type | Description |
|---|---|---|
ok | boolean | Success envelope flag; on false inspect error.code. |
data | object | Operation-specific result; examples are illustrative and synthetic. |
data.state | string | Record/operation state. accepted is not delivery; completed is not a connection test. |
data.mode | string | Operation-specific mode value; preserve its demonstrated type and consult the behavior notes. |
data.delivery_state_at_acceptance | string | Operation-specific delivery state at acceptance value; preserve its demonstrated type and consult the behavior notes. |
data.currency | string | Account transaction currency: TRY or USD. |
data.total | string | Money amount; preserve the returned string/integer representation for precision. |
data.total_minor | integer | Integer minor units: 1000 means 10.00 TRY/USD. |
data.gb | integer | Traffic amount; list/settings operations do not purchase traffic. |
data.days | integer | Plan duration in days, separate from a GB plan’s traffic amount. |
data.target_package_id | integer | Operation-specific target package id value; preserve its demonstrated type and consult the behavior notes. |
data.order | object | Operation-specific order value; preserve its demonstrated type and consult the behavior notes. |
data.order.id | integer | Relevant ARNPROXY record ID; use it instead of the upstream internal ID. |
data.order.number | string | Display order number; not interchangeable with fields requesting an id. |
data.order.location_id | integer | Local catalog location or product-type ID. |
data.order.time_id | integer | Local period/GB-plan record ID, not a day or GB count. |
data.order.last_service_date | string | Last service day: current, previous or projected by the quote. A projection does not renew. |
data.accepted_at | string | Timestamp in the API’s returned representation; example dates are synthetic. |
data.automatic_renewal | boolean | Operation-specific automatic renewal value; preserve its demonstrated type and consult the behavior notes. |
data.source | string | Data source; local records and a live provider lookup are different evidence. |
data.replayed | boolean | Saved result for the same operation was returned, not proof of a new debit/action. |
meta | object | Request correlation and data-source metadata. |
meta.request_id | string | This HTTP request’s correlation ID, not an operation key or order ID. |
meta.phase | string | Operation-specific phase value; preserve its demonstrated type and consult the behavior notes. |
meta.source | string | Data source; local records and a live provider lookup are different evidence. |
Error response
{
"ok": false,
"error": { "code": "INVALID_API_KEY" },
"meta": { "request_id": "000000000000000000000001" }
}Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. Errors & limits →
Behavior & important notes
- Package and list IDs are ARNPROXY record IDs, not upstream package keys or list IDs. A stale package snapshot cannot grant access; refresh it with residential_package_refresh when needed.
- mode=new creates a package; mode=topup adds GB to an existing one. Use residential_catalog/quote first. Balance acceptance and background delivery are separate; follow the same operation key.
- A timeout/5xx is not proof that a write failed. Use the original Idempotency-Key with its status resource. Do not retry under a new key; GET does not resend the change.
- Customers do not select a purpose for Residential orders. For a new package, the server automatically assigns the same fixed purpose as the website checkout; do not send purpose_id, subpurpose_id or other_purpose. A top-up preserves the existing package purpose.
- For compatibility, valid legacy subpurpose_id/other_purpose fields may be accepted with mode=new, but do not change the automatically assigned purpose of a new order. New integrations should omit them. They are not supported with mode=topup. Previously accepted requests can be replayed with the same Idempotency-Key and request; do not repurchase with a new key.
- If the automatic purpose configuration is unavailable, RESIDENTIAL_DEFAULT_PURPOSE_UNAVAILABLE (HTTP 503) is returned without creating an order or debiting the balance. An administrator must check the configuration.