Basis Theory Network Tokens API

The NetworkTokens API from Basis Theory — 6 operation(s) for networktokens.

Operations 7

POST /network-tokens Network tokens create #
POST /network-tokens/{id}/cryptogram Network tokens cryptogram #
DELETE /network-tokens/{id} Network tokens delete #
GET /network-tokens/{id} Network tokens get #
GET /network-tokens/{id}/account Network tokens get account #
PUT /network-tokens/{id}/suspend Network tokens suspend #
PUT /network-tokens/{id}/resume Network tokens resume #

Documentation

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/basis-theory:basis-theory-networktokens-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

basis-theory-networktokens-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Basis Theory Network Tokens API
  description: '## Getting Started

    * Sign-in to Basis Theory and go to Applications

    * Create a Basis Theory Private Application

    * All permissions should be selected

    * Paste the API Key into the `BT-API-KEY` variable'
  version: v1
servers:
- url: https://api.basistheory.com
  description: Default
  x-fern-server-name: default
- url: https://api.us.basistheory.com
  description: US
  x-fern-server-name: us
- url: https://api.eu.basistheory.com
  description: EU
  x-fern-server-name: eu
- url: https://api.test.basistheory.com
  description: Test
  x-fern-server-name: test
security:
- ApiKey: []
tags:
- name: NetworkTokens
paths:
  /network-tokens:
    post:
      tags:
      - NetworkTokens
      operationId: Network_Tokens_Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNetworkTokenRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkToken'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Client Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-fern-sdk-group-name:
      - network-tokens
      x-fern-sdk-method-name: create
      summary: Network tokens create
      x-summary-source: derived
  /network-tokens/{id}/cryptogram:
    post:
      tags:
      - NetworkTokens
      operationId: Network_Tokens_Cryptogram
      parameters:
      - name: id
        in: path
        required: true
        schema:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkTokenCryptogram'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-fern-sdk-group-name:
      - network-tokens
      x-fern-sdk-method-name: cryptogram
      summary: Network tokens cryptogram
      x-summary-source: derived
  /network-tokens/{id}:
    delete:
      tags:
      - NetworkTokens
      operationId: Network_Tokens_Delete
      parameters:
      - name: id
        in: path
        required: true
        schema:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '503':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-fern-sdk-group-name:
      - network-tokens
      x-fern-sdk-method-name: delete
      summary: Network tokens delete
      x-summary-source: derived
    get:
      tags:
      - NetworkTokens
      operationId: Network_Tokens_Get
      parameters:
      - name: id
        in: path
        required: true
        schema:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkToken'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-fern-sdk-group-name:
      - network-tokens
      x-fern-sdk-method-name: get
      summary: Network tokens get
      x-summary-source: derived
  /network-tokens/{id}/account:
    get:
      tags:
      - NetworkTokens
      operationId: Network_Tokens_GetAccount
      parameters:
      - name: id
        in: path
        required: true
        schema:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkTokenAccount'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-fern-sdk-group-name:
      - network-tokens
      - account
      x-fern-sdk-method-name: get
      summary: Network tokens get account
      x-summary-source: derived
  /network-tokens/{id}/suspend:
    put:
      tags:
      - NetworkTokens
      operationId: Network_Tokens_Suspend
      parameters:
      - name: id
        in: path
        required: true
        schema:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkToken'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '503':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-fern-sdk-group-name:
      - network-tokens
      x-fern-sdk-method-name: suspend
      summary: Network tokens suspend
      x-summary-source: derived
  /network-tokens/{id}/resume:
    put:
      tags:
      - NetworkTokens
      operationId: Network_Tokens_Resume
      parameters:
      - name: id
        in: path
        required: true
        schema:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkToken'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '503':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-fern-sdk-group-name:
      - network-tokens
      x-fern-sdk-method-name: resume
      summary: Network tokens resume
      x-summary-source: derived
