Members

Lists merchant members.

OAuth scopes: Requires one of: user.subaccounts, members.read.

Required permissions:

• {"relation":"merchant_read","object_type":"merchant","object_id_param":"merchant_code"}

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.

OAuth scopes: Requires one of: user.subaccounts, members.write.

Required permissions:

• {"relation":"members_create","object_type":"merchant","object_id_param":"merchant_code"}

Retrieve a merchant member.

OAuth scopes: Requires one of: user.subaccounts, members.read.

Required permissions:

• {"relation":"members_view","object_type":"merchant","object_id_param":"merchant_code"}

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.

OAuth scopes: Requires one of: user.subaccounts, members.write.

Required permissions:

• {"relation":"members_update","object_type":"merchant","object_id_param":"merchant_code"}

Deletes a merchant member.

OAuth scopes: Requires one of: user.subaccounts, members.write.

Required permissions:

• {"relation":"members_delete","object_type":"merchant","object_id_param":"merchant_code"}