Firstoken API Docs
  • ⚙️API Reference
    • Firstoken API
      • Tokenization As A Service
        • Simple Tokenization
        • Simple Detokenization
        • Inspect Token
        • Delete Tokens
      • Transactions
        • Create a Transaction
        • Retrieve a Transaction
        • Inspect a Transaction
        • Delete a Transaction
        • Tokenize a Transaction
      • Proxy
        • Allowed Headers
        • Actions
        • Methods
          • POST - Proxy
          • GET - Proxy
          • PUT - Proxy
          • PATCH - Proxy
          • DELETE - Proxy
        • Get Payload Hash
        • Proxy JOSE
        • Proxy WSSEC
      • Inbound Routes
        • Create an Inbound - POST
      • Payments
        • Attributes of the Request
        • Common response
        • Endpoints
          • Authorizations
          • Reversals
          • Capture
            • Capture Refunds
            • Capture Void
          • Payments
            • Payment Refunds
            • Payment Void
          • Refunds void
          • Credit
            • Credit Void
          • Get Transaction Details
        • Decision Manager
          • How it works
          • Create decision
          • Update Decision
        • Risk Payer Authentication
          • How to use it
          • 3-D Secure Flows
            • Successful Frictionless Authentication
            • Unsuccessful Frictionless Authentication
            • Attempts Processing Frictionless Authentication
            • Unavailable Frictionless Authentication
            • Rejected Frictionless Authentication
            • Authentication not available on Lookup
            • Enrollment check error
            • Time-out
            • Bypassed Authentication
            • Successful Step-Up Authentication
            • Unsuccessful Step-Up Authentication
            • Unavailable Step-Up Authentication
            • Require Method URL
        • Point of Sale Payments
          • Authorization
          • Capture
          • Payment
          • Credit
  • 📖Guides
    • Firstoken Captures Hosted Iframe
      • How Firstoken Captures works
      • Generating a JSON Web Token
      • JSON form Schema
      • Iframe Communication
    • De-scoping Components
      • How Firstoken De-scoping Components works
      • Inbound Routes Module
        • Create an Inbound Route
        • Edit an Inbound Route
        • Delete an Inbound Route
      • Webhook Module
        • Create a Webhook
        • Edit a Webhook
        • Delete a Webhook
        • Webhook events
        • How to sign Webhooks data
      • Proxy Module
        • Create a Proxy
        • Edit a Proxy
        • Delete a Proxy
    • Firstoken Captures SDK JS
      • Getting Started
      • Functions
      • Type of Elements
      • Elements Options
      • CSS Object
      • Full Example of Usage
      • SDK versions
Powered by GitBook
On this page
  • Step 1: Basic Route Information
  • Step 2: Rules Configuration
  • Step 3: Finalization

Was this helpful?

  1. Guides
  2. De-scoping Components
  3. Inbound Routes Module

Create an Inbound Route

PreviousInbound Routes ModuleNextEdit an Inbound Route

Last updated 7 months ago

Was this helpful?

For the Inbound Creation, click on “ + new inbound Route” button

In the creation page, will find the following fields that have to complete for create the Inbound:

Step 1: Basic Route Information

  • Name: Enter a unique name for your Inbound. This field is required.

  • Description: Add a brief description if desired. This field is optional.

  • If you want to designate a specific proxy for responses, select it here. Make sure you've created the proxy beforehand.

  • Custom Domain: If you plan to use a custom domain, activate it here. This will allow you to use a CNAME record for customization.

Note: If you choose to use a custom domain, you must designate a proxy in the previous step.

  • IP Whitelist: Specify the IP addresses or CIDR ranges allowed to use this Inbound. Be careful when granting access.

Step 2: Rules Configuration

  • Token Type:

    • Choose between Permanent or Temporal.

    • For permanent tokens, you have the option to make them persistent.

  • Path: If using a custom domain, define the specific path to receive information. Otherwhise will be a read-only input

  • Mapping Data: Complete the following fields with the correct paths for your client's data:

    • Card Number (e.g., "chd.cardnumber")

    • Cardholder Name (e.g., "chd.holder")

    • Expiration Month (e.g., "chd.expiration.month | date: MM")

    • Expiration Year (e.g., "chd.expiration.year | date: YYYY")

    • CVV (only for Transaction actions, e.g., "chd.csc")

    • Tags (only for Tokenization actions, e.g., "tags_IR")

  • Overwritten fields: Select the fields that should be returned with the replaced token. (e.g., “chd” or “cardnumber”)

  • TTL (Time To Live): If you've selected 'transaction' as the action, set a TTL.

  • Include Metadata: Decide if you need additional information in the Inbound response. If so, select "yes" and provide names for the custom fields.

Step 3: Finalization

Once all fields are completed, click the "Create" button. You'll be shown a screen with the URL and corresponding Route ID that you'll need to use.

Remember: You can verify permanent tokens in the Customer Portal (Tokens section) or using the TaaS API. For temporal tokens, use the Transactions API with the transaction ID from the inbound request.

📖
Example of an Inbound Route URL