---
title: "Transfer Group Points"
method: POST
path: "/points/userGroup2/transfer"
---

# Transfer Group Points

`POST /points/userGroup2/transfer`

Lets you transfer points from one account to another account - group to customer, customer to group, or group to group.

## Request body

- object
  - `pointsTobeTransferred` integer, required — Number of points to be transferred.
  - `programId` integer, required — Program ID from which points has to be transferred. Applicable for multi-program orgs.
  - `groupProgramTransfer` boolean — Pass true to transfer group points.
  - `notes` string — A short note on the points transfer.
  - `transferredBy` object — Source account from which points need to be transferred. This field is mandatory. Note: This field is optional when transferring points from an individual to a group..
    - `identifierType` string, required — Identifier type used to identify the group or customer. <br>Supported values for customer: mobile, email, externalId, cardnumber, wechat, martjackId, fbId. <br>Supported values for group: id, externalId, primaryUserId, primaryUserCardnumber, primaryUserMobile, primaryUserEmail.
    - `identifierValue` string, required — Value of the specified identifier type.
    - `source` string — Source in which the customer account is available. Value: FACEBOOK, WEB_ENGAGE, WECHAT, INSTORE, MARTJACK, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, MOBILE_APP. Required for customer entity.
    - `accountId` string — Account ID for sources with multiple account IDs.
  - `toEntity` object — Details of destination account.
    - `type` 'CUSTOMER' | 'USERGROUP2', required — Identifier type used to identify the customer.
    - `identifierType` string, required — Identifier type to identify customer or group. Supported values for customer: mobile, email, externalId, cardnumber, wechat, martjackId, fbId. Supported values for group: id, externalId, primaryUserId, primaryUserCardnumber, primaryUserMobile, primaryUserEmail.
    - `identifierValue` string, required — Value of the specified identifierType.
  - `toEntry` object
    - `source` string — Source in which the customer account is available. Value: FACEBOOK, WEB_ENGAGE, WECHAT, INSTORE, MARTJACK, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, MOBILE_APP. Required for customer entity.
    - `accountId` string — Account ID for sources with multiple accounts.
  - `code` string — Pass the OTP received by the fromCustomer for the current points transfer. To issue OTP, use either /isPointsTransferrable or /issuePointsTransferOtp.
  - `fromEntity` object — Details of the source account.
    - `type` 'CUSTOMER' | 'USERGROUP2' — Type of the entry.
    - `identifierType` string — Identifier type to identify customer or group. Supported values for customer: mobile, email, externalId, cardnumber, wechat, martjackId, fbId. Supported values for group: id, externalId, primaryUserId, primaryUserCardnumber, primaryUserMobile, primaryUserEmail.
    - `identifierValue` string — Value of the specified identifierType.

## Response `200`

200

- union
  - object
    - `data` object[]
      - `toEntityId` integer
      - `toEntityType` string
      - `fromEntityId` integer
      - `fromEntityType` string
      - `pointsTransferDate` string
      - `pointsTransferred` integer
      - `transferId` integer
      - `transferType` string
      - `transferredTo` object
        - `userId` integer
        - `firstName` string
        - `lastName` string
      - `transferredFromUserGroup2` object
        - `id` integer
        - `groupStatus` string
        - `fleetGroupUsers` object[]
          - `userId` integer
          - `groupId` integer
          - `defaultGroup` boolean
          - `active` boolean
          - `primaryMember` boolean
        - `createdBy` integer
        - `createdOn` string
        - `lifeTimePurchases` integer
      - `notes` string
      - `programName` string
      - `pointsTransferBreakupByEarningPrograms` object[]
        - `programId` integer
        - `deductedPoints` integer
        - `programCurrentPoints` integer
    - `warnings` unknown[]
      - unknown
    - `errors` unknown[]
      - unknown
  - object
    - `warnings` unknown[]
      - unknown
    - `errors` object[]
      - `status` boolean
      - `code` integer
      - `message` string
  - object
    - `warnings` unknown[]
      - unknown
    - `errors` object[]
      - `status` boolean
      - `code` integer
      - `message` string

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)