Members | SumUp Developer

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

Endpoints

The Member object

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

idstringrequired
ID of the member.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
roles[]stringrequired
User's roles.
permissions[]stringrequireddeprecated
Caution
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_atstringrequiredformat: date-time
The timestamp of when the member was created.

Example: "2023-01-20T15:16:17Z"
updated_atstringrequiredformat: date-time
The timestamp of when the member was last updated.

Example: "2023-01-20T15:16:17Z"
userobject
Information about the user associated with the membership.
Show attributes
Close
Attributes
- idstringrequired
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
- typestringrequired
  Options: usermanaged_userservice_accountsystem_account
  Type of the user account.
  
  Example: "user"
- emailstringrequired
  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_enabledbooleanrequired
  True if the user has enabled MFA on login.
  
  Example: true
- virtual_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a virtual user (operator).
- service_account_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a service account.
- disabled_atstringformat: date-time
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
- nicknamestring
  User's nickname. Used for display purposes only.
  
  Example: "Test User"
- picturestringformat: 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"
- classicobjectdeprecated
  Classic identifiers of the user.
  
  Show attributes
  Close
  Attributes
  user_idintegerrequiredminimum: 0, maximum: 2147483647
inviteInvite
Pending invitation for membership.
Show attributes
Close
Invite
- emailstringrequiredformat: email
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_atstringrequiredformat: date-time
  Example: "2023-01-20T15:16:17Z"
statusstringrequired
Options: acceptedpendingexpireddisabledunknown
The status of the membership.
metadataobjectmax 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: {}
attributesobject
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

GET/v0.1/merchants/{merchant_code}/members

Lists merchant members.

Requires one of scopes:user.subaccountsmembers.read

Required permissions:merchant_read

Path Parameters

merchant_codestringrequired
Short unique identifier for the merchant.

Example: "MK10CL2A"

Query Parameters

offsetintegerminimum: 0, default: 0
Offset of the first member to return.

Example: 0
limitintegerminimum: 1, maximum: 25, default: 10
Maximum number of members to return.

Example: 10
scrollbooleandefault: false
Indicates to skip count query.

Example: true
emailstring
Filter the returned members by email address prefix.

Example: "user"
user.idstringformat: uuid
Search for a member by user id.

Example: "245b2ead-85bf-45ff-856f-311a88a5d454"
statusstring
Options: acceptedpendingexpireddisabledunknown
Filter the returned members by the membership status.
roles[]string
Filter the returned members by role.

Example: ["role_employee","role_accountant"]

Response

Returns a list of Member objects. See Member object.

items[]Memberrequired
A member is user within specific resource identified by resource id, resource type, and associated roles.
Show attributes
Close
Member
- idstringrequired
  ID of the member.
  
  Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
- roles[]stringrequired
  User's roles.
- permissions[]stringrequireddeprecated
  Caution
  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_atstringrequiredformat: date-time
  The timestamp of when the member was created.
  
  Example: "2023-01-20T15:16:17Z"
- updated_atstringrequiredformat: date-time
  The timestamp of when the member was last updated.
  
  Example: "2023-01-20T15:16:17Z"
- userobject
  Information about the user associated with the membership.
  
  Show attributes
  Close
  Attributes
  idstringrequired
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
  typestringrequired
  Options: usermanaged_userservice_accountsystem_account
  Type of the user account.
  
  Example: "user"
  emailstringrequired
  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_enabledbooleanrequired
  True if the user has enabled MFA on login.
  
  Example: true
  virtual_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a virtual user (operator).
  
  service_account_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a service account.
  
  disabled_atstringformat: date-time
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
  
  nicknamestring
  User's nickname. Used for display purposes only.
  
  Example: "Test User"
  picturestringformat: 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"
  classicobjectdeprecated
  Classic identifiers of the user.
  
  Show attributes
  Close
  Attributes
  user_idintegerrequiredminimum: 0, maximum: 2147483647
