TAtalkdesk
FSI Integrations API

Returns card information

The endpoint allows you to retrieve detailed information about a specific card associated with a contact. By providing the unique contact ID and card ID as path parameters, this endpoint enables you to fetch the specific card's details based on its ID.

get/fsi/contacts/{contact_id}/cards/{card_id}

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/fsi/contacts/{contact_id}/cards/{card_id}
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: fsi-cards:read

Path parameters

contact_idstring required

The contact id

card_idstring required

The card id

Query parameters

interaction_idstring

The interaction id

Response

The card information.

idstring required

Identification for a card

card_namestring

Account owner name

card_numberstring required

A masked card number that can be displayed to the customer.

card_type'DEBIT' | 'CREDIT' | 'ATM' required

Inform the card type

activation_atstring date

Card activation date

expiration_atstring date required

Card expiration date

inactive_datestring date

Card inactivation date

holder_namestring required

The name printed in the card.

issuerstring required

Card's issuer

status'ACTIVE' | 'CLOSED' | 'INACTIVE' | 'BLOCKED' | 'LOST' | 'STOLEN' | 'CANCELED' required

Card's current status

descriptionstring

Card's description

custom_typestring

Card type customized by bank client

custom_statusstring

Card status customized by bank client

account_idstring

Account associated to the card

deactivation_notestring

It contains notes about the deactivation of card.

Example response

{
  "card_number": "XXXXXXXXXXXX4521",
  "issuer": "MASTER CARD"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.