Gifts

Get Gift by lookUpId

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.

get/api/v1/gifts/{lookUpId}

Request

Base URL
https://merchant-api.accruesavings.com
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.

Path parameters

lookUpIdstring required

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

Example:SCAN-LOOKUP-ID

Headers

Client-IDstring 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.

Example:123e4567-e89b-12d3-a456-426614174000

Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

Example response

{
  "data": {
    "attributes": {
      "available": 3000,
      "originalAmount": 5000
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.