- inviteInvite
  Pending invitation for membership.
  
  Show attributes
  Close
  Invite
  emailstringrequiredformat: email
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
  expires_atstringrequiredformat: date-time
  Example: "2023-01-20T15:16:17Z"
- statusstringrequired
  Options: acceptedpendingexpireddisabledunknown
  The status of the membership.
- metadataobjectmax 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: {}
- attributesobject
  Object attributes that are modifiable only by SumUp applications.
  
  Example: {}
total_countinteger
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
sumup members list \
2
  --merchant-code "MK10CL2A"

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

3
async function main() {
4
  const client = new SumUp({ apiKey: "sup_sk_your_api_key" });
5

6
  const result = await client.members.list(
7
    "MK10CL2A",
8
    {
9
      "offset": 0
10
    }
11
  );
12
  console.log(result);
13
}
14

15
main().catch(console.error);

1
using System;
2
using System.Collections.Generic;
3
using System.Threading.Tasks;
4
using SumUp;
5

6
public static class Program
7
{
8
    public static async Task Main()
9
    {
10
        using var client = new SumUpClient();
11
        var response = await client.Members.ListAsync(
12
            "your-merchant-code",
13
            new MembersListOptions
14
            {
15
                Offset = 10,
16
                Limit = 10,
17
                Scroll = true,
18
                Email = "merchant@example.com",
19
                UserId = Guid.Parse("00000000-0000-0000-0000-000000000001"),
20
                UserType = Array.Empty<UserType>(),
21
                Status = MembershipStatus.Accepted,
22
                Roles = Array.Empty<string>(),
23
            });
24

25
        Console.WriteLine(response.StatusCode);
26
    }
27
}

1
import com.sumup.sdk.SumUpClient;
2

3
public final class ListMerchantMembersSample {
4
  public static void main(String[] args) throws Exception {
5
    var client = new SumUpClient();
6

7
    var result = client.members().list(
8
            "MK10CL2A"
9
        );
10
    System.out.println(result);
11
  }
12
}

1
import os
2

3
import sumup
4

5
client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])
6
result = client.members.list(
7
    "MK10CL2A",
8
    offset=0,
9
    limit=10,
10
    scroll=True,
11
    email="user",
12
    user_id="245b2ead-85bf-45ff-856f-311a88a5d454",
13
    status="accepted",
14
    roles=[
15
        "role_employee",
16
        "role_accountant",
17
    ],
18
)
19
print(result)

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

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

1
package main
2

3
import (
4
  "context"
5
  "fmt"
6

7
  "github.com/sumup/sumup-go"
8
)
9

10
func main() {
11
  client := sumup.NewClient()
12
  result, err := client.Members.List(context.TODO(), "MK10CL2A", sumup.MembersListParams{
13
    Offset: new(0),
14
    Limit:  new(10),
15
    Scroll: new(true),
16
    Email:  new("user"),
17
    UserID: new("245b2ead-85bf-45ff-856f-311a88a5d454"),
18
    Status: new(sumup.MembershipStatus("accepted")),
19
    Roles:  []string{"role_employee", "role_accountant"},
20
  })
21
  if err != nil {
22
    panic(err.Error())
23
  }
24

25
  fmt.Printf("%+v\n", result)
26
}

1
use sumup::{Authorization, Client};
2
#[tokio::main]
3
async fn main() {
4
    let client = Client::default()
5
        .with_authorization(Authorization::api_key("sup_sk_test_..."));
6
    let response = client
7
        .members()
8
        .list("MERCHANT_CODE", Default::default())
9
        .await
10
        .expect("list request failed");
11
    println!("{response:#?}");
12
}

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
}

Error 404

Content-Type: application/problem+json

Merchant not found.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Error 404

1
{
2
  "type": "https://developer.sumup.com/problem/not-found",
3
  "title": "Requested resource couldn't be found.",
4
  "status": 404,
5
  "detail": "The requested resource doesn't exist or does not belong to you."
6
}

Members

Create a member

POST/v0.1/merchants/{merchant_code}/members

Adds a member to the merchant account with the specified roles.

