Retrieve a member

MembersPreview feature

Endpoints to manage account members. Members are users that have membership within merchant accounts.

The Member object

A member is user within specific resource identified by resource id, resource type, and associated roles.

Member

id string required

ID of the member.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
roles []string required

User's roles.
permissions []string deprecated required

Permissions include only legacy permissions, please use roles instead. Member access is based on roles within a given resource and the permissions these roles grant.

User's permissions.
created_at string date-time required

The timestamp of when the member was created.

Example: "2023-01-20T15:16:17Z"
updated_at string date-time required

The timestamp of when the member was last updated.

Example: "2023-01-20T15:16:17Z"
user object

Information about the user associated with the membership.
Show attributes
Close

Attributes
- id string required
  
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
- email string required
  
  End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
  
  Example: "example@sumup.com"
- mfa_on_login_enabled boolean required
  
  True if the user has enabled MFA on login.
  
  Example: true
- virtual_user boolean required
  
  True if the user is a virtual user (operator).
- service_account_user boolean required
  
  True if the user is a service account.
- disabled_at string date-time
  
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
- nickname string
  
  User's preferred name. Used for display purposes only.
  
  Example: "Test User"
- picture string uri
  
  URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.
  
  Example: "https://usercontent.sumup.com/44ca0f5b-813b-46e1-aee7-e6242010662e.png"
- classic object deprecated
  
  Classic identifiers of the user.
  
  Show attributes
  
  Close
  
  Attributes
  
  user_id integer required
invite object

Pending invitation for membership.
Show attributes
Close

Invite
- email string email required
  
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_at string date-time required
  
  Example: "2023-01-20T15:16:17Z"
status string required

The status of the membership.
metadata object max properties: 64

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.

Example: {}
attributes object

Object attributes that are modifiable only by SumUp applications.

Example: {}

1
{
2
  "id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
3
  "roles": [
4
    "role_admin",
5
    "role_owner"
6
  ],
7
  "permissions": [
8
    "members_read",
9
    "members_write",
10
    "create_moto_payments",
11
    "full_transaction_history_view",
12
    "refund_transactions",
13
    "create_referral",
14
    "developer_settings_edit",
15
    "developer_settings_access"
16
  ],
17
  "created_at": "2023-01-20T15:16:17Z",
18
  "updated_at": "2023-02-20T15:16:17Z",
19
  "user": {
20
    "id": "44ca0f5b-813b-46e1-aee7-e6242010662e",
21
    "email": "example@sumup.com",
22
    "mfa_on_login_enabled": true,
23
    "virtual_user": false,
24
    "service_account_user": false
25
  },
26
  "status": "accepted"
27
}

Members

List members

Lists merchant members.

Required permissions: merchant_read

Path Parameters

merchant_code string required

Short unique identifier for the merchant.

Example: "MK10CL2A"

Query Parameters

offset integer minimum: 0default: 0

Offset of the first member to return.

Example: 0
limit integer minimum: 1maximum: 25default: 10

Maximum number of members to return.

Example: 10
scroll boolean default: false

Indicates to skip count query.

Example: true
email string

Filter the returned members by email address prefix.

Example: "user"
user.id string uuid

Search for a member by user id.

Example: "245b2ead-85bf-45ff-856f-311a88a5d454"
status string

Options: accepted pending expired disabled unknown

Filter the returned members by the membership status.
roles []string

Filter the returned members by role.

Example: ["role_employee","role_accountant"]

Response 200

items []object required

A member is user within specific resource identified by resource id, resource type, and associated roles.
Show attributes
Close

Member
- id string required
  
  ID of the member.
  
  Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
- roles []string required
  
  User's roles.
- permissions []string deprecated required
  
  Permissions include only legacy permissions, please use roles instead. Member access is based on roles within a given resource and the permissions these roles grant.
  
  User's permissions.
- created_at string date-time required
  
  The timestamp of when the member was created.
  
  Example: "2023-01-20T15:16:17Z"
- updated_at string date-time required
  
  The timestamp of when the member was last updated.
  
  Example: "2023-01-20T15:16:17Z"
