Skip to main content
objectPaymentAccount

Fields

id
ID!

The ID of the payment account.

name
String

The display name of the account.

description
String

A description of the account.

providerId
ID!

The payment provider of the account ('QueryPaymentProviders').

accountIdentifier
String

The identifier the provider uses for the account, for example an account number or a merchant ID.

iban
String

The IBAN of a bank account.

bic
String

The BIC of a bank account.

holder
String

The holder of the account.

isExternal
Boolean!

Whether it is an external account: created with 'CreatePaymentAccount' and filled with 'ImportPaymentTransaction'. Follows from the provider.

canSend
Boolean!

Whether the account can send money, for refunds and bank transfers. Follows from the provider.

needsInteraction
Boolean!

Whether fetching the account needs an interactive confirmation, for example a TAN, or a file. Such an account is fetched in the desktop client, not with 'StartPaymentAccountImport'.

isHidden
Boolean!

Whether the account is hidden: it is not fetched, nothing can be imported into it, and its transactions are left out of the matching and out of the default list. Set with 'HidePaymentAccount' and 'ShowPaymentAccount'.

isAutoImportLocked
Boolean!

Whether the automatic, unattended import of the account is locked. The ERP locks it itself when the bank asks for a confirmation or the credentials are no longer valid. Set with 'LockPaymentAccountAutoImport' and 'UnlockPaymentAccountAutoImport'.

transferPaymentMethodId
ID

The payment method of the payments recorded when a transaction of the account is assigned.

directDebitPaymentMethodId
ID

The payment method for direct debits.

chargebackPaymentMethodId
ID

The payment method for chargebacks and refunds.

importCutoffDate
DateTime

Transactions booked on or before this date are not imported. Empty when there is no such limit. PayPal, Mollie and Amazon Pay accounts do not apply it.