v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

post/transactions/deduct

Request body

member_idstring required

Unique Identifier (Member ID) for the member object in the client’s system which was used while creating a member in Zinrelo.

points_to_be_deductedinteger required

Number of points to be deducted.

transaction_attributesstring json
<p>Apart from the above parameters, you can also pass custom attributes for deduct activities, like <strong>reason and tags.&nbsp;</strong></p> <p>For example:</p> <p><code class="c-mrkdwn__code" data-stringify-type="code">{</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"reason" : "deduct", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"tags" : ["deductionmade","productreturned"]</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">} </code></p>

Example request

{
  "member_id": "john.doe@gmail.com"
}

Response

200

successboolean

Example response

{
  "data": {
    "status": "approved",
    "transaction_attributes": {
      "reason": "deduct",
      "tags": [
        "deductionmade",
        "productreturned"
      ]
    },
    "last_modified_date": "22-Mar-2023 06:19:35",
    "additional_data": {},
    "approver_details": {
      "approver_name": "System"
    },
    "approved_date": "22-Mar-2023 06:19:35",
    "member_id": "5779678689",
    "created_date": "22-Mar-2023 06:19:35",
    "transaction_type": "deduct",
    "id": "641a9df7c2161f000c2eb56a",
    "deduct_info": {
      "points": 100,
      "points_status": "deducted"
    }
  },
  "success": true
}