payment.completed webhook

The payment.completed webhook: a diner paid with Tamr Pay from your app, recorded from the payment provider's own answer.

A diner paid with Tamr Pay from your app: a table's tab, a typed amount, or a pickup paid ahead. Sent when Tamr records the payment paid from the provider's own answer, never because the diner came back to your app. Once per payment: the webhook-id is fixed by the payment. A payment made on Tamr's own QR menu sends none, and a test key's diner can't pay.

Never the payer's number, a name or what was on the bill.

The data object

FieldTypeDescription
externalUserIdstring or null1 to 200 characters.
conversationIdstring or null1 to 200 characters.
paymentIdstring1 to 200 characters.
referencestring1 to 40 characters.
amountstringAn amount in minor units, as a string.
tipstringAn amount in minor units, as a string.
currencystringA three-letter currency code (ISO 4217).
orderIdstring or null1 to 200 characters.
branchstringAn address: lower-case letters, digits and dashes.
tablestring or null1 to 40 characters.

Examples

payment.completed
{
  "type": "payment.completed",
  "timestamp": "2026-11-05T20:03:12.000Z",
  "livemode": true,
  "data": {
    "externalUserId": "user-88213",
    "conversationId": "conv_01",
    "paymentId": "pay_0002",
    "reference": "TP-7K2M9QXA",
    "amount": "2640",
    "tip": "240",
    "currency": "USD",
    "orderId": null,
    "branch": "achrafieh",
    "table": "12"
  }
}

A guest's typed amount at no table, in LBP.

payment.completed
{
  "type": "payment.completed",
  "timestamp": "2026-11-05T20:10:00.000Z",
  "livemode": true,
  "data": {
    "externalUserId": null,
    "conversationId": null,
    "paymentId": "pay_0003",
    "reference": "TP-2B8NW4RT",
    "amount": "1500000",
    "tip": "0",
    "currency": "LBP",
    "orderId": null,
    "branch": "achrafieh",
    "table": null
  }
}

A test event

What Send a test event in the dashboard sends: livemode: false, and every id starting test_.

payment.completed, test
{
  "type": "payment.completed",
  "timestamp": "2026-11-16T12:00:00.000Z",
  "livemode": false,
  "data": {
    "externalUserId": "test_user",
    "conversationId": "test_conversation",
    "paymentId": "test_payment",
    "reference": "TP-TEST0001",
    "amount": "1980",
    "tip": "180",
    "currency": "USD",
    "orderId": null,
    "branch": "test-branch",
    "table": "12"
  }
}