This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.
GuideWalletBatch

Wallet updates

Monitor and cancel batch push update operations from the admin console.

Wallet updates

The Wallet updates page in the admin console lets you track the progress of every batch push update operation and cancel any that are still running.

Open it from Settings → Monitoring → Wallet updates.

Reading the table

Each row represents one batch push update operation — a set of per-pass update tasks triggered by a single API call or system event.

Column
What it shows

Start

When the batch was accepted by the platform.

Last activity

When the most recent per-pass task in the batch was processed.

Operation

The internal operation type that generated the batch.

Correlation

The correlationId supplied in the push-update operation, or an auto-generated value.

Passes

Total number of passes in the batch.

Completed

Number of passes that have been processed (success or failure).

Errors

Number of passes that failed during processing.

Apple

Number of Apple Wallet passes in the batch.

Google

Number of Google Wallet passes in the batch.

Status

Overall batch status — for example, Completed or Running.

Tracking a specific batch with correlationId

If you supply a correlationId through the push-update operation, that value appears in the Correlation column. Use it to quickly locate and monitor the batch you triggered.

Push update for passes matching the filter.

post
/api/{tenantId}/passes/pushUpdate

Authorization: Requires Pass.Write scope.

Filtering: Same as GetPasses�identifiers, metadata, pass type, installation status.

Async: Updates are queued. 200 response means scheduled, not complete. Monitor via statistics endpoint.

Data Merge: Merged into each matching pass. Set UpdateMetadata=true for recomputation (slower). Adjust Throughput for concurrency.

Bulk Operations: Ideal for campaigns, loyalty updates, seasonal offers. Use CorrelationId for tracking.

Use Cases: Campaign push; loyalty tier changes; offer refresh; bulk metadata updates.

Example — push a seasonal offer to all loyalty passes:

POST /api/{tenantId}/passes/pushUpdate
    ?filter[0].field=passType&filter[0].operator=equals&filter[0].value=loyalty
            
{
  "additionalData": { "offer": "summer2025", "discount": "20%" },
  "options": {
    "updateMetadata": true,
    "throughput": 12,
    "correlationId": "campaign-summer-2025"
  }
}
Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Query parameters
Body
additionalDataobject · nullableOptional

Arbitrary data to persist with the pass (for example, loyalty tier, store code, or campaign flags).

passTypestring · nullableOptional

Optional pass type to convert the pass to.

updateMetadatabooleanOptionalDeprecated

Specifies if passes metadata should be updated. Updating metadata is time consuming and could be avoided for notification only push update

Default: false
Responses
200

Passes scheduled for update; returns the count in the response body.

Result returned after scheduling a bulk push update operation.

passCountinteger · int32Optional

Count of passes scheduled for update.

post/api/{tenantId}/passes/pushUpdate
200

Passes scheduled for update; returns the count in the response body.

If you do not supply a correlationId, the platform generates one automatically. You can retrieve it from the API response.

There is no completion webhook at the batch level. Poll the Wallet updates page or check individual pass histories if you need real-time confirmation.

Cancelling a running operation

Select a batch with Running status and use the cancel action to stop further processing. Passes already processed before the cancellation are not rolled back.

Operation names

The Operation column shows the internal name of the component that created the batch. These names reflect the platform's internal architecture and are not meaningful for day-to-day use. Focus on the Correlation column to identify the batches you own.

Last updated