By default, sends an invitation email to the provided address. The recipient must accept the invitation to join the account. When is_managed_user is true, creates a managed user with the provided password and optional nickname and assigns the roles directly, without sending an invitation.

Requires one of scopes:user.subaccountsmembers.write

Required permissions:members_create

Path Parameters

merchant_codestringrequired
Short unique identifier for the merchant.

Example: "MK10CL2A"

Body Parameters

is_managed_userboolean
True if the user is managed by the merchant. In this case, we'll created a virtual user with the provided password and nickname.
emailstringrequiredmax length: 256, format: email
Email address of the member to add.
passwordstringmin length: 8, format: password
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.
nicknamestringmax length: 64
Nickname of the member to add. Only used if is_managed_user is true. Used for display purposes only.

Example: "Test User"
roles[]stringrequiredmin items: 1, max items: 124
List of roles to assign to the new member.
metadataobjectmax 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: {}
attributesobject
Object attributes that are modifiable only by SumUp applications.

Example: {}

Response

Returns the Member object if the creation succeeded. See Member object.

idstringrequired
ID of the member.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
roles[]stringrequired
User's roles.
permissions[]stringrequireddeprecated
Caution
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_atstringrequiredformat: date-time
The timestamp of when the member was created.

Example: "2023-01-20T15:16:17Z"
updated_atstringrequiredformat: date-time
The timestamp of when the member was last updated.

Example: "2023-01-20T15:16:17Z"
userobject
Information about the user associated with the membership.
Show attributes
Close
Attributes
- idstringrequired
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
- typestringrequired
  Options: usermanaged_userservice_accountsystem_account
  Type of the user account.
  
  Example: "user"
- emailstringrequired
  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_enabledbooleanrequired
  True if the user has enabled MFA on login.
  
  Example: true
- virtual_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a virtual user (operator).
- service_account_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a service account.
- disabled_atstringformat: date-time
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
- nicknamestring
  User's nickname. Used for display purposes only.
  
  Example: "Test User"
- picturestringformat: 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"
- classicobjectdeprecated
  Classic identifiers of the user.
  
  Show attributes
  Close
  Attributes
  user_idintegerrequiredminimum: 0, maximum: 2147483647
inviteInvite
Pending invitation for membership.
Show attributes
Close
Invite
- emailstringrequiredformat: email
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_atstringrequiredformat: date-time
  Example: "2023-01-20T15:16:17Z"
statusstringrequired
Options: acceptedpendingexpireddisabledunknown
The status of the membership.
metadataobjectmax 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: {}
attributesobject
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
sumup members create \
2
  --merchant-code "MK10CL2A" \
3
  --email "karl.berg@example.com" \
4
  --password "secret" \
5
  --role "role_employee"

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

3
async function main() {
4
  const client = new SumUp({ apiKey: "sup_sk_your_api_key" });
5

6
  const result = await client.members.create(
7
    "MK10CL2A",
8
    {
9
      "email": "karl.berg@example.com",
10
      "roles": [
11
        "role_employee"
12
      ]
13
    }
14
  );
15
  console.log(result);
16
}
17

18
main().catch(console.error);

1
using System;
2
using System.Collections.Generic;
3
using System.Threading.Tasks;
4
using SumUp;
5

6
public static class Program
7
{
8
    public static async Task Main()
9
    {
10
        using var client = new SumUpClient();
11
        var response = await client.Members.CreateAsync(
12
            "your-merchant-code",
13
            new MembersCreateRequest
14
            {
15
                Email = "karl.berg@example.com",
16
                Roles = new string[]
17
                {
18
                    "role_employee",
19
                },
20
            });
21

22
        Console.WriteLine(response.StatusCode);
23
    }
24
}

1
import com.sumup.sdk.SumUpClient;
2

3
public final class CreateMerchantMemberSample {
4
  public static void main(String[] args) throws Exception {
5
    var client = new SumUpClient();
6

7
    var result = client.members().create(
8
            "MK10CL2A",
9
            com.sumup.sdk.models.CreateMerchantMemberRequest.builder()
10
                .email("karl.berg@example.com")
11
                .roles(java.util.List.of("role_employee"))
12
                .build()
13
        );
14
    System.out.println(result);
15
  }
16
}

