Wallets
Get Wallet by Barcode
Fetch a wallet by barcode lookUpId.
The barcode is validated and scoped to the merchant derived from the request. Use include=user to request user information.
get/api/v1/wallets/barcode/{lookUpId}
Request
- Base URLhttps://merchant-api.accruesavings.com
- Authnone declared. Required headers: Client-ID, Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
lookUpIdstring required
Lookup identifier for the barcode
Example:SCAN-LOOKUP-ID
Query parameters
includestring
Comma-separated list of resources to include. Supported resources: user
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
OK
Example response
{
"included": [
{
"attributes": {
"attachedProfile": {
"referenceId": "Any string identifier provided by you.",
"stableReferenceId": "stable-abc-123",
"effectiveReferenceId": "stable-abc-123",
"email": "User email address kept in your system.",
"phoneNumber": "User phone number kept in your system."
}
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.