---
title: "manualRefundCashout"
method: POST
path: "/api/wallet-events/manual-refund"
tags: ["wallet-event-resource"]
---

# manualRefundCashout

`POST /api/wallet-events/manual-refund`

## Request body

- WalletEvent
  - `acceptor` Acceptor
    - `acceptorName` string
    - `acceptorNameEn` string
    - `active` boolean
    - `address` string
    - `addressEn` string
    - `anonymousPay` boolean
    - `apgCallbackUrl` string
    - `apgSecond` boolean
    - `birthCertDigit` string
    - `birthCertLetter` string
    - `birthCertNumber` string
    - `birthCertSeriesNumber` string
    - `cashoutVip` boolean
    - `centerUpdatableByOwner` boolean
    - `city` string
    - `code` string
    - `companyName` string
    - `companyNationalId` string
    - `contacts` AcceptorContact[]
      - `acceptor` Acceptor — recursive
      - `contactType` 'TELEGRAM' | 'INSTAGRAM' | 'FACEBOOK' | 'LINKEDIN' | 'TWITTER' | 'WHATSAPP' | 'EMAIL' | 'ADDRESS' | 'COORDINATES' | 'TELEPHONE' | 'MOBILE' | 'WEBSITE', required
      - `id` integer
      - `value` string
    - `contractSignDate` string, date
    - `contractSignDateJalali` string
    - `couponCreationFeePercentage` number
    - `dateOfBirth` string
    - `delivery` boolean
    - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING'
    - `departmentRestaurant` boolean
    - `description` string
    - `discountPercentage` number, double
    - `documents` Document[]
      - `acceptor` Acceptor — recursive
      - `contentContentType` string
      - `description` string
      - `documentIdentifier` string
      - `documentKey` string
      - `documentStatus` 'CONFIRMED' | 'REJECTED'
      - `documentType` 'LOGO' | 'MENU' | 'PHOTO' | 'PHOTO_BUILDING' | 'DOCUMENT' | 'BANNER' | 'BANNER_LANDING' | 'BANNER_LANDING_DESKTOP' | 'ID_NATIONAL_CODE' | 'ID_IDENTITY_NUMBER' | 'ID_BUSINESS_LICENSE' | 'ID_SHEBA_CONFIRMATION' | 'ID_POSTAL_CODE' | 'ID_APG_CONTRACT' | 'ID_POS_CONTRACT' | 'ID_ACCEPTOR_CONFIRMATION' | 'ID_OTHERS', required
      - `id` integer
      - `makePublic` boolean
      - `paymentTool` PaymentTool
        - `acceptor` Acceptor, required — recursive
        - `accountBank` 'EGHTESAD_NOVID' | 'ANSAR' | 'IRAN_ZAMIN' | 'PARSIAN' | 'PASARGAD' | 'TAT' | 'TEJARAT' | 'TOSAE_TAVON' | 'TOSAE_SADERAT' | 'HEKMAT_IRANIAN' | 'DAY' | 'REFAH' | 'SAMAN' | 'SEPAH' | 'SARMAYEH' | 'SINA' | 'SHAHR' | 'SADERAT' | 'SANAT_O_MADAN' | 'MEHR' | 'GHAVAMIN' | 'KAR_AFARIN' | 'KESHAVARZI' | 'GARDESHGARI' | 'MARKAZI' | 'MASKAN' | 'MELLAT' | 'MELLI' | 'MEHR_EGHTESAD' | 'POST' | 'TOSAE' | 'KOSAR' | 'MIDDLE_EAST' | 'OTHER'
        - `accountBranch` string
        - `accountBranchCode` string
        - `accountName` string
        - `accountNumber` string
        - `accountSheba` string
        - `confirmed` boolean
        - `documents` Document[]
        - `id` integer
        - `merchant` string
        - `name` string
        - `password` string
        - `picked` boolean
        - `posType` 'GPRS' | 'TYPICAL' | 'LAN' | 'M' | 'PC' | 'WIFI'
        - `sent` boolean
        - `sentMessage` string
        - `serial` string
        - `terminal` string
        - `type` 'WALLET' | 'POS' | 'IPG', required
        - `username` string
      - `statusDescription` string
      - `uploadedOn` string, date-time, required
      - `validFrom` string, date
      - `validTo` string, date
    - `facilities` AcceptorFacility[]
      - `acceptor` Acceptor — recursive
      - `facility` Facility
        - `code` string, required
        - `id` integer
        - `name` string, required
      - `id` integer
    - `familyName` string
    - `familyNameEn` string
    - `fatherName` string
    - `gender` 'MALE' | 'FEMALE'
    - `givenName` string
    - `givenNameEn` string
    - `group` AcceptorGroup
      - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING', required
      - `id` integer
      - `name` string, required
    - `guild` AcceptorGuild
      - `code` string, required
      - `id` integer
      - `name` string
    - `hideUnregisteredUsersForFactor` boolean
    - `id` integer
    - `identityType` 'PERSON' | 'COMPANY'
    - `introducerPercentage` number, double
    - `kargozar` User
      - `activated` boolean, required
      - `clubCardNumber` integer
      - `clubCode` integer
      - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
      - `email` string
      - `firstName` string
      - `fullname` string
      - `gender` 'MALE' | 'FEMALE'
      - `id` integer
      - `imageUrl` string
      - `langKey` string
      - `lastName` string
      - `locked` boolean
      - `login` string, required
      - `mobile` string
      - `nickname` string
      - `notSystem` boolean
      - `originClubCode` integer
      - `persepolisi` boolean
      - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
      - `system` boolean
    - `makePublic` boolean
    - `maxDistance` number
    - `mobile` string
    - `nationalIdNumber` string
    - `nationality` 'IRANIAN' | 'FOREIGNER'
    - `noRawFee` boolean
    - `notifySdkPaymentUrl` boolean
    - `onboarded` boolean
    - `onlineShop` boolean
    - `ostan` Ostan
      - `amarCode` integer, required
      - `id` integer
      - `name` string, required
      - `phoneCode` string
    - `parent` Acceptor — recursive
    - `paymentTools` PaymentTool[]
      - `acceptor` Acceptor, required — recursive
      - `accountBank` 'EGHTESAD_NOVID' | 'ANSAR' | 'IRAN_ZAMIN' | 'PARSIAN' | 'PASARGAD' | 'TAT' | 'TEJARAT' | 'TOSAE_TAVON' | 'TOSAE_SADERAT' | 'HEKMAT_IRANIAN' | 'DAY' | 'REFAH' | 'SAMAN' | 'SEPAH' | 'SARMAYEH' | 'SINA' | 'SHAHR' | 'SADERAT' | 'SANAT_O_MADAN' | 'MEHR' | 'GHAVAMIN' | 'KAR_AFARIN' | 'KESHAVARZI' | 'GARDESHGARI' | 'MARKAZI' | 'MASKAN' | 'MELLAT' | 'MELLI' | 'MEHR_EGHTESAD' | 'POST' | 'TOSAE' | 'KOSAR' | 'MIDDLE_EAST' | 'OTHER'
      - `accountBranch` string
      - `accountBranchCode` string
      - `accountName` string
      - `accountNumber` string
      - `accountSheba` string
      - `confirmed` boolean
      - `documents` Document[]
        - `acceptor` Acceptor — recursive
        - `contentContentType` string
        - `description` string
        - `documentIdentifier` string
        - `documentKey` string
        - `documentStatus` 'CONFIRMED' | 'REJECTED'
        - `documentType` 'LOGO' | 'MENU' | 'PHOTO' | 'PHOTO_BUILDING' | 'DOCUMENT' | 'BANNER' | 'BANNER_LANDING' | 'BANNER_LANDING_DESKTOP' | 'ID_NATIONAL_CODE' | 'ID_IDENTITY_NUMBER' | 'ID_BUSINESS_LICENSE' | 'ID_SHEBA_CONFIRMATION' | 'ID_POSTAL_CODE' | 'ID_APG_CONTRACT' | 'ID_POS_CONTRACT' | 'ID_ACCEPTOR_CONFIRMATION' | 'ID_OTHERS', required
        - `id` integer
        - `makePublic` boolean
        - `paymentTool` PaymentTool — recursive
        - `statusDescription` string
        - `uploadedOn` string, date-time, required
        - `validFrom` string, date
        - `validTo` string, date
      - `id` integer
      - `merchant` string
      - `name` string
      - `password` string
      - `picked` boolean
      - `posType` 'GPRS' | 'TYPICAL' | 'LAN' | 'M' | 'PC' | 'WIFI'
      - `sent` boolean
      - `sentMessage` string
      - `serial` string
      - `terminal` string
      - `type` 'WALLET' | 'POS' | 'IPG', required
      - `username` string
    - `phone` string
    - `pickup` boolean
    - `pickupGap` integer
    - `platformDiscountPercentage` number, double
    - `postcode` string
    - `rank` integer
    - `rawFee` boolean
    - `rawFeeFixed` boolean
    - `rawFeePercentage` number
    - `referralCode` integer
    - `registrar` User
      - `activated` boolean, required
      - `clubCardNumber` integer
      - `clubCode` integer
      - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
      - `email` string
      - `firstName` string
      - `fullname` string
      - `gender` 'MALE' | 'FEMALE'
      - `id` integer
      - `imageUrl` string
      - `langKey` string
      - `lastName` string
      - `locked` boolean
      - `login` string, required
      - `mobile` string
      - `nickname` string
      - `notSystem` boolean
      - `originClubCode` integer
      - `persepolisi` boolean
      - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
      - `system` boolean
    - `registrarType` 'USER' | 'OWNER' | 'EMPLOYEE'
    - `registrationDate` string
    - `registrationNumber` string
    - `shahr` Shahr
      - `amarCode` integer, required
      - `bakhsh` Bakhsh, required
        - `amarCode` integer, required
        - `id` integer
        - `name` string, required
        - `ostan` Ostan, required
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `phoneCode` string
        - `shahrestan` Shahrestan, required
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `ostan` Ostan, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `phoneCode` string
      - `id` integer
      - `name` string, required
      - `ostan` Ostan, required
        - `amarCode` integer, required
        - `id` integer
        - `name` string, required
        - `phoneCode` string
      - `shahrType` integer
      - `shahrestan` Shahrestan, required
        - `amarCode` integer, required
        - `id` integer
        - `name` string, required
        - `ostan` Ostan, required
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `phoneCode` string
      - `shaparakCode` string
    - `shortDescription` string
    - `soldSum` number
    - `state` string
    - `status` 'REQUESTED' | 'CONFIRMED' | 'DOCUMENT_INCOMPLETE' | 'DOCUMENT_CONFIRMED' | 'DOCUMENT_SENT' | 'NEEDTOREVIEW' | 'COMPLETE_PROFILE' | 'ACTIVE' | 'INACTIVE' | 'SYSTEM' | 'EXPIRED' | 'NOTRANSACTION' | 'CLOSED' | 'ORGANIZATIONAL' | 'BUILDING'
    - `storeType` 'VIRTUAL' | 'PHYSICAL'
    - `subGroup` AcceptorSubGroup
      - `group` AcceptorGroup, required
        - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING', required
        - `id` integer
        - `name` string, required
      - `id` integer
      - `name` string, required
    - `subGuild` AcceptorSubGuild
      - `code` string, required
      - `guild` AcceptorGuild, required
        - `code` string, required
        - `id` integer
        - `name` string
      - `id` integer
      - `name` string
    - `tables` boolean
    - `targetGroup` 'MALE' | 'FEMALE' | 'UNISEX'
    - `tax` boolean
    - `taxCode` string
    - `taxRaw` boolean
    - `terminalSecond` boolean
    - `terminalSecondId` string
    - `tradingHours` TradingHours
      - `fri` string
      - `id` integer
      - `mon` string
      - `name` string
      - `publicHolidays` string
      - `sat` string
      - `sun` string
      - `thu` string
      - `tue` string
      - `wed` string
    - `user` User
      - `activated` boolean, required
      - `clubCardNumber` integer
      - `clubCode` integer
      - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
      - `email` string
      - `firstName` string
      - `fullname` string
      - `gender` 'MALE' | 'FEMALE'
      - `id` integer
      - `imageUrl` string
      - `langKey` string
      - `lastName` string
      - `locked` boolean
      - `login` string, required
      - `mobile` string
      - `nickname` string
      - `notSystem` boolean
      - `originClubCode` integer
      - `persepolisi` boolean
      - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
      - `system` boolean
    - `visible` boolean
  - `actionDescription` string
  - `actionType` 'DEPOSIT' | 'WITHDRAW', required
  - `amount` number, required
  - `amountDouble` number, double
  - `balance` number
  - `club` Club
    - `apiKey` string
    - `banner` File
      - `contentType` string
      - `id` integer
      - `path` string
      - `publicId` string, required
      - `type` 'PHOTO' | 'DOCUMENT' | 'AVATAR', required
    - `code` integer
    - `description` string
    - `discount` number
    - `enabled` boolean
    - `id` integer
    - `logo` File
      - `contentType` string
      - `id` integer
      - `path` string
      - `publicId` string, required
      - `type` 'PHOTO' | 'DOCUMENT' | 'AVATAR', required
    - `name` string
    - `owner` User
      - `activated` boolean, required
      - `clubCardNumber` integer
      - `clubCode` integer
      - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
      - `email` string
      - `firstName` string
      - `fullname` string
      - `gender` 'MALE' | 'FEMALE'
      - `id` integer
      - `imageUrl` string
      - `langKey` string
      - `lastName` string
      - `locked` boolean
      - `login` string, required
      - `mobile` string
      - `nickname` string
      - `notSystem` boolean
      - `originClubCode` integer
      - `persepolisi` boolean
      - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
      - `system` boolean
    - `ownera` Acceptor
      - `acceptorName` string
      - `acceptorNameEn` string
      - `active` boolean
      - `address` string
      - `addressEn` string
      - `anonymousPay` boolean
      - `apgCallbackUrl` string
      - `apgSecond` boolean
      - `birthCertDigit` string
      - `birthCertLetter` string
      - `birthCertNumber` string
      - `birthCertSeriesNumber` string
      - `cashoutVip` boolean
      - `centerUpdatableByOwner` boolean
      - `city` string
      - `code` string
      - `companyName` string
      - `companyNationalId` string
      - `contacts` AcceptorContact[]
        - `acceptor` Acceptor — recursive
        - `contactType` 'TELEGRAM' | 'INSTAGRAM' | 'FACEBOOK' | 'LINKEDIN' | 'TWITTER' | 'WHATSAPP' | 'EMAIL' | 'ADDRESS' | 'COORDINATES' | 'TELEPHONE' | 'MOBILE' | 'WEBSITE', required
        - `id` integer
        - `value` string
      - `contractSignDate` string, date
      - `contractSignDateJalali` string
      - `couponCreationFeePercentage` number
      - `dateOfBirth` string
      - `delivery` boolean
      - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING'
      - `departmentRestaurant` boolean
      - `description` string
      - `discountPercentage` number, double
      - `documents` Document[]
        - `acceptor` Acceptor — recursive
        - `contentContentType` string
        - `description` string
        - `documentIdentifier` string
        - `documentKey` string
        - `documentStatus` 'CONFIRMED' | 'REJECTED'
        - `documentType` 'LOGO' | 'MENU' | 'PHOTO' | 'PHOTO_BUILDING' | 'DOCUMENT' | 'BANNER' | 'BANNER_LANDING' | 'BANNER_LANDING_DESKTOP' | 'ID_NATIONAL_CODE' | 'ID_IDENTITY_NUMBER' | 'ID_BUSINESS_LICENSE' | 'ID_SHEBA_CONFIRMATION' | 'ID_POSTAL_CODE' | 'ID_APG_CONTRACT' | 'ID_POS_CONTRACT' | 'ID_ACCEPTOR_CONFIRMATION' | 'ID_OTHERS', required
        - `id` integer
        - `makePublic` boolean
        - `paymentTool` PaymentTool
          - `acceptor` Acceptor, required — recursive
          - `accountBank` 'EGHTESAD_NOVID' | 'ANSAR' | 'IRAN_ZAMIN' | 'PARSIAN' | 'PASARGAD' | 'TAT' | 'TEJARAT' | 'TOSAE_TAVON' | 'TOSAE_SADERAT' | 'HEKMAT_IRANIAN' | 'DAY' | 'REFAH' | 'SAMAN' | 'SEPAH' | 'SARMAYEH' | 'SINA' | 'SHAHR' | 'SADERAT' | 'SANAT_O_MADAN' | 'MEHR' | 'GHAVAMIN' | 'KAR_AFARIN' | 'KESHAVARZI' | 'GARDESHGARI' | 'MARKAZI' | 'MASKAN' | 'MELLAT' | 'MELLI' | 'MEHR_EGHTESAD' | 'POST' | 'TOSAE' | 'KOSAR' | 'MIDDLE_EAST' | 'OTHER'
          - `accountBranch` string
          - `accountBranchCode` string
          - `accountName` string
          - `accountNumber` string
          - `accountSheba` string
          - `confirmed` boolean
          - `documents` Document[]
          - `id` integer
          - `merchant` string
          - `name` string
          - `password` string
          - `picked` boolean
          - `posType` 'GPRS' | 'TYPICAL' | 'LAN' | 'M' | 'PC' | 'WIFI'
          - `sent` boolean
          - `sentMessage` string
          - `serial` string
          - `terminal` string
          - `type` 'WALLET' | 'POS' | 'IPG', required
          - `username` string
        - `statusDescription` string
        - `uploadedOn` string, date-time, required
        - `validFrom` string, date
        - `validTo` string, date
      - `facilities` AcceptorFacility[]
        - `acceptor` Acceptor — recursive
        - `facility` Facility
          - `code` string, required
          - `id` integer
          - `name` string, required
        - `id` integer
      - `familyName` string
      - `familyNameEn` string
      - `fatherName` string
      - `gender` 'MALE' | 'FEMALE'
      - `givenName` string
      - `givenNameEn` string
      - `group` AcceptorGroup
        - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING', required
        - `id` integer
        - `name` string, required
      - `guild` AcceptorGuild
        - `code` string, required
        - `id` integer
        - `name` string
      - `hideUnregisteredUsersForFactor` boolean
      - `id` integer
      - `identityType` 'PERSON' | 'COMPANY'
      - `introducerPercentage` number, double
      - `kargozar` User
        - `activated` boolean, required
        - `clubCardNumber` integer
        - `clubCode` integer
        - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
        - `email` string
        - `firstName` string
        - `fullname` string
        - `gender` 'MALE' | 'FEMALE'
        - `id` integer
        - `imageUrl` string
        - `langKey` string
        - `lastName` string
        - `locked` boolean
        - `login` string, required
        - `mobile` string
        - `nickname` string
        - `notSystem` boolean
        - `originClubCode` integer
        - `persepolisi` boolean
        - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
        - `system` boolean
      - `makePublic` boolean
      - `maxDistance` number
      - `mobile` string
      - `nationalIdNumber` string
      - `nationality` 'IRANIAN' | 'FOREIGNER'
      - `noRawFee` boolean
      - `notifySdkPaymentUrl` boolean
      - `onboarded` boolean
      - `onlineShop` boolean
      - `ostan` Ostan
        - `amarCode` integer, required
        - `id` integer
        - `name` string, required
        - `phoneCode` string
      - `parent` Acceptor — recursive
      - `paymentTools` PaymentTool[]
        - `acceptor` Acceptor, required — recursive
        - `accountBank` 'EGHTESAD_NOVID' | 'ANSAR' | 'IRAN_ZAMIN' | 'PARSIAN' | 'PASARGAD' | 'TAT' | 'TEJARAT' | 'TOSAE_TAVON' | 'TOSAE_SADERAT' | 'HEKMAT_IRANIAN' | 'DAY' | 'REFAH' | 'SAMAN' | 'SEPAH' | 'SARMAYEH' | 'SINA' | 'SHAHR' | 'SADERAT' | 'SANAT_O_MADAN' | 'MEHR' | 'GHAVAMIN' | 'KAR_AFARIN' | 'KESHAVARZI' | 'GARDESHGARI' | 'MARKAZI' | 'MASKAN' | 'MELLAT' | 'MELLI' | 'MEHR_EGHTESAD' | 'POST' | 'TOSAE' | 'KOSAR' | 'MIDDLE_EAST' | 'OTHER'
        - `accountBranch` string
        - `accountBranchCode` string
        - `accountName` string
        - `accountNumber` string
        - `accountSheba` string
        - `confirmed` boolean
        - `documents` Document[]
          - `acceptor` Acceptor — recursive
          - `contentContentType` string
          - `description` string
          - `documentIdentifier` string
          - `documentKey` string
          - `documentStatus` 'CONFIRMED' | 'REJECTED'
          - `documentType` 'LOGO' | 'MENU' | 'PHOTO' | 'PHOTO_BUILDING' | 'DOCUMENT' | 'BANNER' | 'BANNER_LANDING' | 'BANNER_LANDING_DESKTOP' | 'ID_NATIONAL_CODE' | 'ID_IDENTITY_NUMBER' | 'ID_BUSINESS_LICENSE' | 'ID_SHEBA_CONFIRMATION' | 'ID_POSTAL_CODE' | 'ID_APG_CONTRACT' | 'ID_POS_CONTRACT' | 'ID_ACCEPTOR_CONFIRMATION' | 'ID_OTHERS', required
          - `id` integer
          - `makePublic` boolean
          - `paymentTool` PaymentTool — recursive
          - `statusDescription` string
          - `uploadedOn` string, date-time, required
          - `validFrom` string, date
          - `validTo` string, date
        - `id` integer
        - `merchant` string
        - `name` string
        - `password` string
        - `picked` boolean
        - `posType` 'GPRS' | 'TYPICAL' | 'LAN' | 'M' | 'PC' | 'WIFI'
        - `sent` boolean
        - `sentMessage` string
        - `serial` string
        - `terminal` string
        - `type` 'WALLET' | 'POS' | 'IPG', required
        - `username` string
      - `phone` string
      - `pickup` boolean
      - `pickupGap` integer
      - `platformDiscountPercentage` number, double
      - `postcode` string
      - `rank` integer
      - `rawFee` boolean
      - `rawFeeFixed` boolean
      - `rawFeePercentage` number
      - `referralCode` integer
      - `registrar` User
        - `activated` boolean, required
        - `clubCardNumber` integer
        - `clubCode` integer
        - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
        - `email` string
        - `firstName` string
        - `fullname` string
        - `gender` 'MALE' | 'FEMALE'
        - `id` integer
        - `imageUrl` string
        - `langKey` string
        - `lastName` string
        - `locked` boolean
        - `login` string, required
        - `mobile` string
        - `nickname` string
        - `notSystem` boolean
        - `originClubCode` integer
        - `persepolisi` boolean
        - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
        - `system` boolean
      - `registrarType` 'USER' | 'OWNER' | 'EMPLOYEE'
      - `registrationDate` string
      - `registrationNumber` string
      - `shahr` Shahr
        - `amarCode` integer, required
        - `bakhsh` Bakhsh, required
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `ostan` Ostan, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `phoneCode` string
          - `shahrestan` Shahrestan, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `ostan` Ostan, required
              - …
        - `id` integer
        - `name` string, required
        - `ostan` Ostan, required
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `phoneCode` string
        - `shahrType` integer
        - `shahrestan` Shahrestan, required
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `ostan` Ostan, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `phoneCode` string
        - `shaparakCode` string
      - `shortDescription` string
      - `soldSum` number
      - `state` string
      - `status` 'REQUESTED' | 'CONFIRMED' | 'DOCUMENT_INCOMPLETE' | 'DOCUMENT_CONFIRMED' | 'DOCUMENT_SENT' | 'NEEDTOREVIEW' | 'COMPLETE_PROFILE' | 'ACTIVE' | 'INACTIVE' | 'SYSTEM' | 'EXPIRED' | 'NOTRANSACTION' | 'CLOSED' | 'ORGANIZATIONAL' | 'BUILDING'
      - `storeType` 'VIRTUAL' | 'PHYSICAL'
      - `subGroup` AcceptorSubGroup
        - `group` AcceptorGroup, required
          - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING', required
          - `id` integer
          - `name` string, required
        - `id` integer
        - `name` string, required
      - `subGuild` AcceptorSubGuild
        - `code` string, required
        - `guild` AcceptorGuild, required
          - `code` string, required
          - `id` integer
          - `name` string
        - `id` integer
        - `name` string
      - `tables` boolean
      - `targetGroup` 'MALE' | 'FEMALE' | 'UNISEX'
      - `tax` boolean
      - `taxCode` string
      - `taxRaw` boolean
      - `terminalSecond` boolean
      - `terminalSecondId` string
      - `tradingHours` TradingHours
        - `fri` string
        - `id` integer
        - `mon` string
        - `name` string
        - `publicHolidays` string
        - `sat` string
        - `sun` string
        - `thu` string
        - `tue` string
        - `wed` string
      - `user` User
        - `activated` boolean, required
        - `clubCardNumber` integer
        - `clubCode` integer
        - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
        - `email` string
        - `firstName` string
        - `fullname` string
        - `gender` 'MALE' | 'FEMALE'
        - `id` integer
        - `imageUrl` string
        - `langKey` string
        - `lastName` string
        - `locked` boolean
        - `login` string, required
        - `mobile` string
        - `nickname` string
        - `notSystem` boolean
        - `originClubCode` integer
        - `persepolisi` boolean
        - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
        - `system` boolean
      - `visible` boolean
    - `smallLogo` File
      - `contentType` string
      - `id` integer
      - `path` string
      - `publicId` string, required
      - `type` 'PHOTO' | 'DOCUMENT' | 'AVATAR', required
    - `theme` string
    - `type` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
    - `valid` boolean
    - `voucher` number
    - `voucherType` boolean
  - `currency` 'IRR', required
  - `description` string
  - `groupTransferInstance` GroupTransferInstance
    - `id` integer
    - `name` string
    - `owner` User
      - `activated` boolean, required
      - `clubCardNumber` integer
      - `clubCode` integer
      - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
      - `email` string
      - `firstName` string
      - `fullname` string
      - `gender` 'MALE' | 'FEMALE'
      - `id` integer
      - `imageUrl` string
      - `langKey` string
      - `lastName` string
      - `locked` boolean
      - `login` string, required
      - `mobile` string
      - `nickname` string
      - `notSystem` boolean
      - `originClubCode` integer
      - `persepolisi` boolean
      - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
      - `system` boolean
    - `ownera` Acceptor
      - `acceptorName` string
      - `acceptorNameEn` string
      - `active` boolean
      - `address` string
      - `addressEn` string
      - `anonymousPay` boolean
      - `apgCallbackUrl` string
      - `apgSecond` boolean
      - `birthCertDigit` string
      - `birthCertLetter` string
      - `birthCertNumber` string
      - `birthCertSeriesNumber` string
      - `cashoutVip` boolean
      - `centerUpdatableByOwner` boolean
      - `city` string
      - `code` string
      - `companyName` string
      - `companyNationalId` string
      - `contacts` AcceptorContact[]
        - `acceptor` Acceptor — recursive
        - `contactType` 'TELEGRAM' | 'INSTAGRAM' | 'FACEBOOK' | 'LINKEDIN' | 'TWITTER' | 'WHATSAPP' | 'EMAIL' | 'ADDRESS' | 'COORDINATES' | 'TELEPHONE' | 'MOBILE' | 'WEBSITE', required
        - `id` integer
        - `value` string
      - `contractSignDate` string, date
      - `contractSignDateJalali` string
      - `couponCreationFeePercentage` number
      - `dateOfBirth` string
      - `delivery` boolean
      - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING'
      - `departmentRestaurant` boolean
      - `description` string
      - `discountPercentage` number, double
      - `documents` Document[]
        - `acceptor` Acceptor — recursive
        - `contentContentType` string
        - `description` string
        - `documentIdentifier` string
        - `documentKey` string
        - `documentStatus` 'CONFIRMED' | 'REJECTED'
        - `documentType` 'LOGO' | 'MENU' | 'PHOTO' | 'PHOTO_BUILDING' | 'DOCUMENT' | 'BANNER' | 'BANNER_LANDING' | 'BANNER_LANDING_DESKTOP' | 'ID_NATIONAL_CODE' | 'ID_IDENTITY_NUMBER' | 'ID_BUSINESS_LICENSE' | 'ID_SHEBA_CONFIRMATION' | 'ID_POSTAL_CODE' | 'ID_APG_CONTRACT' | 'ID_POS_CONTRACT' | 'ID_ACCEPTOR_CONFIRMATION' | 'ID_OTHERS', required
        - `id` integer
        - `makePublic` boolean
        - `paymentTool` PaymentTool
          - `acceptor` Acceptor, required — recursive
          - `accountBank` 'EGHTESAD_NOVID' | 'ANSAR' | 'IRAN_ZAMIN' | 'PARSIAN' | 'PASARGAD' | 'TAT' | 'TEJARAT' | 'TOSAE_TAVON' | 'TOSAE_SADERAT' | 'HEKMAT_IRANIAN' | 'DAY' | 'REFAH' | 'SAMAN' | 'SEPAH' | 'SARMAYEH' | 'SINA' | 'SHAHR' | 'SADERAT' | 'SANAT_O_MADAN' | 'MEHR' | 'GHAVAMIN' | 'KAR_AFARIN' | 'KESHAVARZI' | 'GARDESHGARI' | 'MARKAZI' | 'MASKAN' | 'MELLAT' | 'MELLI' | 'MEHR_EGHTESAD' | 'POST' | 'TOSAE' | 'KOSAR' | 'MIDDLE_EAST' | 'OTHER'
          - `accountBranch` string
          - `accountBranchCode` string
          - `accountName` string
          - `accountNumber` string
          - `accountSheba` string
          - `confirmed` boolean
          - `documents` Document[]
          - `id` integer
          - `merchant` string
          - `name` string
          - `password` string
          - `picked` boolean
          - `posType` 'GPRS' | 'TYPICAL' | 'LAN' | 'M' | 'PC' | 'WIFI'
          - `sent` boolean
          - `sentMessage` string
          - `serial` string
          - `terminal` string
          - `type` 'WALLET' | 'POS' | 'IPG', required
          - `username` string
        - `statusDescription` string
        - `uploadedOn` string, date-time, required
        - `validFrom` string, date
        - `validTo` string, date
      - `facilities` AcceptorFacility[]
        - `acceptor` Acceptor — recursive
        - `facility` Facility
          - `code` string, required
          - `id` integer
          - `name` string, required
        - `id` integer
      - `familyName` string
      - `familyNameEn` string
      - `fatherName` string
      - `gender` 'MALE' | 'FEMALE'
      - `givenName` string
      - `givenNameEn` string
      - `group` AcceptorGroup
        - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING', required
        - `id` integer
        - `name` string, required
      - `guild` AcceptorGuild
        - `code` string, required
        - `id` integer
        - `name` string
      - `hideUnregisteredUsersForFactor` boolean
      - `id` integer
      - `identityType` 'PERSON' | 'COMPANY'
      - `introducerPercentage` number, double
      - `kargozar` User
        - `activated` boolean, required
        - `clubCardNumber` integer
        - `clubCode` integer
        - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
        - `email` string
        - `firstName` string
        - `fullname` string
        - `gender` 'MALE' | 'FEMALE'
        - `id` integer
        - `imageUrl` string
        - `langKey` string
        - `lastName` string
        - `locked` boolean
        - `login` string, required
        - `mobile` string
        - `nickname` string
        - `notSystem` boolean
        - `originClubCode` integer
        - `persepolisi` boolean
        - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
        - `system` boolean
      - `makePublic` boolean
      - `maxDistance` number
      - `mobile` string
      - `nationalIdNumber` string
      - `nationality` 'IRANIAN' | 'FOREIGNER'
      - `noRawFee` boolean
      - `notifySdkPaymentUrl` boolean
      - `onboarded` boolean
      - `onlineShop` boolean
      - `ostan` Ostan
        - `amarCode` integer, required
        - `id` integer
        - `name` string, required
        - `phoneCode` string
      - `parent` Acceptor — recursive
      - `paymentTools` PaymentTool[]
        - `acceptor` Acceptor, required — recursive
        - `accountBank` 'EGHTESAD_NOVID' | 'ANSAR' | 'IRAN_ZAMIN' | 'PARSIAN' | 'PASARGAD' | 'TAT' | 'TEJARAT' | 'TOSAE_TAVON' | 'TOSAE_SADERAT' | 'HEKMAT_IRANIAN' | 'DAY' | 'REFAH' | 'SAMAN' | 'SEPAH' | 'SARMAYEH' | 'SINA' | 'SHAHR' | 'SADERAT' | 'SANAT_O_MADAN' | 'MEHR' | 'GHAVAMIN' | 'KAR_AFARIN' | 'KESHAVARZI' | 'GARDESHGARI' | 'MARKAZI' | 'MASKAN' | 'MELLAT' | 'MELLI' | 'MEHR_EGHTESAD' | 'POST' | 'TOSAE' | 'KOSAR' | 'MIDDLE_EAST' | 'OTHER'
        - `accountBranch` string
        - `accountBranchCode` string
        - `accountName` string
        - `accountNumber` string
        - `accountSheba` string
        - `confirmed` boolean
        - `documents` Document[]
          - `acceptor` Acceptor — recursive
          - `contentContentType` string
          - `description` string
          - `documentIdentifier` string
          - `documentKey` string
          - `documentStatus` 'CONFIRMED' | 'REJECTED'
          - `documentType` 'LOGO' | 'MENU' | 'PHOTO' | 'PHOTO_BUILDING' | 'DOCUMENT' | 'BANNER' | 'BANNER_LANDING' | 'BANNER_LANDING_DESKTOP' | 'ID_NATIONAL_CODE' | 'ID_IDENTITY_NUMBER' | 'ID_BUSINESS_LICENSE' | 'ID_SHEBA_CONFIRMATION' | 'ID_POSTAL_CODE' | 'ID_APG_CONTRACT' | 'ID_POS_CONTRACT' | 'ID_ACCEPTOR_CONFIRMATION' | 'ID_OTHERS', required
          - `id` integer
          - `makePublic` boolean
          - `paymentTool` PaymentTool — recursive
          - `statusDescription` string
          - `uploadedOn` string, date-time, required
          - `validFrom` string, date
          - `validTo` string, date
        - `id` integer
        - `merchant` string
        - `name` string
        - `password` string
        - `picked` boolean
        - `posType` 'GPRS' | 'TYPICAL' | 'LAN' | 'M' | 'PC' | 'WIFI'
        - `sent` boolean
        - `sentMessage` string
        - `serial` string
        - `terminal` string
        - `type` 'WALLET' | 'POS' | 'IPG', required
        - `username` string
      - `phone` string
      - `pickup` boolean
      - `pickupGap` integer
      - `platformDiscountPercentage` number, double
      - `postcode` string
      - `rank` integer
      - `rawFee` boolean
      - `rawFeeFixed` boolean
      - `rawFeePercentage` number
      - `referralCode` integer
      - `registrar` User
        - `activated` boolean, required
        - `clubCardNumber` integer
        - `clubCode` integer
        - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
        - `email` string
        - `firstName` string
        - `fullname` string
        - `gender` 'MALE' | 'FEMALE'
        - `id` integer
        - `imageUrl` string
        - `langKey` string
        - `lastName` string
        - `locked` boolean
        - `login` string, required
        - `mobile` string
        - `nickname` string
        - `notSystem` boolean
        - `originClubCode` integer
        - `persepolisi` boolean
        - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
        - `system` boolean
      - `registrarType` 'USER' | 'OWNER' | 'EMPLOYEE'
      - `registrationDate` string
      - `registrationNumber` string
      - `shahr` Shahr
        - `amarCode` integer, required
        - `bakhsh` Bakhsh, required
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `ostan` Ostan, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `phoneCode` string
          - `shahrestan` Shahrestan, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `ostan` Ostan, required
              - …
        - `id` integer
        - `name` string, required
        - `ostan` Ostan, required
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `phoneCode` string
        - `shahrType` integer
        - `shahrestan` Shahrestan, required
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `ostan` Ostan, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `phoneCode` string
        - `shaparakCode` string
      - `shortDescription` string
      - `soldSum` number
      - `state` string
      - `status` 'REQUESTED' | 'CONFIRMED' | 'DOCUMENT_INCOMPLETE' | 'DOCUMENT_CONFIRMED' | 'DOCUMENT_SENT' | 'NEEDTOREVIEW' | 'COMPLETE_PROFILE' | 'ACTIVE' | 'INACTIVE' | 'SYSTEM' | 'EXPIRED' | 'NOTRANSACTION' | 'CLOSED' | 'ORGANIZATIONAL' | 'BUILDING'
      - `storeType` 'VIRTUAL' | 'PHYSICAL'
      - `subGroup` AcceptorSubGroup
        - `group` AcceptorGroup, required
          - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING', required
          - `id` integer
          - `name` string, required
        - `id` integer
        - `name` string, required
      - `subGuild` AcceptorSubGuild
        - `code` string, required
        - `guild` AcceptorGuild, required
          - `code` string, required
          - `id` integer
          - `name` string
        - `id` integer
        - `name` string
      - `tables` boolean
      - `targetGroup` 'MALE' | 'FEMALE' | 'UNISEX'
      - `tax` boolean
      - `taxCode` string
      - `taxRaw` boolean
      - `terminalSecond` boolean
      - `terminalSecondId` string
      - `tradingHours` TradingHours
        - `fri` string
        - `id` integer
        - `mon` string
        - `name` string
        - `publicHolidays` string
        - `sat` string
        - `sun` string
        - `thu` string
        - `tue` string
        - `wed` string
      - `user` User
        - `activated` boolean, required
        - `clubCardNumber` integer
        - `clubCode` integer
        - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
        - `email` string
        - `firstName` string
        - `fullname` string
        - `gender` 'MALE' | 'FEMALE'
        - `id` integer
        - `imageUrl` string
        - `langKey` string
        - `lastName` string
        - `locked` boolean
        - `login` string, required
        - `mobile` string
        - `nickname` string
        - `notSystem` boolean
        - `originClubCode` integer
        - `persepolisi` boolean
        - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
        - `system` boolean
      - `visible` boolean
    - `receiverDescription` string
    - `senderDescription` string
    - `template` GroupTransferTemplate
      - `id` integer
      - `name` string, required
      - `order` integer
      - `owner` User
        - `activated` boolean, required
        - `clubCardNumber` integer
        - `clubCode` integer
        - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
        - `email` string
        - `firstName` string
        - `fullname` string
        - `gender` 'MALE' | 'FEMALE'
        - `id` integer
        - `imageUrl` string
        - `langKey` string
        - `lastName` string
        - `locked` boolean
        - `login` string, required
        - `mobile` string
        - `nickname` string
        - `notSystem` boolean
        - `originClubCode` integer
        - `persepolisi` boolean
        - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
        - `system` boolean
      - `ownera` Acceptor
        - `acceptorName` string
        - `acceptorNameEn` string
        - `active` boolean
        - `address` string
        - `addressEn` string
        - `anonymousPay` boolean
        - `apgCallbackUrl` string
        - `apgSecond` boolean
        - `birthCertDigit` string
        - `birthCertLetter` string
        - `birthCertNumber` string
        - `birthCertSeriesNumber` string
        - `cashoutVip` boolean
        - `centerUpdatableByOwner` boolean
        - `city` string
        - `code` string
        - `companyName` string
        - `companyNationalId` string
        - `contacts` AcceptorContact[]
          - `acceptor` Acceptor — recursive
          - `contactType` 'TELEGRAM' | 'INSTAGRAM' | 'FACEBOOK' | 'LINKEDIN' | 'TWITTER' | 'WHATSAPP' | 'EMAIL' | 'ADDRESS' | 'COORDINATES' | 'TELEPHONE' | 'MOBILE' | 'WEBSITE', required
          - `id` integer
          - `value` string
        - `contractSignDate` string, date
        - `contractSignDateJalali` string
        - `couponCreationFeePercentage` number
        - `dateOfBirth` string
        - `delivery` boolean
        - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING'
        - `departmentRestaurant` boolean
        - `description` string
        - `discountPercentage` number, double
        - `documents` Document[]
          - `acceptor` Acceptor — recursive
          - `contentContentType` string
          - `description` string
          - `documentIdentifier` string
          - `documentKey` string
          - `documentStatus` 'CONFIRMED' | 'REJECTED'
          - `documentType` 'LOGO' | 'MENU' | 'PHOTO' | 'PHOTO_BUILDING' | 'DOCUMENT' | 'BANNER' | 'BANNER_LANDING' | 'BANNER_LANDING_DESKTOP' | 'ID_NATIONAL_CODE' | 'ID_IDENTITY_NUMBER' | 'ID_BUSINESS_LICENSE' | 'ID_SHEBA_CONFIRMATION' | 'ID_POSTAL_CODE' | 'ID_APG_CONTRACT' | 'ID_POS_CONTRACT' | 'ID_ACCEPTOR_CONFIRMATION' | 'ID_OTHERS', required
          - `id` integer
          - `makePublic` boolean
          - `paymentTool` PaymentTool
            - `acceptor` Acceptor, required — recursive
            - `accountBank` 'EGHTESAD_NOVID' | 'ANSAR' | 'IRAN_ZAMIN' | 'PARSIAN' | 'PASARGAD' | 'TAT' | 'TEJARAT' | 'TOSAE_TAVON' | 'TOSAE_SADERAT' | 'HEKMAT_IRANIAN' | 'DAY' | 'REFAH' | 'SAMAN' | 'SEPAH' | 'SARMAYEH' | 'SINA' | 'SHAHR' | 'SADERAT' | 'SANAT_O_MADAN' | 'MEHR' | 'GHAVAMIN' | 'KAR_AFARIN' | 'KESHAVARZI' | 'GARDESHGARI' | 'MARKAZI' | 'MASKAN' | 'MELLAT' | 'MELLI' | 'MEHR_EGHTESAD' | 'POST' | 'TOSAE' | 'KOSAR' | 'MIDDLE_EAST' | 'OTHER'
            - `accountBranch` string
            - `accountBranchCode` string
            - `accountName` string
            - `accountNumber` string
            - `accountSheba` string
            - `confirmed` boolean
            - `documents` Document[]
            - `id` integer
            - `merchant` string
            - `name` string
            - `password` string
            - `picked` boolean
            - `posType` 'GPRS' | 'TYPICAL' | 'LAN' | 'M' | 'PC' | 'WIFI'
            - `sent` boolean
            - `sentMessage` string
            - `serial` string
            - `terminal` string
            - `type` 'WALLET' | 'POS' | 'IPG', required
            - `username` string
          - `statusDescription` string
          - `uploadedOn` string, date-time, required
          - `validFrom` string, date
          - `validTo` string, date
        - `facilities` AcceptorFacility[]
          - `acceptor` Acceptor — recursive
          - `facility` Facility
            - `code` string, required
            - `id` integer
            - `name` string, required
          - `id` integer
        - `familyName` string
        - `familyNameEn` string
        - `fatherName` string
        - `gender` 'MALE' | 'FEMALE'
        - `givenName` string
        - `givenNameEn` string
        - `group` AcceptorGroup
          - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING', required
          - `id` integer
          - `name` string, required
        - `guild` AcceptorGuild
          - `code` string, required
          - `id` integer
          - `name` string
        - `hideUnregisteredUsersForFactor` boolean
        - `id` integer
        - `identityType` 'PERSON' | 'COMPANY'
        - `introducerPercentage` number, double
        - `kargozar` User
          - `activated` boolean, required
          - `clubCardNumber` integer
          - `clubCode` integer
          - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
          - `email` string
          - `firstName` string
          - `fullname` string
          - `gender` 'MALE' | 'FEMALE'
          - `id` integer
          - `imageUrl` string
          - `langKey` string
          - `lastName` string
          - `locked` boolean
          - `login` string, required
          - `mobile` string
          - `nickname` string
          - `notSystem` boolean
          - `originClubCode` integer
          - `persepolisi` boolean
          - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
          - `system` boolean
        - `makePublic` boolean
        - `maxDistance` number
        - `mobile` string
        - `nationalIdNumber` string
        - `nationality` 'IRANIAN' | 'FOREIGNER'
        - `noRawFee` boolean
        - `notifySdkPaymentUrl` boolean
        - `onboarded` boolean
        - `onlineShop` boolean
        - `ostan` Ostan
          - `amarCode` integer, required
          - `id` integer
          - `name` string, required
          - `phoneCode` string
        - `parent` Acceptor — recursive
        - `paymentTools` PaymentTool[]
          - `acceptor` Acceptor, required — recursive
          - `accountBank` 'EGHTESAD_NOVID' | 'ANSAR' | 'IRAN_ZAMIN' | 'PARSIAN' | 'PASARGAD' | 'TAT' | 'TEJARAT' | 'TOSAE_TAVON' | 'TOSAE_SADERAT' | 'HEKMAT_IRANIAN' | 'DAY' | 'REFAH' | 'SAMAN' | 'SEPAH' | 'SARMAYEH' | 'SINA' | 'SHAHR' | 'SADERAT' | 'SANAT_O_MADAN' | 'MEHR' | 'GHAVAMIN' | 'KAR_AFARIN' | 'KESHAVARZI' | 'GARDESHGARI' | 'MARKAZI' | 'MASKAN' | 'MELLAT' | 'MELLI' | 'MEHR_EGHTESAD' | 'POST' | 'TOSAE' | 'KOSAR' | 'MIDDLE_EAST' | 'OTHER'
          - `accountBranch` string
          - `accountBranchCode` string
          - `accountName` string
          - `accountNumber` string
          - `accountSheba` string
          - `confirmed` boolean
          - `documents` Document[]
            - `acceptor` Acceptor — recursive
            - `contentContentType` string
            - `description` string
            - `documentIdentifier` string
            - `documentKey` string
            - `documentStatus` 'CONFIRMED' | 'REJECTED'
            - `documentType` 'LOGO' | 'MENU' | 'PHOTO' | 'PHOTO_BUILDING' | 'DOCUMENT' | 'BANNER' | 'BANNER_LANDING' | 'BANNER_LANDING_DESKTOP' | 'ID_NATIONAL_CODE' | 'ID_IDENTITY_NUMBER' | 'ID_BUSINESS_LICENSE' | 'ID_SHEBA_CONFIRMATION' | 'ID_POSTAL_CODE' | 'ID_APG_CONTRACT' | 'ID_POS_CONTRACT' | 'ID_ACCEPTOR_CONFIRMATION' | 'ID_OTHERS', required
            - `id` integer
            - `makePublic` boolean
            - `paymentTool` PaymentTool — recursive
            - `statusDescription` string
            - `uploadedOn` string, date-time, required
            - `validFrom` string, date
            - `validTo` string, date
          - `id` integer
          - `merchant` string
          - `name` string
          - `password` string
          - `picked` boolean
          - `posType` 'GPRS' | 'TYPICAL' | 'LAN' | 'M' | 'PC' | 'WIFI'
          - `sent` boolean
          - `sentMessage` string
          - `serial` string
          - `terminal` string
          - `type` 'WALLET' | 'POS' | 'IPG', required
          - `username` string
        - `phone` string
        - `pickup` boolean
        - `pickupGap` integer
        - `platformDiscountPercentage` number, double
        - `postcode` string
        - `rank` integer
        - `rawFee` boolean
        - `rawFeeFixed` boolean
        - `rawFeePercentage` number
        - `referralCode` integer
        - `registrar` User
          - `activated` boolean, required
          - `clubCardNumber` integer
          - `clubCode` integer
          - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
          - `email` string
          - `firstName` string
          - `fullname` string
          - `gender` 'MALE' | 'FEMALE'
          - `id` integer
          - `imageUrl` string
          - `langKey` string
          - `lastName` string
          - `locked` boolean
          - `login` string, required
          - `mobile` string
          - `nickname` string
          - `notSystem` boolean
          - `originClubCode` integer
          - `persepolisi` boolean
          - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
          - `system` boolean
        - `registrarType` 'USER' | 'OWNER' | 'EMPLOYEE'
        - `registrationDate` string
        - `registrationNumber` string
        - `shahr` Shahr
          - `amarCode` integer, required
          - `bakhsh` Bakhsh, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `ostan` Ostan, required
              - …
            - `shahrestan` Shahrestan, required
              - …
          - `id` integer
          - `name` string, required
          - `ostan` Ostan, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `phoneCode` string
          - `shahrType` integer
          - `shahrestan` Shahrestan, required
            - `amarCode` integer, required
            - `id` integer
            - `name` string, required
            - `ostan` Ostan, required
              - …
          - `shaparakCode` string
        - `shortDescription` string
        - `soldSum` number
        - `state` string
        - `status` 'REQUESTED' | 'CONFIRMED' | 'DOCUMENT_INCOMPLETE' | 'DOCUMENT_CONFIRMED' | 'DOCUMENT_SENT' | 'NEEDTOREVIEW' | 'COMPLETE_PROFILE' | 'ACTIVE' | 'INACTIVE' | 'SYSTEM' | 'EXPIRED' | 'NOTRANSACTION' | 'CLOSED' | 'ORGANIZATIONAL' | 'BUILDING'
        - `storeType` 'VIRTUAL' | 'PHYSICAL'
        - `subGroup` AcceptorSubGroup
          - `group` AcceptorGroup, required
            - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING', required
            - `id` integer
            - `name` string, required
          - `id` integer
          - `name` string, required
        - `subGuild` AcceptorSubGuild
          - `code` string, required
          - `guild` AcceptorGuild, required
            - `code` string, required
            - `id` integer
            - `name` string
          - `id` integer
          - `name` string
        - `tables` boolean
        - `targetGroup` 'MALE' | 'FEMALE' | 'UNISEX'
        - `tax` boolean
        - `taxCode` string
        - `taxRaw` boolean
        - `terminalSecond` boolean
        - `terminalSecondId` string
        - `tradingHours` TradingHours
          - `fri` string
          - `id` integer
          - `mon` string
          - `name` string
          - `publicHolidays` string
          - `sat` string
          - `sun` string
          - `thu` string
          - `tue` string
          - `wed` string
        - `user` User
          - `activated` boolean, required
          - `clubCardNumber` integer
          - `clubCode` integer
          - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
          - `email` string
          - `firstName` string
          - `fullname` string
          - `gender` 'MALE' | 'FEMALE'
          - `id` integer
          - `imageUrl` string
          - `langKey` string
          - `lastName` string
          - `locked` boolean
          - `login` string, required
          - `mobile` string
          - `nickname` string
          - `notSystem` boolean
          - `originClubCode` integer
          - `persepolisi` boolean
          - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
          - `system` boolean
        - `visible` boolean
      - `receiverDescription` string
      - `senderDescription` string
  - `id` integer
  - `refEvent` integer
  - `refPayment` integer
  - `refType` 'CASHIN' | 'CASHIN_IDENTITY' | 'SELL_SCORE' | 'SELL_PLAN' | 'SETTLEMENT' | 'REFUND_VOUCHER' | 'TRANSFER_OPERATION_COST' | 'NOT_REGISTERED_CUSTOMER_OPERATION_COST' | 'BILL_WAGE' | 'SELL_VOUCHER' | 'TRANSFER' | 'MOBILE_CHARGE' | 'INTERNET_CHARGE' | 'AYRIA_PAYMENT' | 'TIP' | 'CONVERTED_SCORE' | 'CASHOUT' | 'REFUND_CASHOUT' | 'PURCHASE' | 'GROUP_TRANSFER_OPERATION_COST' | 'BALANCE_CORRECTION' | 'PURCHASE_SCORE' | 'PAY_BILL' | 'PURCHASE_VOUCHER' | 'CASHOUT_VIP' | 'COUPON_CENTER_DEPOSIT' | 'COUPON_CENTER_WITHDRAW' | 'COUPON_SHARE'
  - `transferType` 'DEBIT' | 'DEBT' | 'GIFT' | 'SALARY' | 'CASH_MANAGEMENT' | 'BUY' | 'OTHER'
  - `user` User
    - `activated` boolean, required
    - `clubCardNumber` integer
    - `clubCode` integer
    - `clubType` 'AYRIA' | 'PERSEPOLIS' | 'KARAFARIN' | 'BIMEHKHAVARMIYANE'
    - `email` string
    - `firstName` string
    - `fullname` string
    - `gender` 'MALE' | 'FEMALE'
    - `id` integer
    - `imageUrl` string
    - `langKey` string
    - `lastName` string
    - `locked` boolean
    - `login` string, required
    - `mobile` string
    - `nickname` string
    - `notSystem` boolean
    - `originClubCode` integer
    - `persepolisi` boolean
    - `plan` 'BASIC' | 'GOLD' | 'STAR' | 'GALAXY'
    - `system` boolean

## Response `200`

OK

## Other responses

- `201` — Created
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.dev/ayriaclub/apis/ayria-api.md) · [All operations](https://skmtc.dev/ayriaclub/apis/ayria-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ayriaclub/ayria-api/revisions/097cded81400/schema)