Notifications

Each time that a Submerchant:

• is successfully onboarded through the Referral Signup Form, or

• a change in information has occurred in a Submerchant of yours

A webhook notification will be sent to the Referral URL that you defined at:

Merchant Panel ➡️ Settings ➡️ API Access ➡️ Referral URL

Firewall configurations

Bear in mind we will only connect through ports 80 and 443. Make sure your Referral URL has one of those ports open accepting connections from us.

Example

{
    "sub_merchant_id":18703
}

Field	Format	Description
sub_merchant_id	Integer	Identifier of the SubMerchant on our end.

Retrieve Submerchant details

With the received sub_merchant_id you can now retrieve the recently created Submerchant's details.

In order to do so, you can generate an API request to the Get submerchant information or you can visit the dedicated section in the Merchant Panel ("Referred merchants").

Example response GET /v3/sub_merchants/{sub_merchant_id}

{
    "sub_merchant_id": 18703,
    "markup_fee": 2.00,
    "sub_merchant_name": "Dunder Mifflin",
    "email": "[email protected]",
    "status": "ACTIVE",
    "external_submerchant_id":"user-9876"
}

markup_fee

The markup_fee is the commision that the Platform receives for each transaction successfully created by the Submerchant. Note that the markup_fee received in the response, is the default value for all recently created Submerchants. It can be aligned with your commercial representative.

You can update the value via API Update a comission and also through the Merchant Panel (in the Referred merchants section).

status

Note that only Submerchants with status ACTIVE are capable to process payments.