1
import os
2

3
import sumup
4

5
client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])
6
result = client.members.create(
7
    "MK10CL2A",
8
    email="karl.berg@example.com",
9
    roles=[
10
        "role_employee",
11
    ],
12
)
13
print(result)

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

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

1
package main
2

3
import (
4
  "context"
5
  "fmt"
6

7
  "github.com/sumup/sumup-go"
8
)
9

10
func main() {
11
  client := sumup.NewClient()
12
  result, err := client.Members.Create(context.TODO(), "MK10CL2A", sumup.MembersCreateParams{
13
    Email: "karl.berg@example.com",
14
    Roles: []string{"role_employee"},
15
  })
16
  if err != nil {
17
    panic(err.Error())
18
  }
19

20
  fmt.Printf("%+v\n", result)
21
}

1
use sumup::{Authorization, Client};
2
#[tokio::main]
3
async fn main() {
4
    let client = Client::default()
5
        .with_authorization(Authorization::api_key("sup_sk_test_..."));
6
    let body = sumup::resources::members::CreateRequest {
7
        attributes: None,
8
        email: "karl.berg@example.com".to_string(),
9
        is_managed_user: None,
10
        metadata: None,
11
        nickname: None,
12
        password: None,
13
        roles: vec!["role_employee".to_string()],
14
    };
15
    let response = client
16
        .members()
17
        .create("MERCHANT_CODE", body)
18
        .await
19
        .expect("create request failed");
20
    println!("{response:#?}");
21
}

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
}

Content-Type: application/problem+json

Invalid request.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Content-Type: application/problem+json

Merchant not found.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Content-Type: application/problem+json

Too many invitations were sent to that user and the rate limit was exceeded. The Retry-After header indicates when the client can retry.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

1
{
2
  "type": "https://developer.sumup.com/problem/bad-request",
3
  "title": "Bad Request",
4
  "status": 400,
5
  "detail": "Request validation failed."
6
}

1
{
2
  "type": "https://developer.sumup.com/problem/not-found",
3
  "title": "Requested resource couldn't be found.",
4
  "status": 404,
5
  "detail": "The requested resource doesn't exist or does not belong to you."
6
}

1
{
2
  "type": "https://developer.sumup.com/problem/too-many-requests",
3
  "title": "Too Many Requests",
4
  "status": 429,
5
  "detail": "Too many requests were sent. Please try again later."
6
}

Members

Retrieve a member

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

Retrieve a merchant member.

Requires one of scopes:user.subaccountsmembers.read

Required permissions:members_view

Path Parameters

merchant_codestringrequired
Short unique identifier for the merchant.

Example: "MK10CL2A"
member_idstringrequired
The ID of the member to retrieve.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"

Response

Returns the Member object for a valid identifier. See Member object.

idstringrequired
ID of the member.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
roles[]stringrequired
User's roles.
permissions[]stringrequireddeprecated
Caution
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_atstringrequiredformat: date-time
The timestamp of when the member was created.

Example: "2023-01-20T15:16:17Z"
updated_atstringrequiredformat: date-time
The timestamp of when the member was last updated.

Example: "2023-01-20T15:16:17Z"
userobject
Information about the user associated with the membership.
Show attributes
Close
Attributes
- idstringrequired
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
- typestringrequired
  Options: usermanaged_userservice_accountsystem_account
  Type of the user account.
  
  Example: "user"
- emailstringrequired
  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_enabledbooleanrequired
  True if the user has enabled MFA on login.
  
  Example: true
- virtual_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a virtual user (operator).
- service_account_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a service account.
- disabled_atstringformat: date-time
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
- nicknamestring
  User's nickname. Used for display purposes only.
  
  Example: "Test User"
- picturestringformat: 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"
- classicobjectdeprecated
  Classic identifiers of the user.
  
  Show attributes
  Close
  Attributes
  user_idintegerrequiredminimum: 0, maximum: 2147483647
