Member transactions and invoices

Example: inspect recorded transaction 4001

Use sample runtimes; the member's selected resource contains transaction 4001.

cURL

curl "${WALLKIT_API_BASE}/api/v1/user/transactions?page=1&limit=10" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

JavaScript

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/transactions", process.env.WALLKIT_API_BASE);
  url.searchParams.set("page", "1");
  url.searchParams.set("limit", "10");
  const response = await fetch(url, { method: "GET", headers: {
    resource: process.env.RESOURCE_KEY, token: process.env.USER_TOKEN
  }});
  console.log(response.status, await response.json());
}
main().catch(console.error);

Python

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urlencode, urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], "/api/v1/user/transactions") + "?" + urlencode({'page': '1', 'limit': '10'})
headers = {"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}
request = Request(url, headers=headers, method="GET")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

HTTP 200 excerpt:

{"items":[{"id":4001,"status":"succeeded","amount":1200,"currency":"USD","purchases":[{"id":5001,"item_type":"subscription","item_id":2001,"amount":1200}],"receipt":null,"payment_source":null}]}

A missing receipt means no selected receipt record was returned, not a failed transaction. Missing source mapping is not proof of a free charge. Read the full field projection for other returned fields.

Example: inspect transaction 4001

Use sample runtimes; this member owns transaction 4001.

cURL

curl "${WALLKIT_API_BASE}/api/v1/user/transactions/4001" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

JavaScript

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/transactions/4001", process.env.WALLKIT_API_BASE);
  
  const response = await fetch(url, { method: "GET", headers: {
    resource: process.env.RESOURCE_KEY, token: process.env.USER_TOKEN
  }});
  console.log(response.status, await response.json());
}
main().catch(console.error);

Python

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urlencode, urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], "/api/v1/user/transactions/4001")
headers = {"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}
request = Request(url, headers=headers, method="GET")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

HTTP 200 excerpt:

{"id":4001,"status":"succeeded","amount":1200,"currency":"USD","purchases":[{"id":5001,"item_type":"subscription","item_id":2001,"amount":1200}],"receipt":null,"refunds":[]}

This describes recorded account state. The absent receipt needs a separate generation/availability decision; succeeded is not independent provider settlement evidence for every originating flow.

Example: retrieve transaction 4001's invoice

Use sample runtimes. Adapt the binary response separately from JSON error bodies; never unconditionally call response.json for this operation.

cURL

curl "${WALLKIT_API_BASE}/api/v1/user/transactions/4001/download" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  --dump-header download-headers.txt \
  --output download-body.bin

Inspect download-headers.txt and HTTP status before treating download-body.bin as a PDF; the request can return JSON errors. These are illustrative local output filenames, not files created during authoring.

JavaScript

// Node.js 18+; built-in fetch. Separate binary from JSON errors.
async function main() {
  const url = new URL("/api/v1/user/transactions/4001/download", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, { method: "GET", headers: { resource: process.env.RESOURCE_KEY, token: process.env.USER_TOKEN } });
  const mediaType = response.headers.get("content-type") || "";
  if (mediaType.includes("application/json")) {
    console.log(response.status, await response.json());
  } else if (!response.ok) {
    console.log(response.status, await response.text());
  } else {
    const bytes = await response.arrayBuffer();
    console.log(response.status, mediaType, bytes.byteLength);
  }
}
main().catch(console.error);

Python

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urlencode, urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], "/api/v1/user/transactions/4001/download")
request = Request(url, headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="GET")
try:
    with urlopen(request) as response:
        media_type = response.headers.get("Content-Type", "")
        if "application/json" in media_type:
            print(response.status, json.load(response))
        else:
            print(response.status, media_type, len(response.read()))
except HTTPError as error:
    media_type = error.headers.get("Content-Type", "")
    if "application/json" in media_type:
        print(error.code, json.load(error))
    else:
        print(error.code, error.read().decode("utf-8", errors="replace"))

Successful response description: PDF bytes for the rendered transaction invoice, with generator filename Transaction_4001.pdf. JSON success example is N/A because the operation streams binary content. Inspect media type/status before opening the output as a PDF.

Example: request transaction 4001's receipt

Use sample runtimes. Assume this member owns the transaction in the supplied resource.

cURL

curl "${WALLKIT_API_BASE}/api/v1/user/transaction/4001/receipt/generate" \
  -X POST \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "Accept: application/json"

JavaScript

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/user/transaction/4001/receipt/generate", process.env.WALLKIT_API_BASE);
  const headers = {
    resource: process.env.RESOURCE_KEY,
    token: process.env.USER_TOKEN,
    Accept: "application/json"
  };
  const response = await fetch(url, {
    method: "POST", headers
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

Python

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], "/api/v1/user/transaction/4001/receipt/generate")
headers = {
    "resource": os.environ["RESOURCE_KEY"],
    "token": os.environ["USER_TOKEN"],
    "Accept": "application/json"
}
request = Request(url, headers=headers, method="POST")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

HTTP 200:

{"success":true}

The generation request was acknowledged. Read transaction detail later for its existing receipt field; do not turn success:true into a claim that a receipt was generated or sent.