List Sub Merchants

Endpoint prepared for member merchants registered with Paymes to list sub merchants.

sub-merchant

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

Request Body

NameTypeDescription

publicKey

string

The key provided by Paymes to the merchant.

page

number

Indicates which page is requested information. It starts from 1.

limit

number

Indicates how many elements are on a page. It can be at most 1000.

{
    "status": true,
    "results": {
        "totalCount": 1,
        "items": [
            {
                "status": true,
                "type": "individual",
                "sub_merchant_id": "45eca5e6-af95-4672-b73b-389ae0f289cd",
                "secret": "6b334055b6f94851b9050c97f1313cd7",
                "name": "Paym",
                "surname": "Es",
                "email": "john@doe.com",
                "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",
                "payout_days": [
                    "1",
                    "4"
                ],
                "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-11 15:51:13",
                "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
            }
        ]
    }
}

Last updated