Previous topic

Customers

Next topic

Charges

This Page

Teams

class fattmerchant.controllers.teams.TeamsController(request)

Class to interface with the team resource in the Core API

create(payload)

Creates a new team through the API

Parameters:

payload (dict) –

A dictionary with all data necessary to create a team

Note

company_name and company_email are required

{
    "company_name": "Fattmerchant",
    "comtact_name": "Fattmerchant",
    "contact_email": "info2@fattmerchant.com",
    "contact_phone": "8555503288",
    "display_name": "Fattmerchant",
    "address_1": "25 Wall Street",
    "address_2": "Suite 1",
    "address_city": "Orlando",
    "address_state": "FL",
    "address_zip": "32801",
    "options": {}
}

Returns:

A tuple with a team object and said team’s api key

Return type:

(Team, string)

Raises:
update_registration(payload)

Private method to make the API call to update a team registration

Parameters:payload (dict) – A dictionary with all data necessary to update team registration
Returns:
A tuple with an api key, a user for a merchant, and said
merchant
Return type:tuple
Raises:ResourceNotUpdatedException – If the team couldn’t be accessed then it wasn’t able to be updated