Creates a new merchant payment account.

The ID of the merchant the payment account is being created for.

Currency for the account. Swagger narrows this property to the currencies currently configured for holding accounts. The authoritative list for the current environment is exposed by GET /api/v1/currencies?capability=Holding.

The name for the account. This name is descriptive only, and will not be used when sending payments, but it should still be set to something that identifies the purpose of the funds. For example "EUR Payment" would be suitable to for an account used for general purpose business payments.

For internal use only. Leave empty unless requested otherwise.

If specified the account type will be set to the specified value disregarding the merchant default account type.

For EUR accounts this can be set to the ID of another account that will act as the backing physical account. The new account will then act as a Virtual account, able to receive funds but the transactions will be recorded against the backing physical account.

Optional property to indicate whether the account is a trust account. The account name is displayed on the statement for trust accounts instead of the merchant name.

Unique id for the account.

The ID of the merchant that owns the account.

The name of the merchant that owns the account.

Balance of the account.

Balance of the account expressed in the currency’s minor units (e.g. cents, pence).

Total of the payouts that have been submitted for processing.

The balance of the submitted payouts expressed in the currency’s minor units (e.g. cents, pence).

Timestamp when the account was created.

Timestamp when the account was last updated.

Currency of the account in ISO 4217 format

Name for the account

Gets a unique display name for the payment account. Useful for when payment accounts need to be listed.

Gets a summary of the payments account's most important properties.

Is the default account

The current available balance of the account. Calculated by subtracting any submitted payments from the current balance.

The available balance expressed in the currency’s minor units (e.g. cents, pence).

The payment account supplier name. A payment account can be supplied by multiple payment processors.

Indicates if the payment account is an externally connected account. Externally connected account can be used to view account balances and transactions.

The ID of the consent used to connect the external account.

The Icon for external accounts

The bank name for external accounts

The date that the external account will expire

Indicates if the payment account is a trust account. The account name is displayed in the statement instead of the merchant name for trust accounts.

States the status of the Xero bank feed connection, if applicable.

Indicates the number of unsynchronised transactions with Xero

Either the name of the user, merchant token or api key that created the account

Indicates the default payment rail for this account. Normally it will be left as the default value but in some special cases it may be set to indicate payouts from this account should be attempted with a specific payment rail.

Indicates whether the account is archived. Archived accounts are not displayed in the UI. If an account receives a payment it will be automatically unarchived.

Indicates the status of the SEPA Instant payment rail for this account.

For virtual accounts this is the ID of the physical account that the virtual account is linked to.

True if the account is a virtual account.