11 operations. Every schema and example on this page is generated from the platform contract.
Dark behind IN_PERSON_SALE_ENABLED (off: 404). Needs can_process_payments.
The shop (also authorises the person).
Only sales in this state.
needs_approvalopenpaidcancelleddeclinedNewest first. Default 30.
needs_approvalopenpaidcancelleddeclinedBefore any discount.
All discounts together.
What the customer pays. Never below 0.
List price of one, before any discount.
This line's own discount.
After the line discount (before any whole-sale discount).
A keypad line only: why it shows on her day list. Null for a menu line, a keypad line at or above the menu price, or a sale made before 4 Nov 2026.
'below_menu_price' its name is one of her menu items (any case, spaces trimmed) and its price for one is below that item's cheapest menu price; 'open_price' no menu item has that name, so it was typed with nothing to check against.
below_menu_priceopen_priceThe menu item it matched ('below_menu_price' only).
That item's cheapest menu price for one ('below_menu_price' only).
linebasketWhich line (0-based), for a line discount.
percentamountset_priceregularstaffdamagedotherWhat it took off, in pence (positive). The customer screen shows "Discount -£x".
Who gave it.
cashbank_transfertap_to_payPresent only for a sale paid by a SumUp or Square tap (refund it with the tap refund route).
sumupsquareA SumUp- or Square-paid sale only: the tap that paid it, for refundTapToPayPayment.
Tap to Pay: the card attempt that paid it (for refundTapToPayPayment and showTapLoyaltyClaim), from any phone. Read on a single sale and on pay; null for cash, transfer, unpaid, or when it could not be read.
Once paid: the buyer's receipt, the order page with its own page token (/o/{number}?t=…, the link emails and texts use). Null until paid. The till shows it as a QR.
Present only when the sale needed the owner.
pendingapproveddeclinedcurl -G "https://www.membber.com/api/v1/in-person-sales" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/in-person-sales", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.listInPersonSales(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"sales": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"order_number": "<order_number>",
"state": "needs_approval",
"currency": "GBP",
"subtotal_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"lines": [
{
"index": -9007199254740991,
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"option_id": "6dff1925-0000-4000-8000-d0c50000006d",
"name": "Example name",
"size_label": "<size_label>",
"colour_label": "<colour_label>",
"custom": true,
"quantity": 1,
"unit_pence": 1500,
"list_total_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"typed_price_flag": {
"reason": "below_menu_price",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"menu_price_pence": 1500
}
}
],
"discounts": [
{
"scope": "line",
"line_index": -9007199254740991,
"kind": "percent",
"value": 1,
"reason": "regular",
"amount_pence": 1500,
"given_by": "4d25ec59-0000-4000-8000-d0c50000004d"
}
],
"payment": {
"method": "cash",
"paid_at": "<paid_at>",
"cash_received_pence": 1500,
"change_pence": 1500,
"provider": "sumup",
"in_person_payment_id": "70145484-0000-4000-8000-d0c500000070",
"tap_payment_id": "b6de3c10-0000-4000-8000-d0c5000000b6"
},
"receipt_url": "https://example.com",
"approval": {
"state": "pending",
"limit_pence": 1500,
"requested_by": "4dfb7ac8-0000-4000-8000-d0c50000004d",
"decided_by": "7a956d7a-0000-4000-8000-d0c50000007a"
},
"created_by": "51a3a90e-0000-4000-8000-d0c500000051",
"created_at": "<created_at>"
}
]
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). Needs can_process_payments and an Idempotency-Key header (UUID v4): the same key is always the same sale (the same key with another basket is 409 IDEMPOTENCY_KEY_REUSED). Prices are read from the server; only a keypad line carries an amount. Stock comes off the same count as online orders, once. Discounts are in pence, rounded half up, never below 0 (line discounts first, then the whole-sale one on what is left). When staff (not the owner) give more discount than the owner's limit, the sale comes back state needs_approval with no stock taken, until the owner approves: the owner's phones get one push, and the sale never runs out of time while it waits. 409 SOLD_OUT (details.menu_item_id) when something ran out.
The shop (also authorises the person).
One of her menu items. Its price is read from the server.
The size/colour row (menu_item_options) when the item has them. Required then (400 OPTION_REQUIRED).
A keypad line: the price of ONE in pence. Use instead of menu_item_id.
A keypad line's name, e.g. "Cake slice".
This line only.
'percent' off (value 0.01 to 100, two decimals at most); 'amount' = pence off (the whole line, or the whole sale); 'set_price' = the new price per item in pence (a line only, never above its list price).
percentamountset_pricePercent, or pence (a whole number), as kind says.
Optional: regular, staff, damaged or other.
regularstaffdamagedotherWhole sale: 'percent' or 'amount' (not set_price).
'percent' off (value 0.01 to 100, two decimals at most); 'amount' = pence off (the whole line, or the whole sale); 'set_price' = the new price per item in pence (a line only, never above its list price).
percentamountset_pricePercent, or pence (a whole number), as kind says.
Optional: regular, staff, damaged or other.
regularstaffdamagedotherOne walk-up sale.
needs_approvalopenpaidcancelleddeclinedBefore any discount.
All discounts together.
What the customer pays. Never below 0.
List price of one, before any discount.
This line's own discount.
After the line discount (before any whole-sale discount).
A keypad line only: why it shows on her day list. Null for a menu line, a keypad line at or above the menu price, or a sale made before 4 Nov 2026.
'below_menu_price' its name is one of her menu items (any case, spaces trimmed) and its price for one is below that item's cheapest menu price; 'open_price' no menu item has that name, so it was typed with nothing to check against.
below_menu_priceopen_priceThe menu item it matched ('below_menu_price' only).
That item's cheapest menu price for one ('below_menu_price' only).
linebasketWhich line (0-based), for a line discount.
percentamountset_priceregularstaffdamagedotherWhat it took off, in pence (positive). The customer screen shows "Discount -£x".
Who gave it.
cashbank_transfertap_to_payPresent only for a sale paid by a SumUp or Square tap (refund it with the tap refund route).
sumupsquareA SumUp- or Square-paid sale only: the tap that paid it, for refundTapToPayPayment.
Tap to Pay: the card attempt that paid it (for refundTapToPayPayment and showTapLoyaltyClaim), from any phone. Read on a single sale and on pay; null for cash, transfer, unpaid, or when it could not be read.
Once paid: the buyer's receipt, the order page with its own page token (/o/{number}?t=…, the link emails and texts use). Null until paid. The till shows it as a QR.
Present only when the sale needed the owner.
pendingapproveddeclinedcurl -X POST "https://www.membber.com/api/v1/in-person-sales" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"lines": [
{
"quantity": 1
}
]
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/in-person-sales", {
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
lines: [
{
quantity: 1
}
]
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.createInPersonSale(
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
lines: [.init(
quantity: 1
)]
))
).ok.body.json
print(response){
"sale": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"order_number": "<order_number>",
"state": "needs_approval",
"currency": "GBP",
"subtotal_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"lines": [
{
"index": -9007199254740991,
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"option_id": "6dff1925-0000-4000-8000-d0c50000006d",
"name": "Example name",
"size_label": "<size_label>",
"colour_label": "<colour_label>",
"custom": true,
"quantity": 1,
"unit_pence": 1500,
"list_total_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"typed_price_flag": {
"reason": "below_menu_price",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"menu_price_pence": 1500
}
}
],
"discounts": [
{
"scope": "line",
"line_index": -9007199254740991,
"kind": "percent",
"value": 1,
"reason": "regular",
"amount_pence": 1500,
"given_by": "4d25ec59-0000-4000-8000-d0c50000004d"
}
],
"payment": {
"method": "cash",
"paid_at": "<paid_at>",
"cash_received_pence": 1500,
"change_pence": 1500,
"provider": "sumup",
"in_person_payment_id": "70145484-0000-4000-8000-d0c500000070",
"tap_payment_id": "b6de3c10-0000-4000-8000-d0c5000000b6"
},
"receipt_url": "https://example.com",
"approval": {
"state": "pending",
"limit_pence": 1500,
"requested_by": "4dfb7ac8-0000-4000-8000-d0c50000004d",
"decided_by": "7a956d7a-0000-4000-8000-d0c50000007a"
},
"created_by": "51a3a90e-0000-4000-8000-d0c500000051",
"created_at": "<created_at>"
}
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). Needs can_process_payments. The phone polls this after a tap; paid only once Stripe says so.
The shop (also authorises the person).
One walk-up sale.
needs_approvalopenpaidcancelleddeclinedBefore any discount.
All discounts together.
What the customer pays. Never below 0.
List price of one, before any discount.
This line's own discount.
After the line discount (before any whole-sale discount).
A keypad line only: why it shows on her day list. Null for a menu line, a keypad line at or above the menu price, or a sale made before 4 Nov 2026.
'below_menu_price' its name is one of her menu items (any case, spaces trimmed) and its price for one is below that item's cheapest menu price; 'open_price' no menu item has that name, so it was typed with nothing to check against.
below_menu_priceopen_priceThe menu item it matched ('below_menu_price' only).
That item's cheapest menu price for one ('below_menu_price' only).
linebasketWhich line (0-based), for a line discount.
percentamountset_priceregularstaffdamagedotherWhat it took off, in pence (positive). The customer screen shows "Discount -£x".
Who gave it.
cashbank_transfertap_to_payPresent only for a sale paid by a SumUp or Square tap (refund it with the tap refund route).
sumupsquareA SumUp- or Square-paid sale only: the tap that paid it, for refundTapToPayPayment.
Tap to Pay: the card attempt that paid it (for refundTapToPayPayment and showTapLoyaltyClaim), from any phone. Read on a single sale and on pay; null for cash, transfer, unpaid, or when it could not be read.
Once paid: the buyer's receipt, the order page with its own page token (/o/{number}?t=…, the link emails and texts use). Null until paid. The till shows it as a QR.
Present only when the sale needed the owner.
pendingapproveddeclinedcurl -G "https://www.membber.com/api/v1/in-person-sales/c9c6d3c2-0000-4000-8000-d0c5000000c9" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/in-person-sales/{saleId}", {
params: { path: { saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9" }, query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.getInPersonSale(
path: .init(saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9"),
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"sale": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"order_number": "<order_number>",
"state": "needs_approval",
"currency": "GBP",
"subtotal_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"lines": [
{
"index": -9007199254740991,
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"option_id": "6dff1925-0000-4000-8000-d0c50000006d",
"name": "Example name",
"size_label": "<size_label>",
"colour_label": "<colour_label>",
"custom": true,
"quantity": 1,
"unit_pence": 1500,
"list_total_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"typed_price_flag": {
"reason": "below_menu_price",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"menu_price_pence": 1500
}
}
],
"discounts": [
{
"scope": "line",
"line_index": -9007199254740991,
"kind": "percent",
"value": 1,
"reason": "regular",
"amount_pence": 1500,
"given_by": "4d25ec59-0000-4000-8000-d0c50000004d"
}
],
"payment": {
"method": "cash",
"paid_at": "<paid_at>",
"cash_received_pence": 1500,
"change_pence": 1500,
"provider": "sumup",
"in_person_payment_id": "70145484-0000-4000-8000-d0c500000070",
"tap_payment_id": "b6de3c10-0000-4000-8000-d0c5000000b6"
},
"receipt_url": "https://example.com",
"approval": {
"state": "pending",
"limit_pence": 1500,
"requested_by": "4dfb7ac8-0000-4000-8000-d0c50000004d",
"decided_by": "7a956d7a-0000-4000-8000-d0c50000007a"
},
"created_by": "51a3a90e-0000-4000-8000-d0c500000051",
"created_at": "<created_at>"
}
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). The OWNER only (403 OWNER_ONLY). Approve takes the stock and opens the sale (409 SOLD_OUT if it ran out meanwhile); decline ends it with no stock ever taken. Asking again with the same decision answers as it is; the other decision after one was made is 409 ALREADY_DECIDED.
The shop (also authorises the person).
approvedeclineOne walk-up sale.
needs_approvalopenpaidcancelleddeclinedBefore any discount.
All discounts together.
What the customer pays. Never below 0.
List price of one, before any discount.
This line's own discount.
After the line discount (before any whole-sale discount).
A keypad line only: why it shows on her day list. Null for a menu line, a keypad line at or above the menu price, or a sale made before 4 Nov 2026.
'below_menu_price' its name is one of her menu items (any case, spaces trimmed) and its price for one is below that item's cheapest menu price; 'open_price' no menu item has that name, so it was typed with nothing to check against.
below_menu_priceopen_priceThe menu item it matched ('below_menu_price' only).
That item's cheapest menu price for one ('below_menu_price' only).
linebasketWhich line (0-based), for a line discount.
percentamountset_priceregularstaffdamagedotherWhat it took off, in pence (positive). The customer screen shows "Discount -£x".
Who gave it.
cashbank_transfertap_to_payPresent only for a sale paid by a SumUp or Square tap (refund it with the tap refund route).
sumupsquareA SumUp- or Square-paid sale only: the tap that paid it, for refundTapToPayPayment.
Tap to Pay: the card attempt that paid it (for refundTapToPayPayment and showTapLoyaltyClaim), from any phone. Read on a single sale and on pay; null for cash, transfer, unpaid, or when it could not be read.
Once paid: the buyer's receipt, the order page with its own page token (/o/{number}?t=…, the link emails and texts use). Null until paid. The till shows it as a QR.
Present only when the sale needed the owner.
pendingapproveddeclinedcurl -X POST "https://www.membber.com/api/v1/in-person-sales/c9c6d3c2-0000-4000-8000-d0c5000000c9/approval" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"decision": "approve"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/in-person-sales/{saleId}/approval", {
params: { path: { saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9" } },
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
decision: "approve"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.decideInPersonSaleApproval(
path: .init(saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9"),
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
decision: .approve
))
).ok.body.json
print(response){
"sale": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"order_number": "<order_number>",
"state": "needs_approval",
"currency": "GBP",
"subtotal_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"lines": [
{
"index": -9007199254740991,
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"option_id": "6dff1925-0000-4000-8000-d0c50000006d",
"name": "Example name",
"size_label": "<size_label>",
"colour_label": "<colour_label>",
"custom": true,
"quantity": 1,
"unit_pence": 1500,
"list_total_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"typed_price_flag": {
"reason": "below_menu_price",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"menu_price_pence": 1500
}
}
],
"discounts": [
{
"scope": "line",
"line_index": -9007199254740991,
"kind": "percent",
"value": 1,
"reason": "regular",
"amount_pence": 1500,
"given_by": "4d25ec59-0000-4000-8000-d0c50000004d"
}
],
"payment": {
"method": "cash",
"paid_at": "<paid_at>",
"cash_received_pence": 1500,
"change_pence": 1500,
"provider": "sumup",
"in_person_payment_id": "70145484-0000-4000-8000-d0c500000070",
"tap_payment_id": "b6de3c10-0000-4000-8000-d0c5000000b6"
},
"receipt_url": "https://example.com",
"approval": {
"state": "pending",
"limit_pence": 1500,
"requested_by": "4dfb7ac8-0000-4000-8000-d0c50000004d",
"decided_by": "7a956d7a-0000-4000-8000-d0c50000007a"
},
"created_by": "51a3a90e-0000-4000-8000-d0c500000051",
"created_at": "<created_at>"
}
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). Needs can_process_payments. An open Tap to Pay attempt is cancelled at Stripe first. 409 ALREADY_PAID when the money is in, a tap that went through included (refund it instead). Already cancelled: answered as it is. A sale still unpaid 2 hours after it was made (after the owner's decision, for one that waited for her; never while it waits) is cancelled the same way by itself, but never while a tap made or written in the last 5 minutes is open.
The shop (also authorises the person).
One walk-up sale.
needs_approvalopenpaidcancelleddeclinedBefore any discount.
All discounts together.
What the customer pays. Never below 0.
List price of one, before any discount.
This line's own discount.
After the line discount (before any whole-sale discount).
A keypad line only: why it shows on her day list. Null for a menu line, a keypad line at or above the menu price, or a sale made before 4 Nov 2026.
'below_menu_price' its name is one of her menu items (any case, spaces trimmed) and its price for one is below that item's cheapest menu price; 'open_price' no menu item has that name, so it was typed with nothing to check against.
below_menu_priceopen_priceThe menu item it matched ('below_menu_price' only).
That item's cheapest menu price for one ('below_menu_price' only).
linebasketWhich line (0-based), for a line discount.
percentamountset_priceregularstaffdamagedotherWhat it took off, in pence (positive). The customer screen shows "Discount -£x".
Who gave it.
cashbank_transfertap_to_payPresent only for a sale paid by a SumUp or Square tap (refund it with the tap refund route).
sumupsquareA SumUp- or Square-paid sale only: the tap that paid it, for refundTapToPayPayment.
Tap to Pay: the card attempt that paid it (for refundTapToPayPayment and showTapLoyaltyClaim), from any phone. Read on a single sale and on pay; null for cash, transfer, unpaid, or when it could not be read.
Once paid: the buyer's receipt, the order page with its own page token (/o/{number}?t=…, the link emails and texts use). Null until paid. The till shows it as a QR.
Present only when the sale needed the owner.
pendingapproveddeclinedcurl -X POST "https://www.membber.com/api/v1/in-person-sales/c9c6d3c2-0000-4000-8000-d0c5000000c9/cancel" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/in-person-sales/{saleId}/cancel", {
params: { path: { saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9" } },
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.cancelInPersonSale(
path: .init(saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9"),
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066"
))
).ok.body.json
print(response){
"sale": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"order_number": "<order_number>",
"state": "needs_approval",
"currency": "GBP",
"subtotal_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"lines": [
{
"index": -9007199254740991,
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"option_id": "6dff1925-0000-4000-8000-d0c50000006d",
"name": "Example name",
"size_label": "<size_label>",
"colour_label": "<colour_label>",
"custom": true,
"quantity": 1,
"unit_pence": 1500,
"list_total_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"typed_price_flag": {
"reason": "below_menu_price",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"menu_price_pence": 1500
}
}
],
"discounts": [
{
"scope": "line",
"line_index": -9007199254740991,
"kind": "percent",
"value": 1,
"reason": "regular",
"amount_pence": 1500,
"given_by": "4d25ec59-0000-4000-8000-d0c50000004d"
}
],
"payment": {
"method": "cash",
"paid_at": "<paid_at>",
"cash_received_pence": 1500,
"change_pence": 1500,
"provider": "sumup",
"in_person_payment_id": "70145484-0000-4000-8000-d0c500000070",
"tap_payment_id": "b6de3c10-0000-4000-8000-d0c5000000b6"
},
"receipt_url": "https://example.com",
"approval": {
"state": "pending",
"limit_pence": 1500,
"requested_by": "4dfb7ac8-0000-4000-8000-d0c50000004d",
"decided_by": "7a956d7a-0000-4000-8000-d0c50000007a"
},
"created_by": "51a3a90e-0000-4000-8000-d0c500000051",
"created_at": "<created_at>"
}
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). Needs can_process_payments and an Idempotency-Key header (UUID v4). cash: the change is worked out here and the sale is paid at once (409 CASH_SHORT if less than the total). bank_transfer: staff confirm it arrived; paid at once. tap_to_pay: starts the card attempt through the Tap to Pay routes' own code (also behind STRIPE_TAP_TO_PAY_ENABLED), amount = the total, 0% Membber fee; the sale is paid ONLY when Stripe's webhook confirms. With provider sumup (behind SUMUP_TAP_TO_PAY_ENABLED): a SumUp attempt for the sale, the answer's `sumup` is the SDK checkout, and the sale is paid ONLY when SumUp's own transaction matches (poll getTapToPayPayment with payment_id); it then gets the same claim code as cash. With provider square (behind SQUARE_TAP_TO_PAY_ENABLED) the same, the answer's `square` what Square's Mobile Payments SDK takes, paid ONLY when Square's own payment matches. A sale can never be paid twice (409 ALREADY_PAID); a sale waiting for the owner is 409 NEEDS_APPROVAL. A cash or transfer payment cancels any open tap attempt first. The Idempotency-Key belongs to this sale: the same key used to pay another sale is 409 IDEMPOTENCY_KEY_REUSED. A paid sale is handed over as it is paid, so it is never an order to hand over. Cash or bank_transfer, with TAP_TO_PAY_LOYALTY_ENABLED on too: the sale gets its one claim code (the same QR as a card tap), read with showTapLoyaltyClaim using the sale id.
The shop (also authorises the person).
cashbank_transfertap_to_payCash only: what the customer handed over. Change is worked out here.
tap_to_pay only: who takes it. Default 'stripe'. 'sumup' (her own SumUp account, behind SUMUP_TAP_TO_PAY_ENABLED) or 'square' (her own Square account, behind SQUARE_TAP_TO_PAY_ENABLED).
stripesumupsquareOne walk-up sale.
needs_approvalopenpaidcancelleddeclinedBefore any discount.
All discounts together.
What the customer pays. Never below 0.
List price of one, before any discount.
This line's own discount.
After the line discount (before any whole-sale discount).
A keypad line only: why it shows on her day list. Null for a menu line, a keypad line at or above the menu price, or a sale made before 4 Nov 2026.
'below_menu_price' its name is one of her menu items (any case, spaces trimmed) and its price for one is below that item's cheapest menu price; 'open_price' no menu item has that name, so it was typed with nothing to check against.
below_menu_priceopen_priceThe menu item it matched ('below_menu_price' only).
That item's cheapest menu price for one ('below_menu_price' only).
linebasketWhich line (0-based), for a line discount.
percentamountset_priceregularstaffdamagedotherWhat it took off, in pence (positive). The customer screen shows "Discount -£x".
Who gave it.
cashbank_transfertap_to_payPresent only for a sale paid by a SumUp or Square tap (refund it with the tap refund route).
sumupsquareA SumUp- or Square-paid sale only: the tap that paid it, for refundTapToPayPayment.
Tap to Pay: the card attempt that paid it (for refundTapToPayPayment and showTapLoyaltyClaim), from any phone. Read on a single sale and on pay; null for cash, transfer, unpaid, or when it could not be read.
Once paid: the buyer's receipt, the order page with its own page token (/o/{number}?t=…, the link emails and texts use). Null until paid. The till shows it as a QR.
Present only when the sale needed the owner.
pendingapproveddeclinedTap to Pay: the attempt, for getTapToPayPayment.
Tap to Pay: for the Terminal SDK.
SumUp Tap to Pay, while the attempt is open: the checkout for SumUp's SDK. Absent or null otherwise.
Set as the SumUp checkout's foreignTransactionID: Membber's attempt id.
The SumUp merchant the SDK must be logged in as.
The total as SumUp's SDK takes it, in major units (12.50).
ISO-4217, upper case, as SumUp's SDK takes it.
Square Tap to Pay, while the attempt is open: what Square's Mobile Payments SDK takes. Absent or null otherwise.
PaymentParameters.referenceID: Membber's attempt id.
PaymentParameters.paymentAttemptID (the SDK's idempotency; on an SDK before 2.3.0, its idempotencyKey): the same attempt id.
The Square location the SDK is authorized for and the payment must be taken at.
The Square merchant the payment must belong to.
Money.amount, in the smallest unit.
ISO-4217, upper case, as Square's Money takes it.
curl -X POST "https://www.membber.com/api/v1/in-person-sales/c9c6d3c2-0000-4000-8000-d0c5000000c9/pay" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"method": "cash"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/in-person-sales/{saleId}/pay", {
params: { path: { saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9" } },
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
method: "cash"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.payInPersonSale(
path: .init(saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9"),
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
method: .cash
))
).ok.body.json
print(response){
"sale": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"order_number": "<order_number>",
"state": "needs_approval",
"currency": "GBP",
"subtotal_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"lines": [
{
"index": -9007199254740991,
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"option_id": "6dff1925-0000-4000-8000-d0c50000006d",
"name": "Example name",
"size_label": "<size_label>",
"colour_label": "<colour_label>",
"custom": true,
"quantity": 1,
"unit_pence": 1500,
"list_total_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"typed_price_flag": {
"reason": "below_menu_price",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"menu_price_pence": 1500
}
}
],
"discounts": [
{
"scope": "line",
"line_index": -9007199254740991,
"kind": "percent",
"value": 1,
"reason": "regular",
"amount_pence": 1500,
"given_by": "4d25ec59-0000-4000-8000-d0c50000004d"
}
],
"payment": {
"method": "cash",
"paid_at": "<paid_at>",
"cash_received_pence": 1500,
"change_pence": 1500,
"provider": "sumup",
"in_person_payment_id": "70145484-0000-4000-8000-d0c500000070",
"tap_payment_id": "b6de3c10-0000-4000-8000-d0c5000000b6"
},
"receipt_url": "https://example.com",
"approval": {
"state": "pending",
"limit_pence": 1500,
"requested_by": "4dfb7ac8-0000-4000-8000-d0c50000004d",
"decided_by": "7a956d7a-0000-4000-8000-d0c50000007a"
},
"created_by": "51a3a90e-0000-4000-8000-d0c500000051",
"created_at": "<created_at>"
},
"payment_id": "6022b9f4-0000-4000-8000-d0c500000060",
"client_secret": "<client_secret>",
"sumup": {
"foreign_transaction_id": "ef68f4e7-0000-4000-8000-d0c5000000ef",
"merchant_code": "EXAMPLE10",
"total": "<total>",
"amount_pence": 1500,
"currency_code": "GBP"
},
"square": {
"reference_id": "e20bea8f-0000-4000-8000-d0c5000000e2",
"payment_attempt_id": "36cd53a6-0000-4000-8000-d0c500000036",
"location_id": "20ebb9e5-0000-4000-8000-d0c500000020",
"merchant_id": "2239f2f2-0000-4000-8000-d0c500000022",
"amount_pence": 1500,
"currency_code": "GBP"
}
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). Needs can_process_payments and an Idempotency-Key header (UUID v4): the same key is always the same refund, and a key already used for another sale, or with another goods_returned or amount, is 409 IDEMPOTENCY_KEY_REUSED. Two refunds of one sale at once: the second is 409 REFUNDED_MEANWHILE, nothing recorded. No money moves here: she hands the cash back or sends the transfer herself, and this records it, so the sale reads Refunded or Part refunded and her day list and totals are right. The desk refund limit applies: full refund rights refund any amount; till rights only within the shop's desk limit (403 REFUND_NEEDS_OWNER, details.limit_pence, over it). 409 NOT_A_CASH_SALE for a card sale (refund the Tap to Pay payment instead), 409 NOT_PAID before it was paid, 409 NOTHING_TO_REFUND when all of it went back, 409 REFUND_OVER_REMAINING (details.remaining_pence) when more than is left. Stamps earned on the sale are recounted on what was kept. The stock stays out unless goods_returned is true.
The shop (also authorises the person).
What she handed back, in pence. Omit for everything still left.
Why (kept on the shop trail).
The goods came back across the counter, so the stock goes back. Only on a refund of everything left (409 GOODS_RETURN_NEEDS_FULL_REFUND otherwise). Default false: the stock stays out.
One walk-up sale.
needs_approvalopenpaidcancelleddeclinedBefore any discount.
All discounts together.
What the customer pays. Never below 0.
List price of one, before any discount.
This line's own discount.
After the line discount (before any whole-sale discount).
A keypad line only: why it shows on her day list. Null for a menu line, a keypad line at or above the menu price, or a sale made before 4 Nov 2026.
'below_menu_price' its name is one of her menu items (any case, spaces trimmed) and its price for one is below that item's cheapest menu price; 'open_price' no menu item has that name, so it was typed with nothing to check against.
below_menu_priceopen_priceThe menu item it matched ('below_menu_price' only).
That item's cheapest menu price for one ('below_menu_price' only).
linebasketWhich line (0-based), for a line discount.
percentamountset_priceregularstaffdamagedotherWhat it took off, in pence (positive). The customer screen shows "Discount -£x".
Who gave it.
cashbank_transfertap_to_payPresent only for a sale paid by a SumUp or Square tap (refund it with the tap refund route).
sumupsquareA SumUp- or Square-paid sale only: the tap that paid it, for refundTapToPayPayment.
Tap to Pay: the card attempt that paid it (for refundTapToPayPayment and showTapLoyaltyClaim), from any phone. Read on a single sale and on pay; null for cash, transfer, unpaid, or when it could not be read.
Once paid: the buyer's receipt, the order page with its own page token (/o/{number}?t=…, the link emails and texts use). Null until paid. The till shows it as a QR.
Present only when the sale needed the owner.
pendingapproveddeclinedHow the sale was paid, and so how she gave the money back.
cashbank_transferThis refund.
Everything refunded on the sale so far, this one included.
Nothing is left to refund.
The stock went back (goods_returned on a full refund).
True when this answered a refund already recorded with this Idempotency-Key.
curl -X POST "https://www.membber.com/api/v1/in-person-sales/c9c6d3c2-0000-4000-8000-d0c5000000c9/refund" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"reason": "Added at the front desk"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/in-person-sales/{saleId}/refund", {
params: { path: { saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9" } },
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
reason: "Added at the front desk"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.refundInPersonSale(
path: .init(saleId: "c9c6d3c2-0000-4000-8000-d0c5000000c9"),
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
reason: "Added at the front desk"
))
).ok.body.json
print(response){
"sale": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"order_number": "<order_number>",
"state": "needs_approval",
"currency": "GBP",
"subtotal_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"lines": [
{
"index": -9007199254740991,
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"option_id": "6dff1925-0000-4000-8000-d0c50000006d",
"name": "Example name",
"size_label": "<size_label>",
"colour_label": "<colour_label>",
"custom": true,
"quantity": 1,
"unit_pence": 1500,
"list_total_pence": 1500,
"discount_pence": 1500,
"total_pence": 1500,
"typed_price_flag": {
"reason": "below_menu_price",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"menu_price_pence": 1500
}
}
],
"discounts": [
{
"scope": "line",
"line_index": -9007199254740991,
"kind": "percent",
"value": 1,
"reason": "regular",
"amount_pence": 1500,
"given_by": "4d25ec59-0000-4000-8000-d0c50000004d"
}
],
"payment": {
"method": "cash",
"paid_at": "<paid_at>",
"cash_received_pence": 1500,
"change_pence": 1500,
"provider": "sumup",
"in_person_payment_id": "70145484-0000-4000-8000-d0c500000070",
"tap_payment_id": "b6de3c10-0000-4000-8000-d0c5000000b6"
},
"receipt_url": "https://example.com",
"approval": {
"state": "pending",
"limit_pence": 1500,
"requested_by": "4dfb7ac8-0000-4000-8000-d0c50000004d",
"decided_by": "7a956d7a-0000-4000-8000-d0c50000007a"
},
"created_by": "51a3a90e-0000-4000-8000-d0c500000051",
"created_at": "<created_at>"
},
"refund": {
"method": "cash",
"amount_pence": 1500,
"refunded_pence": 1500,
"full_refund": true,
"stock_returned": true,
"replayed": true
}
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). Needs can_process_payments (the owner, and staff with till rights). Today is her own day, in her time zone (Europe/London if hers is not a real one). Only sales paid today, newest first (one rung up before midnight and paid after it is today's); nothing unpaid or called off. Totals come twice: gross (refunds not taken off) and after_refunds. A keypad line below her menu price, or with no menu item of that name, is in flagged_lines.
The shop (also authorises the person).
Today in her time zone (YYYY-MM-DD).
Her IANA time zone, e.g. 'Europe/London'.
What the customer paid (before any refund).
What has been given back since. 0 when nothing.
How it was paid.
cashbank_transfertap_to_payRefunded since: not at all, in part, or in full.
nonepartfullSomeone claimed this sale's stamps code (a tap's or a cash sale's). Null when it could not be read.
Who made the sale at the till.
Their name. Null when they have none on record.
Keypad lines below her menu price, or with an open price. Empty when none.
The line (0-based).
What was typed.
The typed price for one.
below_menu_priceopen_priceThe item's cheapest menu price ('below_menu_price' only).
Sales with at least one flagged line.
As paid today, refunds NOT taken off.
Given back since, on today's sales.
As paid today, with refunds taken off.
True when there were more than 500 sales today; only the newest 500 are listed.
curl -G "https://www.membber.com/api/v1/in-person-sales/day" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/in-person-sales/day", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.getInPersonSaleDay(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"date": "<date>",
"time_zone": "<time_zone>",
"sales": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"order_number": "<order_number>",
"paid_at": "<paid_at>",
"total_pence": 1500,
"refunded_pence": 1500,
"method": "cash",
"refund": "none",
"code_claimed": true,
"rung_up_by": "201fb5b8-0000-4000-8000-d0c500000020",
"rung_up_by_name": "<rung_up_by_name>",
"flagged_lines": [
{
"index": -9007199254740991,
"name": "Example name",
"quantity": 1,
"unit_pence": 1500,
"reason": "below_menu_price",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"menu_price_pence": 1500
}
]
}
],
"totals": {
"sales": -9007199254740991,
"flagged_sales": -9007199254740991,
"gross": {
"total_pence": 1500,
"cash_pence": 1500,
"bank_transfer_pence": 1500,
"tap_to_pay_pence": 1500
},
"refunded_pence": 1500,
"after_refunds": {
"total_pence": 1500,
"cash_pence": 1500,
"bank_transfer_pence": 1500,
"tap_to_pay_pence": 1500
}
},
"more": true
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). Needs can_process_payments. Discounts are not repeated. A line whose item was removed is left out; a line with too few left comes back sold_out: true.
The shop (also authorises the person).
Today's price (menu lines), or the old keypad amount.
True when there is not enough left now. Flag it; do not add it.
Null when there is no paid walk-up sale yet.
curl -G "https://www.membber.com/api/v1/in-person-sales/last" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/in-person-sales/last", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.repeatLastInPersonSale(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"lines": [
{
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"option_id": "6dff1925-0000-4000-8000-d0c50000006d",
"name": "Example name",
"size_label": "<size_label>",
"colour_label": "<colour_label>",
"custom": true,
"quantity": 1,
"unit_pence": 1500,
"sold_out": true
}
],
"from_sale_id": "673e6c7e-0000-4000-8000-d0c500000067"
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). Needs can_process_payments. Default 500 (£5).
The shop (also authorises the person).
The most discount staff can give on one sale without the owner. 0 = none.
curl -G "https://www.membber.com/api/v1/in-person-sales/settings" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/in-person-sales/settings", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.getInPersonSaleSettings(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"staff_discount_limit_pence": 1500
}Dark behind IN_PERSON_SALE_ENABLED (off: 404). The OWNER only (403 OWNER_ONLY). Recorded on the shop trail.
The shop (also authorises the person).
The most discount staff can give on one sale without the owner. 0 = none.
curl -X PUT "https://www.membber.com/api/v1/in-person-sales/settings" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"staff_discount_limit_pence": 1500
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PUT("/api/v1/in-person-sales/settings", {
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
staff_discount_limit_pence: 1500
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.setInPersonSaleSettings(
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
staffDiscountLimitPence: 1500
))
).ok.body.json
print(response){
"staff_discount_limit_pence": 1500
}