Create Sub Merchant

Endpoint prepared for member merchants registered with Paymes to create sub merchant.

sub-merchant/create

POST https://api.paym.es/marketplace/v1/sub-merchant/create

Request Body

Name	Type	Description
publicKey*	string	The key provided by Paymes to the merchant.
type*	string	It is the parameter that determines the type of sub-merchant and can take two different values; 'individual' - Individual 'corporate' - Corporate / Sole Proprietorship
name*	string	Sub-merchant authorized person name.
surname*	string	Sub-merchant authorized person surname.
email*	string	Sub-merchant email.
phone*	number	Sub-merchant phone. You must send it with the country code without the + at the beginning. Example : 31687153565
iban*	string	The IBAN of the account to which the sub-merchant payment will be sent.
pin	number	Sub-merchant authorized person identification number. (Personal Identification Number)
tin	string	Sub-merchant tax number. Required when the "type" parameter is sent as "corporate". (Tax Identification Number)
tax_office	string	Sub-merchant tax office. Required when "type" parameter is sent as "corporate" and "company_country" parameter is "TR".
company_name	string	Sub-merchant company name. Required when the “type” parameter is sent as “corporate”.
company_country	string	Sub-merchant company country. Required when the “type” parameter is sent as “corporate”.
company_city	string	Sub-merchant company city. Required when the “type” parameter is sent as “corporate”.
company_address	string	Sub-merchant company address "Required when the “type” parameter is sent as “corporate”.
commission_ratio_local	string	Sub-merchant local commission ratio by country. The lowest local commission rate of the merchant it is affiliated with, the highest 100
commission_ratio_foreign	string	Sub-merchant foreign commission ratio by country. The lowest foreign commission rate of the merchant it is affiliated with, the highest 100
payout_days	array	Sub-merchant can only receive payment on the payment days of the parent merchant to which it is affiliated. If this information is not specified, it will be paid on the payment days of the parent merchant it is affiliated with.
company_postal_code	String	Sub-merchant company address postal code "Required when the “type” parameter is sent as “corporate”.

200

{
    "status": true,
    "results": {
        "type": "individual",
        "sub_merchant_id": "17e06dd6-9cbd-4b40-9a2f-b1c6824d751a",
        "secret": "3fd11e639e0d4fe293998ec53122d947",
        "name": "Paym",
        "surname": "Es",
        "email": "[e-mail]",
        "phone": "905555555555",
        "iban": "TR240006263288597775565638",
        "pin": "1111111111",
        "tin": "11111111111",
        "tax_office": "ERENKÖY",
        "company_name": "test",
        "company_country": "TR",
        "company_city": "34",
        "company_address": "Bağdat Cad.",
        "company_postal_code": "34000",
        "is_payout_enabled": 1,
        "payout_days": [
            "1",
            "4"
        ],
        "onboarded_at": "2021-10-12 11:13:08",
        "updated_at": "2021-10-12 11:13:08",
        "created_at": "2021-10-12 11:13:08",
        "full_name": "Paym Es",
        "available_payout_days": [
            1,
            2,
            3,
            4,
            5
        ],
        "commission_ratio": {
            "local": "2.51",
            "foreign": "2.51"
        },
        "can_use_foreign_credit_card": false
    }
}

422

{
    "status": false,
    "error": {
        "phone": [
            "The phone has already been taken."
        ]
    }
}