Create a new account for a client under a specific provider.

Retrieve a single account by ID.

Get Accounts

Retrieve all accounts for a client.

Delete Account

Delete an existing account.

Update Account

Update the details of an existing account.

Transaction Statement

Retrieve a list of transactions for a date range.

Create Account

The Create Account endpoint creates a new account for a client (merchant or company) under a specific provider.

POST https://your_connector_url/customers/{customerId}/clients/{clientId}/accounts

Path Params

Parameter	Type	Description
customerId	String	The ID of the customer.
clientId	String	The ID of the client (merchant) the account will belong to.

Body Params

Parameter	Type	Required	Description
name	String	Yes	The name of the client (merchant or company). This is a company name, not a user name.
clientId	String	Yes	The ID of the client (merchant or company).
address	String	Yes	Primary address information (street name, street number). This is a company address, not a user address.
address2	String	No	Secondary address information (apartments, suites, PO Boxes).
city	String	Yes	The city of the client (merchant or company).
postalCode	String	Yes	The postal code of the client (merchant or company).
assetType	String	Yes	The currency of the account. Set by the provider or chosen by the user during account creation if multiple options are enabled.
partnerProduct	String	Yes	The code of the product offered by a partner associated with the account. Also available via the Get Partner Product endpoint in the `code` field.
countryCode	String	Yes	The country code of the client. Uses ISO 3166-2.
legislationCountry	String	No	The legislation country of the client (merchant or company).
readOnly	Boolean	Yes	Defines if the account is read-only. If set to `true`, the user cannot make any payments.

signUpRequest Object

The signUpRequest object contains the data a client (merchant or company) must provide when creating an account. Required.

Parameter	Type	Required	Description
id	String	Yes	The unique identifier for the sign-up request.
cif	String	Yes	The CIF (Tax Identification Code) of the client.
clientType	ClientType	Yes	The type of client — `BUSINESS` or `CONSUMER`.
subOrganisationType	OrganisationType	Yes	The organisation type of the client.
endUserId	String	—	The ID of the merchant user who submitted the account creation request.

📘
OrganisationType Enum
The OrganisationType enum represents the different types of organisations.
Values:
SOLE_TRADER, LIMITED, PARTNERSHIP, CHARITY, PUBLIC_LIMITED, ASSOCIATION, SUPPORT_GROUP, NON_REG_PARTNERSHIP, NOT_YET_REGISTERED
Read more about organisation type here.

shareholders (list of objects)

Each shareholder object includes the following parameters:

Parameter	Type	Description
name	String	First name of the shareholder.
surname	String	Last name of the shareholder.
birthDate	Date	Date of birth of the shareholder.
country	String	Country of residence of the shareholder.
percentageOfShares	String	Percentage of shares belonging to the shareholder.
city	String	City of residence of the shareholder.
address	String	Main line of the address of the shareholder.
address2	String	Secondary address information (apartments, suites, PO Boxes).
postalCode	String	Postcode of the shareholder.

directors (list of objects)

Each director object contains information about a director of the merchant (client or company). There can be one or more directors.

Parameter	Type	Description
documentType	String	The verification document (one document per director).
documentNumber	String	The number of the verification document.
documentExpirationDate	YYYY-mm-dd	The expiration date of the document.
documentIssueDate	YYYY-mm-dd	The issue date of the document.
documentIssuerCountry	String	The country that issued the document.
tin	String	The Tax Identification Number.
postalCode	String	The postal code of the director.
address	String	The address of the director.
address2	String	Secondary address information (apartments, suites, PO Boxes).
city	String	City of residence of the director.
email	String	Email of the director.
phone	Object	Phone number of the director (see phone fields below).
firstName	String	First name of the director.
lastName	String	Last name of the director.
dateOfBirth	yyyy-MM-dd HH:mm:ss.SSS	Date of birth of the director.
appointmentDate	Date	Appointment date of the director.
countryOfResidence	countryCode	Country of residence of the director.
accountPurposes	Set<String>	The intended purposes for the account.
expectedVolume	Object	The expected volume of transactions (see fields below).

