Time	Status	User Agent
Retrieving recent requests…

Rate Limit

Region	Default Limit (RPM)
Asia-2 (Singapore)	1500
Asia-1 (N. Virginia)	1500
EMEA (Ireland)	700

👍
Notes

To avoid any confusion related to timezone conversion, you can raise a ticket and enable the CONF_ORG_DISABLE_MACHINE_TIME_CONV configuration. When the configuration is enabled, the time from the payload, without the UTC offset, is stored in the database for all clusters. For more information, refer to the documentation here.

You cannot register a customer with this API. Hence, you need to pass only registered identifiers for regular transactions.

You can enable the configuration CONF_ALLOW_TRANSACTION_RETURN_AFTER_GROUP_TRANSITION to allow returns for former group members . When this config is active and when a return transaction is performed for a user who has left the group, the points allocated to the group as part of the original transaction are also reverted. To enable, raise a ticket to the Product Support Team.

You can disable the configuration CONF_POINTS_RETURN_ENABLED to prevent the reversal of earned points when a transaction is returned. When a user returns a transaction, the points earned for that transaction are not reversed. To reverse the points, you can use the Manual Points Adjustment API.

CONFIG_SKIP_SECONDARY_ID_ON_PRIMARY_MISMATCH is enabled: If the primary identifier is different but any of the secondary identifiers exist, a new customer is registered with the primary identifier ignoring the secondary identifier. The config is available on the Registration Page of InTouch Profile > Organization Settings > Miscellaneous.

To enable these configurations for your organisation, raise a JIRA ticket to the Capillary Product Support team.

Negative values for transaction values such as amount, discount are not considered.

Header information

Header name	Description
SKIP-DOWNSTREAM	If set to true, the API request adds the customer transaction record directly without notifying downstream systems such as the Loyalty Engine (EMF) or event notification services, and no side effects will be generated. This allows the API to behave like a data import, where no loyalty actions or event triggers are executed.

Example request

{
  "type": "REGULAR",
  "billNumber": "bill00076",
  "discount": "100",
  "billAmount": "1900",
  "note": "this is test",
  "grossAmount": "2000",
  "deliveryStatus": "DELIVERED",
  "userGroup2Id":98765,
  "userGroup2PrimaryUserId":"",
  "userGroup2ExternalId": "",
  "lineItemsV2": [
      {
        "amount": 1200,
        "parentBillNumber": "bill00075",
        "returnType":"LINE_ITEM",
        "type":"RETURN",
        "description": "blue large jeans",
        "discount": 0,
        "itemCode": "ITEMJEANS0005",
        "qty": 1,
        "rate": 1200,
        "serial": 1,
        "value": 1200,
        "returnable": false,
        "returnableDays": 0,
        "customFields": {},
        "imgUrl": ""
      },
      {
        "amount": 6570,
        "type":"REGULAR",
        "description": "blue large jeans",
        "discount": 0,
        "itemCode": "ITEMJEANS0ih05",
        "qty": 1,
        "rate": 1200,
        "serial": 1,
        "value": 1200,
        "returnable": false,
        "returnableDays": 0,
        "customFields": {},
        "imgUrl": ""
      }
    ],
  "promotionEvaluationId":"",
  "appliedPromotionIdentifiers":[""]
}

curl --location 'https://eu.api.capillarytech.com/v2/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGpfY2FwaWYXJ5OjTY3ZDJiMGM2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=X4PRfLORRqKZSXB7MLTZg1y0xdBGOGW1RV_AcjWliKU-1732681336338-0.0.1.1-604800000; _cfuvid=pQo4iSbMnKqqdxXU15Vk3fp0H5PhV1EQrHA0LUs2dHc-1744274957604-0.0.1.1-604800000' \
--data '{
    "type": "NOT_INTERESTED",
    "billNumber": "test00notinterested003",
    "billingDate": "2025-04-10T12:30:00+05:30",
    "discount": "2000",
    "billAmount": "6000",
    "note": "This is not interested transaction number 03",
    "grossAmount": "8000",
    "deliveryStatus": "PLACED",
    "notInterestedReason": "Notes on why the customer is not interested to enroll into the loyalty",
    "paymentModes": [
        {
            "mode": "Card Payment",
            "value": 5104,
            "notes": "Sample notes for card payment",
            "attributes": {
                "card_type": "Visa"
            }
        }
    ],
    "attribution": {
        "createDate": "2025-04-10T12:30:00+05:30",
        "createdBy": {
                "id": 75155297,
                "code": "tj_capillary",
                "name": "tj_capillary",
                "type": "TILL"
            }
    },
    "extendedFields": {
        "age": "35",
        "gender": "male",
        "card_used": "1111222233334444",
        "city": "Bangalore"
    },
    "customFields": {
        "paymentmode": "card",
        "origin": "instore",
        "booking_date": "2025-04-10"
    },
    "lineItemsV2": [
        {
            "itemCode": "model_id_001",
            "description": "Steel Bottle",
            "amount": 2000.0,
            "rate": 750.0,
            "qty": 4.0,
            "value": 3000.0,
            "discount": 1000.0,
            "returnable": "true",
            "returnableDays": 30,
            "extendedFields": {}
        },
        {
            "itemCode": "model_id_002",
            "description": "Sports Shoe",
            "amount": 2000.0,
            "rate": 1000.0,
            "qty": 2.0,
            "value": 2000.0,
            "discount": 0.0,
            "extendedFields": {}
        },
        {
            "itemCode": "model_id_003",
            "description": "Wood Table",
            "amount": 2000.0,
            "rate": 3000.0,
            "qty": 1.0,
            "value": 3000.0,
            "discount": 1000.0,
            "extendedFields": {}
        }
    ] 
}'

{
  "type": "RETURN",
  "billNumber": "num-567567",
  "id": 875045569,
  "returnType": "FULL",
  "discount": "10",
  "billAmount": "200",
  "note": "This is test",
  "grossAmount": "110",
  "deliveryStatus": "SHIPPED",
     "extendedFields": {
    "ship_first_name": "Ram",
    "ship_last_name": "Singh",
    "checkin_date":"2010-06-04 21:08:12",
    "checkout_date":"2010-06-05 21:08:12"
  },
  "customFields": {
    "paymentmode": "cash"
  },
  "lineItemsV2": [
    {
      "itemCode": "sku_234_2",
      "amount": 100.5,
      "rate": 100.5,
      "qty": 1.0,
      "value":100.5,
      "extendedFields": {
        "MetalRate": "22.02",
        "GrossWeight": "10.50"
      }
    },
    {
      "itemCode": "sku_sdf_10",
      "amount": 100.5,
      "rate": 100.5,
      "qty": 1.0,
      "value":100.5,
      "extendedFields": {
        "MetalRate": "22.02",
        "GrossWeight": "10.50"
      }
    }
  ]
}