- user object
  
  Information about the user associated with the membership.
  
  Show attributes
  
  Close
  
  Attributes
  
  id string required
  
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
  
  email string required
  
  End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
  
  Example: "example@sumup.com"
  
  mfa_on_login_enabled boolean required
  
  True if the user has enabled MFA on login.
  
  Example: true
  
  virtual_user boolean required
  
  True if the user is a virtual user (operator).
  
  service_account_user boolean required
  
  True if the user is a service account.
  
  disabled_at string date-time
  
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
  
  nickname string
  
  User's preferred name. Used for display purposes only.
  
  Example: "Test User"
  
  picture string uri
  
  URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.
  
  Example: "https://usercontent.sumup.com/44ca0f5b-813b-46e1-aee7-e6242010662e.png"
  
  classic object deprecated
  
  Classic identifiers of the user.
  
  Show attributes
  
  Close
  
  Attributes
  
  user_id integer required
- invite object
  
  Pending invitation for membership.
  
  Show attributes
  
  Close
  
  Invite
  
  email string email required
  
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
  
  expires_at string date-time required
  
  Example: "2023-01-20T15:16:17Z"
- status string required
  
  The status of the membership.
- metadata object max properties: 64
  
  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.
  
  Example: {}
- attributes object
  
  Object attributes that are modifiable only by SumUp applications.
  
  Example: {}
total_count integer

Example: 3

