Retrieve an operator | SumUp Developer

Subaccounts

Endpoints for managing merchant sub-accounts (operators).

The object

Operator account for a merchant.

Attributes

id integer required
username string required

Example: "operator1@mydomain.com"
nickname string nullable

Example: "Operator 1"
disabled boolean required
created_at string date-time required

The timestamp of when the operator was created.
updated_at string date-time required

The timestamp of when the operator was last updated.
permissions object required

Permissions assigned to an operator or user.
Show attributes
Close

Attributes
- create_moto_payments boolean required
- create_referral boolean required
- full_transaction_history_view boolean required
- refund_transactions boolean required
- admin boolean required
account_type string required

Options: operator normal

1
{
2
  "id": 0,
3
  "username": "operator1@mydomain.com",
4
  "nickname": "Operator 1",
5
  "disabled": false,
6
  "created_at": "",
7
  "updated_at": "",
8
  "permissions": {
9
    "create_moto_payments": false,
10
    "create_referral": false,
11
    "full_transaction_history_view": false,
12
    "refund_transactions": false,
13
    "admin": false
14
  },
15
  "account_type": ""
16
}

Subaccounts

List operatorsDeprecated

Returns list of operators for currently authorized user's merchant.

Required permissions: members_list

Query Parameters

query string

Search query used to filter users that match given query term.

Current implementation allow querying only over the email address. All operators whos email address contains the query string are returned.
include_primary boolean

If true the list of operators will include also the primary user.

Response 200

[]object

Show attributes

id integer required
username string required

Example: "operator1@mydomain.com"
nickname string nullable

Example: "Operator 1"
disabled boolean required
created_at string date-time required

The timestamp of when the operator was created.
updated_at string date-time required

The timestamp of when the operator was last updated.
permissions object required

Permissions assigned to an operator or user.
Show attributes
Close

Attributes
- create_moto_payments boolean required
- create_referral boolean required
- full_transaction_history_view boolean required
- refund_transactions boolean required
- admin boolean required
account_type string required

Options: operator normal

1
curl https://api.sumup.com/v0.1/me/accounts \
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.subaccounts.listSubAccounts();

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Subaccounts.ListSubAccountsAsync();

1
import com.sumup.sdk.SumUpClient;
2

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

5
var result = client.subaccounts().listSubAccounts();

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.subaccounts.list_sub_accounts()

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

3
$result = $sumup->subaccounts->listSubAccounts();

1
client := sumup.NewClient()
2

3
result, err := client.Subaccounts.ListSubAccounts(context.Background())

1
use sumup::Client;
2

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

5
let result = client.subaccounts().list_sub_accounts(sumup::ListSubAccountsParams{
6
    query: Some("query".to_string()),
7
    include_primary: Some("include_primary".to_string()),
8
}).await;

1
[
2
  {
3
    "id": 0,
4
    "username": "operator1@mydomain.com",
5
    "nickname": "Operator 1",
6
    "disabled": false,
7
    "created_at": "",
8
    "updated_at": "",
9
    "permissions": {
10
      "create_moto_payments": false,
11
      "create_referral": false,
12
      "full_transaction_history_view": false,
13
      "refund_transactions": false,
14
      "admin": false
15
    },
16
    "account_type": ""
17
  }
18
]

Subaccounts

Create an operatorDeprecated

Creates new operator for currently authorized users' merchant.

Required permissions: members_update

Body Parameters

username string email required

Example: "operator1@mydomain.com"
password string min length: 8 required

Example: "correct horse batter staple"
nickname string

Example: "Operator 1"
permissions object
Show attributes
Close

Attributes
- create_moto_payments boolean
- create_referral boolean
- full_transaction_history_view boolean
- refund_transactions boolean

Response 200

id integer required
username string required

Example: "operator1@mydomain.com"
nickname string nullable

Example: "Operator 1"
disabled boolean required
created_at string date-time required

The timestamp of when the operator was created.
updated_at string date-time required

The timestamp of when the operator was last updated.
permissions object required

Permissions assigned to an operator or user.
Show attributes
Close

Attributes
- create_moto_payments boolean required
- create_referral boolean required
- full_transaction_history_view boolean required
- refund_transactions boolean required
- admin boolean required
account_type string required

Options: operator normal

1
curl https://api.sumup.com/v0.1/me/accounts \
2
 -X POST \
3
 -H "Authorization: Bearer $SUMUP_API_KEY" \
4
 --json '{
5
    "username": "operator1@mydomain.com",
6
    "password": "correct horse batter staple"
7
  }'

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

3
const client = new SumUp();
4

5
const result = await client.subaccounts.createSubAccount({
6
  username: "operator1@mydomain.com",
7
  password: "correct horse batter staple",
8
});

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Subaccounts.CreateSubAccountAsync(
6
    new CreateSubAccountBody
7
    {
8
        Username = "operator1@mydomain.com",
9
        Password = "correct horse batter staple",
10
    }
11
);

1
import com.sumup.sdk.SumUpClient;
2

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

