Gnosis Pay User Account API

openapi: 3.2.0
info:
  title: User Service User Account API
  version: 0.0.0
servers:
- url: https://core.prod.gnosispay.com/user-api
  description: Production
  variables: {}
- url: https://core.sandbox.gnosispay.in/user-api
  description: Sandbox
  variables: {}
tags:
- name: User Account
paths:
  /user/account:
    post:
      operationId: User_createUserAccount
      summary: Create Account
      description: Create an account for the authenticated user.
      parameters: []
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountSuccess'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '409':
          description: The request conflicts with the current state of the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountConflict'
        '502':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountBadGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - User Account
      security:
      - BearerAuth: []
      x-ogen-operation-group: User
    get:
      operationId: User_getUserAccount
      summary: Get Account
      description: Get the account details for the authenticated user.
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '502':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserAccountBadGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - User Account
      security:
      - BearerAuth: []
      x-ogen-operation-group: User
  /user/account/limit:
    get:
      operationId: User_getUserAccountLimit
      summary: Get Account Daily Spending Limit
      description: 'Returns the daily spending limit configured on the authenticated user

        account. `currency` is the account native currency (`nativeCurrency`

        from `GET /user/account`), and `amount` is in minor units of that

        currency — divide by 10^`decimals` to get the major-unit value. USD,

        EUR, and GBP use 2 decimal places. `syncStatus` indicates whether the

        most recent update has been applied. Once synced, this is a cumulative

        spending limit, not a per-transaction cap: an authorization that meets

        or exceeds the limit can be approved, after which subsequent eligible

        authorizations are declined.'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountLimit'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '502':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserAccountLimitBadGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - User Account
      security:
      - BearerAuth: []
      x-ogen-operation-group: User
    put:
      operationId: User_setUserAccountLimit
      summary: Set Account Daily Spending Limit
      description: 'Sets the daily spending limit for the authenticated user account.

        `currency` must match the account native currency (`nativeCurrency` from

        `GET /user/account`), and `amount` is in minor units of that currency.

        USD, EUR, and GBP use 2 decimal places, so 1000000 is 10,000.00. The

        response returns the new limit immediately with `syncStatus: pending`

        and transitions to `synced` once the change has been applied. Once

        synced, this is a cumulative spending limit, not a per-transaction cap:

        an authorization that meets or exceeds the limit can be approved, after

        which subsequent eligible authorizations are declined.'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountLimit'
        '400':
          description: The server could not understand the request due to invalid syntax.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetUserAccountLimitBadRequestBody'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '502':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetUserAccountLimitBadGateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - User Account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetAccountLimitRequest'
            examples:
              example0:
                description: 10,000.00 EUR
                value:
                  amount: 1000000
                  currency: EUR
      security:
      - BearerAuth: []
      x-ogen-operation-group: User
