> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Money Buff Reference

Describes the fields within models/actions whose parameters can be adjusted when applying buffs with GS2-Buff, and how to configure the scope in which those buffs are applied.




{{% alert title="Note" color="info" %}}
See [BuffEntryModel](api_reference/buff/master_data/#buffentrymodel) for more information on the buff entry model.
{{% /alert %}}
## Action
Types of actions that can apply buffs

### Gs2Money:DepositByUserId
Deposit balance to Wallet by User ID

Adds the specified amount of currency to the wallet for the specified user.
If the price is 0, it is treated as free currency; otherwise, it is treated as paid currency.


#### Target fields for buff application

##### count


[Wallet - Wallet](../sdk#wallet)



|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| count | int |  | ✓|  | 1 ~ 2147483646 | Quantity of premium currency to be granted |


##### Example Master Data



**JSON**
```json
"targetAction": {
    "targetActionName": "Gs2Money:DepositByUserId",
    "targetFieldName": "count",
    "conditionGrns": [
    ],
    "rate": 1.0
}
```

#### Buff Application Condition Model

##### Gs2Money:Wallet


Wallet


##### Example Master Data


**JSON**
```json
"conditionGrns": [
    {
        "targetModelName": "Gs2Money:Wallet",
        "targetGrn": "grn:gs2:{region}:{ownerId}:money:{namespaceName}:user:{userId}:wallet:{slot}"
    }
]
```



---

### Gs2Money:Withdraw
Consume balance from wallet

Withdraws the specified amount of currency from the wallet for the requesting user.
If paidOnly is false, free currency is consumed first, then paid currency. If paidOnly is true, only paid currency is consumed.
The response includes the price of the consumed currency.


#### Target fields for buff application

##### count


[Wallet - Wallet](../sdk#wallet)



|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| count | int |  | ✓|  | 1 ~ 2147483646 | Quantity of premium currency to be consumed |


##### Example Master Data



**JSON**
```json
"targetAction": {
    "targetActionName": "Gs2Money:Withdraw",
    "targetFieldName": "count",
    "conditionGrns": [
    ],
    "rate": 1.0
}
```

#### Buff Application Condition Model

##### Gs2Money:Wallet


Wallet


##### Example Master Data


**JSON**
```json
"conditionGrns": [
    {
        "targetModelName": "Gs2Money:Wallet",
        "targetGrn": "grn:gs2:{region}:{ownerId}:money:{namespaceName}:user:{userId}:wallet:{slot}"
    }
]
```



---

### Gs2Money:WithdrawByUserId
Consume balance from Wallet by User ID

Withdraws the specified amount of currency from the wallet for the specified user.
If paidOnly is false, free currency is consumed first, then paid currency.


#### Target fields for buff application

##### count


[Wallet - Wallet](../sdk#wallet)



|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| count | int |  | ✓|  | 1 ~ 2147483646 | Quantity of premium currency to be consumed |


##### Example Master Data



**JSON**
```json
"targetAction": {
    "targetActionName": "Gs2Money:WithdrawByUserId",
    "targetFieldName": "count",
    "conditionGrns": [
    ],
    "rate": 1.0
}
```

#### Buff Application Condition Model

##### Gs2Money:Wallet


Wallet


##### Example Master Data


**JSON**
```json
"conditionGrns": [
    {
        "targetModelName": "Gs2Money:Wallet",
        "targetGrn": "grn:gs2:{region}:{ownerId}:money:{namespaceName}:user:{userId}:wallet:{slot}"
    }
]
```



---