v50

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-0342108400.9 KB

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"
}