# Constants

AccountIdentifierTypeACCOUNTNUMBER captures enum value "ACCOUNT_NUMBER".
AccountIdentifierTypeBBAN captures enum value "BBAN".
AccountIdentifierTypeIBAN captures enum value "IBAN".
AccountIdentifierTypeSEBG captures enum value "SE_BG".
AccountIdentifierTypeSEPG captures enum value "SE_PG".
CounterpartyPartyTypeCOMPANY captures enum value "COMPANY".
CounterpartyPartyTypeINDIVIDUAL captures enum value "INDIVIDUAL".
CreateCounterpartyRequestPartyTypeCOMPANY captures enum value "COMPANY".
CreateCounterpartyRequestPartyTypeINDIVIDUAL captures enum value "INDIVIDUAL".
CreateDirectDebitRequestDirectDebitSchemeTypeAUTOGIRO captures enum value "AUTOGIRO".
CreateDirectDebitRequestDirectDebitSchemeTypeSDDB2B captures enum value "SDD_B2B".
CreateDirectDebitRequestDirectDebitSchemeTypeSDDCORE captures enum value "SDD_CORE".
CreateMandateRequestDirectDebitSchemeTypeAUTOGIRO captures enum value "AUTOGIRO".
CreateMandateRequestDirectDebitSchemeTypeSDDB2B captures enum value "SDD_B2B".
CreateMandateRequestDirectDebitSchemeTypeSDDCORE captures enum value "SDD_CORE".
CreatePaymentRequestChargeBearerCREDITOR captures enum value "CREDITOR".
CreatePaymentRequestChargeBearerDEBTOR captures enum value "DEBTOR".
CreatePaymentRequestChargeBearerSHARED captures enum value "SHARED".
CreatePaymentRequestPaymentSchemeTypeAUCT captures enum value "AU_CT".
CreatePaymentRequestPaymentSchemeTypeAUCTBPAY captures enum value "AU_CT_BPAY".
CreatePaymentRequestPaymentSchemeTypeBGCT captures enum value "BG_CT".
CreatePaymentRequestPaymentSchemeTypeCHCT captures enum value "CH_CT".
CreatePaymentRequestPaymentSchemeTypeCROSSBORDER captures enum value "CROSS_BORDER".
CreatePaymentRequestPaymentSchemeTypeDKA2A captures enum value "DK_A2A".
CreatePaymentRequestPaymentSchemeTypeDKCTFIK71 captures enum value "DK_CT_FIK71".
CreatePaymentRequestPaymentSchemeTypeDKCTFIK73 captures enum value "DK_CT_FIK73".
CreatePaymentRequestPaymentSchemeTypeDKCTFIK75 captures enum value "DK_CT_FIK75".
CreatePaymentRequestPaymentSchemeTypeDKCTINST captures enum value "DK_CT_INST".
CreatePaymentRequestPaymentSchemeTypeDKCTSAMEDAY captures enum value "DK_CT_SAMEDAY".
CreatePaymentRequestPaymentSchemeTypeGBCTBACS captures enum value "GB_CT_BACS".
CreatePaymentRequestPaymentSchemeTypeGBCTCHAPS captures enum value "GB_CT_CHAPS".
CreatePaymentRequestPaymentSchemeTypeGBCTFPS captures enum value "GB_CT_FPS".
CreatePaymentRequestPaymentSchemeTypeKRCT captures enum value "KR_CT".
CreatePaymentRequestPaymentSchemeTypeMXCT captures enum value "MX_CT".
CreatePaymentRequestPaymentSchemeTypeNOCT captures enum value "NO_CT".
CreatePaymentRequestPaymentSchemeTypeSCT captures enum value "SCT".
CreatePaymentRequestPaymentSchemeTypeSCTINST captures enum value "SCT_INST".
CreatePaymentRequestPaymentSchemeTypeSEA2A captures enum value "SE_A2A".
CreatePaymentRequestPaymentSchemeTypeSEGIRO captures enum value "SE_GIRO".
CreatePaymentRequestPaymentSchemeTypeSGCT captures enum value "SG_CT".
CreatePaymentRequestPaymentSchemeTypeTHCT captures enum value "TH_CT".
CreatePaymentRequestPaymentSchemeTypeUSCTACH captures enum value "US_CT_ACH".
CreatePaymentRequestPaymentSchemeTypeUSCTWIRE captures enum value "US_CT_WIRE".
DirectDebitStatusACCEPTED captures enum value "ACCEPTED".
DirectDebitStatusAPPROVED captures enum value "APPROVED".
DirectDebitStatusCREATED captures enum value "CREATED".
DirectDebitStatusEXECUTED captures enum value "EXECUTED".
DirectDebitStatusFAILED captures enum value "FAILED".
DirectDebitStatusPENDINGSUBMISSION captures enum value "PENDING_SUBMISSION".
DirectDebitStatusRECONCILED captures enum value "RECONCILED".
DirectDebitStatusREJECTED captures enum value "REJECTED".
DirectDebitStatusRETURNED captures enum value "RETURNED".
DirectDebitStatusSENT captures enum value "SENT".
MandateStatusACCEPTED captures enum value "ACCEPTED".
MandateStatusACTIVE captures enum value "ACTIVE".
MandateStatusCANCELLATIONSENT captures enum value "CANCELLATION_SENT".
MandateStatusCANCELLED captures enum value "CANCELLED".
MandateStatusCREATED captures enum value "CREATED".
MandateStatusFAILED captures enum value "FAILED".
MandateStatusPENDINGCANCELLATION captures enum value "PENDING_CANCELLATION".
MandateStatusPENDINGCANCELLATIONSUBMISSION captures enum value "PENDING_CANCELLATION_SUBMISSION".
MandateStatusPENDINGSUBMISSION captures enum value "PENDING_SUBMISSION".
MandateStatusSENT captures enum value "SENT".
MembershipRoleTypeOPERATORROLE captures enum value "OPERATOR_ROLE".
MembershipRoleTypeREGULARROLE captures enum value "REGULAR_ROLE".
MembershipRoleTypeSERVICEROLE captures enum value "SERVICE_ROLE".
NationalIdentifierTypeCIVIC captures enum value "CIVIC".
NationalIdentifierTypeCOMPANY captures enum value "COMPANY".
PaymentChargeBearerCREDITOR captures enum value "CREDITOR".
PaymentChargeBearerDEBTOR captures enum value "DEBTOR".
PaymentChargeBearerSHARED captures enum value "SHARED".
PaymentStatusACCEPTED captures enum value "ACCEPTED".
PaymentStatusAPPROVED captures enum value "APPROVED".
PaymentStatusCREATED captures enum value "CREATED".
PaymentStatusEXECUTED captures enum value "EXECUTED".
PaymentStatusFAILED captures enum value "FAILED".
PaymentStatusPENDINGATBANK captures enum value "PENDING_AT_BANK".
PaymentStatusPENDINGSUBMISSION captures enum value "PENDING_SUBMISSION".
PaymentStatusRECONCILED captures enum value "RECONCILED".
PaymentStatusREJECTED captures enum value "REJECTED".
PaymentStatusRETURNED captures enum value "RETURNED".
PaymentStatusSENT captures enum value "SENT".
ReconciliationDetailsStatusBOOKED captures enum value "BOOKED".
ReconciliationDetailsStatusEXPECTED captures enum value "EXPECTED".
ReconciliationDetailsStatusRECONCILED captures enum value "RECONCILED".
ReconciliationDetailsTransactableTypeEXPECTEDTRANSACTION captures enum value "EXPECTED_TRANSACTION".
ReconciliationDetailsTransactableTypePAYMENT captures enum value "PAYMENT".
RegulatoryReportingDetailIndicatorBOTH captures enum value "BOTH".
RegulatoryReportingDetailIndicatorCREDITOR captures enum value "CREDITOR".
RegulatoryReportingDetailIndicatorDEBTOR captures enum value "DEBTOR".
RemittanceInformationTypeOCR captures enum value "OCR".
RemittanceInformationTypeSTRUCTURED captures enum value "STRUCTURED".
RemittanceInformationTypeUNSTRUCTURED captures enum value "UNSTRUCTURED".
RoleTypeOPERATORROLE captures enum value "OPERATOR_ROLE".
RoleTypeREGULARROLE captures enum value "REGULAR_ROLE".
RoleTypeSERVICEROLE captures enum value "SERVICE_ROLE".
TransactionCounterpartyDetailsPartyTypeCOMPANY captures enum value "COMPANY".
TransactionCounterpartyDetailsPartyTypeINDIVIDUAL captures enum value "INDIVIDUAL".
UpdateCounterpartyRequestPartyTypeCOMPANY captures enum value "COMPANY".
UpdateCounterpartyRequestPartyTypeINDIVIDUAL captures enum value "INDIVIDUAL".

