SfAccountResponse

API version of Account

Methods

The following API methods use this data model.

• Retrieve All Accounts

  Required Fields

  servicerId

string

The unique identifier for servicer.

currency

string

ISO 4217 currency code.

Optional Fields

accountId

string, nullable

The unique identifier for account.

companyId

string, nullable

The unique identifier for company.

servicerName

string, nullable

Servicer name for the given connected account.

accountUsername

string, nullable

User name of the account (typically an email address).

nickname

string, nullable

Nickname of the account assigned by the account owner.

status

string, nullable

Enum: “PENDING” “ACTIVE” “CANCELLED” “AUTH_REQUIRED” “AWAITING_VERIFICATION”

syncStatus

string, nullable

Enum: “SYNC_IN_PROGRESS” “SYNC_COMPLETE” If the account supports synchronisation, for example, it is a GoCardless account and supports importing mandates, then this field may be set to one of the two below.

isEnabled

boolean, nullable

Whether the connected account is enabled or not.

publishableKey

string, nullable

API key for the given connected account.

capabilities

string[], nullable

Items Enum: “card” “direct-debit” An array of payment types supported by the provider in the company’s country.

authorisation

AccountAuthorisation, nullable

Optional information that can be used to complete account activation at the servicer.