Skip to navigation
Terminal APITip

Get tip status

Returns the status of a tip interaction. result is absent while status is pending.

On success, result contains the base amount, the tip the customer chose, and the tip-inclusive total, all as decimal-dollar strings with two decimal places. On failure or cancellation, result contains only error.

A 404 means the interaction never existed, the device_id is wrong, or the interaction expired.

Authentication

AuthorizationBearer

Use a Payments API key as the bearer token: Authorization: Bearer <api_key>. Get a fresh key from Refresh API Keys.

Path parameters

device_idstringRequired

Hardware Serial Number (HSN) of the terminal, provided by your Integration Delivery lead.

interaction_idstringRequiredformat: "uuid"

The interaction_id returned when the interaction was created.

Query parameters

midstringOptional

Merchant ID. Required when your bearer token is an ISV token acting on behalf of a merchant. If the mid can’t be resolved to an authorized account, the request returns 400.

Response

Interaction status
interaction_idstringformat: "uuid"
The interaction identifier.
statusenum
Status of the interaction.
Allowed values:
resultobjectOptional

Present once the interaction finishes. On success, contains the amounts. On failure or cancellation, contains only error.

updated_atstringOptionalformat: "date-time"
Time of the last status update. Present once the interaction finishes.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error