phone fields:

Parameter	Type	Description
phoneNumber	String	Phone number without the country code.
countryCode	countryCode	Country code.
intnlPhoneNumber	String	International phone number with the country code.

expectedVolume fields:

Parameter	Type	Description
currency	currency	The currency.
range	range	The range reflecting the volume.
type	String	Type of transactions.

Additional Body Params

Parameter	Type	Description
registrationDate	YYYY-mm-dd	The registration date of the merchant's company.
industryCode	industryCode	The code of the industry the merchant's company belongs to.
phone	Object	The phone number of the merchant (see phone fields above).
email	String	The email of the merchant (client or company).
alias	String	The account alias — a descriptive identifier (name) given to an account.

Response

Returns a response containing the details of the created account.

Parameter	Type	Required	Description
accountId	String	Yes	The unique ID of the created account.
iban	String	Yes	The IBAN.
bicSwiftForSEPA	String	Yes	The Bank Identification Code (BIC) for SEPA.
bicSwiftForSWIFT	String	Yes	The Bank Identification Code (BIC) for SWIFT. If the same BIC applies to both SEPA and SWIFT, use the same value for both fields.
ukAccountNumber	String	Yes (UK)	UK-specific account number.
ukSortCode	String	Yes (UK)	UK-specific sort code.
accountNumber	String	Yes (US)	US-specific account number.
routingNumber	String	Yes (US)	US-specific routing number.
internationalEnabled	Boolean	Yes	Indicates whether the account supports international payments.
correspondentBank	String	If international	The correspondent bank name. If you cannot pass these details and return `null`, these fields will appear empty in the account details section.
correspondentBankAddress	String	If international	The correspondent bank address.
correspondentBankSWIFT	String	If international	The correspondent bank SWIFT code.
assetType	assetType	Yes	The currency of the account.
createdAt	Date-time	Yes	The date of account creation by the provider.
status	String	Yes	The status of the account.
totalBalance	Double (2 decimals)	Yes	The total balance on the account.
availableBalance	Double (2 decimals)	Yes	The available balance. If the provider only offers a single balance, use the same value for both fields.
countryCode	String	Yes	Country code where the account was created. Uses ISO 3166-2.
holderName	String	Yes	The name of the account owner (client/company name, not a user name). Toqio retrieves this via the Get Account endpoint.
holderAddress	String	No (Deprecated)	The address of the account owner. Use the `holderAddress` object instead.
holderAddress	Object	Yes	The address of the account owner (see holderAddress fields below). Toqio retrieves this via the Get Account endpoint.
alias	String	No	The account alias — a descriptive identifier (name) given to an account.
holderBank	String	Yes	The name of the bank providing the account.
holderBankAddress	String	Yes	The address of the bank providing the account.
bankCountry	String	Yes	The country where the banking provider is registered.
partnerProduct	String	Yes	The product code offered by the banking provider associated with the account. Defined in the provider integration connector.
wireRoutingNumber	String	No	Wire routing number.
achRoutingNumber	String	No	ACH routing number.

holderAddress object fields:

Parameter	Type	Required	Description
address	String	Yes	Primary address information (street name, street number). Company address, not a user address.
address2	String	No	Secondary address information (apartments, suites, PO Boxes).
city	String	Yes	The city of the client (merchant or company).
postalCode	String	Yes	The postal code of the client (merchant or company).

📘
Account creation automated notifications
If your banking provider supports account holder creation simultaneously with account creation, you can use account creation automated notifications. These email notifications alert the Customer's admin user in two cases:

If the account holder creation fails on the BaaS side, the account is marked with a "Quarantine" status. The Customer's admin user will need to review the account application in the admin portal to either approve or stop the account creation process.

If there is an error in the banking provider's database related to the account holder, the Customer's admin user will receive an email notification detailing the error.

To set up this logic, use signUpResponse.

signUpResponse Parameter

The signUpResponse object is optional and includes:

Parameter	Type	Required	Description
sendQuarantinedEmail	Boolean	Yes	If enabled, triggers an email to the Customer admin user informing them that a Merchant intended to create an account but it is on hold due to quarantine status. The admin user can review the application in the admin portal.
sendKycCheckEmail	Boolean	Yes	If enabled, triggers an email to the Customer admin user informing them that a Merchant could not create an account due to a KYC check error in the banking provider database.
kycCheckEmailMessage	String	If `sendKycCheckEmail` is `true`	The email message to send to the Customer admin user.

Quarantine email content

"The creation of a new account for {companyName} has been quarantined in the firewall. Please, review the application to allow or prevent the account to be created. You can follow the case and get additional details in the admin portal by following this link {linkUrl}"

📘
Enabling Provider Capabilities related to this endpoint
If your banking provider requires a signature for account creation, consider enabling the needAccountSignature provider capability.
When needAccountSignature is set to true, the banking provider mandates an account signature during account creation. This enables a custom user flow that incorporates the account signature feature. Read more about capabilities.

accountCanIssueCards Parameter

This optional boolean indicates whether the created account can be used to issue a new card.

If set to TRUE, the account appears in the account selector during the "Issue New Card" flow.
If set to FALSE, the account is excluded from the selector in that flow.
If not specified, defaults to TRUE.

Get Account

The Get Account endpoint retrieves a single account of a merchant (client or company) under a specific provider.

GET https://your_connector_url/customers/{customerId}/clients/{clientId}/accounts/{accountId}

Path Params

Parameter	Type	Description
customerId	String	The ID of the customer.
clientId	String	The ID of the client (merchant) the account belongs to.
accountId	String	The ID of the account.

Response Body

Parameter	Type	Required	Description
accountId	String	Yes	The ID of the account.
ukAccountNumber	String	Yes (UK)	UK-specific account number.
ukSortCode	String	Yes (UK)	UK-specific sort code.
iban	String	Yes	The IBAN.
bicSwiftForSEPA	String	Yes	The Bank Identification Code (BIC) for SEPA.
bicSwiftForSWIFT	String	Yes	The Bank Identification Code (BIC) for SWIFT. If the same BIC applies to both, use the same value.
assetType	assetType	Yes	The currency of the account.
createdAt	Date-time	Yes	The date of account creation by the provider.
status	String	Yes	The status of the account.
totalBalance	Double (2 decimals)	Yes	The total balance on the account.
availableBalance	Double (2 decimals)	Yes	The available balance. If the provider only offers a single balance, the same value is used for both.
countryCode	String	Yes	Country code where the account was created. Uses ISO 3166-2.
holderName	String	Yes	The name of the account owner (client/company name, not a user name). Toqio retrieves this via the provider integration connector.
holderAddress	String	No (Deprecated)	The address of the account owner. Use the `holderAddress` object instead.
holderAddress	Object	Yes	The address of the account owner (see holderAddress fields in Create Account response).
internationalEnabled	Boolean	Yes	Indicates whether the account supports international payments.
correspondentBank	String	If international	The correspondent bank name.
correspondentBankAddress	String	If international	The correspondent bank address.
correspondentBankSWIFT	String	If international	The correspondent bank SWIFT code.
holderBank	String	Yes	The name of the bank providing the account.
holderBankAddress	String	Yes	The address of the bank providing the account.
bankCountry	String	Yes	The country where the banking provider is registered.
partnerProduct	String	Yes	The product code offered by the banking provider associated with the account. Available via the Get Partner Product endpoint in the `code` field.
wireRoutingNumber	String	No	Wire routing number.
achRoutingNumber	String	No	ACH routing number.
signUpResponse	Object	No	Read more about it here.

Get Accounts

The Get Accounts endpoint retrieves all accounts of a merchant (client or company) under a specific provider.

GET https://your_connector_url/customers/{customerId}/clients/{clientId}/accounts

Path Params

Parameter	Type	Description
customerId	String	The ID of the customer.
clientId	String	The ID of the client (merchant) the accounts belong to.