curl --location 'https://eu.api.capillarytech.com/v2/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGpfY2FwaWxsYXJ5OjVjMTc3MDJlOTI5NjQ4MjUzZTY3ZDJiMGM2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=X4PRfLORRqKZSXB7MLTZg1y0xdBGOGW1RV_AcjWliKU-1732681336338-0.0.1.1-604800000; _cfuvid=c.5agx8tmOi_4rS6BQFx4PU8ZWeuDT8iIAjHm8y6_cg-1744095133839-0.0.1.1-604800000' \
--data '{
    "type": "NOT_INTERESTED",
    "billNumber": "test00notinterested001",
    "billingDate": "2025-04-08T11:00:00+05:30",
    "discount": "0",
    "billAmount": "6000",
    "note": "This is transaction number 68",
    "grossAmount": "6000",
    "deliveryStatus": "PLACED",
    "paymentModes": [
        {
            "mode": "Card Payment",
            "value": 5104,
            "notes": "Sample notes for card payment",
            "attributes": {
                "card_type": "Visa"
            }
        }
    ],
    "lineItemsV2": [
        {
            "itemCode": "model_id_001",
            "description": "Steel Bottle",
            "amount": 2000.0,
            "rate": 500.0,
            "qty": 4.0,
            "value": 2000.0,
            "extendedFields": {}
        }   
    ]  
}'

curl --location 'https://eu.api.capillarytech.com/v2/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGpfY2FwaWxsYXJ5OjVjMTc3MDJlOTI5NjQ4MjUzZTY3ZDJiMGM2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=X4PRfLORRqKZSXB7MLTZg1y0xdBGOGW1RV_AcjWliKU-1732681336338-0.0.1.1-604800000; _cfuvid=c.5agx8tmOi_4rS6BQFx4PU8ZWeuDT8iIAjHm8y6_cg-1744095133839-0.0.1.1-604800000' \
--data '{
    "type": "NOT_INTERESTED_RETURN",
    "billNumber": "test00notinterested001",
    "id": "323301425",
    "returnType": "LINE_ITEM",
    "discount": "0",
    "billAmount": "6000",
    "billingDate": "2025-04-08T12:00:00Z",
    "purchaseTime": "2025-04-08T11:00:00Z",
    "note": "Returning the Transaction number not interested 001",
    "grossAmount": "6000",
    "deliveryStatus": "PLACED",
    "lineItemsV2": [
        {
            "itemCode": "model_id_001",
            "amount": 2000.0,
            "rate": 500.0,
            "qty": 4.0,
            "value": 2000.0
        }
    ]
}'

curl --location 'https://eu.api.capillarytech.com/v2/transactions?identifierName=mobile&identifierValue=919999988886' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGpfY2FwaWxsYXOjVjMQ4MjUzZTY3ZDJiMGM2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=X4PRfLORRqKZSXB7MLTZg1y0xdBGOGW1RV_AcjWliKU-1732681336338-0.0.1.1-604800000; _cfuvid=Cnd3GuZRDUPsvYCQrN.OtibNGgPv1zaSL420fIOkRdI-1744268670314-0.0.1.1-604800000' \
--data '{
    "type": "REGULAR",
    "billNumber": "test00transact078",
    "billingDate": "2025-04-10T12:00:00+05:30",
    "discount": "0",
    "billAmount": "60",
    "note": "This is transaction number 78",
    "grossAmount": "60",
    "deliveryStatus": "PLACED",
    "currencyCode": "USD",
    "addWithLocalCurrency": "true",
    "paymentModes": [
        {
            "mode": "Card Payment",
            "value": 5104,
            "notes": "Sample notes for card payment",
            "attributes": {
                "card_type": "Visa"
            }
        }
    ],
    "attribution": {
        "createDate": "2025-04-10T10:00:00+05:30",
        "createdBy": {
                "id": 75155297,
                "code": "tj_capillary",
                "name": "tj_capillary",
                "type": "TILL"
            }
    },
    "lineItemsV2": [
        {
            "itemCode": "model_id_001",
            "description": "Steel Bottle",
            "amount": 20.0,
            "rate": 5.0,
            "qty": 4.0,
            "value": 20.0,
            "returnable": "true",
            "returnableDays": 30,
            "extendedFields": {
            }
        }
    ] 
}'

curl --location 'https://eu.api.capillarytech.com/v2/transactions?identifierName=mobile&identifierValue=919999988886' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGpfY2FwaWxsYXJiMGM2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=X4PRfLORRqKZSXB7MLTZg1y0xdBGOGW1RV_AcjWliKU-1732681336338-0.0.1.1-604800000; _cfuvid=YU7Bnc0X5He.GY7KGOCFX9gF.l12EJtA6ckkWeKBg9I-1744275531100-0.0.1.1-604800000' \
--data '{
    "type": "RETURN",
    "billNumber": "test00transact072",
    "parentBillNumber": "newReturnTxnNo072",
    "id": "884689535",
    "returnType": "FULL",
    "discount": "0",
    "billAmount": "6000",
    "billingDate": "2025-04-09T15:00:00Z",
    "purchaseTime": "2025-04-08T12:00:00Z",
    "note": "Returning the Transaction number 72",
    "grossAmount": "6000",
    "deliveryStatus": "PLACED"
}'

curl --location 'https://eu.api.capillarytech.com/v2/transactions?identifierName=mobile&identifierValue=919999988886' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGpfY2FwaWxsYX2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=X4PRfLORRqKZSXB7MLTZg1y0xdBGOGW1RV_AcjWliKU-1732681336338-0.0.1.1-604800000; _cfuvid=i6YpwanlOMY0ncm9XnrqlIxjsmPA5Xe9XW_Jn8W9ue0-1744276398751-0.0.1.1-604800000' \
--data '{
    "type": "RETURN",
    "billNumber": "test00transact074",
    "parentBillNumber": "newReturnTxnNo074",
    "id": "884689604",
    "returnType": "LINE_ITEM",
    "discount": "0",
    "billAmount": "3000",
    "billingDate": "2025-04-09T15:00:00Z",
    "purchaseTime": "2025-04-08T17:30:00Z",
    "note": "Returning the Transaction number 74",
    "grossAmount": "5160",
    "deliveryStatus": "PLACED",
    "lineItemsV2": [
        {
            "itemCode": "model_id_001",
            "amount": 1720.0,
            "rate": 430.0,
            "qty": 4.0,
            "value": 1720.0
        }
    ]
}'

