🚧 This project is currently in active development. A sandbox environment will be made available soon for testing and exploration. Stay tuned!

Portal users with access to a merchant

Sandbox

GET

/v1/merchants/{merchantId}/users

Lists the portal users attached to the merchant, with role and status.

Request

Authorization

API Key

Add parameter in header

api_key

Example:

api_key: ********************

Path Params

Responses

🟢200

application/json

Users on the merchant

Bodyapplication/json

🟠404NotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/merchants//users' \
--header 'api_key: <api-key>'

Response Example

200 - Example 1

{
    "data": [
        {
            "relationship_id": 0,
            "id": 0,
            "name": "string",
            "email": "string",
            "roles": [
                "string"
            ],
            "merchant_role_id": 0,
            "reseller_id": 0,
            "status": "active",
            "last_login": "string"
        }
    ]
}

Bank account on file (account numbers masked)

KYC documents uploaded for a merchant