Add an App Store purchase

Example

curl "https://api.switchfile.io/v1/account/app-store/transactions" \
  -H "Authorization: Bearer $SWITCHFILE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "signed_transaction": "eyJhbGciOiJFUzI1NiIsIng1YyI6WyJNSUlF..."
  }'

const res = await fetch("https://api.switchfile.io/v1/account/app-store/transactions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SWITCHFILE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    signed_transaction: "eyJhbGciOiJFUzI1NiIsIng1YyI6WyJNSUlF..."
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

<?php
$ch = curl_init('https://api.switchfile.io/v1/account/app-store/transactions');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode([
        'signed_transaction' => 'eyJhbGciOiJFUzI1NiIsIng1YyI6WyJNSUlF...',
    ]),
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('SWITCHFILE_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException("HTTP $status: $response");
}
print_r(json_decode($response, true));

import os
import requests

res = requests.post(
    "https://api.switchfile.io/v1/account/app-store/transactions",
    headers={"Authorization": f"Bearer {os.environ['SWITCHFILE_API_KEY']}"},
    json={
        "signed_transaction": "eyJhbGciOiJFUzI1NiIsIng1YyI6WyJNSUlF...",
    },
)
res.raise_for_status()
print(res.json())

Request body

Responses

• 200OK

  • balancestring (integer) | integerrequired
  • creditedbooleanrequired

    false: nothing was added now, because the transaction was added before or Apple refunded it (finish it in StoreKit anyway)

  • creditsstring (integer) | integerrequired

    Credits this request added (0 when nothing was added)

  • product_idstringrequired
  • refundedbooleanrequired

    true: Apple refunded the whole purchase, so it adds no credits

  • transaction_idstringrequired

  200 application/jsonCopy

  {
    "transaction_id": "2000000812345678",
    "product_id": "io.switchfile.app.credits1000",
    "credits": 1000,
    "credited": true,
    "refunded": false,
    "balance": 2240
  }

• 401The API key is missing or not validUNAUTHENTICATED

  401 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-unauthenticated",
    "title": "Unauthenticated",
    "status": 401,
    "code": "UNAUTHENTICATED",
    "detail": "Missing or invalid API key."
  }

• 403The purchase was made for another account (appAccountToken), or is a test purchase from an account that is not a test accountTRANSACTION_NOT_YOURS

  403 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-transaction-not-yours",
    "title": "Transaction not yours",
    "status": 403,
    "code": "TRANSACTION_NOT_YOURS",
    "detail": "This purchase was made for another switchfile account."
  }

• 404Does not exist for this accountNOT_FOUND

  404 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-not-found",
    "title": "Not found",
    "status": 404,
    "code": "NOT_FOUND",
    "detail": "Not found."
  }

• 409Already added to another accountTRANSACTION_ALREADY_USED

  409 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-transaction-already-used",
    "title": "Transaction already used",
    "status": 409,
    "code": "TRANSACTION_ALREADY_USED",
    "detail": "This purchase was already added to another account."
  }

• 422Not signed by the App Store, or an unknown productINVALID_TRANSACTION

  422 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-invalid-transaction",
    "title": "Invalid transaction",
    "status": 422,
    "code": "INVALID_TRANSACTION",
    "detail": "The transaction is not signed by the App Store."
  }

• 429Too many requests or a daily quota is used up. See Retry-AfterRATE_LIMIT_EXCEEDED

  429 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-rate-limit-exceeded",
    "title": "Rate limit exceeded",
    "status": 429,
    "code": "RATE_LIMIT_EXCEEDED",
    "detail": "Too many requests. Try again in 12 seconds."
  }

• 503Not available right now or busy. See Retry-AfterPURCHASES_UNAVAILABLE

  503 application/problem+jsonCopy

  {
    "type": "https://switchfile.io/docs/api/v1#errors-purchases-unavailable",
    "title": "Purchases unavailable",
    "status": 503,
    "code": "PURCHASES_UNAVAILABLE",
    "detail": "Purchases in the app are not available right now."
  }

Error bodies and codes are explained in Errors.