components:
  schemas:
    CreateAccountSuccess:
      type: object
      required:
      - accountId
      properties:
        accountId:
          $ref: '#/components/schemas/uuid'
    GetUserAccountBadGateway:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    SetUserAccountLimitBusinessError:
      type: object
      required:
      - kind
      - success
      - error
      properties:
        kind:
          type: string
          enum:
          - business
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
      description: Business failure when the requested account limit is not accepted.
    CreateAccountBadGateway:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    AccountChain:
      type: object
      required:
      - name
      - id
      properties:
        name:
          $ref: '#/components/schemas/AccountChainName'
        id:
          $ref: '#/components/schemas/AccountChainID'
    SetAccountLimitRequest:
      type: object
      required:
      - amount
      - currency
      properties:
        amount:
          type: integer
          format: int64
          minimum: 1
          description: 'Daily spending limit in minor units of `currency`.

            USD, EUR, and GBP use 2 decimal places, so 1000000 is 10,000.00.'
          examples:
          - 1000000
        currency:
          type: string
          description: 'ISO-4217 currency code. Must match the account native currency

            (`nativeCurrency` from `GET /user/account`).'
          examples:
          - EUR
      examples:
      - amount: 1000000
        currency: EUR
    Unauthorized:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    AccountStatus:
      type: string
      enum:
      - provisioning
      - active
      - blocked
      - closed
    CreateAccountConflict:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    AccountLimit:
      type: object
      required:
      - amount
      - currency
      - decimals
      - syncStatus
      - updatedAt
      - spentToday
      - remaining
      properties:
        amount:
          type: integer
          format: int64
          description: 'Daily limit in minor units of `currency`. Divide by 10^`decimals` to get

            the major-unit value. USD, EUR, and GBP use 2 decimal places.'
        currency:
          type: string
          description: 'ISO-4217 currency code — the account native currency (`nativeCurrency`

            from `GET /user/account`).'
        decimals:
          type: integer
          format: int32
          description: Number of decimal places for this currency (2 for USD, EUR, and GBP).
        syncStatus:
          type: string
          enum:
          - pending
          - synced
          - failed
          description: 'Replication state of the limit. `pending` immediately after an update,

            `synced` once the change has been applied, `failed` if the change could not

            be applied after retries.'
        updatedAt:
          type: string
          format: date-time
          description: Last time this limit was modified.
        spentToday:
          type: integer
          format: int64
          description: 'Amount spent today against this limit, in minor units of `currency`.

            Resets at the start of each calendar day.'
        remaining:
          type: integer
          format: int64
          description: 'Remaining headroom today, in minor units of `currency`. Equals max(0,

            amount - spentToday).'
    ValidationErrorDetail:
      type: object
      required:
      - name
      - message
      properties:
        name:
          type: string
          enum:
          - ValidationError
        message:
          type: string
    Account:
      type: object
      required:
      - id
      - kycProfileId
      - safeOwnerAddress
      - safeAddress
      - chain
      - chainName
      - reference
      - nativeCurrency
      - additionalCurrencies
      - createdAt
      - updatedAt
      - closedAt
      - status
      - provisionedAt
      properties:
        id:
          $ref: '#/components/schemas/uuid'
        kycProfileId:
          $ref: '#/components/schemas/uuid'
        safeOwnerAddress:
          type: string
        safeAddress:
          anyOf:
          - type: string
          - type: 'null'
        chain:
          $ref: '#/components/schemas/AccountChain'
        chainName:
          type: string
        reference:
          anyOf:
          - type: string
          - type: 'null'
        nativeCurrency:
          type: string
          description: 'ISO-4217 currency code the account is denominated in. The account daily

            spending limit is set and reported in this currency.'
          examples:
          - EUR
        additionalCurrencies:
          type: array
          items:
            type: string
          description: ISO-4217 currency codes the account supports besides `nativeCurrency`.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        closedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
        status:
          $ref: '#/components/schemas/AccountStatus'
        provisionedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
    Error:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    uuid:
      type: string
      format: uuid
    AccountChainName:
      type: string
      enum:
      - celo
      - gnosis
    SetUserAccountLimitValidationError:
      type: object
      required:
      - kind
      - success
      - error
      properties:
        kind:
          type: string
          enum:
          - validation
        success:
          type: boolean
          enum:
          - false
        error:
          $ref: '#/components/schemas/ValidationErrorDetail'
      description: Validation failure when the account limit request cannot be decoded.
    SetUserAccountLimitBadGateway:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    GetUserAccountLimitBadGateway:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    NotFound:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
    SetUserAccountLimitBadRequestBody:
      type: object
      oneOf:
      - $ref: '#/components/schemas/SetUserAccountLimitValidationError'
      - $ref: '#/components/schemas/SetUserAccountLimitBusinessError'
      discriminator:
        propertyName: kind
        mapping:
          validation: '#/components/schemas/SetUserAccountLimitValidationError'
          business: '#/components/schemas/SetUserAccountLimitBusinessError'
      description: 'Discriminated 400 body for setting account limits. Both variants include

        `kind` so clients can branch on validation vs business failures.'
    AccountChainID:
      type: string
      enum:
      - '42220'
      - '100'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer