Team bank accounts
List a team's bank accounts
Required scope: team-bank-accounts:read
Organization authorization: supported
path Parameters
teamIdList a team's bank accounts › Responses
The team's bank accounts
nameName of the bank account
createdAtWhen the bank account was created
idId of the bank account
typeWhich set of fields identifies the account. Determines what the other fields must contain.
ibanIBAN of the bank account
swiftSWIFT/BIC of the bank account
bsbBSB number of the bank account (Australia)
sortCodeSort code of the bank account (United Kingdom)
accountNumberAccount number of the bank account
routingNumberRouting number of the bank account (United States)
accountTypeAccount type, required with receive option routing_account
transitNumberTransit number of the bank account
institutionNumberInstitution number of the bank account
currencyIdId of the bank account's currency
updatedAtWhen the bank account was last updated
Add a bank account to a team
Required scope: team-bank-accounts:write
Organization authorization: supported
The required fields depend on type value provided with the request
path Parameters
teamIdAdd a bank account to a team › Request Body
nameName of the bank account
typeWhich set of fields identifies the bank account.iban requires iban. swift requires swift. bsb requires bsb. sort_account requires sortCode and accountNumber. routing_account requires routingNumber, accountNumber and accountType. local_canadian requires institutionNumber, transitNumber and accountNumber. emirates requires iban.
ibanIBAN of the bank account. Validated against its check digits.
swiftSWIFT/BIC of the bank account
bsbBSB number of the bank account (Australia)
sortCodeSort code of the bank account (United Kingdom)
accountNumberAccount number of the bank account
routingNumberRouting number of the bank account (United States)
accountTypeAccount type, required with receive option routing_account
transitNumberTransit number of the bank account (Canada, 5 digits)
institutionNumberInstitution number of the bank account (Canada, 3 digits)
Add a bank account to a team › Responses
Bank account created
Update a team's bank account
Required scope: team-bank-accounts:write
Organization authorization: supported
An omitted field keeps its stored value. The account must still satisfy the fields its type requires once the update is applied.
path Parameters
teamIdbankAccountIdUpdate a team's bank account › Request Body
typeWhich set of fields identifies the account.iban requires iban. swift requires swift. bsb requires bsb. sort_account requires sortCode and accountNumber. routing_account requires routingNumber, accountNumber and accountType. local_canadian requires institutionNumber, transitNumber and accountNumber. emirates requires iban.
nameName of the bank account
ibanIBAN of the bank account. Validated against its check digits.
swiftSWIFT/BIC of the bank account
bsbBSB number of the bank account (Australia)
sortCodeSort code of the bank account (United Kingdom)
accountNumberAccount number of the bank account
routingNumberRouting number of the bank account (United States)
accountTypeAccount type, required with receive option routing_account
transitNumberTransit number of the bank account (Canada, 5 digits)
institutionNumberInstitution number of the bank account (Canada, 3 digits)
Update a team's bank account › Responses
Bank account updated
nameName of the bank account
createdAtWhen the bank account was created
idId of the bank account
typeWhich set of fields identifies the account. Determines what the other fields must contain.
ibanIBAN of the bank account
swiftSWIFT/BIC of the bank account
bsbBSB number of the bank account (Australia)
sortCodeSort code of the bank account (United Kingdom)
accountNumberAccount number of the bank account
routingNumberRouting number of the bank account (United States)
accountTypeAccount type, required with receive option routing_account
transitNumberTransit number of the bank account
institutionNumberInstitution number of the bank account
currencyIdId of the bank account's currency
updatedAtWhen the bank account was last updated