inviteInvite
Pending invitation for membership.
Show attributes
Close
Invite
- emailstringrequiredformat: email
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_atstringrequiredformat: date-time
  Example: "2023-01-20T15:16:17Z"
statusstringrequired
Options: acceptedpendingexpireddisabledunknown
The status of the membership.
metadataobjectmax 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: {}
attributesobject
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
sumup members get "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP" \
2
  --merchant-code "MK10CL2A"

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

3
async function main() {
4
  const client = new SumUp({ apiKey: "sup_sk_your_api_key" });
5

6
  const result = await client.members.get(
7
    "MK10CL2A",
8
    "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
9
  );
10
  console.log(result);
11
}
12

13
main().catch(console.error);

1
using System;
2
using System.Collections.Generic;
3
using System.Threading.Tasks;
4
using SumUp;
5

6
public static class Program
7
{
8
    public static async Task Main()
9
    {
10
        using var client = new SumUpClient();
11
        var response = await client.Members.GetAsync(
12
            "your-merchant-code",
13
            "example-id");
14

15
        Console.WriteLine(response.StatusCode);
16
    }
17
}

1
import com.sumup.sdk.SumUpClient;
2

3
public final class GetMerchantMemberSample {
4
  public static void main(String[] args) throws Exception {
5
    var client = new SumUpClient();
6

7
    var result = client.members().get(
8
            "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
9
            "MK10CL2A"
10
        );
11
    System.out.println(result);
12
  }
13
}

1
import os
2

3
import sumup
4

5
client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])
6
result = client.members.get(
7
    "MK10CL2A",
8
    "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
9
)
10
print(result)

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

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

1
package main
2

3
import (
4
  "context"
5
  "fmt"
6

7
  "github.com/sumup/sumup-go"
8
)
9

10
func main() {
11
  client := sumup.NewClient()
12
  result, err := client.Members.Get(context.TODO(), "MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP")
13
  if err != nil {
14
    panic(err.Error())
15
  }
16

17
  fmt.Printf("%+v\n", result)
18
}

1
use sumup::{Authorization, Client};
2
#[tokio::main]
3
async fn main() {
4
    let client = Client::default()
5
        .with_authorization(Authorization::api_key("sup_sk_test_..."));
6
    let response = client
7
        .members()
8
        .get("MERCHANT_CODE", "MEMBER_ID")
9
        .await
10
        .expect("get request failed");
11
    println!("{response:#?}");
12
}

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
}

Error 404

Content-Type: application/problem+json

Merchant or member not found.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Error 404

1
{
2
  "type": "https://developer.sumup.com/problem/not-found",
3
  "title": "Requested resource couldn't be found.",
4
  "status": 404,
5
  "detail": "The requested resource doesn't exist or does not belong to you."
6
}

Members

Update a member

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

Updates a merchant member and returns the updated member.

Providing roles replaces the member’s assigned roles and can grant or revoke access. Providing metadata replaces the entire metadata object. For managed users, user.nickname changes the display name and user.password replaces the password. Updating the password also enables the managed user account.

Requires one of scopes:user.subaccountsmembers.write

Required permissions:members_update

Path Parameters

merchant_codestringrequired
Short unique identifier for the merchant.

Example: "MK10CL2A"
member_idstringrequired
The ID of the member to retrieve.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"

Body Parameters

roles[]stringmin items: 1, max items: 124
metadataobjectmax 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: {}
attributesobject
Object attributes that are modifiable only by SumUp applications.

Example: {}
userobject
Allows you to update user data of managed users.
Show attributes
Close
Attributes
- nicknamestringmax length: 64
  User's nickname. Used for display purposes only.
  
  Example: "Test User"
- passwordstringmin length: 8, format: password
  Password of the member to add. Only used if is_managed_user is true.

Response

Returns the updated Member object if the update succeeded. See Member object.

