New Merchant Info - Onboarding API

The New Merchant Info API is used to create a new merchant Info.

Request

Path Params

Body Params application/json

Example

{
    "basicInfo": {
        "groupID": "string",
        "merchantID": "string",
        "merchantName": "string",
        "merchantEnglishName": "string",
        "mailingAddress": "string",
        "branchID": "string",
        "city": "string",
        "clientID": "string",
        "merchantRegistrationName": "string",
        "businessRegistrationNumber": "string",
        "merchantLegalPersonID": "string",
        "paymentPurposeCode": "string",
        "contactInfos": [
            {
                "contactName": "string",
                "emailAddress": "string",
                "phoneNumber": "string",
                "titleOrDepartment": "string",
                "birthday": "string"
            }
        ]
    },
    "secretKeyConfiguration": {
        "merchantLevelKey": true
    },
    "refundOnPortal": {
        "supportRefundOnPortal": true,
        "refundTimeFrame": "str"
    },
    "mdrRules": {
        "followMDRRule": true,
        "mdrRuleType": "string",
        "fixedRate": "strin",
        "merchantMDRs": [
            {
                "planID": "string",
                "externalPlanID": "string",
                "validityStartDate": "string",
                "validityEndDate": "string"
            }
        ]
    },
    "settlementTo": "string",
    "riskFunctionCategory": {
        "supportTransactionLimit": true,
        "planID": "string",
        "externalPlanID": "string"
    }
}

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "basicInfo": {
        "acquirerID": "string",
        "acquirerName": "string",
        "acquirerEnglishName": "string",
        "groupID": "string",
        "groupName": "string",
        "groupEnglishName": "string",
        "merchantID": "string",
        "merchantName": "string",
        "merchantEnglishName": "string",
        "mailingAddress": "string",
        "branchID": "string",
        "branchName": "string",
        "branchEnglishName": "string",
        "city": "string",
        "clientID": "string",
        "merchantType": "string",
        "merchantRegistrationName": "string",
        "businessRegistrationNumber": "string",
        "merchantLegalPersonID": "string",
        "paymentPurposeCode": "string",
        "status": "string",
        "onboardingDate": "2019-08-24T14:15:22.123Z"
    },
    "result": {
        "code": "string",
        "message": "string"
    }
}