curl --location 'https://eu.api.capillarytech.com/v2/transactions?identifierName=mobile&identifierValue=919999988886' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGpfY2F' \
--header 'Cookie: _cfuvid=X4PRfLORRqKZSXB7MLTZg1y0xdBGOGW1RV_AcjWliKU-1732681336338-0.0.1.1-604800000; _cfuvid=dXAF7a_EpZ9d8Sh5mCK0uuxNr9CG.erEIcsPDWo5Ep8-1744276620970-0.0.1.1-604800000' \
--data '{
    "type": "RETURN",
    "billNumber": "test00transact073",
    "parentBillNumber": "newReturnTxnNo073",
    "id": "884689585",
    "returnType": "AMOUNT",
    "discount": "0",
    "billAmount": "3000",
    "billingDate": "2025-04-09T15:00:00Z",
    "purchaseTime": "2025-04-08T17:30:00Z",
    "note": "Returning the Transaction number 73",
    "grossAmount": "5160",
    "deliveryStatus": "PLACED"
}'

curl --location 'https://eu.api.capillarytech.com/v2/transactions?identifierName=mobile&identifierValue=9988776655' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic bmVlc3cmV0aWxsc3NuZWUyMzoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==' \
--header 'Cookie: _cfuvid=FYM89UEh4pTep5Aoer76YyEOju6FrJ7OZ3I_9.5VBYs-1755060082615-0.0.1.1-604800000' \
--data '{
  "type": "REGULAR",
  "billNumber": "num-1234",
  "discount": "10",
  "billAmount": "200",
  "note": "This is test",
  "grossAmount": "110",
  "deliveryStatus": "SHIPPED",
    "paymentModes": [
        {
          "mode": "Card Payment",
          "value": 5104,
          "notes": "Sample notes",
          "attributes": {
             "card_type": "Visa"
           }
        }
    ], 
  "extendedFields": {
    "ship_first_name": "Ram",
    "ship_last_name": "Singh",
    "checkin_date":"2010-06-04 21:08:12",
    "checkout_date":"2010-06-05 21:08:12"
  },
  "customFields": {
    "paymentmode": "cash"
  },
  "lineItemsV2": [
    {
      "itemCode": "sku_234_2",
      "amount": 100.5,
      "rate": 100.5,
      "qty": 1.0,
      "value":100.5,
      "extendedFields": {
        "MetalRate": "22.02",
        "GrossWeight": "10.50"
      }
    },
    {
      "itemCode": "sku_sdf_10",
      "amount": 100.5,
      "rate": 100.5,
      "qty": 1.0,
      "value":100.5,
      "extendedFields": {
        "MetalRate": "22.02",
        "GrossWeight": "10.50"
      }
    }
  ],
  "promotionEvaluationId":"60f5713c4c5cb92ab2da320e", 
  "loyaltyPromotionIdentifiers":[
    "ABC-12345",
    "Diwali_Promotion_2020",
    "New_Year_Promotion_2020"
  ],
  "appliedPromotionIdentifiers": ["eyJwcm9tb3Rpb25JZCI6IjYxMmU1YzVlNDEzM2I1NmFiZTBmMDczZSIsImRpc2NvdW50IjoiMTAwMC4wMDAwMDAiLCJhbW91bnQiOiIzMDAwLjAwMDAwMCIsImRpc2NvdW50QXBwbGllZFF0eSI6IjEiLCJwcm9tb3Rpb25BcHBsaWVkUXR5IjoiMy4wMDAwMDAiLCJyZWRlbXB0aW9uQ291bnQiOjEsInNrdSI6IkpOU1JFRzAyIiwidmVyc2lvbiI6InYxIn0=", "eyJwcm9tb3Rpb25JZCI6IjYxMmU1YzVlNDEzM2I1NmFiZTBmMDczZSIsImRpc2NvdW50IjoiMTAwMC4wMDAwMDAiLCJhbW91bnQiOiIzMDAwLjAwMDAwMCIsImRpc2NvdW50QXBwbGllZFF0eSI6IjEiLCJwcm9tb3Rpb25BcHBsaWVkUXR5IjoiMy4wMDAwMDAiLCJyZWRlbXB0aW9uQ291bnQiOjEsInNrdSI6IkpOU1JFRzAyIiwidmVyc2lvbiI6InYxIn1="
   ]
}  '

curl --location 'https://eu.api.capillarytech.com/v2/transactions?identifierName=externalId&identifierValue=12341234&source=INSTORE' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Z2VvcbW86MmQ1OTNhMjI2MTk1OGE2NWI5ZjAxMzU5NGIwNDllZTk=' \
--header 'Cookie: CC=SsNOOAg5wluqSzGKnjuMRas2uFN70lmDUUDl1_kDeTCPGGGt-OTyq; CT=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6WyIyMzMyNTMiXSwib3JnSUQiOjAsImV4cCI6MTc2MTU4MzI3NywiaWF0IjoxNzYxNDk2ODc3LCJpc3MiOiJjYXBpbGxhcnl0ZWNoLmNvbSIsImF1ZCI6ImNhcGlsbGFyeSxpbnRvdWNoLGFyeWEscmVvbixhcHBzIiwic291cmNlIjoiV0VCQVBQIiwicmVmZXJlbmNlSUQiOiI1MDY4NTUzNSJ9.JhfrpB9-T8A6HPh7a-xrACXDd-yrY0qKfYLHZEWH58U; OID=0; _cfuvid=i65tdaVD.qHnEc.GQSg4DfOXaVdTBw8IgLJWn6XwPnY-1762940980377-0.0.1.1-604800000' \
--header 'X-CAP-API-AUTH-ORG-ID: 50672' \
--data '{
  "type" : "REGULAR",
  "billNumber" : "nusmbers-erfWDse3sst7ss-5176417625s0600sw0",
  "billingDate" : "2025-11-12 23:58:26",
  "discount" : 0,
  "billAmount" : "1000",
  "note" : "test note",
  "grossAmount" : "1000",
  "deliveryStatus" : "DELIVERED",
  "paymentModes" : [{"mode": "Cash", "value": "500",
               "appliedPaymentVoucherIdentifiers":
                   ["eyJwcm9tb3Rpb25JZCI6IjY5MTQyMzI2NzllMzcyNjFmZTVkNGVmMyIsImRpc2NvdW50IjoiMTAwLjAwMDAwMCIsImFtb3VudCI6IjEwMDAuMDAwMDAwIiwicmVkZW1wdGlvbkNvdW50IjoxLCJwcm9tb0NvZGUiOiJVUTM4VCIsInZlcnNpb24iOiJ2MSJ9"]}],
  "extendedFields" : { },
  "customFields" : { },
  "lineItemsV2" : [ ],
  "appliedPromotionIdentifiers" : ["eyJwcm9tb3Rpb25JZCI6IjY5MTQyMzI2NzllMzcyNjFmZTVkNGVmMyIsImRpc2NvdW50IjoiMTAwLjAwMDAwMCIsImFtb3VudCI6IjEwMDAuMDAwMDAwIiwicmVkZW1wdGlvbkNvdW50IjoxLCJwcm9tb0NvZGUiOiJVUTM4VCIsInZlcnNpb24iOiJ2MSJ9"],
  "promotionEvaluationId" : "691457fa79e37261fe5d51b7"
}'