idstringrequired
ID of the member.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
roles[]stringrequired
User's roles.
permissions[]stringrequireddeprecated
Caution
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_atstringrequiredformat: date-time
The timestamp of when the member was created.

Example: "2023-01-20T15:16:17Z"
updated_atstringrequiredformat: date-time
The timestamp of when the member was last updated.

Example: "2023-01-20T15:16:17Z"
userobject
Information about the user associated with the membership.
Show attributes
Close
Attributes
- idstringrequired
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
- typestringrequired
  Options: usermanaged_userservice_accountsystem_account
  Type of the user account.
  
  Example: "user"
- emailstringrequired
  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_enabledbooleanrequired
  True if the user has enabled MFA on login.
  
  Example: true
- virtual_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a virtual user (operator).
- service_account_userbooleanrequireddeprecated
  Caution
  Rely on type instead.
  
  True if the user is a service account.
- disabled_atstringformat: date-time
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
- nicknamestring
  User's nickname. Used for display purposes only.
  
  Example: "Test User"
- picturestringformat: 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"
- classicobjectdeprecated
  Classic identifiers of the user.
  
  Show attributes
  Close
  Attributes
  user_idintegerrequiredminimum: 0, maximum: 2147483647
inviteInvite
Pending invitation for membership.
Show attributes
Close
Invite
- emailstringrequiredformat: email
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_atstringrequiredformat: date-time
  Example: "2023-01-20T15:16:17Z"
statusstringrequired
Options: acceptedpendingexpireddisabledunknown
The status of the membership.
metadataobjectmax 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: {}
attributesobject
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
sumup members update "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP" \
2
  --merchant-code "MK10CL2A" \
3
  --role "role_manager" \
4
  --nickname "New Employee Name"

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

3
async function main() {
4
  const client = new SumUp({ apiKey: "sup_sk_your_api_key" });
5

6
  const result = await client.members.update(
7
    "MK10CL2A",
8
    "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
9
    {}
10
  );
11
  console.log(result);
12
}
13

14
main().catch(console.error);

1
using System;
2
using System.Collections.Generic;
3
using System.Threading.Tasks;
4
using SumUp;
5

6
public static class Program
7
{
8
    public static async Task Main()
9
    {
10
        using var client = new SumUpClient();
11
        var response = await client.Members.UpdateAsync(
12
            "your-merchant-code",
13
            "example-id",
14
            new MembersUpdateRequest { });
15

16
        Console.WriteLine(response.StatusCode);
17
    }
18
}

1
import com.sumup.sdk.SumUpClient;
2

3
public final class UpdateMerchantMemberSample {
4
  public static void main(String[] args) throws Exception {
5
    var client = new SumUpClient();
6

7
    var result = client.members().update(
8
            "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
9
            "MK10CL2A",
10
            com.sumup.sdk.models.UpdateMerchantMemberRequest.builder()
11
                .build()
12
        );
13
    System.out.println(result);
14
  }
15
}

1
import os
2

3
import sumup
4

5
client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])
6
result = client.members.update(
7
    "MK10CL2A",
8
    "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
9
)
10
print(result)

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
package main
2

3
import (
4
  "context"
5
  "fmt"
6

7
  "github.com/sumup/sumup-go"
8
)
9

10
func main() {
11
  client := sumup.NewClient()
12
  result, err := client.Members.Update(context.TODO(), "MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP", sumup.MembersUpdateParams{})
13
  if err != nil {
14
    panic(err.Error())
15
  }
16

17
  fmt.Printf("%+v\n", result)
18
}

1
use sumup::{Authorization, Client};
2
#[tokio::main]
3
async fn main() {
4
    let client = Client::default()
5
        .with_authorization(Authorization::api_key("sup_sk_test_..."));
6
    let body = sumup::resources::members::UpdateRequest {
7
        ..Default::default()
8
    };
9
    let response = client
10
        .members()
11
        .update("MERCHANT_CODE", "MEMBER_ID", body)
12
        .await
13
        .expect("update request failed");
14
    println!("{response:#?}");
15
}

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
}

Content-Type: application/problem+json

