Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Quotas

Update quota

Updates a quota by its ID.

A quota is the number of asset shares. One asset can consist of a single share or multiple shares.

You can get quota IDs with the <a href="https://developers.pismo.io/pismo-docs/reference/assetquotas" target="_blank">List asset quotas</a> endpoint.

This endpoint generates a Quota updated event.

patch/v1/issuer/{issuer_id}/assets/{asset_id}/quotas/{quota_id}

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.

quota_idstring required

Quota ID

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

operation_type'DELETE' | 'SUSPEND' | 'RESUME' | 'CALL_CENTER_ACTIVATION' | 'CARDHOLDER_STEPUP_APP_TO_APP' | 'TOKEN_DEVICE_BIDING_APPROVE' | 'TOKEN_DEVICE_BINDING_APPROVE_BANK_APP' required

Operation type:

  • DELETE - Delete token

  • SUSPEND - Suspend token

  • RESUME - Resume suspended token

  • CALL_CENTER_ACTIVATION - Call center verification

  • CARDHOLDER_STEPUP_APP_TO_APP - App2App verification

  • TOKEN_DEVICE_BIDING_APPROVE - Device verification, approve and activate the most recently inactive device (only Visa)

  • TOKEN_DEVICE_BINDING_APPROVE_CALL_CENTER - Device verification with call center activation, approve and activate the most recently inactive device (only Visa)

  • TOKEN_DEVICE_BINDING_APPROVE_BANK_APP - Device verification with bank app approval, approve and activate the most recently inactive device (only Visa)

Note: For App2App token activation, set this field to CARDHOLDER_STEPUP_APP_TO_APP (Mastercard) and CALL_CENTER_ACTIVATION (Visa).

purchased_unitsinteger

Number of purchased units

customer_namestring

Applicable only to Brazil. Account owner's name for the individual or corporate customer. Required when providing the has_asset_registration object.

Example request

{
  "operation_type": "amendment",
  "purchased_units": 1,
  "customer_name": "Patti Waggin"
}

Response

OK

asset_idstring

Asset ID. This ID is client-generated. It must be between 1 and 128 characters long and consist of only the characters [a-z,A-Z,0-9,-,:].

quota_idstring

Quota ID

issuer_idstring

Issuer ID. For more information, see issuer identification number

unitsinteger

Number of asset units

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

customer_type'NATURAL' | 'LEGAL'

Applicable only to Brazil. Customer type: NATURAL is an individual. LEGAL is a corporation or other legal entity type. Required when providing the has_asset_registration object.

document_numberstring

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.

customer_namestring

Applicable only to Brazil. Account owner's name for the individual or corporate customer. Required when providing the has_asset_registration object.

deposit_numberstring

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.

Example response

{
  "asset_id": "6ea8094b-73ba-4737-93ad-370c27c54813",
  "quota_id": "c2d581cb-5c9c-40ab-8783-724feb372132",
  "issuer_id": "98400-0-0d",
  "units": 20,
  "created_at": "2024-09-12T16:46:16.43663522",
  "customer_type": "NATURAL",
  "document_number": "7777888hh",
  "customer_name": "Jane Bartholomew",
  "deposit_number": "7777888hh"
}