curl --location 'https://eu.api.capillarytech.com/v2/transactions?identifierName=mobile&source=INSTORE&rawSideEffects=true&identifierValue=919999988886' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGpfY2FxsYXJ5OMGM2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=X4PRfLORRqKZSXLTZg1y0xdBGOGW1RV_AcjWliKU-1732681336338-0.0.1.1-604800000; _cfuvid=VH8h7P8UwzFAby87uUbP8LWtvkhp3XJd1vkMEeK7f3o-1769686379495-0.0.1.1-604800000' \
--data '{
    "type": "MIXED",
    "billNumber": "docdemotxn00loyal0018",
    "billingDate": "2026-01-29T17:00:00+05:30",
    "billAmount": "2000",
    "note": "DDtxn L 0017",
    "grossAmount": "2000",
    "deliveryStatus": "PLACED",
    "lineItemsV2": [
        {
        "amount": 2000,
        "parentBillNumber": "docdemotxn00loyal0017",
        "returnType":"LINE_ITEM",
        "type":"RETURN",
        "description": "Sports Shoes",
        "discount": 0,
        "itemCode": "model_id_001",
        "qty": 1.0
      },
      {
        "amount": 2000,
        "type":"REGULAR",
        "description": "Sports Shoes",
        "discount": 0,
        "itemCode": "model_id_002",
        "qty": 1,
        "rate": 2000
      }
    ] 
}'

Mixed transaction example

curl -i -X POST \
   -H "X-CAP-API-AUTH-KEY:Qjc0M0EI0N0Q5QzAxOEI=" \
   -H "Content-Type:application/json" \
   -H "X-CAP-API-AUTH-ORG-ID:50583" \
   -H "Authorization:Basic a3Jpc2huYS50aWxsU5MDc1Yjk2NGIwNzE1MmQyMzRiNzA=" \
   -d \
'{
  "source": "INSTORE",
  "type": "REGULAR",
  "billNumber": "ReturnTxnCHeck12",
  "billingDate": "2026-02-16T09:01:39+00:00",
  "discount": "0.0",
  "billAmount": "201",
  "note": "Regular Order",
  "grossAmount": "201",
  "deliveryStatus": "DELIVERED",
  "customFields": {
    "cashier_id":"1234"
  },
  "extendedFields":{
    "additional_discount":12
  },
  "paymentModes": [
    {
      "notes": "Loyalty Points",
      "mode": "Loyalty Points Redemption",
      "value": "50.0"
    },
    {
      "notes": "Others",
      "mode": "Others",
      "value": "50.0"
    }
  ],
  "redemptions": {
    "pointsRedemptions": [
      null,
      "SwlDee"
    ]
  },
  "lineItemsV2":[
    {
      "itemCode":"sku_486741_88",
      "amount":100.5,
      "description":"sample description",
      "discount":0,
      "rate":100.5,
      "qty":1,
      "extendedFields":{
        "additional_discount":0.0
      }
    },
    {
      "itemCode":"sku_486741_77",
      "amount":100.5,
      "description":"sample description",
      "discount":0,
      "rate":100.5,
      "qty":1,
      "extendedFields":{
        "additional_discount":0.0
      }
    }
  ]
}' \
 'https://eu.intouch.capillarytech.com/v2/transactions?identifierName=mobile&identifierValue=9591'

curl -i -X POST \
   -H "X-CAP-API-AUTH-KEY:Qjc0M0ExMDE0VFNDI0N0Q5QzAxOEI=" \
   -H "Content-Type:application/json" \
   -H "X-CAP-API-AUTH-ORG-ID:50583" \
   -H "Authorization:Basic a3Jpc2huYS50aWxsMDE6Mk2NGIwNzE1MmQyMzRiNzA=" \
   -d \
'{
  "source": "INSTORE",
  "type": "REGULAR",
  "billNumber": "MixedTransaction12",
  "billingDate": "2026-02-17T09:01:39+00:00",
  "discount": "0.0",
  "billAmount": "100.5",
  "parentBillNumber":"ReturnTxnCHeck12",
  "note": "Regular Order",
  "grossAmount": "100.5",
  "deliveryStatus": "DELIVERED",
  "customFields": {
    "cashier_id":"1234"
  },
  "extendedFields":{
    "additional_discount":12
  },
  "lineItemsV2":[
    {
      "type": "RETURN",
      "returnType": "LINE_ITEM",
      "parentBillNumber":"ReturnTxnCHeck12",
      "originalTxnNumber":"ReturnTxnCHeck12",
      "itemCode":"sku_486741_88",
      "amount":100.5,
      "description":"sample description",
      "discount":0,
      "rate":100.5,
      "qty":1
    },
    {
      "itemCode":"sku_486741_00",
      "amount":100.5,
      "description":"sample description",
      "discount":0,
      "rate":100.5,
      "qty":1,
      "extendedFields":{
        "additional_discount":0.0
      }
    }
  ]
}' \
 'https://eu.intouch.capillarytech.com/v2/transactions?identifierName=mobile&identifierValue=954'

Request Query Parameters

Parameter	Type	Description
identifierName*	Enum	Pass any of the registered identifier name of the customer. Values: `mobile`, `email`, `externalId`, `id`, `wechat`, `martjackId`, `fbId` (Facebook ID), `cardnumber`, `cardExternalId`.
identifierValue*	string	Pass the respective identifier value. For example, if identifierName is `mobile`, identifierValue is the mobile number. Required: When `identifierName=mobile`, you must provide a non-empty identifierValue. If identifierValue is missing or empty, the API returns a 400 Bad Request error.
source	Enum	Pass the source from which the transaction is made. Values: `INSTORE`(for InStore), `WECHAT` (WeChat), `MARTJACK`(AnywhereCommerce), `WEB_ENGAGE` (Web-engage integration), `ECOMMERCE` (ECOMMERCE), `JD` (JD), `TAOBAO` (Taobao), `TMALL` (TMall), `FACEBOOK` (Facebook), `WEBSITE` (other website), `OTHERS` (any other source).
accountId	string	For sources with multiple accounts (such as MARTJACK, WECHAT), pass the respective account ID. Not applicable for INSTORE source.
use_asynch	boolean	Pass `true` to run Loyalty activities in the background, side effects will not be returned in the API response. If `false`, API will wait for Loyalty activities to complete and then respond to the client with side effects in the API response.
rawSideEffects	boolean	Pass `true` to get complete details of incentives such as awardOn, expiryDate, strategyIds and so on.

