> For the complete documentation index, see [llms.txt](https://firstoken.gitbook.io/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://firstoken.gitbook.io/api-docs/api-reference.md).

# API Reference

- [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)


---

# 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 that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://firstoken.gitbook.io/api-docs/api-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.