PIpismo
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/assets-accrual
  • URL
    https://sandbox.pismolabs.io/assets-accrual/v1/issuer/{issuer_id}/assets/{asset_id}/block
  • Auth
    HTTP bearer

Path parameters

issuer_idstring required

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

asset_idstring required

Client assigned asset ID. Must consist of the characters [a-z,A-Z,0-9,-,:] with a range from 1 to 128.

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

A government document number, such as a social security number (US). Must be numeric with 11-14 digits.

status'BLOCK' | 'UNBLOCK'

Asset block status

external_idstring

Client-provided external asset ID. No longer than 128 alphanumeric characters.

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.