5
var result = client.subaccounts().createSubAccount(
6
  CreateSubAccountBody.builder()
7
    .username("operator1@mydomain.com")
8
    .password("correct horse batter staple")
9
    .build()
10
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.subaccounts.create_sub_account(CreateSubAccountBody(
6
  username="operator1@mydomain.com",
7
  password="correct horse batter staple",
8
))

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

3
$result = $sumup->subaccounts->createSubAccount([
4
  'username' => 'operator1@mydomain.com',
5
  'password' => 'correct horse batter staple',
6
]);

1
client := sumup.NewClient()
2

3
result, err := client.Subaccounts.CreateSubAccount(context.Background(), sumup.SubaccountsCreateSubAccountParams{
4
  Username: "operator1@mydomain.com",
5
  Password: "correct horse batter staple",
6
})

1
use sumup::Client;
2

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

5
let result = client.subaccounts().create_sub_account(sumup::CreateSubAccountBody{
6
  username: "operator1@mydomain.com".to_string(),
7
  password: "correct horse batter staple".to_string(),
8
}).await;

1
{
2
  "id": 0,
3
  "username": "operator1@mydomain.com",
4
  "nickname": "Operator 1",
5
  "disabled": false,
6
  "created_at": "",
7
  "updated_at": "",
8
  "permissions": {
9
    "create_moto_payments": false,
10
    "create_referral": false,
11
    "full_transaction_history_view": false,
12
    "refund_transactions": false,
13
    "admin": false
14
  },
15
  "account_type": ""
16
}

Subaccounts

Retrieve an operatorDeprecated

Returns specific operator.

Required permissions: members_view

Path Parameters

operator_id integer required

The unique identifier for the operator.

Response 200

id integer required
username string required

Example: "operator1@mydomain.com"
nickname string nullable

Example: "Operator 1"
disabled boolean required
created_at string date-time required

The timestamp of when the operator was created.
updated_at string date-time required

The timestamp of when the operator was last updated.
permissions object required

Permissions assigned to an operator or user.
Show attributes
Close

Attributes
- create_moto_payments boolean required
- create_referral boolean required
- full_transaction_history_view boolean required
- refund_transactions boolean required
- admin boolean required
account_type string required

Options: operator normal

1
curl https://api.sumup.com/v0.1/me/accounts/{operator_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.subaccounts.compatGetOperator("operator_id");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Subaccounts.CompatGetOperatorAsync(
6
    "operator_id"
7
);

1
import com.sumup.sdk.SumUpClient;
2

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

5
var result = client.subaccounts().compatGetOperator(
6
  "operator_id"
7
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.subaccounts.compat_get_operator("operator_id")

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

3
$result = $sumup->subaccounts->compatGetOperator('operator_id');

1
client := sumup.NewClient()
2

3
result, err := client.Subaccounts.CompatGetOperator(context.Background(), "operator_id")

1
use sumup::Client;
2

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

5
let result = client.subaccounts().compat_get_operator("operator_id").await;

1
{
2
  "id": 0,
3
  "username": "operator1@mydomain.com",
4
  "nickname": "Operator 1",
5
  "disabled": false,
6
  "created_at": "",
7
  "updated_at": "",
8
  "permissions": {
9
    "create_moto_payments": false,
10
    "create_referral": false,
11
    "full_transaction_history_view": false,
12
    "refund_transactions": false,
13
    "admin": false
14
  },
15
  "account_type": ""
16
}

Subaccounts

Update an operatorDeprecated

Updates operator. If the operator was disabled and their password is updated they will be unblocked.

Required permissions: members_update

Path Parameters

operator_id integer required

The unique identifier for the operator.

Body Parameters

password string min length: 8

Example: "correct horse batter staple"
username string max length: 256email
disabled boolean
nickname string

Example: "Operator 1"
permissions object
Show attributes
Close

Attributes
- create_moto_payments boolean
- create_referral boolean
- full_transaction_history_view boolean
- refund_transactions boolean

Response 200

id integer required
username string required

Example: "operator1@mydomain.com"
nickname string nullable

Example: "Operator 1"
disabled boolean required
created_at string date-time required

The timestamp of when the operator was created.
updated_at string date-time required

The timestamp of when the operator was last updated.
permissions object required

Permissions assigned to an operator or user.
Show attributes
Close

Attributes
- create_moto_payments boolean required
- create_referral boolean required
- full_transaction_history_view boolean required
- refund_transactions boolean required
- admin boolean required
account_type string required

Options: operator normal

1
curl https://api.sumup.com/v0.1/me/accounts/{operator_id} \
2
 -X PUT \
3
 -H "Authorization: Bearer $SUMUP_API_KEY" \
4
 --json '{}'

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

3
const client = new SumUp();
4

5
const result = await client.subaccounts.updateSubAccount("operator_id", {
6

7
});

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Subaccounts.UpdateSubAccountAsync(
6
    "operator_id",
7
    new UpdateSubAccountBody
8
    {
9

10
    }
11
);

1
import com.sumup.sdk.SumUpClient;
2

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

5
var result = client.subaccounts().updateSubAccount(
6
  "operator_id",
7
  UpdateSubAccountBody.builder()
8

9
    .build()
10
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.subaccounts.update_sub_account("operator_id", UpdateSubAccountBody(
6

7
))

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

3
$result = $sumup->subaccounts->updateSubAccount('operator_id', [
4

5
]);

1
client := sumup.NewClient()
2

3
result, err := client.Subaccounts.UpdateSubAccount(context.Background(), "operator_id", sumup.SubaccountsUpdateSubAccountParams{
4

5
})

1
use sumup::Client;
2

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

5
let result = client.subaccounts().update_sub_account("operator_id", sumup::UpdateSubAccountBody{}).await;

1
{
2
  "id": 0,
3
  "username": "operator1@mydomain.com",
4
  "nickname": "Operator 1",
5
  "disabled": false,
6
  "created_at": "",
7
  "updated_at": "",
8
  "permissions": {
9
    "create_moto_payments": false,
10
    "create_referral": false,
11
    "full_transaction_history_view": false,
12
    "refund_transactions": false,
13
    "admin": false
14
  },
15
  "account_type": ""
16
}