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

# Grant SMS credits to the account wallet (crédit)

> Adds `amount` SMS credits (a strictly positive integer) to the single account wallet and records them as an `adjustment` entry on the credit ledger, with the optional `source` kept as the operator note. This is the UNPAID path: no money changes hands and Stripe is not involved, so use it for pilots, goodwill and corrections only — a customer-funded top-up must go through the top-up checkout operation instead. There is no revoke verb; a correction is another grant (or a negative ledger movement made elsewhere). NOT IDEMPOTENT — there is no dedup key, so a retried call grants the credits a SECOND time and appends a second ledger entry; if a request times out, read the overview and check the ledger before retrying. Returns the wallet as it stands after the credits settled.



## OpenAPI

````yaml /openapi.json post /v1/credits/grant
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/credits/grant:
    post:
      tags:
        - Billing
      summary: Grant SMS credits to the account wallet (crédit)
      description: >-
        Adds `amount` SMS credits (a strictly positive integer) to the single
        account wallet and records them as an `adjustment` entry on the credit
        ledger, with the optional `source` kept as the operator note. This is
        the UNPAID path: no money changes hands and Stripe is not involved, so
        use it for pilots, goodwill and corrections only — a customer-funded
        top-up must go through the top-up checkout operation instead. There is
        no revoke verb; a correction is another grant (or a negative ledger
        movement made elsewhere). NOT IDEMPOTENT — there is no dedup key, so a
        retried call grants the credits a SECOND time and appends a second
        ledger entry; if a request times out, read the overview and check the
        ledger before retrying. Returns the wallet as it stands after the
        credits settled.
      operationId: grantCredits
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  minimum: 0
                  exclusiveMinimum: true
                  maximum: 9007199254740991
                source:
                  type: string
                  minLength: 1
              required:
                - amount
              example:
                amount: 500
                source: pilot seed
      responses:
        '200':
          description: The account wallet at its new materialized balance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  accountId:
                    type: string
                    minLength: 1
                  smsCreditBalance:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  planTier:
                    type: string
                    minLength: 1
                  planRenewsAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                  updatedAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                required:
                  - accountId
                  - smsCreditBalance
                  - updatedAt
                additionalProperties: false
                description: The account wallet at its new materialized balance.
                example:
                  accountId: network
                  smsCreditBalance: 500
                  planTier: starter
                  planRenewsAt: '2026-08-28T00:00:00.000Z'
                  updatedAt: '2026-07-28T09:12:00.000Z'
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````