> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peridot.id/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Checkout deposit intent (DOKU-hosted page, all channels)

> netAmountIdr is the NET credited to the user (minimum Rp50.000,
API-enforced — no DOKU minimum). Total payable = net + PeridotID fee
(0.1% min Rp100 no cap; Rp0 for verified apps) + the app's stacked fee
(when `clientId` is given) + the selected method's DOKU gateway fee.
All quotes are snapshotted on the row. `paymentMethod` is a category key
(VIRTUAL_ACCOUNT/EWALLET/CARD/QRIS) or a specific DOKU code; it locks
`payment_method_types` at DOKU. Omit it to let DOKU show all channels
(no gateway fee added). Quote first via POST /fiat/deposits/quote.




## OpenAPI

````yaml /openapi.yaml post /fiat/deposits/checkout
openapi: 3.0.3
info:
  title: PeridotID API
  version: 0.1.0
  description: >
    Gaming Identity Platform — Authentication, Identity, and Profile for the
    Peridot ecosystem.


    ## Base URL

    All endpoints are prefixed with `/v1`.


    | Environment | Base URL |

    |---|---|

    | Production | `https://api.pid.peridotvault.com/v1` |

    | Local dev | `http://localhost:3300/v1` |


    ## Authentication

    Authentication is **cookie-based**. After a successful Google sign-in the
    API sets two

    `HttpOnly` cookies:


    - `pid_access` — short-lived JWT access token (15 min), sent on every
    request.

    - `pid_refresh` — long-lived rotating refresh token (30 days), only sent to
    `/v1/auth`.


    Browsers handle these automatically; non-browser clients must send

    `Cookie: pid_access=<token>` on each request and call `/v1/auth/refresh`
    before the

    access token expires.
  contact:
    name: PeridotID
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.pid.peridotvault.com/v1
    description: Production
  - url: http://localhost:3300/v1
    description: Local development
security: []
tags:
  - name: auth
    description: Login, logout, token refresh, and machine (client-credentials) tokens
  - name: identity
    description: The user's identity across products
  - name: profile
    description: The user's public profile
  - name: wallet
    description: >
      The user's wallet, associated with their PID. **Deprecated (V3 surface)**
      — preserved

      for existing clients, backed by `linked_address` chain accounts. Use
      `/account` and

      the smart account instead.
  - name: account
    description: >-
      PeridotID account — owns chain accounts (smart account PDA, legacy linked
      address)
  - name: fiat
    description: |
      The internal IDR fiat ledger: balances, statements, sends, and money-in.
      Top-ups enter through a hosted DOKU Checkout page (no Sub-Account) and
      credit the internal ledger once the payment is corroborated. Any identity
      can send to any identity (escrow/payouts). Fees: global 0.1% (min Rp100,
      no cap) plus optional per-app fees that stack and credit the app. Bank
      withdrawals (redemption) are disabled for now.
  - name: apps
    description: |
      Third-party apps ("Sign in with PeridotID"): client_id, allowed origins,
      optional backend secret, ledger callbacks (deferred), and a per-app fee
      schedule. Owner-scoped — a non-owner gets 404. App backends authenticate
      server-side with `POST /v1/auth/token` (client credentials).
  - name: credentials
    description: >
      Signing authorities (secp256r1 passkeys). Google OAuth proves identity; a

      passkey authorizes the wallet. The first credential registers freely; each
      additional

      credential requires approval by an existing credential
      (existing-credential approval rule).
  - name: permissions
    description: >
      EVM permission grants (scoped P-256 session keys, WHITEPAPER.md §10).
      Validation is pure

      hygiene + canonical id/challenge computation; submission-time account
      binding

      is enforced by the relay path.
  - name: session-keys
    description: >
      SVM gameplay sessions (Ed25519 session keys in isolated PDAs,
      WHITEPAPER.md §11).

      Validation is pure hygiene + canonical address/challenge computation;

      submission-time vault binding is enforced by the relay path.
  - name: openapi
    description: Machine-readable API specification
paths:
  /fiat/deposits/checkout:
    post:
      tags:
        - fiat
      summary: Create a Checkout deposit intent (DOKU-hosted page, all channels)
      description: |
        netAmountIdr is the NET credited to the user (minimum Rp50.000,
        API-enforced — no DOKU minimum). Total payable = net + PeridotID fee
        (0.1% min Rp100 no cap; Rp0 for verified apps) + the app's stacked fee
        (when `clientId` is given) + the selected method's DOKU gateway fee.
        All quotes are snapshotted on the row. `paymentMethod` is a category key
        (VIRTUAL_ACCOUNT/EWALLET/CARD/QRIS) or a specific DOKU code; it locks
        `payment_method_types` at DOKU. Omit it to let DOKU show all channels
        (no gateway fee added). Quote first via POST /fiat/deposits/quote.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - netAmountIdr
              properties:
                netAmountIdr:
                  type: string
                clientId:
                  type: string
                  description: Optional app context (per-app fee + verified waiver)
                paymentMethod:
                  type: string
                  description: Category key or DOKU payment_method_types code
      responses:
        '200':
          description: Checkout deposit intent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutDeposit'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - cookieAuth: []
components:
  schemas:
    CheckoutDeposit:
      type: object
      required:
        - id
        - providerRef
        - paymentUrl
        - tokenId
        - grossIdr
        - feeIdr
        - netIdr
        - feePolicyVersion
        - providerStatus
        - createdAt
      properties:
        id:
          type: string
        providerRef:
          type: string
          description: Invoice number at DOKU (idempotency key)
        paymentUrl:
          type: string
          description: DOKU-hosted payment page (all banks, QRIS, e-money, cards)
        tokenId:
          type: string
        expiredDate:
          type: string
          nullable: true
        grossIdr:
          type: string
          description: Total payable at DOKU (net + PeridotID fee + app fee + gateway fee)
        totalIdr:
          type: string
          description: Same as grossIdr (Total Payment)
        feeIdr:
          type: string
          description: PeridotID fee (Rp0 for verified apps)
        appFeeIdr:
          type: string
          description: The initiating app's own stacked fee (0 when no app context)
        gatewayFeeIdr:
          type: string
          description: DOKU payment-gateway fee for the selected method
        transferFeeIdr:
          type: string
          description: Combined display line — PeridotID fee+PPN + DOKU gateway fee+PPN
        paymentMethod:
          type: string
          nullable: true
          description: Selected category key or DOKU method code
        netIdr:
          type: string
          description: Net credited to the user (the entered amount)
        feePolicyVersion:
          type: integer
        providerStatus:
          type: string
        createdAt:
          type: string
          format: date-time
    ApiError:
      type: object
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
        message:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
  responses:
    BadRequest:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            statusCode: 400
            message:
              - >-
                handle must be 3-20 chars: lowercase letters, numbers,
                underscore
    Unauthorized:
      description: Missing, expired, or invalid access/refresh token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            statusCode: 401
            message: Unauthorized
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: pid_access
      description: JWT access token set by /auth/google/callback or /auth/refresh

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.