API Reference

Suspend

post
https://api-sandbox.blackhawknetwork.com/v1/servicing/cards/suspend

Suspends one or more eGift SecureLink URLs, each with a mandatory reason, by placing a temporary hold that prevents users from viewing the associated eGift. Error Codes. This does not block the underlying card or prevent redemption using previously accessed credentials.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Each item requires its own reason, matching the initiating actor.

Suspends by eGiftID, retrieval reference number, or card reference - each with its own reason and optional risk context. eGiftID and retrievalReferenceNumber are reserved for internal use only.

string
enum
required

Identifier type for all items in this request. Must be consistent across the array. eGiftId and retrievalReferenceNumber are reserved for internal use only.

Allowed:
items
array of objects
required
length ≥ 1

Items to suspend, identified by the type set in itemType.

items*

A single item to suspend, with its reason and optional risk context.

string
required
^[A-Za-z0-9_-]{3,64}$

Identifier matching the type declared in itemType.

reason
object
required

The reason this item is being suspended.

riskContext
object

Optional risk signal context from the partner's risk engine, applicable to Suspend. All fields are optional and any unlisted attribute is accepted.

memo
object

Optional audit memo attached to the servicing operation, capturing context for audit trail purposes.

string
enum
required

Actor that initiated the servicing operation.

Allowed:
Headers
uuid
required

Caller-supplied request identifier (UUID v4), used as the idempotency key for this request — retrying with the same value will not create a duplicate operation. Echoed back in the response.

uuid

Correlation identifier (UUID v4) used to trace this request across systems. Optional — generated by the service if the caller omits it.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?