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 API

Check 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

NameTypeRequiredDescription
paymentIdstringYes1 to 200 characters.

Headers

NameTypeRequiredDescription
x-tamr-devicestringNoGuest sessions only: the device id the session was exchanged with. Matches ^[A-Za-z0-9_-]{8,128}$.
x-tamr-appstringNoNative 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

FieldTypeDescription
paymentIdstring1 to 200 characters.
referencestring1 to 40 characters.
statusstringOne of open, paid, failed, expired, refunded, unknown. An open list: read a value you don't know as unknown.
amountstringAn amount in minor units, as a string.
tipstringAn amount in minor units, as a string.
totalstringAn amount in minor units, as a string.
currencystringA three-letter currency code (ISO 4217).
expiresAtstring (date-time) or null
providerstringMay be absent. 1 to 40 characters.
paystringMay 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"

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.codeStatusWhat to do
app_key_invalid401The key is wrong, revoked or of another kind. Check it in the dashboard.
sdk_disabled403The SDK isn't switched on for this restaurant. Ask Tamr.
origin_not_allowed403A browser called from an origin the key doesn't list. Add the origin to the key.
session_expired401Start a new session with a fresh token or code, then send the call again once.
invalid_request400A field doesn't match the spec. The message says which.
rate_limited429Wait retryAfter seconds (also in the Retry-After header), then try again.
not_found404Not this diner's, or doesn't exist. The two read the same on purpose.