UK Gateway

An Account is the leading entity that is used to store transactions. An account can have a single currency. When submitting a transaction, the currency of the 'account' determines the currency of the transaction. Accounts belong to an organisation, multiple accounts of the same or different currencies can be tied to a single organisation.

Processors need to be linked to an account in order to connect to a payment method, read more about processors here.

Accounts should not be confused with user accounts. User accounts for users interacting with the platform.

Transactions can only belong in a single account, the ID of the account should be used in the account field of the transaction or selected from the dropdown menu (MOTO). refunds, chargebacks and Credit Fund Transfers (CFT's) are also linked to an account.

Creating an Account

For a full overview including parameter descriptions of the /account endpoint please visit the API documentation. The following sample POST call to $BASEURL/v1/account can be used to create an account:

{
    "currency_code": "EUR",
    "description": "This is the main account",
    "disabled": true,
    "name": "string",
    "organisation": "string",
    "processors": [
        null
    ],
    "webhook_chargeback_update": "string",
    "webhook_refund_update": "string",
    "webhook_transaction_update": "string"
}

Relationship to account

The following items can be linked to an account:

• Processors

More information on the relationships between accounts and other items can be found here.

Webhooks

Accounts can have webhooks that fire for updates on transactions, refunds and chargebacks created within that account. Read more about Webhooks here.

UI Guide

The following page describes how to create and edit an account. In order to create or edit an account you will need the ProviderAdmin role. More information on that can be found here.

1. Navigate to the Account tab. Click 'Add Account'

2. Fill out the form with your account details and click save:

• Name:Name of account. Can be changed later.
• Organisation: The organisation the account belongs to. More information with regard to relationships between organisations and accounts can be found here. Cannot be changed later.
• Currency: Currency of the account. Cannot be changed later.
• Processors: Select the processors you would like to connect to this account. Read more about processors here.

3. Verify the account was created: