---
title: Integration Guides
slug: integration-guides
docTags: 
createdAt: 2026-06-01T13:20:13.286Z
---

Forter provides **secure, PCI-compliant solutions** for handling payment card data. This guide outlines **integration options, best practices**, and **key considerations** for implementing Forter’s card vaulting services.

***

# Hosted Fields + Proxy

::::WorkflowBlock
:::WorkflowBlockItem
### Collect card data securely

Forter’s [Hosted Fields](docId\:ehMPR2ImC2DyqB79Qi0RW) enables secure collection of card data on the checkout page to remove PCI scope.
:::

:::WorkflowBlockItem
### Call Forter using the token

When calling Forter /Orders endpoint
Instead of sending the card number in payment.creditCard 
send the token in:
payment.tokenizedCard.tokenType="FORTER\_TOKEN"
payment.tokenizedCard.token=\<Token>
:::

:::WorkflowBlockItem
### Process payments using a token

Once the customer enters their payment credentials, Forter provides an agnostic **single-use token** (or "nonce") that can be used to **process tokenized payments with any PSP**. Refer to the [Detokenization Proxy](docId\:OfFNU07xBM4EPefHK2jsf) guide to learn how.
:::

:::WorkflowBlockItem
### Upgrade to multi-use token (Optional)

To store a token for future transactions (e.g., saved cards or recurring payments), upgrade a single-use token to a multi-use token by calling the `/upgrade` endpoint.
:::
::::

***

# Direct API Integration

:::hint{type="warning"}
This solution is compatible for PCI level 1 merchants only
:::

Forter’s **Limited PCI Compliance** approach allows merchants to handle tokenized card data while limiting their PCI scope.

::::WorkflowBlock
:::WorkflowBlockItem
### Tokenize card data

After collecting card details, generate a token using one of the following API calls:

- **Multi-use token**: Call the `/tokenize` endpoint .
- **Single-use token**: Call the `/create-single-use-token`  endpoint.

To generate a **network token**, set `networkToken.provision` to `true` when calling the `/tokenize` endpoint.
:::

:::WorkflowBlockItem
### Detokenize for payment processing

When ready to process a payment, retrieve the original card details by calling the `/detokenize` endpoint, then proceed with payment processing.
:::

:::WorkflowBlockItem
### Upgrade to multi-use token (Optional)

To store a token for future transactions (e.g., saved cards or recurring payments), upgrade a single-use token to a multi-use token by calling the `/upgrade` endpoint.
:::
::::

***

# Examples

## Sending a request to Forter

:::ExpandableHeading
### Forter's Order API

```curl
  curl 'https://api.forter-secure.com/v3/orders/{id}' \
 -X POST \
 -H 'Content-type: application/json' \
 -H 'x-forter-siteid: SITE_ID' \
 -H 'api-version: API_VERSION' \
 -H 'authorization: Basic dGVzdDo=' \
 --data '
{
  "orderId": "2356fdse0rr489",
  "orderType": "WEB",
  "authorizationStep": "PRE_AUTHORIZATION",
  "totalAmount": {
    "amountUSD": "99.95",
    "amountLocalCurrency": "105.55",
    "currency": "CAD",
    "amountMerchantMainCurrency": "125.95",
    "merchantMainCurrency": "EUR"
  },
  "totalDiscount": {
    "couponCodeUsed": "FATHERSDAY2015",
    "discountType": "COUPON"
  },
  "payment": [
   {
     "tokenizedCard": {
         "tokenType": "FORTER_TOKEN",
         "token": "<Token>"
     },
     "billingDetails": {
        "personalDetails": {
            "fullName": "Or Paul",
            "email": "or.paul@gmail.com"
        },
        "phone": [],
        "address": {
            "zip": "90043", 
            "address1": "123 17th St",
            "city": "Santa Monica", 
            "region": "CA", 
            "country": "US"
        }
     },
     "amount": {
        "currency": "EUR",
        "amountLocalCurrency": "90.00",
        "amountUSD": "100.00"
     }
  },
  "primaryRecipient": {
    "personalDetails": {
      "firstName": "John",
      "lastName": "Smith",
      "gender": "MALE",
      "birthdate": "1987-05-22",
      "email": "john_s@test.com"
    },
    "address": {
      "address1": "235 Montgomery st.",
      "address2": "Ste. 1110",
      "zip": "94104",
      "city": "San Francisco",
      "region": "CA",
      "country": "US",
      "company": "Generic Corp. ltd.",
      "savedData": {
        "usedSavedData": true,
        "choseToSaveData": false
      }
    },
    "comments": {
      "userCommentsToMerchant": "Please wrap with care!!",
      "messageToBeneficiary": "Enjoy the gift John!",
      "merchantComments": "Shipping delayed"
    }
  },
  "phoneOrderInformation": {
    "customerWebId": "123456789",
    "callerFirstName": "John",
    "callerLastName": "Smith",
    "callerId": "2121234567",
    "callStartTime": 1412345911,
    "callDuration": 4,
    "remarks": "The customer is buying the product for a friend",
    "merchantAgentData": {
      "merchantAgentName": "John Smith",
      "merchantAgentId": "HG36885TZ"
    }
  },
  "historicalData": {
    "orderStatus": "COMPLETED",
    "merchantOrderStatus": "Shipped",
    "fraud": "FRAUD_CHARGEBACK"
  }
}
'
```
:::