Members

Retrieve a member

Retrieve a merchant member.

get/v0.1/merchants/{merchant_code}/members/{member_id}

Path parameters

merchant_codestring required

Example:MK10CL2A

Short unique identifier for the merchant.

member_idstring required

Example:mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP

The ID of the member to retrieve.

Response

Returns the Member object for a valid identifier.

idstring required

ID of the member.

rolesstring[] required

User's roles.

permissionsstring[] required

User's permissions.

created_atstring date-time required

The timestamp of when the member was created.

updated_atstring date-time required

The timestamp of when the member was last updated.

status'accepted' | 'pending' | 'expired' | 'disabled' | 'unknown' required

The status of the membership.

metadataMetadata

Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.

attributesAttributes

Object attributes that are modifiable only by SumUp applications.

Example response

{
  "id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
  "roles": [
    "role_admin",
    "role_owner"
  ],
  "permissions": [
    "members_read",
    "members_write",
    "create_moto_payments",
    "full_transaction_history_view",
    "refund_transactions",
    "create_referral",
    "developer_settings_edit",
    "developer_settings_access"
  ],
  "created_at": "2023-01-20T15:16:17Z",
  "updated_at": "2023-02-20T15:16:17Z",
  "user": {
    "id": "44ca0f5b-813b-46e1-aee7-e6242010662e",
    "email": "example@sumup.com",
    "mfa_on_login_enabled": true,
    "virtual_user": false,
    "service_account_user": false
  },
  "status": "accepted"
}

Changes

Changed in 7 of the 53 revisions of this API.111

Jul 10, 2026c75ca16e1e442See the full diff
- ○
  the security scope members.read was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope user.subaccounts was added to the endpoint's security scheme oauth2
  api-security-scope-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 18, 202689d32e0b22e213See the full diff
- ▲
  the user/classic/user_id response's property type/format changed from integer/int32 to integer/ for status 200
  response-property-type-changed
- ○
  response property user/service_account_user deprecated
  response-property-deprecated
- ○
  response property user/virtual_user deprecated
  response-property-deprecated
- ○
  added the required property user/type to the response with the 200 status
  response-required-property-added
Mar 11, 2026cd79d83b07e01See the full diff
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 404
  response-media-type-name-specialized
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 11, 2025b8fb7c9463b81See the full diff
- ○
  added the media type application/json for the response with the status 404
  response-media-type-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 29, 20254dc4b073a6a91See the full diff
- ○
  response property permissions deprecated
  response-property-deprecated
Mar 26, 202580a17713e7a81See the full diff
- ○
  added the required property user/service_account_user to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 25, 2025cdadac3315a12See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security oauth2 was added to the API
  api-security-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history