Accounts and Cards

Get Card Tokens

Changed on

Use the Get Card Tokens endpoint to retrieve information on tokens associated with a card. 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/getCardTokens

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/getCardTokens
  • 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 48-character reference assigned to a token and used to identify the token for the duration of its lifetime. Pattern: 48-char alphanumeric Example: "DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c"

includeDeviceTokensOnlyboolean

Specifies whether to receive only the tokens tied to the cardholder device:

  • true — <glossary:MDES> returns only the device-based tokens
  • false — MDES returns all tokens mapped to the PAN (server, device, and <glossary:COF>).

Pattern: Boolean Example: true

excludeDeletedIndicatorboolean

Specifies whether to exclude deleted tokens from the search results. Valid values:

  • true — Exclude deleted tokens from the search results.
  • false — Include deleted tokens in the search results.

Pattern: true or false Example: true

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "tokenUniqueReference": "DWSPMC00000000010906a349d9ca4eb1a4d53e3c90a11d9c"
}

Response

Changes

    • breaking

      the // response property's maxLength was unset from 11 for the response status