Helpcenter +918010117117 https://cdn1.storehippo.com/s/573db3149f0d58741f0cc63b/ms.settings/5256837ccc4abf1d39000001/57614ef64256dc6851749879-480x480.png" support@storehippo.com https://www.facebook.com/StoreHippohttps://twitter.com/StoreHippohttps://www.linkedin.com/company/hippoinnovations/https://plus.google.com/+Storehippo/posts
B4,309-10 Spaze iTech Park, Sector 49, Sohna Road, 122001 Gurgaon India
call to replace anchor tags contains '/admin' in href

Update Store Credit and Wallet with the API

StoreHippo allows you to update the loyalty wallet and store credit transactions in the Users > Wallet Transactions section. 

Along with that, you can also update the wallet transactions through API. To update the wallet transactions through API, follow the steps given below:

Credit or Debit Loyalty Wallet points through API

Fields

Value

Description

action

Type: string

Brief action about wallet transaction

Ex - “Points redeemed”

amount

Type: number

Amount to credit/ debit loyalty points

Ex- 66.5

description

Type: string

Brief description about the transaction

Ex- “test description”

posting_type

Type: string

Type of transaction - Credit/ Debit

Type

Type: string

Type of Wallet to be used against transaction - 

Ex- loyalty

User

Type: string

User to be used for the transaction

Ex -"5f8547a19cfc913194f45bc4"

Crediting loyalty points

  • For crediting loyalty points to a user through API, you need to use the "POST" command on the "ms.wallet_transactions" entity with the following request data:
{
action: "test points credit"


amount: "66.5"

description: "test description"

posting_type: "credit"

type: "loyalty"

user: "5f8547a19cfc913194f45bc4"

}

When the request is successful, the wallet transaction ID is received in response data. You can use this ID to find transaction details in wallet transactions ex -

data: {

_id: "5f85a5b9c3a3c1073086236e"

}

Debiting loyalty points

  • For debiting loyalty points to a user through API, you need to use the "POST" command on the "ms.wallet_transactions" entity with the following request data -
{
action: "test points debit"


amount: "66.5"

description: "test description"

posting_type: "debit"

type: "loyalty"

user: "5f8547a19cfc913194f45bc4"

}

When the request is successful, the wallet transaction ID is received in response data. You can use this ID to find transaction details in wallet transactions Ex -

data: {

_id: "5f85aba2c3a3c107308623f8"

}

Credit or Debit StoreCredit points through API

Similar to the loyalty wallets, you can update the StoreCredit transactions through API.

Fields

Value

Description

action

Type: string

Brief action about wallet transaction

Ex - “Points redeemed”

amount

Type: number

Amount to credit/ debit StoreCredits

Ex- 66.5

description

Type: string

Brief description about the transaction

Ex- “test description”

posting_type

Type: string

Type of transaction - Credit/ Debit

Type

Type: string

Type of Wallet to be used against transaction - 

Ex- StoreCredits

User

Type: string

User to be used for the transaction

Ex -"5f8547a19cfc913194f45bc4"

Crediting StoreCredit points

  • For crediting StoreCredit points to a user through API, you need to use the "POST" command on the "ms.wallet_transactions" entity with the following request data -
{
action: "test points credit"


amount: "66.5"

description: "test description"

posting_type: "credit"

type: "StoreCredit"

user: "5f8547a19cfc913194f45bc4"

}

When the request is successful, the wallet transaction ID is received in response data. You can use this ID to find transaction details in wallet transactions Ex -

data: {

_id: "5f85aba2c3a3c107366fgt6"

}

Debiting StoreCredit points

  • For debiting StoreCredit points to a user through API, you need to use the "POST" command on the "ms.wallet_transactions" entity with the following request data -
{
action: "test points debit"


amount: "66.5"

description: "test description"

posting_type: "debit"

type: "StoreCredit"

user: "5f8547a19cfc913194f45bc4"

}

When the request is successful, the wallet transaction ID is received in the response data. You can use this ID to find transaction details in wallet transactions Ex -

data: {

_id: "5f85aba2c3a3c10730865jp5"

}

Share:

2020-12-28T06:11:42.741Z