Request Body Parameters

Parameter	Type	Description
extendedFields	obj	Valid transaction level extended field details in name and value pairs.
type*	Enum	Type of transaction. Supported value: `REGULAR` for loyalty transactions. `RETURN` for return transactions. `NOT_INTERESTED`, `NOT_INTERESTED_RETURN`.
returnType**	Enum	For a return transaction, pass the return type. Values: `AMOUNT`, `FULL`, `LINE_ITEM`. Note: The value `CANCELLED` is not supported for `NOT_INTERESTED_RETURN` transactions. Only `AMOUNT`, `FULL`, and `LINE_ITEM` are valid for `NOT_INTERESTED_RETURN`.
notInterestedReason	string	Notes on why the customer is not interested to enroll into the loyalty (type = NOT_INTERESTED). Max characters supported - 255.
billNumber*	string	Unique transaction number for normal or mixed transactions and original transaction number for return transactions. Note*: The maximum length for a bill number is 50 characters.
id	long	Transaction ID of the transaction that needs to be returned. Identifies the specific transaction to be returned when identical bill numbers exist across different transactions. This is applicable when the CONF_LOYALTY_BILL_NUMBER_UNIQUE_ONLY_STORE configuration is enabled, and the same bill number is used for transactions at different stores. Example: Store A: Customer transaction with bill number B1 Store B: Different transaction also with bill number B1 In this scenario, you can include the transaction ID in the return transaction payload to: Distinguish between transactions with identical bill numbers Prevent failures in return transactions due to duplicate bill numbers
billAmount	double	Net transaction amount.
billingDate	date-time	Date and time of the transaction in the ISO 8601 format - `YYYY-MM-DDTHH:MM:SSZ`.
discount	double	Discount availed for the transaction or line item (discount amount).
grossAmount	double	Transaction amount before discount.
outlierStatus	Enum	Transaction level outlier status. Values: `NORMAL`, `INTERNAL`, `FRAUD`, `OUTLIER`, `TEST`, `DELETED`, `FAILED`, `OTHER`. This overrides the outlier status of the configured outlier settings.
note	string	Additional information about the transaction.
deliveryStatus	Enum	Delivery status of the item. Values: `PLACED`, `PROCESSED`, `SHIPPED`, `DELIVERED`, `RETURNED`. You can update the status using v2 PUT `/transactions`
userGroup2Id	int	External ID of the user group to be associated with the transaction. Any one among the parameters with userGroup2 is required to associate the transaction with a group.
userGroup2PrimaryUserId	long	ID of the primary user of the group to be associated with the transaction.
userGroup2ExternalId	string	External ID of the user group to be associated with the transaction.
currencyCode	string	ISO currency code of the transaction to add transaction with local currency. For example, `INR` for Indian Rupee, `SGD` for Singapore Dollar, `EUR` for Euro, `IQD` for Iraqi Dinar. Pass the currency code that are supported for your org (InTouch > Organization Setup) and ensure the currency conversion ratio is set using `v2/currencyratio`.
addWithLocalCurrency	boolean	Pass `true` to add a transaction in local currency.
customFields	obj	Details of transaction-level custom fields. Line item level custom fields are not supported.
purchaseTime	date-time	Actual date of transaction of the returning bill in Date and time of the transaction in ISO 8601 standard - `YYYY-MM-DDTHH:MM:SSZ`.
promotionEvaluationId	string	Promotion evaluation ID for the transaction. Pass the `evaluationId` value returned by the `POST /api_gateway/v1/promotions/evaluate` response here to validate that the promotions being redeemed match what was evaluated.
appliedPromotionIdentifiers	array	Promotion identifiers applied to the transaction. Pass the `identifier` values from the `appliedPromotions[]` array in the `POST /api_gateway/v1/promotions/evaluate` response here. This field is specifically used for promotions that apply to the entire cart (i.e., transaction-level discounts). For item-specific promotions, include this parameter within the relevant lineItemsV2 object instead. This field is not applicable for the redemption of cart promotion gift voucher. To generate this string, evaluate the cart promotion using the Evaluate Cart Promotions API, and use the `identifier` field from the `appliedPromotions` object in the response. The decoded identifier will include details like: `{"promotionId": "612e5c5e4133b56abe0f073e", "discount": "1000.000000", "amount": "3000.000000", "discountAppliedQty": "1", "promotionAppliedQty": "3.000000", "redemptionCount": 1, "sku": "JNSREG02","version": "v1"}`
loyaltyPromotionIdentifiers	array	Identifier(s) of loyalty promotion(s) that you want to tag to the transaction.
lineitemsV2	obj	Details of line items.
attribution	obj	Mapping to tag the transaction to a different user or till (other than the current user).
redemptions	obj	Details of points and coupon redemptions for the transaction.
paymentModes	obj	Payment details used for the transaction.

lineitemsV2 Object

Parameter	Type	Description
amount	double	Net line item amount. Value - discount = amount.
description	string	Short text describing the line item. Shown with the SKU in Member Care. If omitted, Member Care displays only the SKU. There is no limit set on the number of characters.
discount	int	Discount received on the line item.
itemCode	string	Unique code of the transaction line-item.
qty	double	Quantity of the current line item.
rate	double	Price of each line item.
serial	string	Serial number of the line-item.
value	double	Gross amount of the item. Usually, rate*qty = value.
returnable	boolean	Pass `true` if the item can be returned post purchase.
returnableDays	int	Maximum number of days the item is allowed to return.
customFields	obj	Transaction or line-item level custom field details.
imgUrl	string	URL of the product image.
attributes	obj	Attributes of the product in name-value pairs.
addOnDetails	obj	Details add-on item.
splitDetails	obj	Details of split item.
parentBillNumber	string	Return transaction number. Applicable only for mixed transaction (transaction that involves both purchase and return - exchange).
purchaseTime	date-time	Actual date of transaction of the return item in ISO 8601 format - `YYYY-MM-DDTTHHSSZ`.
returnType	Enum	Return type of the line item. Value - `AMOUNT`, `FULL`, `LINE_ITEM`.
type	Enum	Type of the line item. Value: `REGULAR` (for regular line item purchase), `NOT_INTERESTED` (for line item purchase with no customer tagging), `RETURN` (to return a regular line item ), `NOT_INTERESTED_RETURN` (to return a line item of no-interested transaction).
appliedPromotionIdentifiers	array	Cart or catalog promotions applied to the transaction line item. To apply a promotion to the whole cart, use the appliedPromotionIdentifiers parameter at the main transaction level.
extendedFields	obj	Valid transaction line-item level extended field details.
comboDetails	obj	Details combo, bundle, or split items.