Cannot set password or nickname for an invited user.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Content-Type: application/problem+json

Cannot change password for managed user. Password was already used before.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Content-Type: application/problem+json

Merchant or member not found.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Content-Type: application/problem+json

Cannot update member as some data conflict with existing members.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

1
{
2
  "type": "https://developer.sumup.com/problem/bad-request",
3
  "title": "Bad Request",
4
  "status": 400,
5
  "detail": "Request validation failed."
6
}

1
{
2
  "type": "https://developer.sumup.com/problem/forbidden",
3
  "title": "Forbidden",
4
  "status": 403,
5
  "detail": "You do not have permission to perform this action."
6
}

1
{
2
  "type": "https://developer.sumup.com/problem/not-found",
3
  "title": "Requested resource couldn't be found.",
4
  "status": 404,
5
  "detail": "The requested resource doesn't exist or does not belong to you."
6
}

1
{
2
  "type": "https://developer.sumup.com/problem/conflict",
3
  "title": "Conflict",
4
  "status": 409,
5
  "detail": "The request conflicts with the current state of the resource."
6
}

Members

Delete a member

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

Deletes a merchant member.

Requires one of scopes:user.subaccountsmembers.write

Required permissions:members_delete

Path Parameters

merchant_codestringrequired
Short unique identifier for the merchant.

Example: "MK10CL2A"
member_idstringrequired
The ID of the member to retrieve.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"

Response

Returns empty response.

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
sumup members delete "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP" \
2
  --merchant-code "MK10CL2A"

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

3
async function main() {
4
  const client = new SumUp({ apiKey: "sup_sk_your_api_key" });
5

6
  const result = await client.members.delete(
7
    "MK10CL2A",
8
    "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
9
  );
10
  console.log(result);
11
}
12

13
main().catch(console.error);

1
using System;
2
using System.Collections.Generic;
3
using System.Threading.Tasks;
4
using SumUp;
5

6
public static class Program
7
{
8
    public static async Task Main()
9
    {
10
        using var client = new SumUpClient();
11
        var response = await client.Members.DeleteAsync(
12
            "your-merchant-code",
13
            "example-id");
14

15
        Console.WriteLine(response.StatusCode);
16
    }
17
}

1
import com.sumup.sdk.SumUpClient;
2

3
public final class DeleteMerchantMemberSample {
4
  public static void main(String[] args) throws Exception {
5
    var client = new SumUpClient();
6

7
    client.members().delete(
8
            "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
9
            "MK10CL2A"
10
        );
11
  }
12
}

1
import os
2

3
import sumup
4

5
client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])
6
client.members.delete(
7
    "MK10CL2A",
8
    "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
9
)

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

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

1
package main
2

3
import (
4
  "context"
5

6
  "github.com/sumup/sumup-go"
7
)
8

9
func main() {
10
  client := sumup.NewClient()
11
  if err := client.Members.Delete(context.TODO(), "MK10CL2A", "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"); err != nil {
12
    panic(err.Error())
13
  }
14
}

1
use sumup::{Authorization, Client};
2
#[tokio::main]
3
async fn main() {
4
    let client = Client::default()
5
        .with_authorization(Authorization::api_key("sup_sk_test_..."));
6
    let response = client
7
        .members()
8
        .delete("MERCHANT_CODE", "MEMBER_ID")
9
        .await
10
        .expect("delete request failed");
11
    println!("{response:#?}");
12
}

Error 403
Error 404

Content-Type: application/problem+json

Member deletion was forbidden.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Content-Type: application/problem+json

Merchant or member not found.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

Error 403
Error 404

1
{
2
  "type": "https://developer.sumup.com/problem/forbidden",
3
  "title": "Forbidden",
4
  "status": 403,
5
  "detail": "You do not have permission to perform this action."
6
}

1
{
2
  "type": "https://developer.sumup.com/problem/not-found",
3
  "title": "Requested resource couldn't be found.",
4
  "status": 404,
5
  "detail": "The requested resource doesn't exist or does not belong to you."
6
}