Skip to content
APIs
/
/Decrypt Token API

Tokenization Service (0.0.8)

This service is used to tokenize securely converts sensitive payment information (such as credit card numbers, bank account details, or mobile wallet identifiers) into unique, non-sensitive tokens.

Github Documentation
Download OpenAPI description
osi-token-api.json
osi-token-api.yaml
Languages
Servers
Mock server
https://docs.nelnetpay.com/_mock/apis/osi-token-api/
LOCAL
http://localhost:8080/tokenization-service/
DEV
https://localhost:16778/tokenization-service/
SIT
https://localhost:16779/tokenization-service/
QA
https://localhost:16780/tokenization-service/
UAT
https://localhost:16781/tokenization-service/

Tokenize API

Tokenization offers a set of RESTful APIs for token management, including creation, update, retrieval, and deletion of tokens. The APIs enable secure tokenization of the various payment account data like ACH Bank Account, Credit Card, and Apple Pay.

Operations

Decrypt Token API

This endpoint allows authorized clients to securely retrieve the original payment data associated with a specific token.

Operations

Decrypt a Token

Request

Retrieve the original payment data associated with a specific token. This endpoint requires authentication and is intended for use by authorized clients only.

Security
bearerAuth
Bodyapplication/jsonrequired

Token and Type for decryption.

tokenstringrequired

Token that would be decrypted.

Example: "e4eaaaf2-d142-11e1-b3e4-080027620cdd"
typesArray of strings

Type of decrypted details that would be returned.

Example: ["ACH","PAN"]
curl -i -X POST \
  https://docs.nelnetpay.com/_mock/apis/osi-token-api/token-service/tokens/sensitive-data \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "9c5a8d98-ccd3-452b-be55-e66ad2132e98",
    "types": [
      "ACH"
    ]
  }'

Responses

Successful token decryption or error response.

Bodyapplication/json
responseCodestringrequired

A code that represents the outcome of the transaction

Example: "0"
responseMessagestring

A list of brief descriptions about the error encountered. If multiple messages need to be returned, it will be separated with ';' character

Example: "An unexpected system error occurred. Please check with support."
tokenstring

Token in UUID format

Example: "85ce5afd-31b2-4612-a6ef-c1e2aba3ca71"
formatPreservedTokenstring

Format preserved token

Example: "4927384619273842"
cryptcardstring

Direct token

Example: "4TestYx9OuN8145"
bankAccountobject
creditCardobject
dpanobject
mpanobject
networkTokenobject
Response
application/json

ACH Response

{
  "responseCode": "0",
  "responseMessage": "Token Decrypted",
  "token": "07ba706d-dcfc-4bfc-b161-4469a2633862",
  "formatPreservedToken": "6558766560401113",
  "cryptcard": "4TestYx9OuN8145",
  "bankAccount": {
    "accountNumber": "4111111111111113",
    "routingNumber": "021000031",
    "accountType": "Savings",
    "tenderType": "Consumer"
  }
}