Accounts

Accounts on the Connectivity service are representations of a user's accounts on the associated payment provider. These accounts serve as a bridge between the user and the payment provider, viewing transaction history, making payments with a few clicks and ensuring a secure and reliable payment experience. Overall, accounts on the Connectivity service play a crucial role in simplifying and enhancing the user's payment journey, making it more convenient, efficient, and secure.

An account on the Formance platform is represented by various fields, each serving a specific purpose. These fields include:

• ID: This unique identifier is used to distinguish the account within the Connectivity service.
• Reference: The account reference on the payments provider, which helps link it to the appropriate transactions.
• Provider: The payment provider associated with the account
• Type: This field indicates the type of the account, which can be either INTERNAL or EXTERNAL (c.f. below)
• CreatedAt: This field displays the date and time of the account's creation on the payments provider, allowing users to track the account's history.
• DefaultAsset: While optional, this field allows users to specify a default asset for the account, streamlining transactions and providing convenience.
• AccountName: Also optional, this field enables users to assign a name to the account, making it easier to identify and manage.

By including these fields, the Formance platform offers a comprehensive and flexible account management system, catering to the diverse needs of its users.

How to fetch and see accounts list#

Formance console#

On the Formance Console, you can easily access the complete list of accounts by simply clicking on the Accounts tab located on the left-hand side of the menu. This intuitive interface allows you to conveniently view all the necessary information related to each account with just a few clicks.

By clicking on the View button situated on the right side of each account, you can delve deeper into the details of that specific account. This provides you with a comprehensive overview of the account, including essential information such as the default asset associated with it and the current balance.

With this user-friendly feature, you can effortlessly navigate through the Formance Console and gain a thorough understanding of your accounts, enabling you to make informed decisions based on the detailed information provided.

API#

You can also fetch the list of accounts programmatically:

fctl payments accounts list

If all goes well, you should see:

ID                     | AccountName | CreatedAt            | ConnectorID       | DefaultAsset | DefaultCurrency | Reference | Type
<Internal Formance ID> | Name 1      | 2023-08-28T09:58:34Z | <ConnectorID>     | EUR/2        | EUR/2           | Ref1      | INTERNAL
<Internal Formance ID> | Name 2      | 2023-08-14T09:26:07Z | <ConnectorID>     |              |                 | Ref2      | EXTERNAL
<Internal Formance ID> | Name 3      | 2023-07-25T11:48:44Z | <ConnectorID>     | USD/2        | USD/2           | Ref3      | INTERNAL
<Internal Formance ID> | Name 4      | 2021-03-25T15:11:17Z | <ConnectorID>     | EUR/2        | EUR/2           | Ref4      | INTERNAL

To fetch the details of a specific account:

fctl payments accounts get <ACCOUNT_ID>

If all goes well, you should see:

# Information
ID              | <Internal Formance ID>
AccountName     | Name 1
CreatedAt       | 2023-08-28T09:58:34Z
ConnectorID     | <ConnectorID>
DefaultAsset    | EUR/2
Reference       | Ref1
Type            | INTERNAL

Internal Accounts#

An INTERNAL account refers to an account where you have operational control within the payment provider, such as a digital e-wallet or payment service provider account. You can view balances, transaction history, and use these accounts as sources for transfers and payouts.

In addition to its primary purpose, an INTERNAL account offers versatile functionality, allowing users to perform the following actions:

1. Transfer funds from one INTERNAL account to another INTERNAL account (Transfer)
2. Withdraw funds from an INTERNAL account to an EXTERNAL account (Payout)

These features provide users with flexibility and convenience when managing their finances within the platform.

External Accounts#

EXTERNAL accounts are used as destinations for payouts, typically bank accounts where you cannot view balances or initiate transfers from. You can only move funds from INTERNAL accounts to EXTERNAL accounts, not the reverse.

External Accounts creation#

You can utilize Formance's Connectivity service to effortlessly create EXTERNAL accounts on the various associated providers. These providers include beneficiaries and recipient accounts, depending on the specific providers you choose.

In order to create an External Account, you can only do it via the API for the moment while waiting for the Formance Console to be updated.

cat > bank-account.json << 'EOF'
{
  "name": "My Bank Account",
  "provider": "BANKING-CIRCLE",
  "country": "FR",
  "iban": "FR1420041010050500013M02606",
  "swiftBicCode": "PSSTFRPPMON",
  "accountNumber": "0500013M026"
}
EOF

fctl payments bankaccounts create bank-account.json

Please note that in order to complete the transaction, you will need to provide the following details: the name of the bank account, the name of the payments provider, the country where the account is held, the International Bank Account Number (IBAN), and the swiftBicCode. Alternatively, you may also provide only the account number if the other details are not available.