comboDetails object

Parameter	Type	Description
itemCode	string	Unique line-item code.
quantity	double	Quantity of the current combo item.
description	string	One or two liner description of add-on, split, or combo item.
rate	double	Price of the combo item.
value	double	Item price excluding discount.
comboType	string	Type of the combo. `COMBO_PARENT`, `COMBO_ITEM`, `ADD_ON_ITEM`, `SPLIT`.

attribution Object

Parameter	Type	Description
createDate	date-time	Date of the transaction in ISO 8601 standard format.
createdBy	obj	User ID or store entity (like TILL ID, store ID) associated with the transaction.
code	string	Unique code of the entity.
type	Enum	Type of the attribution entity. Value: `ZONE`, `CONCEPT`, `STORE`, `TILL`, `STR_SERVER`, `ADMIN_USER`, `ASSOCIATE`, `RULE`, `OU`.

redemptions Object

Parameter	Type	Description
pointsRedemptions	array	Unique points redemption id(s) that you want to apply for the transaction. For example, [727272, 237878]
couponRedemptions	array	Unique coupon redemption id(s) that you want to apply for the transaction. For example, [727272, 237878]

paymentModes Object

Parameter	Type	Description
mode	string	Mode of payment.
value	double	Amount paid through the current mode.
notes	string	Additional information related to the payment mode. Max characters - 250.
attributes	obj	Attributes of the payment mode as name-value pairs.
appliedPaymentVoucherIdentifiers	array	Payment specific gift voucher identifiers from the cart promotion evaluation request.This is applicable for redemption of gift voucher in cart promotion.

⚠️
Note
If any attribute value in the attributes object (such as wallet_type) contains leading or trailing spaces, the system ignores that attribute. Ignored attributes are not included in the transaction payload. This may cause tender-based rules to be bypassed and fallback or default payment methods to be applied, which can affect point allocation across programs. To ensure correct processing, always remove leading and trailing spaces from all attribute values in the payment mode.

📘
Important Notes for Not Interested Return Transaction

PurchaseTime should be both in transaction level as well as line-item level

PurchaseTime is the billingDate of the parent bill(In the return payload)

BillingDate in the return payload will be a future date when the bill is being returned.

PurchaseTime is always in the past compared to the billingDate

BillNumber in the return payload should be the same as the parent bill

Request body

{
  "type": "REGULAR",
  "billNumber": "num-1234",
  "billingDate":"2021-11-10T23:08:49+05:30",
  "discount": "10",
  "billAmount": "200",
  "note": "This is a transaction",
  "grossAmount": "110",
  "deliveryStatus": "SHIPPED",
    "paymentModes": [
        {
          "mode": "Card Payment",
          "value": 5104,
          "notes": "Sample notes",
          "attributes": {
             "card_type": "Visa"
           }
        }
    ], 
  "extendedFields": {
    "ship_first_name": "Ram",
    "ship_last_name": "Singh",
    "checkin_date":"2010-06-04 21:08:12",
    "checkout_date":"2010-06-05 21:08:12"
  },
  "customFields": {
    "paymentmode": "cash"
  },
  "lineItemsV2": [
    {
      "itemCode": "sku_234_2",
      "amount": 100.5,
      "rate": 100.5,
      "qty": 1.0,
      "value":100.5,
      "extendedFields": {
        "MetalRate": "22.02",
        "GrossWeight": "10.50"
      }
    },
    {
      "itemCode": "sku_sdf_10",
      "amount": 100.5,
      "rate": 100.5,
      "qty": 1.0,
      "value":100.5,
      "extendedFields": {
        "MetalRate": "22.02",
        "GrossWeight": "10.50"
      }
    }
  ],
  "promotionEvaluationId":"60f5713c4c5cb92ab2da320e", 
  "loyaltyPromotionIdentifiers":[
    "ABC-12345",
    "Diwali_Promotion_2020",
    "New_Year_Promotion_2020"
  ],
  "appliedPromotionIdentifiers": ["eyJwcm9tb3Rpb25JZCI6IjYxMmU1YzVlNDEzM2I1NmFiZTBmMDczZSIsImRpc2NvdW50IjoiMTAwMC4wMDAwMDAiLCJhbW91bnQiOiIzMDAwLjAwMDAwMCIsImRpc2NvdW50QXBwbGllZFF0eSI6IjEiLCJwcm9tb3Rpb25BcHBsaWVkUXR5IjoiMy4wMDAwMDAiLCJyZWRlbXB0aW9uQ291bnQiOjEsInNrdSI6IkpOU1JFRzAyIiwidmVyc2lvbiI6InYxIn0=", "eyJwcm9tb3Rpb25JZCI6IjYxMmU1YzVlNDEzM2I1NmFiZTBmMDczZSIsImRpc2NvdW50IjoiMTAwMC4wMDAwMDAiLCJhbW91bnQiOiIzMDAwLjAwMDAwMCIsImRpc2NvdW50QXBwbGllZFF0eSI6IjEiLCJwcm9tb3Rpb25BcHBsaWVkUXR5IjoiMy4wMDAwMDAiLCJyZWRlbXB0aW9uQ291bnQiOjEsInNrdSI6IkpOU1JFRzAyIiwidmVyc2lvbiI6InYxIn1="
   ]
}

curl --location 'https://eu.api.capillarytech.com/v2/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGpfY2FwaWxsYXJ5OjVjMTc3MDJlOTI5NjQ4MjUzZTY3ZDJiMGM2ZTk5ZjE5' \
--header 'Cookie: _cfuvid=X4PRfLORRqKZSXB7MLTZg1y0xdBGOGW1RV_AcjWliKU-1732681336338-0.0.1.1-604800000; _cfuvid=c.5agx8tmOi_4rS6BQFx4PU8ZWeuDT8iIAjHm8y6_cg-1744095133839-0.0.1.1-604800000' \
--data '{
    "type": "NOT_INTERESTED_RETURN",
    "billNumber": "test00notinterested001",
    "id": "323301425",
    "returnType": "LINE_ITEM",
    "discount": "0",
    "billAmount": "6000",
    "billingDate": "2025-04-08T12:00:00Z",
    "purchaseTime": "2025-04-08T11:00:00Z",
    "note": "Returning the Transaction number not interested 001",
    "grossAmount": "6000",
    "deliveryStatus": "PLACED",
    "lineItemsV2": [
        {
            "itemCode": "model_id_001",
            "amount": 2000.0,
            "rate": 500.0,
            "qty": 4.0,
            "value": 2000.0
        }
    ]
}'

