GAgalileo-ft
Accounts and Cards

Manage Card Token

Use the Manage Card Token endpoint to delete, suspend, or resume a single token. To use this endpoint, the MTLCM product parameter must be set. This endpoint is currently valid only for Mastercard.

🚧 Notice

The token-management endpoints are available by special arrangement only. Enabling this feature requires additional setup and costs. Contact SoFi Tech Solutions for details.

post/manageCardToken

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/manageCardToken
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>.. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

The <glossary:PRN>, <glossary:PAN> or <glossary:CAD> of the account. For card-specific endpoints such as this one, the CAD is preferred. Do not use the PRN if more than one card has ever been associated with this account. Pattern: PAN, PRN, or CAD Example: "999103447228"

tokenUniqueReferencestring nullable

A unique reference assigned to a token and used to identify the token for the duration of its lifetime. Also called the TUR. Pattern: 48-char alphanumeric Example: "DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c"

operation'DELETE' | 'SUSPEND' | 'RESUME' | 'ACTIVATE' required

Operation to perform. Pattern: String Example:"SUSPEND"

reasonCodestring nullable

The reason for operation. See <a href="ref:api-reference-manage-card-token-values" target="_blank">Manage Card Token Values</a> for valid values. Pattern: String Example: "STOLEN"

deleteFromConsumerAppboolean nullable

If operation: DELETE, specify whether to delete the token from the cardholder device only or from both the device and the <glossary:MDES> platform:

  • true — Delete the token from the cardholder device only.
  • false — Delete the token from both the device and the MDES platform.

Pattern: String Example: true

agentIdstring nullable

The ID of the agent performing the token management operation. Used to track who made the change in notes. Pattern: String Example: "agent123"

userIdstring nullable

The ID of the user performing the token management operation. Used to track who made the change in notes. Pattern: String Example: "user456"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "tokenUniqueReference": "DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c",
  "operation": "SUSPEND",
  "reasonCode": "STOLEN",
  "agentId": "agent123",
  "userId": "user456"
}

Response

token_unique_referencestring

A unique reference assigned to a token and used to identify the token for the duration of its lifetime.

Example response

{
  "token_unique_reference": "DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c"
}

Changes

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