components:
  schemas:
    CardArtImage:
      type: object
      properties:
        url:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        height:
          type:
          - integer
          - 'null'
          format: int32
        width:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    NetworkToken:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        tenant_id:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          format: uuid
        data:
          $ref: '#/components/schemas/Card'
        card:
          $ref: '#/components/schemas/CardDetails'
        network_token:
          $ref: '#/components/schemas/CardDetails'
        par:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        created_by:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          format: uuid
        created_at:
          maxLength: 40
          type: string
          format: date-time
        modified_by:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type:
          - string
          - 'null'
          format: uuid
        modified_at:
          maxLength: 40
          type:
          - string
          - 'null'
          format: date-time
        token_id:
          type:
          - string
          - 'null'
        token_intent_id:
          type:
          - string
          - 'null'
        _extras:
          $ref: '#/components/schemas/NetworkTokenExtras'
      additionalProperties: false
    Card:
      type: object
      properties:
        number:
          type:
          - string
          - 'null'
        expiration_month:
          type:
          - integer
          - 'null'
          format: int32
        expiration_year:
          type:
          - integer
          - 'null'
          format: int32
        cvc:
          type:
          - string
          - 'null'
      additionalProperties: false
    AdditionalCardDetails:
      type: object
      properties:
        brand:
          type:
          - string
          - 'null'
        funding:
          type:
          - string
          - 'null'
        authentication:
          type:
          - string
          - 'null'
        issuer:
          $ref: '#/components/schemas/CardIssuer'
      additionalProperties: false
    CardIssuer:
      type: object
      properties:
        country:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
    CardIssuerCountry:
      type: object
      properties:
        alpha2:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        numeric:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationProblemDetails:
      type: object
      properties:
        errors:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              type: string
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    NetworkTokenExtras:
      type: object
      properties:
        deduplicated:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    NetworkTokenAccount:
      type: object
      properties:
        card_art:
          $ref: '#/components/schemas/CardArt'
      additionalProperties: false
    CardDetails:
      type: object
      properties:
        bin:
          type:
          - string
          - 'null'
        last4:
          type:
          - string
          - 'null'
        expiration_month:
          type:
          - integer
          - 'null'
          format: int32
        expiration_year:
          type:
          - integer
          - 'null'
          format: int32
        brand:
          type:
          - string
          - 'null'
        funding:
          type:
          - string
          - 'null'
        authentication:
          type:
          - string
          - 'null'
        issuer:
          $ref: '#/components/schemas/CardIssuer'
        issuer_country:
          $ref: '#/components/schemas/CardIssuerCountry'
        segment:
          type:
          - string
          - 'null'
        product:
          $ref: '#/components/schemas/CardProduct'
        additional:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AdditionalCardDetails'
      additionalProperties: false
    Address:
      type: object
      properties:
        line1:
          type:
          - string
          - 'null'
        line2:
          type:
          - string
          - 'null'
        line3:
          type:
          - string
          - 'null'
        postal_code:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
        state_code:
          type:
          - string
          - 'null'
        country_code:
          type:
          - string
          - 'null'
      additionalProperties: false
    CardProduct:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
      additionalProperties: false
    CreateNetworkTokenRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Card'
        token_id:
          type:
          - string
          - 'null'
        token_intent_id:
          type:
          - string
          - 'null'
        expiration_month:
          type:
          - integer
          - 'null'
          format: int32
        expiration_year:
          type:
          - integer
          - 'null'
          format: int32
        cardholder_info:
          $ref: '#/components/schemas/CardholderInfo'
        merchant_id:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type:
          - string
          - 'null'
          format: uuid
          deprecated: true
        configuration_merchant_id:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type:
          - string
          - 'null'
          format: uuid
        owner_merchant_id:
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    NetworkTokenCryptogram:
      type: object
      properties:
        cryptogram:
          type:
          - string
          - 'null'
        eci:
          type:
          - string
          - 'null'
      additionalProperties: false
    CardArt:
      type: object
      properties:
        background_color:
          type:
          - string
          - 'null'
        logo:
          $ref: '#/components/schemas/CardArtImage'
        card_image:
          $ref: '#/components/schemas/CardArtImage'
      additionalProperties: false
    CardholderInfo:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        address:
          $ref: '#/components/schemas/Address'
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Authorization by API Key inside request's BT-API-KEY header
      name: BT-API-KEY
      in: header
x-provenance:
  method: harvested
  publisher: Basis Theory
  source: https://api.basistheory.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)