Update Sub Merchant

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

sub-merchant/update

POST https://api.paym.es/marketplace/v1/sub-merchant/update/{sub_merchant_id}

Path Parameters

Name	Type	Description
sub_merchant_id*	string	The "id" parameter of the sub-merchant you want to edit.

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. There can be 2 values. 'individual' - Individual / Sole Proprietorship 'corporate' - Corporate
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 number of the account to which the sub-merchant payment will be sent.
pin	number	Sub-merchant authorized person identification number.
tin	string	Sub-merchant tax number. Required when the "type" parameter is sent as "corporate".
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_district	string	Sub-merchant company district 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 codfe "Required when the “type” parameter is sent as “corporate”.

200

{
    "status": true,
    "results": {
        "status": true,
        "type": "individual",
        "sub_merchant_id": "45eca5e6-af95-4672-b73b-389ae0f289cd",
        "secret": "6b334055b6f94851b9050c97f1313cd7",
        "name": "Paym",
        "surname": "Es",
        "email": "[e-mail]",
        "phone": "0 (541) 161 32 46",
        "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",
        "payout_days": [
            "1"
        ],
        "is_payout_enabled": 1,
        "is_paused": null,
        "onboarded_at": "2021-10-11 15:51:13",
        "created_at": "2021-10-11 15:51:13",
        "updated_at": "2021-10-12 11:27:06",
        "full_name": "Paym Es",
        "available_payout_days": [
            1,
            2,
            3,
            4,
            5
        ],
        "commission_ratio": {
            "local": "2.99",
            "foreign": "2.99"
        },
        "can_use_foreign_credit_card": false
    }
}

422

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