1
curl https://api.sumup.com/v0.1/merchants/{merchant_code}/members \
2
 -X GET \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.members.list("MK10CL2A");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Members.ListAsync(
6
    "MK10CL2A"
7
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.members().listMerchantMembers(
6
  "MK10CL2A"
7
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.members.list("MK10CL2A")

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->members->list('MK10CL2A');

1
client := sumup.NewClient()
2

3
result, err := client.Members.List(context.Background(), "MK10CL2A")

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.members().list("MK10CL2A", sumup::ListMerchantMembersParams{
6
    offset: Some(0),
7
    limit: Some(10),
8
    scroll: Some(true),
9
    email: Some("user".to_string()),
10
    user_id: Some("245b2ead-85bf-45ff-856f-311a88a5d454".to_string()),
11
    status: Some("status".to_string()),
12
    roles: Some(["role_employee","role_accountant"]),
13
}).await;

1
{
2
  "items": [
3
    {
4
      "id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
5
      "roles": [
6
        "role_admin",
7
        "role_owner"
8
      ],
9
      "permissions": [
10
        "members_read",
11
        "members_write",
12
        "create_moto_payments",
13
        "full_transaction_history_view",
14
        "refund_transactions",
15
        "create_referral",
16
        "developer_settings_edit",
17
        "developer_settings_access"
18
      ],
19
      "created_at": "2023-01-20T15:16:17Z",
20
      "updated_at": "2023-02-20T15:16:17Z",
21
      "user": {
22
        "id": "44ca0f5b-813b-46e1-aee7-e6242010662e",
23
        "email": "example@sumup.com",
24
        "mfa_on_login_enabled": true,
25
        "virtual_user": false,
26
        "service_account_user": false
27
      },
28
      "status": "accepted"
29
    }
30
  ],
31
  "total_count": 3
32
}

Members

Create a member

Create a merchant member.

Required permissions: members_create

Path Parameters

merchant_code string required

Short unique identifier for the merchant.

Example: "MK10CL2A"

Body Parameters

is_managed_user boolean

True if the user is managed by the merchant. In this case, we'll created a virtual user with the provided password and nickname.
email string email required

Email address of the member to add.
password string min length: 8password

Password of the member to add. Only used if is_managed_user is true. In the case of service accounts, the password is not used and can not be defined by the caller.
nickname string

Nickname of the member to add. Only used if is_managed_user is true. Used for display purposes only.

Example: "Test User"
roles []string required

List of roles to assign to the new member.
metadata object max properties: 64

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.

Example: {}
attributes object

Object attributes that are modifiable only by SumUp applications.

Example: {}

Member

id string required

ID of the member.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
roles []string required

User's roles.
permissions []string deprecated required

Permissions include only legacy permissions, please use roles instead. Member access is based on roles within a given resource and the permissions these roles grant.

User's permissions.
created_at string date-time required

The timestamp of when the member was created.

Example: "2023-01-20T15:16:17Z"
updated_at string date-time required

The timestamp of when the member was last updated.

Example: "2023-01-20T15:16:17Z"
user object

Information about the user associated with the membership.
Show attributes
Close

Attributes
- id string required
  
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
- email string required
  
  End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
  
  Example: "example@sumup.com"
- mfa_on_login_enabled boolean required
  
  True if the user has enabled MFA on login.
  
  Example: true
- virtual_user boolean required
  
  True if the user is a virtual user (operator).
- service_account_user boolean required
  
  True if the user is a service account.
- disabled_at string date-time
  
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
- nickname string
  
  User's preferred name. Used for display purposes only.
  
  Example: "Test User"
- picture string uri
  
  URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.
  
  Example: "https://usercontent.sumup.com/44ca0f5b-813b-46e1-aee7-e6242010662e.png"
- classic object deprecated
  
  Classic identifiers of the user.
  
  Show attributes
  
  Close
  
  Attributes
  
  user_id integer required
invite object

Pending invitation for membership.
Show attributes
Close

Invite
- email string email required
  
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_at string date-time required
  
  Example: "2023-01-20T15:16:17Z"
status string required

The status of the membership.
metadata object max properties: 64

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.

Example: {}
attributes object

Object attributes that are modifiable only by SumUp applications.

Example: {}

1
curl https://api.sumup.com/v0.1/merchants/{merchant_code}/members \
2
 -X POST \
3
 -H "Authorization: Bearer $SUMUP_API_KEY" \
4
 --json '{
5
    "email": "karl.berg@example.com",
6
    "roles": [
7
      "role_employee"
8
    ]
9
  }'

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.members.create("MK10CL2A", {
6
  email: "karl.berg@example.com",
7
  roles: ["role_employee"],
8
});

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Members.CreateAsync(
6
    "MK10CL2A",
7
    new CreateMerchantMemberBody
8
    {
9
        Email = "karl.berg@example.com",
10
        Roles = new[] { "role_employee" },
11
    }
12
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.members().createMerchantMember(
6
  "MK10CL2A",
7
  CreateMerchantMemberBody.builder()
8
    .email("karl.berg@example.com")
9
    .roles(java.util.List.of(
10
        "role_employee"
11
      ))
12
    .build()
13
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.members.create("MK10CL2A", CreateMerchantMemberBody(
6
  email="karl.berg@example.com",
7
  roles=["role_employee"],
8
))

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->members->create('MK10CL2A', [
4
  'email' => 'karl.berg@example.com',
5
  'roles' => [    'role_employee'],
6
]);

1
client := sumup.NewClient()
2

3
result, err := client.Members.Create(context.Background(), "MK10CL2A", sumup.MembersCreateParams{
4
  Email: "karl.berg@example.com",
5
  Roles: ["role_employee"],
6
})

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.members().create("MK10CL2A", sumup::CreateMerchantMemberBody{
6
  email: "karl.berg@example.com".to_string(),
7
  roles: vec!["role_employee"],
8
}).await;

1
{
2
  "id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
3
  "roles": [
4
    "role_admin",
5
    "role_owner"
6
  ],
7
  "permissions": [
8
    "members_read",
9
    "members_write",
10
    "create_moto_payments",
11
    "full_transaction_history_view",
12
    "refund_transactions",
13
    "create_referral",
14
    "developer_settings_edit",
15
    "developer_settings_access"
16
  ],
17
  "created_at": "2023-01-20T15:16:17Z",
18
  "updated_at": "2023-02-20T15:16:17Z",
19
  "user": {
20
    "id": "44ca0f5b-813b-46e1-aee7-e6242010662e",
21
    "email": "example@sumup.com",
22
    "mfa_on_login_enabled": true,
23
    "virtual_user": false,
24
    "service_account_user": false
25
  },
26
  "status": "accepted"
27
}

Members

Retrieve a member

Retrieve a merchant member.

Required permissions: members_view

Path Parameters

merchant_code string required

Short unique identifier for the merchant.

Example: "MK10CL2A"
member_id string required

The ID of the member to retrieve.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"

Member

id string required

ID of the member.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
roles []string required

User's roles.
permissions []string deprecated required

Permissions include only legacy permissions, please use roles instead. Member access is based on roles within a given resource and the permissions these roles grant.

User's permissions.
created_at string date-time required

The timestamp of when the member was created.

Example: "2023-01-20T15:16:17Z"
updated_at string date-time required

The timestamp of when the member was last updated.

Example: "2023-01-20T15:16:17Z"
user object

Information about the user associated with the membership.
Show attributes
Close

Attributes
- id string required
  
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
- email string required
  
  End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
  
  Example: "example@sumup.com"
- mfa_on_login_enabled boolean required
  
  True if the user has enabled MFA on login.
  
  Example: true
- virtual_user boolean required
  
  True if the user is a virtual user (operator).
- service_account_user boolean required
  
  True if the user is a service account.
- disabled_at string date-time
  
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
- nickname string
  
  User's preferred name. Used for display purposes only.
  
  Example: "Test User"
- picture string uri
  
  URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.
  
  Example: "https://usercontent.sumup.com/44ca0f5b-813b-46e1-aee7-e6242010662e.png"
- classic object deprecated
  
  Classic identifiers of the user.
  
  Show attributes
  
  Close
  
  Attributes
  
  user_id integer required
invite object

Pending invitation for membership.
Show attributes
Close

Invite
- email string email required
  
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_at string date-time required
  
  Example: "2023-01-20T15:16:17Z"
status string required

The status of the membership.
metadata object max properties: 64

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.

Example: {}
attributes object

Object attributes that are modifiable only by SumUp applications.

Example: {}

1
curl https://api.sumup.com/v0.1/merchants/{merchant_code}/members/{member_id} \
2
 -X GET \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.members.get("MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Members.GetAsync(
6
    "MK10CL2A",
7
    "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
8
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.members().getMerchantMember(
6
  "MK10CL2A",
7
  "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
8
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.members.get("MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP")

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->members->get('MK10CL2A', 'mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP');

1
client := sumup.NewClient()
2

3
result, err := client.Members.Get(context.Background(), "MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP")

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.members().get("MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP").await;

1
{
2
  "id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
3
  "roles": [
4
    "role_admin",
5
    "role_owner"
6
  ],
7
  "permissions": [
8
    "members_read",
9
    "members_write",
10
    "create_moto_payments",
11
    "full_transaction_history_view",
12
    "refund_transactions",
13
    "create_referral",
14
    "developer_settings_edit",
15
    "developer_settings_access"
16
  ],
17
  "created_at": "2023-01-20T15:16:17Z",
18
  "updated_at": "2023-02-20T15:16:17Z",
19
  "user": {
20
    "id": "44ca0f5b-813b-46e1-aee7-e6242010662e",
21
    "email": "example@sumup.com",
22
    "mfa_on_login_enabled": true,
23
    "virtual_user": false,
24
    "service_account_user": false
25
  },
26
  "status": "accepted"
27
}

Members

Update a member

Update the merchant member.

Required permissions: members_update

Path Parameters

merchant_code string required

Short unique identifier for the merchant.

Example: "MK10CL2A"
member_id string required

The ID of the member to retrieve.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"

Body Parameters

roles []string
metadata object max properties: 64

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.

Example: {}
attributes object

Object attributes that are modifiable only by SumUp applications.

Example: {}
user object

Allows you to update user data of managed users.
Show attributes
Close

Attributes
- nickname string
  
  User's preferred name. Used for display purposes only.
  
  Example: "Test User"
- password string min length: 8password
  
  Password of the member to add. Only used if is_managed_user is true.

Member

id string required

ID of the member.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
roles []string required

User's roles.
permissions []string deprecated required

Permissions include only legacy permissions, please use roles instead. Member access is based on roles within a given resource and the permissions these roles grant.

User's permissions.
created_at string date-time required

The timestamp of when the member was created.

Example: "2023-01-20T15:16:17Z"
updated_at string date-time required

The timestamp of when the member was last updated.

Example: "2023-01-20T15:16:17Z"
user object

Information about the user associated with the membership.
Show attributes
Close

Attributes
- id string required
  
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
- email string required
  
  End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
  
  Example: "example@sumup.com"
- mfa_on_login_enabled boolean required
  
  True if the user has enabled MFA on login.
  
  Example: true
- virtual_user boolean required
  
  True if the user is a virtual user (operator).
- service_account_user boolean required
  
  True if the user is a service account.
- disabled_at string date-time
  
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
- nickname string
  
  User's preferred name. Used for display purposes only.
  
  Example: "Test User"
- picture string uri
  
  URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.
  
  Example: "https://usercontent.sumup.com/44ca0f5b-813b-46e1-aee7-e6242010662e.png"
- classic object deprecated
  
  Classic identifiers of the user.
  
  Show attributes
  
  Close
  
  Attributes
  
  user_id integer required
invite object

Pending invitation for membership.
Show attributes
Close

Invite
- email string email required
  
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_at string date-time required
  
  Example: "2023-01-20T15:16:17Z"
status string required

The status of the membership.
metadata object max properties: 64

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.

Example: {}
attributes object

Object attributes that are modifiable only by SumUp applications.

Example: {}

1
curl https://api.sumup.com/v0.1/merchants/{merchant_code}/members/{member_id} \
2
 -X PUT \
3
 -H "Authorization: Bearer $SUMUP_API_KEY" \
4
 --json '{
5
    "Update member\'s role": {
6
      "roles": [
7
        "role_manager"
8
      ]
9
    },
10
    "Update managed user": {
11
      "user": {
12
        "nickname": "New Employee Name"
13
      }
14
    }
15
  }'

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.members.update("MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP", {
6
  Update member's role: {"roles":["role_manager"]},
7
  Update managed user: {"user":{"nickname":"New Employee Name"}},
8
});

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Members.UpdateAsync(
6
    "MK10CL2A",
7
    "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
8
    new UpdateMerchantMemberBody
9
    {
10
        UpdateMemberSRole = null,
11
        UpdateManagedUser = null,
12
    }
13
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.members().updateMerchantMember(
6
  "MK10CL2A",
7
  "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
8
  UpdateMerchantMemberBody.builder()
9
    .updateMemberSRole(null)
10
    .updateManagedUser(null)
11
    .build()
12
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.members.update("MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP", UpdateMerchantMemberBody(
6
  Update member's role={"roles":["role_manager"]},
7
  Update managed user={"user":{"nickname":"New Employee Name"}},
8
))

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->members->update('MK10CL2A', 'mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP', [
4
  'Update member's role' => [
5
      'roles' => [      'role_manager'],
6
    ],
7
  'Update managed user' => [
8
      'user' => [
9
            'nickname' => 'New Employee Name',
10
          ],
11
    ],
12
]);

1
client := sumup.NewClient()
2

3
result, err := client.Members.Update(context.Background(), "MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP", sumup.MembersUpdateParams{
4
  UpdateMemberSRole: {"roles":["role_manager"]},
5
  UpdateManagedUser: {"user":{"nickname":"New Employee Name"}},
6
})

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.members().update("MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP", sumup::UpdateMerchantMemberBody{
6
  update_member_s_role: {"roles":["role_manager"]},
7
  update_managed_user: {"user":{"nickname":"New Employee Name"}},
8
}).await;

1
{
2
  "id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
3
  "roles": [
4
    "role_admin",
5
    "role_owner"
6
  ],
7
  "permissions": [
8
    "members_read",
9
    "members_write",
10
    "create_moto_payments",
11
    "full_transaction_history_view",
12
    "refund_transactions",
13
    "create_referral",
14
    "developer_settings_edit",
15
    "developer_settings_access"
16
  ],
17
  "created_at": "2023-01-20T15:16:17Z",
18
  "updated_at": "2023-02-20T15:16:17Z",
19
  "user": {
20
    "id": "44ca0f5b-813b-46e1-aee7-e6242010662e",
21
    "email": "example@sumup.com",
22
    "mfa_on_login_enabled": true,
23
    "virtual_user": false,
24
    "service_account_user": false
25
  },
26
  "status": "accepted"
27
}

Members

Delete a member

Deletes a merchant member.

Required permissions: members_delete

Path Parameters

merchant_code string required

Short unique identifier for the merchant.

Example: "MK10CL2A"
member_id string required

The ID of the member to retrieve.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"

1
curl https://api.sumup.com/v0.1/merchants/{merchant_code}/members/{member_id} \
2
 -X DELETE \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.members.delete("MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Members.DeleteAsync(
6
    "MK10CL2A",
7
    "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
8
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.members().deleteMerchantMember(
6
  "MK10CL2A",
7
  "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
8
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.members.delete("MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP")

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->members->delete('MK10CL2A', 'mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP');

1
client := sumup.NewClient()
2

3
result, err := client.Members.Delete(context.Background(), "MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP")

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.members().delete("MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP").await;