Response Parameters

Parameter	Description
createdId	Unique ID of the transaction.
warnings	Object containing warnings, if any.
errors	Object containing errors, if any.
sideEffects	Object containing details of issued reward currencies (points and alternate currencies). This will not appear if the header `SKIP-DOWNSTREAM` is set to true.
-entityType	Type of entity. Possible values: `USER` (customer), `USERGROUP2` (user group)
-rawAwardedPoints	Total number of points awarded, without any rounding adjustments.
-awardedPoints	Total number of points awarded after rounding.
-type	Type of reward currency awarded. Possible values `points` and `alternate_currency`
-rawAwardedValue	Total number of alternate currencies awarded, without any rounding adjustments.
-alternateCurrencyIdentifier	Unique identifier of the alternate currency that is generated when creating an alternate currency.
-alternateCurrencyName	Unique name of the alternate currency issued.
-awardedValue	Total number of alternate currencies awarded after rounding.
rawSideEffects	Array containing raw details of various side effects, such as target loyalty and award details.
-currentEventTargetValue	Current value (progress) of the milestone/target the user is enrolled in.
-definedTargetValue	Total target value of the milestone/target the user is enrolled in.
-periodEndDate	End date of the target in YYYY-MM-DD
-periodRefCode	Reference code/name provided for the target period.
-periodStartDate	Start date of the target in YYYY-MM-DD
-targetAchievedValueAfterEvent	Target value of the milestone/target after the transaction.
-targetAchievedValueBeforeEvent	Target value of the milestone/target before the transaction.
-targetEvaluationType	Evaluation strategy for the target group. This defines how the system calculates and tracks the achievement of targets over time. Possible values:- FIXED_CALENDAR_WINDOW - CYCLIC_WINDOW - PERIOD_AGNOSTIC_WINDOW
-targetGroupId	Unique ID of the target group.
-targetGroupName	Unique name of the target group.
-targetName	Unique name of the target.
-targetRuleId	Unique ID for the target rule.
-userId	Unique ID of the customer.
-awardOn	Context or entity on which the points or rewards are awarded. Possible values:`BILL`: Points are awarded on the entire bill/transaction. `BILL_LINEITEM`: Points are awarded on a specific line item within the bill. `BILL_PROMOTION`: Points are awarded on the bill due to a specific promotion. `BILL_LINEITEM_PROMOTION`: Points are awarded on a specific line item due to a promotion. `CUSTOMER_PROMOTION`: Points are awarded to the customer due to a promotion, not directly tied to a bill or line item. `OTHER`: Used for cases that do not fit the above categories.
-awardStrategyId	Unique identifier of the award strategy to be used, which defines how the issued reward currency is calculated.
-awardedOn	Date when the reward currency was awarded in `dd(ordinal) MMM, yyyy` format.
-awardedOnMillis	Date when the reward currency was awarded in Unix timestamp (milliseconds).
-billNumber	Unique identifier of the bill.
-customerId	Unique identifier of the customer.
-evaluatedEntity	Type of entity. Possible values: `USER` and `USERGROUP2`
-expiryDate	Date when the reward currency expires in `dd(ordinal) MMM, yyyy` format.
-expiryDateMillis	Date when the reward currency expires in Unix timestamp (milliseconds).
-expiryStrategyId	Unique identifier of the expiry strategy to be used, which defines when the issued reward currency expires.
-initialQuantity
-initialSourceValue	Total transaction amount for the bill.
-isDefaultProgram	Indicates if it's part of the default loyalty program.
-isReferrer	Indicates if the customer is a referrer.
-lineItemId	Unique ID of the line-item.
-pointTypeId
-pointTypeIsRedeemable	Indicates if the point type is redeemable.
-pointTypeName	Type of points issued for the transaction. Possible values: `Main, Promised`
-points	Total points issued for the transaction.
-pointsBeforeCapping	Total points issued for the transaction before limits are applied.
-programId	Unique ID of the loyalty program.
-promoId	Unique ID of the loyalty promotion.
-promoIdentifier	External identifier for the loyalty promotion.
-promoName	Unique name of the loyalty promotion that is part of the transaction.
-quantity	Quantity of a specific item purchased.
-ruleId	Unique identifier for the specific loyalty rule that was applied during the transaction's evaluation.
-ruleSetId	Unique identifier for the set of loyalty rules that was evaluated for the transaction.
-sourceId	Unique identifier for the source of the awarded points. For example, if the source was a bill, this value will be the billId of the particular bill.
-sourceType	Source of the awarded points. Possible values: `Bill`, `Customer`, `PartnerProgram`.
-sourceValue	Total bill amount paid by the customer.
-tenderCodeId	Payment method for the transaction.
loyaltyDetails	Object containing details of the loyalty program.
customerInfo	Object containing details of the customer.
-firstName	First name of the customer.
-lastName	Last name of the customer.

{
    "createdId": 880613909,
    "warnings": [],
    "errors": [],
    "sideEffects": [
        {
            "entityType": "USER",
            "rawAwardedPoints": 1000,
            "awardedPoints": 1000,
            "type": "points"
        },
        {
            "entityType": "USER",
            "rawAwardedValue": 1000,
            "alternateCurrencyIdentifier": "9DxGBP",
            "alternateCurrencyName": "DocCoin",
            "awardedValue": 1000,
            "type": "alternate_currency"
        }
    ],
    "loyaltyDetails": [],
    "customerInfo": {
        "firstName": "John",
        "lastName": "Pork"
    }
}

