# Firstoken API Docs ## Firstoken API Docs - [Overview](https://firstoken.gitbook.io/api-docs/api-reference/overview.md) - [Permanent Tokenization](https://firstoken.gitbook.io/api-docs/api-reference/permanent-tokenization.md) - [Create a permanent token](https://firstoken.gitbook.io/api-docs/api-reference/permanent-tokenization/create-a-permanent-token.md) - [Detokenize a permanent token](https://firstoken.gitbook.io/api-docs/api-reference/permanent-tokenization/detokenize-a-permanent-token.md) - [Inspect a permanent token](https://firstoken.gitbook.io/api-docs/api-reference/permanent-tokenization/inspect-a-permanent-token.md) - [Delete permanent tokens](https://firstoken.gitbook.io/api-docs/api-reference/permanent-tokenization/delete-permanent-tokens.md) - [Transactions](https://firstoken.gitbook.io/api-docs/api-reference/transactions.md) - [Create a Transaction](https://firstoken.gitbook.io/api-docs/api-reference/transactions/create-a-transaction.md) - [Retrieve a Transaction](https://firstoken.gitbook.io/api-docs/api-reference/transactions/retrieve-a-transaction.md) - [Inspect a Transaction](https://firstoken.gitbook.io/api-docs/api-reference/transactions/inspect-a-transaction.md) - [Delete a Transaction](https://firstoken.gitbook.io/api-docs/api-reference/transactions/delete-a-transaction.md) - [Tokenize a Transaction](https://firstoken.gitbook.io/api-docs/api-reference/transactions/tokenize-a-transaction.md) - [Proxy](https://firstoken.gitbook.io/api-docs/api-reference/proxy.md) - [Allowed Headers](https://firstoken.gitbook.io/api-docs/api-reference/proxy/allowed-headers.md) - [Actions](https://firstoken.gitbook.io/api-docs/api-reference/proxy/actions.md) - [Methods](https://firstoken.gitbook.io/api-docs/api-reference/proxy/methods.md) - [POST - Proxy](https://firstoken.gitbook.io/api-docs/api-reference/proxy/methods/post-proxy.md) - [GET - Proxy](https://firstoken.gitbook.io/api-docs/api-reference/proxy/methods/get-proxy.md) - [PUT - Proxy](https://firstoken.gitbook.io/api-docs/api-reference/proxy/methods/put-proxy.md) - [PATCH - Proxy](https://firstoken.gitbook.io/api-docs/api-reference/proxy/methods/patch-proxy.md) - [DELETE - Proxy](https://firstoken.gitbook.io/api-docs/api-reference/proxy/methods/delete-proxy.md) - [Get Payload Hash](https://firstoken.gitbook.io/api-docs/api-reference/proxy/get-payload-hash.md) - [Proxy JOSE](https://firstoken.gitbook.io/api-docs/api-reference/proxy/proxy-jose.md) - [Proxy WSSEC](https://firstoken.gitbook.io/api-docs/api-reference/proxy/proxy-wssec.md) - [Inbound Routes](https://firstoken.gitbook.io/api-docs/api-reference/inbound-routes.md) - [Create an Inbound - POST](https://firstoken.gitbook.io/api-docs/api-reference/inbound-routes/create-an-inbound-post.md) - [Payments](https://firstoken.gitbook.io/api-docs/api-reference/payments.md) - [Attributes of the Request](https://firstoken.gitbook.io/api-docs/api-reference/payments/attributes-of-the-request.md) - [Common response](https://firstoken.gitbook.io/api-docs/api-reference/payments/common-response.md) - [Endpoints](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints.md) - [Authorizations](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/authorizations.md) - [Reversals](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/reversals.md) - [Capture](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/capture.md) - [Capture Refunds](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/capture/capture-refunds.md) - [Capture Void](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/capture/capture-void.md) - [Payments](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/payments.md) - [Payment Refunds](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/payments/payment-refunds.md) - [Payment Void](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/payments/payment-void.md) - [Refunds void](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/refunds-void.md) - [Credit](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/credit.md) - [Credit Void](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/credit/credit-void.md) - [Get Transaction Details](https://firstoken.gitbook.io/api-docs/api-reference/payments/endpoints/get-transaction-details.md) - [Point of Sale Payments](https://firstoken.gitbook.io/api-docs/api-reference/payments/point-of-sale-payments.md) - [Authorization](https://firstoken.gitbook.io/api-docs/api-reference/payments/point-of-sale-payments/authorization.md) - [Capture](https://firstoken.gitbook.io/api-docs/api-reference/payments/point-of-sale-payments/capture.md) - [Payment](https://firstoken.gitbook.io/api-docs/api-reference/payments/point-of-sale-payments/payment.md) - [Credit](https://firstoken.gitbook.io/api-docs/api-reference/payments/point-of-sale-payments/credit.md) - [Payments API - KOIN](https://firstoken.gitbook.io/api-docs/api-reference/payments/payments-api-koin.md) - [Payments - Complete Flow](https://firstoken.gitbook.io/api-docs/api-reference/payments/payments-api-koin/payments-complete-flow.md) - [Authorization](https://firstoken.gitbook.io/api-docs/api-reference/payments/payments-api-koin/authorization.md) - [Card Validation](https://firstoken.gitbook.io/api-docs/api-reference/payments/payments-api-koin/card-validation.md) - [Capture](https://firstoken.gitbook.io/api-docs/api-reference/payments/payments-api-koin/capture.md) - [Payment Refund](https://firstoken.gitbook.io/api-docs/api-reference/payments/payments-api-koin/payment-refund.md) - [Authorization Void](https://firstoken.gitbook.io/api-docs/api-reference/payments/payments-api-koin/authorization-void.md) - [Get Transaction Details](https://firstoken.gitbook.io/api-docs/api-reference/payments/payments-api-koin/get-transaction-details.md) - [Testing Guide](https://firstoken.gitbook.io/api-docs/api-reference/payments/payments-api-koin/testing-guide.md) - [Risk](https://firstoken.gitbook.io/api-docs/api-reference/risk.md) - [Firstoken Fraud](https://firstoken.gitbook.io/api-docs/api-reference/risk/firstoken-fraud.md) - [How it works](https://firstoken.gitbook.io/api-docs/api-reference/risk/firstoken-fraud/how-it-works.md) - [Create decision](https://firstoken.gitbook.io/api-docs/api-reference/risk/firstoken-fraud/create-decision.md): Creates a new fraud decision to evaluate a transaction. - [Update Decision](https://firstoken.gitbook.io/api-docs/api-reference/risk/firstoken-fraud/update-decision.md): Updates an existing decision that is in manual review status. - [Payer Authentication (3D-Secure)](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure.md) - [How it works](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/how-it-works.md) - [Detailed Flow Scenarios](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/detailed-flow-scenarios.md) - [Frictionless Success Flow](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/detailed-flow-scenarios/frictionless-success-flow.md) - [Pending Authentication Flow](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/detailed-flow-scenarios/pending-authentication-flow.md): Challenge Required - [Frictionless Failed Authentication](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/detailed-flow-scenarios/frictionless-failed-authentication.md) - [Data-Only Authentication](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/data-only-authentication.md) - [Test Cards](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/test-cards.md) - [Endpoints](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/endpoints.md) - [Setup](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/endpoints/setup.md): Initializes the payer authentication process and obtains the necessary tokens for the 3D Secure flow. - [Check enroll](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/endpoints/check-enroll.md): Verifies if the card is enrolled in 3-D Secure and initiates the authentication challenge if required. - [Validate](https://firstoken.gitbook.io/api-docs/api-reference/risk/payer-authentication-3d-secure/endpoints/validate.md): Validates the authentication results after the user completes the 3D Secure challenge. - [Network Token](https://firstoken.gitbook.io/api-docs/api-reference/network-token.md) - [Enroll Card](https://firstoken.gitbook.io/api-docs/api-reference/network-token/enroll-card.md): Enrolls a Firstoken permanent token in the card network's tokenization program. - [Get Payment Credentials](https://firstoken.gitbook.io/api-docs/api-reference/network-token/get-payment-credentials.md) - [How Network Token works](https://firstoken.gitbook.io/api-docs/api-reference/network-token/how-network-token-works.md) - [Integration Flows](https://firstoken.gitbook.io/api-docs/api-reference/network-token/integration-flows.md) - [Test Cards for Network Token](https://firstoken.gitbook.io/api-docs/api-reference/network-token/test-cards-for-network-token.md) - [Quick Start: Tokenize a Card via API](https://firstoken.gitbook.io/api-docs/guides/quick-start-tokenize-a-card-via-api.md) - [How Firstoken Works to Reduce Your Scope](https://firstoken.gitbook.io/api-docs/guides/how-firstoken-works-to-reduce-your-scope.md) - [Implementing Hosted Iframes](https://firstoken.gitbook.io/api-docs/guides/implementing-hosted-iframes.md) - [How Captures works](https://firstoken.gitbook.io/api-docs/guides/implementing-hosted-iframes/how-captures-works.md) - [Generating a JSON Web Token](https://firstoken.gitbook.io/api-docs/guides/implementing-hosted-iframes/generating-a-json-web-token.md) - [JSON form Schema](https://firstoken.gitbook.io/api-docs/guides/implementing-hosted-iframes/json-form-schema.md) - [Iframe Communication](https://firstoken.gitbook.io/api-docs/guides/implementing-hosted-iframes/iframe-communication.md) - [Implementing Captures SDK JS](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js.md) - [Getting Started](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js/getting-started.md) - [Functions](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js/functions.md): Callback functions allow you to customize the logic of the form. - [Type of Elements](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js/type-of-elements.md) - [Elements Options](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js/elements-options.md) - [JWT Authentication for Firstoken SDK](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js/jwt-authentication-for-firstoken-sdk.md) - [CSS Object](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js/css-object.md) - [Full Example of usage](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js/full-example-of-usage.md) - [SDK versions](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js/sdk-versions.md) - [Migration & Compatibility](https://firstoken.gitbook.io/api-docs/guides/implementing-captures-sdk-js/migration-and-compatibility.md) - [Implementing Monitor](https://firstoken.gitbook.io/api-docs/guides/implementing-monitor.md) - [CSP Real-Time Monitoring](https://firstoken.gitbook.io/api-docs/guides/implementing-monitor/csp-real-time-monitoring.md) - [How it works in practice](https://firstoken.gitbook.io/api-docs/guides/implementing-monitor/csp-real-time-monitoring/how-it-works-in-practice.md) - [Security Headers Scanner](https://firstoken.gitbook.io/api-docs/guides/implementing-monitor/security-headers-scanner.md) - [How Security Headers Scanning Works](https://firstoken.gitbook.io/api-docs/guides/implementing-monitor/security-headers-scanner/how-security-headers-scanning-works.md) - [Resources and Script Inventory](https://firstoken.gitbook.io/api-docs/guides/implementing-monitor/resources-and-script-inventory.md) - [How Resources Inventory Works](https://firstoken.gitbook.io/api-docs/guides/implementing-monitor/resources-and-script-inventory/how-resources-inventory-works.md) - [PCI DSS 11.6.1 Compliance](https://firstoken.gitbook.io/api-docs/guides/implementing-monitor/pci-dss-11.6.1-compliance.md) - [PCI DSS 6.4.3 Compliance](https://firstoken.gitbook.io/api-docs/guides/implementing-monitor/pci-dss-6.4.3-compliance.md) - [Implementing Reverse Proxy](https://firstoken.gitbook.io/api-docs/guides/implementing-reverse-proxy.md) - [SFTP File Processing](https://firstoken.gitbook.io/api-docs/guides/sftp-file-processing.md) - [Migrate Stored Cards to Firstoken](https://firstoken.gitbook.io/api-docs/guides/migrate-stored-cards-to-firstoken.md) - [3D-Secure: Full Implementation Guide](https://firstoken.gitbook.io/api-docs/guides/3d-secure-full-implementation-guide.md): Guide to integrate 3D-Secure in your own checkout using the Firstoken API and Cardinal Songbird in the browser. - [Cardinal Songbird Integration](https://firstoken.gitbook.io/api-docs/guides/cardinal-songbird-integration.md) - [KOIN - Device Fingerprint Session ID](https://firstoken.gitbook.io/api-docs/guides/koin-device-fingerprint-session-id.md) - [Create an Inbound Route](https://firstoken.gitbook.io/api-docs/how-to/create-an-inbound-route.md) - [Create a Proxy](https://firstoken.gitbook.io/api-docs/how-to/create-a-proxy.md) - [Create a Webhook](https://firstoken.gitbook.io/api-docs/how-to/create-a-webhook.md) - [Webhook Events](https://firstoken.gitbook.io/api-docs/how-to/create-a-webhook/webhook-events.md) - [Webhook Signatures Validati](https://firstoken.gitbook.io/api-docs/how-to/create-a-webhook/webhook-signatures-validati.md) - [Generate a Report](https://firstoken.gitbook.io/api-docs/how-to/generate-a-report.md) - [Manage Users and Roles](https://firstoken.gitbook.io/api-docs/how-to/manage-users-and-roles.md) - [Create an API Key or External App](https://firstoken.gitbook.io/api-docs/how-to/create-an-api-key-or-external-app.md) - [Enable Two-Factor Authentication](https://firstoken.gitbook.io/api-docs/how-to/enable-two-factor-authentication.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://firstoken.gitbook.io/api-docs/api-reference/overview.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.