External Account Paylet

What is an External Account?

An External Account is a bank account as owned by a Corporate Identity that is used as a source or destination of funds to or from OPC instruments (e.g. to or from a Managed Account owned by the same Corporate Identity owner). A Corporate Identity can be linked with one or more External Accounts – of one or more currencies. Refer to the Transaction Paylets (Deposit Paylet and Withdraw Paylet) for more information how an External Account can be used as a source or destination Payment Instrument. Refer to the External Accounts Swagger documentation for the complete list of APIs that may be invoked in relation to External Accounts.

External Account Paylet API

URL Method Description
/external_accounts/profiles/get POST Retrieves a list of the Profiles that can be used to create an External Account.
/external_accounts/profiles/{id}/get POST Look up external account profiles, filtered by the specified criteria. All fields in the filter are optional. Paging is also supported.
/external_accounts/_/create POST Create an Instance of an External Account.
/external_accounts/get POST Retrieve a list of External Accounts of a Programme.
/external_accounts/{id}/get POST Retrieve a specific External Account instance with specified ID.

External Account Instance Attributes

Attribute Name Description
Id The ID of an External Account instance
Profile id The Profile ID of the Profile used to create the instance
Owner id The ID of the Corporate Identity instance that owns the External Account instance
Friendly name A user-friendly name of the External Account instance
Programme id The ID of the Programme that the External Account instance is part of
External account info Details of the External Account. This includes these attributes: Bank account number, Payee, Bank name, Bank code, Branch code, Account type, Check digits, IBAN code, Swift code, Branch address, Country, Additional Information, Currency
Actions Indicates the actions which may be performed on an External Account instance in its current state
Creation Timestamp Indicates when the external account was created (similar to standard UNIX epoch timestamp but uses millisecond precision instead of seconds)