Invite New Merchant

Send invitation to merchant for the merchant portal

Invite new merchant

POSThttps://<PayEngine-host>/merchant/invite

Retrieve the details of a merchant.

Request Body

Name	Type	Description
name*	string	Merchant name
email*	string	Merchant's email address to which invite has to be sent
external_id	string	Merchant ID from your system (optional)

200 Response

Name	Type	Description
message	string	Success or failure message of the invite
data.id	string	Merchant ID
data.created_at	string	Creation date of the email invite
data.updated_at	string	Updated date for this invite
data.account_id	string	Partner Account ID
data.email	string	Mechant's email address to which email was sent
data.status	string	Merchant's application status
data.data	object	Contains merchant's application details if the partner fills some merchant's information. Or else, it will empty
data.external_id	string	External ID provided in the request
data.invite_url	string	URL for the merchant onboarding application. This is the same link that is provided in the email
data.name	string	Merchant's name
data.country	string	Merchant's country
data.feeschedule_id	string	Fee Schedule ID assigned to this merchant application

Sample Request

Sample Request

{
  "name": "Tesst Merchant",
  "email": "[email protected]",
  "external_id":"ABC123" 
}

Sample Response

{
    "message": "Invitation to [email protected] successfully sent",
    "data": {
        "id": "d44f7f86-204d-419f-80ba-a50a15607600",
        "created_at": "2024-04-19T17:22:20.621Z",
        "updated_at": "2024-04-19T17:22:20.621Z",
        "account_id": "3cab79a6-31bd-43e6-9a0c-e5870b18fa38",
        "email": "[email protected]",
        "status": "editing",
        "external_id": ABC123,
        "invite_url": "https://abc/signup/user?id=YNP8nfChdjOBm1up&[email protected]",
        "name": "Test Merchant",
        "data": {},
        "country": "US",
        "feeschedule_id": "cec063cc-2363-48e0-9124-e8e3760d00ab"
    }
}