Add Transaction with Local Currency

Lets you add transactions with a different currency using the currency conversion ratio. The following are the prerequisites or checklists for the API.

📘

Notes

  • Enable CONF_CURRENCY_CONVERSION_ENABLE on the Billing Configuration page of InTouch Profile > Organization Settings > Systems & Deployment > InTouch POS Configurations.
  • Configure org’s base currency and supported currencies on the Organization Setup page of InTouch Profile > Organization Settings > Organization Setup > Organization Profile.
  • If no currency code is provided, the system will use the store's default currency.
  • All monetary values should be provided in the local currency format.
  • The API automatically handles conversion between local and base currency.
  • The response includes both local and base currency values for all monetary fields.
  • Add relevant currency conversion ratios in the back-end either through /v2/currencyratio API or through Data Import.
  • The issual of points/coupon or redemption is calculated automatically as per the destination currency.

Rate Limit

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

Request Body Parameters

Parameter

Type

Description

type

Enum

Type of transaction. regular for loyalty transaction, `not_interested for non-loyalty or not-interested transactions.

credit_note

obj

Details of credit note

currency_code

string

Currency code applicable in ISO format.

notes

string

Additional information about the transaction.

qty

double

Quantity of the current line-item.

rate

float

Price of each each line-item.

value

float

Represents the pre-discount total for a single line item. Calculated as: value = rate × quantity. Example: If a line item has a rate of $10 and quantity of 2, value would be $20.

amount

double

Net transaction amount. The actual transaction amount after discount.

billing_time

date-time

Date and time of the transaction. By default, the current system date and time will be considered.

gross_amount

double

Represents the total transaction amount before any discounts are applied. It's the sum of all line items' values before discounts.
Used in calculations involving the total transaction value.

discount

double

Discount availed for the transaction (discount amount).

outlier_status

Enum

Pass the outlier status of the transaction at transaction level, and outlier status of the line-item at line-item level.
Values: INTERNAL, NORMAL, INVALID, OUTLIER, FAILED``, DELETED, RETRO, FRAUD, TEST, OTHER```.

source

Enum

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).

not_interested_reason

string

Reason why the customer is not interested to register. Applicable only for not-interested transactions.

customer

obj

Pass customer information. Applicable for non-loyalty and not-interested transactions.

extended_fields

obj

Valid transaction level extended field details in name and value pairs. You can also pass line-item level extended field details in line_item object.

customer object

ParameterTypeDescription
mobile/email/id/external_idstringPass any of the registered identifiers of the customer. Required for regular transaction.
firstnamestringFirst name of the customer.
lastnamestringLast name of the customer.

credit_note object

Parameter

Type

Description

amount

double

Net transaction amount of the original bill. Represents the final amount after discounts are applied. For line items: amount = value - discount. For transactions: amount = gross_amount - total_discount

notes

string

Additional information about the transaction.

number*

string

Unique transaction number. The uniqueness depends on the configuration CONF_LOYALTY_BILL_NUMBER_UNIQUE_IN_DAYS set in InTouch Settings > System & Deployment > InTouch POS Configuration > Billing.

  • *Note**: The maximum length for a bill number is 50 characters.

Error Codes

CodeDescription
400Bad Request - Invalid input parameters
401Unauthorized - Invalid or missing authentication
403Forbidden - Insufficient permissions
404Not Found - Resource not found
500Internal Server Error
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!