Consumer Holds

Overview

Retrieve and manage the holds and red flags placed on a consumer. Consumer Holds enables developers to see what is blocking a consumer’s activity, understand why, and release red flags once they are resolved across WEX platforms. It includes operations for process holds, red flags, red flag settings, and releasing a red flag. Use this resource to show consumers and administrators the status of holds, check how red flags are configured, and clear flags without manual back-office work.

Consumer Holds API Operations

The Consumer Holds API includes the following operations. Select the API Reference tab to find functional information about each one.

• Get Consumer Process Hold
• Get Consumer Red Flag
• Get Red Flag Settings
• Release Red Flag
• Modernization: It provides a standardized, clear, and modern RESTful endpoint, making it easier to integrate with current systems.
• Integration: It allows you to easily consume and integrate hold and red flag data, powering your own consumer-facing and administrative experiences.
• Growth & Innovation: Using our API, you can improve your own products and create a smoother experience for your customers and consumers.

What can the API do?

The Consumer Holds API allows you to perform functions related to the consumer’s:

• Process holds, with the flag reason
• Active red flags
• Red flag settings by process type
• Red flag release

Key Features

• Returns a consumer’s process holds with the flag reason. Use include_active and include_released to choose which holds appear.
• Returns the consumer’s active red flags, paginated.
• Returns the red flag configuration for a process type, including whether red flags are enabled and the flags that apply (for example, for CARD_ISSUANCE).
• Releases a red flag with a status and a reason, and clears the process holds associated with it.
• Confirms which flag and related process holds were released.
• Protects against duplicate release requests with a required Idempotency-Key header (a UUID).

Consumer Holds API Operations

The Consumer Holds API includes the following operations. Select the API Reference tab to find functional information about each one.

• Get Consumer Process Hold
• Get Consumer Red Flag
• Get Red Flag Settings
• Release Red Flag