API reference

Create internal account

post
https://sandbox.numeral.io/v1/internal_accounts

Create an internal account, which can refer to an existing active account holder. This internal account will only be created in Numeral system and should be created by your bank beforehand. It will refer to either: (1) a type own account, namely a record of a financial institution connected account or (2) a type virtual account managed by your bank.

Body Params
connected_account_ids
array
connected_account_ids
string
enum
required

The type of the internal account.

Allowed:
string
required
length ≤ 100

The name of the internal account.

string
required
length ≤ 100

The name of the internal account holder.

alternative_holder_names
array of strings
length ≤ 100

Alternative account holder names, for instance if the account is a joint account.

alternative_holder_names
string
required

The account number of the internal account. Own internal accounts accept IBANs and UK domestic account numbers, and virtual internal accounts accept any alphanumerical account numbers up to 35 characters.

string
enum

The format of the account number. When set, it must match account_number unless the format is other or tokenized.

Allowed:
string

The bank code. Mandatory for internal accounts of type = own.

string
enum

The format of the bank code. When set, it must match bank_code unless the format is other or tokenized.

Allowed:
organization_identification
object

The organization identification of the internal account. See more here.

uuid

The ID of the account holder to which the internal account belongs to. It must not be disabled.

holder_address
object

The address of the account holder, as an address object.

string

The unique reference for organisations collecting payments by SEPA Direct Debit.

custom_fields
object

Custom fields in JSON key:value format. See Custom fields.

metadata
object

Additional client data in JSON format. See Metadata.

string
enum

The CBS this internal account refers to. Only mambu is supported.

Allowed:
string
length ≤ 100

The ID of the account in linked CBS. Must be provided if cbs_source is provided.

string
enum

The type of account in linked CBS. Only deposit supported. Must be provided if cbs_source is provided.

Allowed:
boolean

Whether the internal account is synchronized with the bank.

boolean

Whether the account number should be automatically generated by Mambu Payments. Contact your account manager to activate this feature.

currencies
array of strings

ISO 4217 currencies of the account.

currencies
string

BIC of the internal account. Used for Swift correspondent payments.

string

Distinguished name (DN) of the internal account. Used for Swift correspondent payments.

Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago