Skip to main content

Account Types

An account type is a set of information about a specific Payment Service Provider and contains information about required credentials, available transaction fields and more.

To get information about account types, users and partners can use

  • the GetAccountTypes method, to get a list of all available account types;
  • the GetAccountType method, to get detailed info about the parameters, required to create the account.

It is recommended to use the accountFields array of the metadata returned by this method to dynamically build the user interface for the credentials for the selected account type. Each account type should not be hard-coded.

You may also use our Account UI for account creation to avoid creating your own user interfaces.

Deprecated account types​

The account type metadata contains a deprecated property. If it is true, the account type is still supported for existing accounts, but should not be used for new ones:

  • New accounts: hide deprecated account types from the selection your users see when they add a new account.
  • Existing accounts: keep using the metadata of the account type, for example to display and update the account fields of an existing account. Don't filter deprecated account types out of the metadata you look up for existing accounts.

A common reason for a deprecation is that a better replacement is available for the same provider, for example an API-based account type that replaces a file-based account type.

PayData informs partners about deprecations and the next steps, such as moving existing accounts to the replacement account type.