RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Nested in API

payment

A tender applied to an order.

Nested under order.payments. Methods: CASH, CARD, STORE_CREDIT, GIFT_CARD, OTHER.

Exposure

Appears nested inside Merchant API responses (not a top-level route).

What

The payment object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

10 fields on payment. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Payment id (detail responses).

Type
id: string

method

OrderPaymentMethod

Tender method on the order.

Type
method: CASH | CARD | STORE_CREDIT | GIFT_CARD | OTHER

amount

number

Amount applied for this payment.

Type
amount: number

tendered

number | null

Cash tendered when method is CASH (may exceed amount).

Type
tendered: number | null

changeGiven

number | null

Change returned on a cash tender.

Type
changeGiven: number | null

cardType

string | null

Card brand label for receipts (e.g. "Visa Debit").

Type
cardType: string | null

cardLast4

string | null

Last four digits of the card when available.

Type
cardLast4: string | null

authCode

string | null

Card auth code printed on the receipt.

Type
authCode: string | null

transactionReference

string | null

Provider transaction id for the receipt / reconciliation.

Type
transactionReference: string | null

createdAt

string

ISO-8601 timestamp (detail responses).

Type
createdAt: string

Related