---
title: "Get Gift by lookUpId"
method: GET
path: "/api/v1/gifts/{lookUpId}"
tags: ["Gifts"]
---

# Get Gift by lookUpId

`GET /api/v1/gifts/{lookUpId}`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/gifts/{lookUpId}`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/gifts/:lookUpId/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetch remaining gift balance by scanned `lookUpId`.

  The identifier is scoped to the merchant derived from the request. Amounts are integer cents.

  `data.id` is the gift public reference. Point-of-sale spend must POST `/api/v1/payment-intents` with the **path** `lookUpId` — never send `data.id` as `walletId`.

## Path parameters

- `lookUpId` string, required: Scanned lookup identifier for the gift. Use this same string as payment-intent lookUpId to spend.

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Response `200`

OK

- GetGiftByLookUpIdResponse
  - `data` Gift, required: A gift remaining-balance lookup.
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'Gift', required
    - `attributes` object, required
      - `available` integer, required: Remaining amount available to spend, in integer cents.
      - `originalAmount` integer, required: Original gift amount, in integer cents.

## Other responses

- `400`: LookUpId expired or invalid
- `404`: Gift for lookUpId not found

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)