# Structs

Account account swagger:model Account.
AccountIdentifier account identifier swagger:model AccountIdentifier.
AccountIdentifierSlim Slim variant of AccountIdentifier, a strict subset.
AccountSlim account slim swagger:model AccountSlim.
AccountTrx a subset of an Account set on each Transaction swagger:model AccountTrx.
AddBankRequest add bank request swagger:model AddBankRequest.
AddBankResponse add bank response swagger:model AddBankResponse.
Address address swagger:model Address.
Affiliation affiliation swagger:model Affiliation.
Amount amount swagger:model Amount.
AmountInput amount input swagger:model AmountInput.
ApprovalStep approval step swagger:model ApprovalStep.
AttachedTransaction attached transaction swagger:model AttachedTransaction.
AuthTypeInfo auth type info swagger:model AuthTypeInfo.
Balance balance swagger:model Balance.
BalanceByCurrencyDetails balance by currency details swagger:model BalanceByCurrencyDetails.
BankSlim Slim variant of Bank, a strict subset.
BankTransactionCode bank transaction code swagger:model BankTransactionCode.
ChallengeResponse challenge response swagger:model ChallengeResponse.
Connection connection swagger:model Connection.
ConnectionCapabilities connection capabilities swagger:model ConnectionCapabilities.
ConnectionType connection type swagger:model ConnectionType.
ContactDetails contact details swagger:model ContactDetails.
ContactDetailsSlim contact details slim swagger:model ContactDetailsSlim.
Counterparty A Counterparty represents a person or business.
CounterpartyIdentifier counterparty identifier swagger:model CounterpartyIdentifier.
CounterpartySlim counterparty slim swagger:model CounterpartySlim.
CreateAffiliationRequest create affiliation request swagger:model CreateAffiliationRequest.
CreateCounterpartyRequest create counterparty request swagger:model CreateCounterpartyRequest.
CreateDirectDebitRequest create direct debit request swagger:model CreateDirectDebitRequest.
CreateEmbeddedExternalAccountRequest create embedded external account request swagger:model CreateEmbeddedExternalAccountRequest.
CreateExpectedTransactionRequest create expected transaction request swagger:model CreateExpectedTransactionRequest.
CreateExternalAccountRequest create external account request swagger:model CreateExternalAccountRequest.
CreateMandateRequest create mandate request swagger:model CreateMandateRequest.
CreateOrderEventBatchRequest create order event batch request swagger:model CreateOrderEventBatchRequest.
CreatePaymentRequest create payment request swagger:model CreatePaymentRequest.
CreateRejectRequest create reject request swagger:model CreateRejectRequest.
CreateTestbankAccountRequest create testbank account request swagger:model CreateTestbankAccountRequest.
CreateTransactionCharacteristics create transaction characteristics swagger:model CreateTransactionCharacteristics.
CreateWebhookRequest create webhook request swagger:model CreateWebhookRequest.
CreateWizardConnectionRequest create wizard connection request swagger:model CreateWizardConnectionRequest.
Currency currency swagger:model Currency.
CurrencyExchange currency exchange swagger:model CurrencyExchange.
DataPoint data point swagger:model DataPoint.
DataSeries data series swagger:model DataSeries.
DeprecatedCreditTransferScheme Deprecated.
DirectDebit direct debit swagger:model DirectDebit.
DirectDebitScheme direct debit scheme swagger:model DirectDebitScheme.
Email email swagger:model Email.
ErrorDetails error details swagger:model ErrorDetails.
ErrorResponse error response swagger:model ErrorResponse.
Event event swagger:model Event.
ExpectedTransaction expected transaction swagger:model ExpectedTransaction.
ExternalAccount An ExternalAccount represents an account that does not belong to your organization.
ExternalAccountSlim external account slim swagger:model ExternalAccountSlim.
FetchCapabilities fetch capabilities swagger:model FetchCapabilities.
Iamv2WebAuthnChallenge iamv2 web authn challenge swagger:model iamv2.WebAuthnChallenge.
IdentifierMarketIdentifiers identifier market identifiers swagger:model identifier.MarketIdentifiers.
Limitations limitations swagger:model Limitations.
MainapiDirectDebitCapability mainapi direct debit capability swagger:model mainapi.DirectDebitCapability.
MainapiSearchResponseTotalHits mainapi search response total hits swagger:model mainapi.SearchResponseTotalHits.
MainapiSignatureCapability mainapi signature capability swagger:model mainapi.SignatureCapability.
MainapiTransferCapability mainapi transfer capability swagger:model mainapi.TransferCapability.
Mandate mandate swagger:model Mandate.
Market market swagger:model Market.
Membership membership swagger:model Membership.
MetadataGroupIn metadata group in swagger:model MetadataGroupIn.
MfaSetting mfa setting swagger:model MfaSetting.
MfaTotpParams mfa totp params swagger:model MfaTotpParams.
MiscAvailableScopes misc available scopes swagger:model misc.availableScopes.
NationalIdentifier national identifier swagger:model NationalIdentifier.
Organization organization swagger:model Organization.
PartyIdentification party identification swagger:model PartyIdentification.
Payment payment swagger:model Payment.
PaymentApprovalChain payment approval chain swagger:model PaymentApprovalChain.
PaymentApprovalStep payment approval step swagger:model PaymentApprovalStep.
PaymentScheme Deprecated.
PopulateFlags populate flags swagger:model PopulateFlags.
ProprietaryBankTransactionCode proprietary bank transaction code swagger:model ProprietaryBankTransactionCode.
PushCapabilities push capabilities swagger:model PushCapabilities.
QueryResponse query response swagger:model QueryResponse.
ReconcileExpectedTransactionRequest reconcile expected transaction request swagger:model ReconcileExpectedTransactionRequest.
ReconciliationDetails The ReconciliationDetails object is attached to Transactions, Expected-Transactions and Payments.
RegulatoryReportingDetail RegulatoryReporting is an optional field that can be set when additional information is needed due to regulatory and statutory requirements.
RemittanceInformation remittance information swagger:model RemittanceInformation.
ReturnReason return reason swagger:model ReturnReason.
Role role swagger:model Role.
RoleSlim role slim swagger:model RoleSlim.
SchemesSignatureScheme schemes signature scheme swagger:model schemes.SignatureScheme.
SecretDefinition secret definition swagger:model SecretDefinition.
SlimAffiliation slim affiliation swagger:model SlimAffiliation.
SlimConnectionType slim connection type swagger:model SlimConnectionType.
TestbankAccountIdentifier testbank account identifier swagger:model testbank.AccountIdentifier.
TestbankAddress testbank address swagger:model testbank.Address.
TestbankAmount testbank amount swagger:model testbank.Amount.
TestbankBankSlim testbank bank slim swagger:model testbank.BankSlim.
TestbankBankTransactionCode testbank bank transaction code swagger:model testbank.BankTransactionCode.
TestbankContactDetails testbank contact details swagger:model testbank.ContactDetails.
TestbankCurrencyExchange testbank currency exchange swagger:model testbank.CurrencyExchange.
TestbankNationalIdentifier testbank national identifier swagger:model testbank.NationalIdentifier.
TestbankReturnReason testbank return reason swagger:model testbank.ReturnReason.
TestbankTransactionCharacteristics testbank transaction characteristics swagger:model testbank.TransactionCharacteristics.
TestbankTransactionCounterpartyDetails testbank transaction counterparty details swagger:model testbank.TransactionCounterpartyDetails.
TestbankTransactionExternalAccount testbank transaction external account swagger:model testbank.TransactionExternalAccount.
TestbankTransactionVirtualAccount testbank transaction virtual account swagger:model testbank.TransactionVirtualAccount.
ThirdParty third party swagger:model ThirdParty.
Transaction transaction swagger:model Transaction.
TransactionCharacteristics transaction characteristics swagger:model TransactionCharacteristics.
TransactionCounterpartyDetails transaction counterparty details swagger:model TransactionCounterpartyDetails.
TransactionExternalAccount transaction external account swagger:model TransactionExternalAccount.
TransactionVirtualAccount transaction virtual account swagger:model TransactionVirtualAccount.
TransferScheme transfer scheme swagger:model TransferScheme.
TriggerCondition trigger condition swagger:model TriggerCondition.
TriggerConditionInput trigger condition input swagger:model TriggerConditionInput.
UnreconcileExpectedTransactionRequest unreconcile expected transaction request swagger:model UnreconcileExpectedTransactionRequest.
UpdatableBank updatable bank swagger:model UpdatableBank.
UpdateAccountRequest update account request swagger:model UpdateAccountRequest.
UpdateCounterpartyRequest update counterparty request swagger:model UpdateCounterpartyRequest.
UpdateExternalAccountRequest update external account request swagger:model UpdateExternalAccountRequest.
UpdateWebhookRequest update webhook request swagger:model UpdateWebhookRequest.
User user swagger:model User.
UserSlim user slim swagger:model UserSlim.
ValidationRule A validation rule applies rules to the affected resource.
WebAuthnChallenge web authn challenge swagger:model WebAuthnChallenge.
Webhook webhook swagger:model Webhook.
WebhookFilter webhook filter swagger:model WebhookFilter.
WebhookPayload webhook payload swagger:model WebhookPayload.
WebhookSigningKey webhook signing key swagger:model WebhookSigningKey.

# Interfaces

MandateEventDetails mandate event details swagger:model MandateEventDetails.
OrderEventDetails order event details swagger:model OrderEventDetails.

# Type aliases

ExternalMetadata ExternalMetadata is a string-string key-value store that can be used to store information known at the time of resource creation.