Assets

Block/unblock banking asset

Block or unblock a banking asset

If the request succeeds, this endpoint generates an Asset blocked event; otherwise, generates an Asset block failed event.

post/v1/issuer/{issuer_id}/assets/{asset_id}/block

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/v1/issuer/{issuer_id}/assets/{asset_id}/block
  • Auth
    none declared

Path parameters

issuer_idstring required

Issuer ID. For more information, refer to issuer identification number

assetIdstring required

Image asset ID. This is the image_asset_id field returned from the Get eligible token requestors endpoint.

Headers

x-cidstring

The Correlation IDentifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header from an API endpoint call.

If this field isn't passed, one is automatically generated.

Request body

unitsinteger required

Number of asset units

document_numberstring required

Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.

status'BLOCK' | 'UNBLOCK'

Asset block status

external_idstring

Provider-generated unique ID for client monitoring and tracking

reasonstring

Reason asset was blocked

Example request

{
  "units": 50,
  "document_number": "83759935060",
  "status": "BLOCK",
  "external_id": "cac02d17-2587-4a7e-ae6a-b449049a8529",
  "reason": "Test block 50 units"
}

Response

ACCEPTED

202AssetBlockedResponse required(unresolved $ref)

Changes

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