Update Card Details (Single)

Lets you update an existing card details such as card status label, status, custom fields, and extended field values of a card.

👍

Note

For detailed information about the APIs and for hands-on testing, refer to the API overview documentation and step-by-step guide on making your first API call.

Prerequisites

  • Basic Authentication
  • Default access group

Resource information

HTTP methodGET
AuthenticationBasic
Pagination supported?NO
Rate limitYES
Batch supportNO

Request Parameters

Parameter

Data Type

Description

cardNumber*

String

Unique card number to be updated.

seriesId

Integer

Unique identifier of the card series.

statusLabel

String

New status label to set for the card. Allowed values: NOT_ISSUED, ACTIVE, SUSPENDED, DELETED, EXPIRED, ISSUED.

statusInfo

Object

Additional status details.

- reason

String

Reason for updating the card status.

mappedEntity

Object

Information about the entity mapped to the card.

- type

String

Type of entity (e.g., TILL).

- value

String

Name or value of the entity.

- id

Integer

Unique identifier of the entity.

customFields

Object

Custom fields associated with the card.

- type

String

Type of the custom field.

- value

String

Value of the custom field.

extendedFields

Object

Extended fields for additional metadata.

- card_requested_by

String

Value indicating who requested the card.

Response Parameter

Parameter (parameters marked by * are mandatory)DataTypeDescription
cardId*intUnique identifier for the card.
customerIdintUnique identifier for the customer linked to the card.
extendedFieldsobjectKey-value pairs for additional custom fields.
— card_requested_bystringUser who requested the card.
customFieldsobjectAdditional custom field data as key-value pairs.
mappedEntityobjectInformation about the entity mapped to the card.
— typestringType of the entity (e.g., TILL).
— valuestringValue of the mapped entity (e.g., till name).
— idintUnique identifier of the mapped entity.
cardNumberstringCard number assigned.
seriesIdintUnique identifier for the card series.
orgIdintOrganization identifier.
entityIdintEntity identifier linked to the card.
statusLabelInfoobjectInformation about the card's status label.
— createdOnstringDate when the status label was created.
— descriptionstringDescription of the status label.
— entityStatusIdintIdentifier for the entity status.
— idintUnique identifier for the status label.
— isActivebooleanIndicates if the status label is active.
— labelstringLabel description (e.g., ACTIVE).
— orgIdintOrganization identifier.
— updatedOnstringDate when the status label was last updated.
— statusstringStatus value (e.g., ACTIVE).
— typestringType of entity the status label belongs to (e.g., CARD).
— actionsobjectActions related to the status label.
— defaultbooleanIndicates if this is the default status label.
statusInfoobjectAdditional status-related information.
— reasonstringReason for the current status change.
— actionsarrayList of actions related to status changes.
transactionNotAllowedbooleanIndicates if transactions are disallowed on this card.
activeAndDigitalbooleanIndicates if the card is both active and digital.
warningsarrayList of warnings, if any.
— statusbooleanWarning status.
— codeintWarning code.
— messagestringWarning message description.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!