Create a Transaction Rule

Create Transaction Rule

POST https://workspace.myeshopbox.com/payments/v1/transactionRules

Headers

Name
Type
Description

Authorization

string

The Bearer token to grant access to the API

Request Body

Name
Type
Description

ruleName

string

Name for a transaction rule

channelId

string

Unique Id for a sales channel, It is a combination of portal, seller account and fulfillment module.

feeId

array

Fee ids for which transaction rule is created

dueDays

number

Number of days in which payment will be due

settlementType

string

Frequency at which payment will be received, Enum: WEEKLY, MONTHLY, DAILY

settlementDates

string

Date of month at which payment is to be done iff settlementType is MONTHLY

settlementWeekdays

string

Day of week at which settlement is to be done iff settlementType is WEEKLY

transactionRuleId

string

Rule Id for a particular channel

status

boolean

Active or Inactive status of a transaction rule, Reconciliation is not done for Inactive status

portalId

string

Unique Id for a portal (Ex. Amazon, Flipkart)

transactionId

number

Unique Id for any transaction rule

{
    "status": "success"
}

curl -X POST https://workspace.myeshopbox.com/payments/api/v1/transactionRules \
-H "Content-Type: application/json" \
-H "Authorization: Bearer XXXX" \
-d $'{
    "ruleName": "TR2",
    "channelId": "12",
    "feeId": [
        "1",
        "3",
        "5"
    ],
    "dueDays": "7",
    "settlementType": "weekly",
    "settlementDates": "",
    "settlementWeekdays": "Thursday",
    "transactionRuleId": "",
    "status": "",
    "portalId": 2,
    "transactionId": 3
}'

Last updated