{
    "createdId": 889244354,
    "warnings": [],
    "errors": [],
    "sideEffects": [],
    "rawSideEffects": [
        {
            "currentEventTargetValue": "1000.0",
            "definedTargetValue": "2000.000",
            "periodEndDate": "2025-07-28",
            "periodRefCode": "Cycle_6",
            "periodStartDate": "2025-07-27",
            "targetAchievedValueAfterEvent": "1000.000",
            "targetAchievedValueBeforeEvent": "0.000",
            "targetEvaluationType": "FIXED_CALENDAR_WINDOW",
            "targetGroupId": "2514",
            "targetGroupName": "Test Milestone UAT 23 July",
            "targetName": "Test Milestone UAT 23 July",
            "targetRuleId": "2711",
            "type": "TARGETLOYALTY",
            "userId": "566135941"
        },
        {
            "alternateCurrencyIdentifier": "null",
            "alternateCurrencyName": "null",
            "awardOn": "BILL",
            "awardStrategyId": "11926",
            "awardedOn": "28th Jul, 2025",
            "awardedOnMillis": "1753711200000",
            "billNumber": "txn-05",
            "customerId": "566135941",
            "evaluatedEntity": "USER",
            "expiryDate": "28th Jul, 2025",
            "expiryDateMillis": "1753711200000",
            "expiryStrategyId": "11932",
            "initialQuantity": "null",
            "initialSourceValue": "1000.0",
            "isDefaultProgram": "false",
            "isReferrer": "false",
            "lineItemId": "-1",
            "pointTypeId": "2183",
            "pointTypeIsRedeemable": "true",
            "pointTypeName": "Main",
            "points": "0.000",
            "pointsBeforeCapping": "0.000",
            "programId": "983",
            "promoId": "-1",
            "promoIdentifier": "",
            "promoName": "",
            "quantity": "null",
            "ruleId": "126539906",
            "ruleSetId": "126369894",
            "sourceId": "889244354",
            "sourceType": "Bill",
            "sourceValue": "1000.0",
            "tenderCodeId": "-1",
            "type": "AWARD"
        },
        {
            "alternateCurrencyIdentifier": "null",
            "alternateCurrencyName": "null",
            "awardOn": "BILL",
            "awardStrategyId": "11926",
            "awardedOn": "28th Jul, 2025",
            "awardedOnMillis": "1753711200000",
            "billNumber": "txn-05",
            "customerId": "566135941",
            "evaluatedEntity": "USER",
            "expiryDate": "28th Jul, 2025",
            "expiryDateMillis": "1753711200000",
            "expiryStrategyId": "11932",
            "initialQuantity": "null",
            "initialSourceValue": "1000.0",
            "isDefaultProgram": "false",
            "isReferrer": "false",
            "lineItemId": "-1",
            "pointTypeId": "2183",
            "pointTypeIsRedeemable": "true",
            "pointTypeName": "Main",
            "points": "0.000",
            "pointsBeforeCapping": "0.000",
            "programId": "983",
            "promoId": "-1",
            "promoIdentifier": "",
            "promoName": "",
            "quantity": "null",
            "ruleId": "126539906",
            "ruleSetId": "126369894",
            "sourceId": "889244354",
            "sourceType": "Bill",
            "sourceValue": "1000.0",
            "tenderCodeId": "-1",
            "type": "AWARD"
        },
        {
            "alternateCurrencyIdentifier": "null",
            "alternateCurrencyName": "null",
            "awardOn": "BILL",
            "awardStrategyId": "11879",
            "awardedOn": "28th Jul, 2025",
            "awardedOnMillis": "1753711200000",
            "billNumber": "txn-05",
            "customerId": "566135941",
            "evaluatedEntity": "USER",
            "expiryDate": "22nd Aug, 2025",
            "expiryDateMillis": "1755907199999",
            "expiryStrategyId": "11825",
            "initialQuantity": "null",
            "initialSourceValue": "1000.0",
            "isDefaultProgram": "true",
            "isReferrer": "false",
            "lineItemId": "-1",
            "pointTypeId": "2143",
            "pointTypeIsRedeemable": "true",
            "pointTypeName": "Main",
            "points": "2000.000",
            "pointsBeforeCapping": "2000.000",
            "programId": "973",
            "promoId": "-1",
            "promoIdentifier": "",
            "promoName": "",
            "quantity": "null",
            "ruleId": "126526786",
            "ruleSetId": "126358113",
            "sourceId": "889244354",
            "sourceType": "Bill",
            "sourceValue": "1000.0",
            "tenderCodeId": "-1",
            "type": "AWARD"
        },
        {
            "alternateCurrencyIdentifier": "9DxGBP",
            "alternateCurrencyName": "DocCoin",
            "awardOn": "BILL",
            "awardStrategyId": "11879",
            "awardedOn": "28th Jul, 2025",
            "awardedOnMillis": "1753711200000",
            "billNumber": "txn-05",
            "customerId": "566135941",
            "evaluatedEntity": "USER",
            "expiryDate": "22nd Aug, 2025",
            "expiryDateMillis": "1755907199999",
            "expiryStrategyId": "11825",
            "initialQuantity": "null",
            "initialSourceValue": "1000.0",
            "isDefaultProgram": "true",
            "isReferrer": "false",
            "lineItemId": "-1",
            "pointTypeId": "2164",
            "pointTypeIsRedeemable": "false",
            "pointTypeName": "DocCoin_REGULAR",
            "points": "2000.000",
            "pointsBeforeCapping": "2000.000",
            "programId": "973",
            "promoId": "-1",
            "promoIdentifier": "",
            "promoName": "",
            "quantity": "null",
            "ruleId": "126526786",
            "ruleSetId": "126358113",
            "sourceId": "889244354",
            "sourceType": "Bill",
            "sourceValue": "1000.0",
            "tenderCodeId": "-1",
            "type": "AWARD"
        }
    ],
    "loyaltyDetails": [],
    "customerInfo": {
        "firstName": "John",
        "lastName": "Pork"
    }
}

Error codes

Error code	Cause	Solution
Time mismatch between billing time and response time	Time conversion is not disabled.	Enable the CONF_ORG_DISABLE_MACHINE_TIME_CONV configuration. When the configuration is enabled, the time from the payload, without the UTC offset, is stored in the database for all clusters. For more information, refer to the documentation here.
400: Missing or empty identifierValue when identifierName=mobile	identifierValue is required	Pass a valid, non-empty identifierValue when identifierName is set to mobile. The API returns a 400 Bad Request error if identifierValue is missing or empty.
624: Invalid return transaction time, Return transaction should happen after add transaction	Incomplete body parameters	Parameter `purchaseTime` should be passed in the body.
603: Invalid transaction id	Transaction ID is incorrect	Use the correct transaction ID.
400: Invalid returnType for NOT_INTERESTED_RETURN	returnType is CANCELLED	Use only AMOUNT, FULL, or LINE_ITEM as returnType for NOT_INTERESTED_RETURN transactions. The value CANCELLED is not supported.

Add/Return transaction (single)

Rate Limit

Notes

Header information

Example request

Mixed transaction example

Request Query Parameters

Request Body Parameters

lineitemsV2 Object

comboDetails object

attribution Object

redemptions Object

paymentModes Object

Note

Important Notes for `Not Interested Return` Transaction

Request body

Response Parameters

Error codes

Rate Limit

Notes

Header information

Example request

Mixed transaction example

Request Query Parameters

Request Body Parameters

lineitemsV2 Object

comboDetails object

attribution Object

redemptions Object

paymentModes Object

Note

Important Notes for Not Interested Return Transaction

Request body

Response Parameters

Error codes

200200

201201

400400

Important Notes for `Not Interested Return` Transaction