Get a payment
Read where one of the diner's Tamr Pay payments stands: open, paid, failed, expired or refunded.
GET
/api/v1/pay/{paymentId}Client APICheck it when the diner comes back from the provider's page. A status this version doesn't know reads as unknown.
Authentication
Client API. Send your publishable key in x-tamr-key and the diner's session in x-tamr-session, from Start a session. For a guest's session, also send its device id in x-tamr-device. A browser may call it only from an origin listed on the key.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
paymentId | string | Yes | 1 to 200 characters. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
x-tamr-device | string | No | Guest sessions only: the device id the session was exchanged with. Matches ^[A-Za-z0-9_-]{8,128}$. |
x-tamr-app | string | No | Native apps only: the app's iOS bundle id or Android package name. A key used from an app it doesn't list is logged, never refused. Matches ^[A-Za-z][A-Za-z0-9_-]*(\.[A-Za-z0-9_-]+)+$. |
Response
| Field | Type | Description |
|---|---|---|
paymentId | string | 1 to 200 characters. |
reference | string | 1 to 40 characters. |
status | string | One of open, paid, failed, expired, refunded, unknown. An open list: read a value you don't know as unknown. |
amount | string | An amount in minor units, as a string. |
tip | string | An amount in minor units, as a string. |
total | string | An amount in minor units, as a string. |
currency | string | A three-letter currency code (ISO 4217). |
expiresAt | string (date-time) or null | |
provider | string | May be absent. 1 to 40 characters. |
pay | string | May be absent. One of tab, amount, order, unknown. An open list: read a value you don't know as unknown. |
Example
curl https://tamr.link/api/v1/pay/pay_0002 \
-H "x-tamr-key: $TAMR_APP_KEY" \
-H "x-tamr-session: $TAMR_SESSION"import { createClient } from "@tamr/api";
const tamr = createClient({ appKey: process.env.TAMR_APP_KEY });
// Sign the diner in first, with a token your backend signed (or a launch code).
await tamr.startSession({ token: dinerToken });
const result = await tamr.payGet("pay_0002");
console.log(result);import os
import requests
API = "https://tamr.link/api/v1"
headers = {
"x-tamr-key": os.environ["TAMR_APP_KEY"],
"x-tamr-session": os.environ["TAMR_SESSION"], # from POST /api/v1/sdk/session
}
payment_id = "pay_0002"
response = requests.get(
f"{API}/pay/{payment_id}",
headers=headers,
timeout=30,
)
response.raise_for_status()
print(response.json())Example response
{
"paymentId": "pay_0002",
"reference": "TP-7K2M9QXA",
"status": "paid",
"amount": "2400",
"tip": "240",
"total": "2640",
"currency": "USD",
"expiresAt": "2026-11-05T20:05:00.000Z"
}Errors
Every error has the same body; switch on data.code. See Errors and rate limits.
data.code | Status | What to do |
|---|---|---|
app_key_invalid | 401 | The key is wrong, revoked or of another kind. Check it in the dashboard. |
sdk_disabled | 403 | The SDK isn't switched on for this restaurant. Ask Tamr. |
origin_not_allowed | 403 | A browser called from an origin the key doesn't list. Add the origin to the key. |
session_expired | 401 | Start a new session with a fresh token or code, then send the call again once. |
invalid_request | 400 | A field doesn't match the spec. The message says which. |
rate_limited | 429 | Wait retryAfter seconds (also in the Retry-After header), then try again. |
not_found | 404 | Not this diner's, or doesn't exist. The two read the same on purpose. |