🔌Transaction API

This API Endpoint receive your order transaction.

Environment

Host

• Test: https://normalize-txns-service.stag.tekoapis.net

• Production: https://normalize-txns-service.tekoapis.com

Security

Header

• X-API-KEY: API owner will provide for each service an API key

• TRACE-ID: TraceId is used to block spam requests in the current 5 seconds per traceId. Recommend value format: {order_id}_{order_status}

Normalize transaction from Omni transactions.

Receive Omni transactions.

POSThttp://normalize-txns-service.dev.tekoapis.net/v1/transaction/normalize

Authorization

X-API-KEY

Body

application/json

merchantIdstring

Company ID on CDP (CDP provide)

Example: "soibien"

merchantNamestring

Company name on CDP (CDP provide)

Example: "Sói Biển"

senderEmailstring

Customer's email

Example: "[e-mail]"

senderPhoneNumberstring

Customer's phone

Example: 943999999

senderFullNamestring

Customer's fullname

Example: "Nguyễn Văn A"

senderAccountIdstring

Customer's id

Example: "SB241408"

shopIdstring

ID of shop/store where the order was created

Example: "SB01"

shopNamestring

Name of shop/store where the order was created

Example: "SoiBien Hoang Cau"

shopLocationIdstring

The location ward id of the store where the order was created

Example: 10114

shopLocationNamestring

The location address of the store where the order was created

Example: "Phường Thành Công - Quận Ba Đình - Thành phố Hà Nội"

terminalIdstring

ID of terminal where the order was created

Example: "Soibien_North"

terminalNamestring

Name of terminal where the order was created

Example: "Sói Biển Miền Bắc"

paymentDateinteger

The order created at this timestamp

Example: 1628490676000

paymentTotalAmountinteger

total amount of order, not included the discount amount

Example: 150000

paymentRealAmountinteger

total amount of order, included the discount amount. So paymentRealAmount =< paymentTotalAmount

Example: 140000

paymentDiscountAmountinteger

discount amount of order

Example: 10000

paymentChannelMethodstring

The method of payment for the order. E.g. CASH, BANK_TRANSFER, COD, MOMO, COD, CARD...

Example: "CASH"

txnRefstring

Id of the order

Example: "TD000034"

orderCouponCodesarray of string

List coupon codes that applied for the order

orderLineItemsarray of object

Details of the items in the order

paymentTransactionsarray of object

This contains payment transactions. It even allows multiple payment methods for an order.

statusstring

Order Status. E.g. PENDING, CANCELLED, DELIVERED, RETURNED...

Example: "DELIVERED"

createdAtinteger

Example: 1628490676000

updatedAtinteger

Example: 1628490676000

Response

200

OK

Body

application/json

codenumber

Example: 0

messagestring

Example: "Success!"

datastring

Request

JavaScriptCurlPython

const response = await fetch('http://normalize-txns-service.dev.tekoapis.net/v1/transaction/normalize', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "merchantId": "soibien",
      "merchantName": "Sói Biển",
      "senderEmail": "[e-mail]",
      "senderPhoneNumber": "0948999999",
      "senderFullName": "Nguyễn Văn A",
      "senderAccountId": "SB241408",
      "shopId": "SB01",
      "shopName": "SoiBien Hoang Cau",
      "shopLocationId": 10114,
      "shopLocationName": "Phường Thành Công - Quận Ba Đình - Thành phố Hà Nội",
      "terminalId": "Soibien_North",
      "terminalName": "Sói Biển Miền Bắc",
      "paymentDate": 1628490676000,
      "paymentTotalAmount": 299000,
      "paymentRealAmount": 259000,
      "paymentDiscountAmount": 40000,
      "paymentChannelMethod": "CASH",
      "txnRef": "TD000034",
      "orderCouponCodes": [
        "PROMO20",
        "FREESHIP"
      ],
      "orderLineItems": [
        {
          "skuId": "SKU12384192",
          "skuName": "Cải bắp Vietgap Đà Lạt 500g",
          "quantity": "0.66",
          "categoryId": "tuoisong01",
          "categoryName": "Tươi sống 01",
          "brandId": "112",
          "brandName": "dalatfarm",
          "itemPrice": 22000,
          "itemTotalAmount": 14520,
          "SellerId": 2
        },
        {
          "skuId": "SKU12331279",
          "skuName": "Sườn Thăn lợn Hòa Bình",
          "quantity": "0.55",
          "categoryId": "tuoisong03",
          "categoryName": "Tươi sống 03",
          "brandId": "144",
          "brandName": "CP",
          "itemPrice": 239000,
          "itemTotalAmount": 131450,
          "SellerId": 40
        }
      ],
      "paymentTransactions": [
        {
          "paymentMethod": "CASH",
          "paymentAmount": 125970
        },
        {
          "paymentMethod": "LOYALTY",
          "paymentAmount": 20000
        }
      ],
      "status": "DELIVERED",
      "createdAt": 1628490676000,
      "updatedAt": 1628490676000
    }),
});
const data = await response.json();

Response

200

{
  "code": 0,
  "message": "Success!",
  "data": "text"
}

Location code

440KB

location_data.xlsx