Response

The response is an array of account response objects.

Delete Account

The Delete Account endpoint deletes an existing account for a merchant (client or company) under a specific provider.

On Toqio's side, this action can only be executed if the account has no funds and it is not the main account. The CANCEL account button triggers this endpoint.

DELETE https://your_connector_url/customers/{customerId}/clients/{clientId}/accounts/{accountId}

Path Params

Parameter	Type	Description
customerId	String	The ID of the customer.
clientId	String	The ID of the client (merchant) the account belongs to.
accountId	String	The ID of the account.

Response

Returns a response indicating the result of the delete operation.

📘
Enabling Provider Capabilities related to this endpoint
canCancelAccounts: Defines whether the provider allows cancelling accounts. When an account is cancelled, account holder users can no longer use the account but can still view its details. The status changes to CLOSED in the integration and CANCELLED in the Toqio database.
canRemoveAccounts: Defines whether the provider allows removing accounts. If removed, the account is not visible to account holder users. Only available for accounts with no balance that are not main accounts. The status changes to REMOVED in the Toqio database.
Read more about capabilities.

Update Account

The Update Account endpoint updates the details of an existing account of a merchant (client or company) under a specific provider.

PUT https://your_connector_url/customers/{customerId}/clients/{clientId}/accounts/{accountId}

Path Params

Parameter	Type	Description
customerId	String	The ID of the customer.
clientId	String	The ID of the client (merchant) the account belongs to.
accountId	String	The ID of the account.

Body Params

Parameter	Type	Required	Description
alias	String	—	The alias of the account in Toqio.
address	String	Yes	Primary address information (street name, street number). Company address, not a user address.
address2	String	No	Secondary address information (apartments, suites, PO Boxes).
city	String	Yes	The city of the client (merchant or company).
postalCode	String	Yes	The postal code of the client (merchant or company).
status	ToqioAccountStatus	—	The status of the account in Toqio.

📘
ToqioAccountStatus enum
The ToqioAccountStatus enum represents the different statuses an account can have. Read more.
Values: CLOSED, ACTIVE, PENDING, HIDE, QUARANTINE, FAILED

Response

The response contains the same parameters as the account response.

Find account transaction list statement

The Find account transaction list statement endpoint retrieves a list of transactions for a date range of an existing account for a merchant (client or company) under a specific provider.

POST https://your_connector_url/customers/{customerId}/clients/{clientId}/accounts/{accountId}/bankStatement

Path Params

Parameter	Type	Description
customerId	String	The ID of the customer.
clientId	String	The ID of the client (merchant) the account belongs to.
accountId	String	The ID of the account.

Body Params

Parameter	Type	Description
start	Date	The start date of the statement period.
end	Date	The end date of the statement period.

Response

Returns a list of transactions within the specified date range. The response is an array of objects:

Parameter	Type	Required	Description
balance	Double (2 decimals)	Yes	The balance corresponding to the transaction.
date	yyyy-MM-dd'T'HH:mm:ss.SSS'Z'	Yes	The date and time of the transaction — displayed as the "Completed" field in the statement.
transactionNumber	String	Yes	The number of the transaction.

This response provides the account transaction list statement:

The merchant user accesses this feature by clicking the "Download PDF" button on the account details page. The user selects a custom date range, and a PDF document is generated with the transactions that occurred within that range.

📘
Enabling Provider Capabilities related to this endpoint
Verify if the banking provider permits users to select today's date as the end date. If allowed, enable the allowTodayStatement capability as true. When this capability is not enabled, users can only download statements up to two days prior to today's date.
You can also define whether users can access account statements older than 6 months by setting the allowSixMonthsStatements capability. If set to true, users can retrieve account statements beyond the 6-month timeframe. Read more about capabilities.
You can also define whether users can access account statements older than 6 months by setting the allowSixMonthsStatements capability. If allowSixMonthsStatements is set to true, users will be able to retrieve account statements beyond the 6-month timeframe. Read more about capabilities.