diff --git a/404.html b/404.html index f7d9e34c985..a40c9da80c8 100644 --- a/404.html +++ b/404.html @@ -7,13 +7,13 @@ - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/api-reference/directives/deprecated/index.html b/api-reference/directives/deprecated/index.html index be33ffd7f4a..967a3e4ee06 100644 --- a/api-reference/directives/deprecated/index.html +++ b/api-reference/directives/deprecated/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

deprecated

Marks an element of a GraphQL schema as no longer supported.

directive @deprecated(
  reason: String = "No longer supported"
) on 
  | FIELD_DEFINITION
  | ARGUMENT_DEFINITION
  | INPUT_FIELD_DEFINITION
  | ENUM_VALUE

Arguments​

deprecated.reason ● String scalar​

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by CommonMark.

- + \ No newline at end of file diff --git a/api-reference/directives/include/index.html b/api-reference/directives/include/index.html index ae29f9d5bd2..da969857a1f 100644 --- a/api-reference/directives/include/index.html +++ b/api-reference/directives/include/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

include

Directs the executor to include this field or fragment only when the if argument is true.

directive @include(
  if: Boolean!
) on 
  | FIELD
  | FRAGMENT_SPREAD
  | INLINE_FRAGMENT

Arguments​

include.if ● Boolean! non-null scalar​

Included when true.

- + \ No newline at end of file diff --git a/api-reference/directives/skip/index.html b/api-reference/directives/skip/index.html index 3e88c277dc1..fdb14875402 100644 --- a/api-reference/directives/skip/index.html +++ b/api-reference/directives/skip/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

skip

Directs the executor to skip this field or fragment when the if argument is true.

directive @skip(
  if: Boolean!
) on 
  | FIELD
  | FRAGMENT_SPREAD
  | INLINE_FRAGMENT

Arguments​

skip.if ● Boolean! non-null scalar​

Skipped when true.

- + \ No newline at end of file diff --git a/api-reference/directives/specified-by/index.html b/api-reference/directives/specified-by/index.html index a381bf62a83..7bfc84ce75c 100644 --- a/api-reference/directives/specified-by/index.html +++ b/api-reference/directives/specified-by/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

specifiedBy

Exposes a URL that specifies the behavior of this scalar.

directive @specifiedBy(
  url: String!
) on SCALAR

Arguments​

specifiedBy.url ● String! non-null scalar​

The URL that specifies the behavior of this scalar.

- + \ No newline at end of file diff --git a/api-reference/enums/account-country/index.html b/api-reference/enums/account-country/index.html index ceec0b069c8..4a42b759d61 100644 --- a/api-reference/enums/account-country/index.html +++ b/api-reference/enums/account-country/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountCountry

Refers to the country of the account. It will determine the country code of the local IBAN of the account.

Available Account Country: CCA3

enum AccountCountry {
  FRA
  DEU
  ESP
  NLD
}

Values​

AccountCountry.FRA​

French account with a French IBAN, starting with FR.

AccountCountry.DEU​

German account with a German IBAN, starting with DE.

AccountCountry.ESP​

Spanish account with a Spanish IBAN, starting with ES.

AccountCountry.NLD​

Dutch account with a Dutch IBAN, starting with DU.

Member of​

Account object ● OnboardCompanyAccountHolderInput input ● OnboardIndividualAccountHolderInput input ● Onboarding object ● OnboardingInfo object ● UpdateCompanyOnboardingInput input ● UpdateIndividualOnboardingInput input

- + \ No newline at end of file diff --git a/api-reference/enums/account-funding-limits-reached-reason/index.html b/api-reference/enums/account-funding-limits-reached-reason/index.html index fe5de12a4b8..0ca624f27fe 100644 --- a/api-reference/enums/account-funding-limits-reached-reason/index.html +++ b/api-reference/enums/account-funding-limits-reached-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountFundingLimitsReachedReason

No description

enum AccountFundingLimitsReachedReason {
  InstantFundingLimitExceededRejection
  FundingLimitExceededRejection
  ProjectInstantFundingLimitExceededRejection
  ProjectFundingLimitExceededRejection
  GlobalInstantFundingLimitExceededRejection
  GlobalFundingLimitExceededRejection
  InsufficientFundsRejection
}

Values​

AccountFundingLimitsReachedReason.InstantFundingLimitExceededRejection​

Account Holder instant funding limit exceeded

AccountFundingLimitsReachedReason.FundingLimitExceededRejection​

Account Holder funding limit exceeded

AccountFundingLimitsReachedReason.ProjectInstantFundingLimitExceededRejection​

Project instant funding limit exceeded

AccountFundingLimitsReachedReason.ProjectFundingLimitExceededRejection​

Project funding limit exceeded

AccountFundingLimitsReachedReason.GlobalInstantFundingLimitExceededRejection​

Global instant funding limit exceeded

AccountFundingLimitsReachedReason.GlobalFundingLimitExceededRejection​

Global funding limit exceeded

AccountFundingLimitsReachedReason.InsufficientFundsRejection​

Insufficient funds rejection

- + \ No newline at end of file diff --git a/api-reference/enums/account-holder-order-by-field-input/index.html b/api-reference/enums/account-holder-order-by-field-input/index.html index 2da195eb375..7cc944a6a5a 100644 --- a/api-reference/enums/account-holder-order-by-field-input/index.html +++ b/api-reference/enums/account-holder-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/account-holder-status/index.html b/api-reference/enums/account-holder-status/index.html index e73446b20d8..8dddf5b4262 100644 --- a/api-reference/enums/account-holder-status/index.html +++ b/api-reference/enums/account-holder-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountHolderStatus

Account holder status.

enum AccountHolderStatus {
  Enabled
  Suspended
  Canceled
}

Values​

AccountHolderStatus.Enabled​

When the account holder is enabled.

AccountHolderStatus.Suspended​

When the account holder is suspended.

AccountHolderStatus.Canceled​

When the account holder is canceled.

Member of​

AccountHolderCanceledStatusInfo object ● AccountHolderEnabledStatusInfo object ● AccountHolderFilterInput input ● AccountHolderStatusInfo interface ● AccountHolderSuspendedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/account-holder-type/index.html b/api-reference/enums/account-holder-type/index.html index dd7e2648171..04ee61e85d2 100644 --- a/api-reference/enums/account-holder-type/index.html +++ b/api-reference/enums/account-holder-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountHolderType

Account holder type

enum AccountHolderType {
  Individual
  Company
}

Values​

AccountHolderType.Individual​

Individual (Natural person)

AccountHolderType.Company​

Company (Legal person)

Member of​

AccountHolderCompanyInfo object ● AccountHolderFilterInput input ● AccountHolderIndividualInfo object ● AccountHolderInfo interface ● OnboardingAccountHolderInfo interface ● OnboardingCompanyAccountHolderInfo object ● OnboardingFiltersInput input ● OnboardingIndividualAccountHolderInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/account-language/index.html b/api-reference/enums/account-language/index.html index 02637c0c3b2..30e29b35599 100644 --- a/api-reference/enums/account-language/index.html +++ b/api-reference/enums/account-language/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/account-membership-order-by-field-input/index.html b/api-reference/enums/account-membership-order-by-field-input/index.html index 27b60c07908..b93c2db07d6 100644 --- a/api-reference/enums/account-membership-order-by-field-input/index.html +++ b/api-reference/enums/account-membership-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/account-membership-status/index.html b/api-reference/enums/account-membership-status/index.html index fcef3ab5e83..b5b7d5932ce 100644 --- a/api-reference/enums/account-membership-status/index.html +++ b/api-reference/enums/account-membership-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipStatus

AccountMembership enabled

enum AccountMembershipStatus {
  ConsentPending
  InvitationSent
  BindingUserError
  Enabled
  Suspended
  Disabled
}

Values​

AccountMembershipStatus.ConsentPending​

when the consent to invite the account membership is pending

AccountMembershipStatus.InvitationSent​

when the account membership is invited

AccountMembershipStatus.BindingUserError​

when the user binded with errors to the account membership

AccountMembershipStatus.Enabled​

when the account membership is enabled

AccountMembershipStatus.Suspended​

when the account membership is suspended

AccountMembershipStatus.Disabled​

when the account membership is disabled

Member of​

AccountMembershipBindingUserErrorStatusInfo object ● AccountMembershipConsentPendingStatusInfo object ● AccountMembershipDisabledStatusInfo object ● AccountMembershipEnabledStatusInfo object ● AccountMembershipInvitationSentStatusInfo object ● AccountMembershipsFilterInput input ● AccountMembershipStatusInfo interface ● AccountMembershipSuspendedStatusInfo object ● MembershipsFilterInput input

- + \ No newline at end of file diff --git a/api-reference/enums/account-memberships-permission/index.html b/api-reference/enums/account-memberships-permission/index.html index ed00195065e..e110d0814ce 100644 --- a/api-reference/enums/account-memberships-permission/index.html +++ b/api-reference/enums/account-memberships-permission/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/account-order-by-field-input/index.html b/api-reference/enums/account-order-by-field-input/index.html index bfb8e042f64..7d3e0d339f6 100644 --- a/api-reference/enums/account-order-by-field-input/index.html +++ b/api-reference/enums/account-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/account-received-direct-debit-order-by-field-input/index.html b/api-reference/enums/account-received-direct-debit-order-by-field-input/index.html index e4f720b2eb0..1e428577b14 100644 --- a/api-reference/enums/account-received-direct-debit-order-by-field-input/index.html +++ b/api-reference/enums/account-received-direct-debit-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/account-standing-order-order-by-field-input/index.html b/api-reference/enums/account-standing-order-order-by-field-input/index.html index abf0839c452..268b17f873f 100644 --- a/api-reference/enums/account-standing-order-order-by-field-input/index.html +++ b/api-reference/enums/account-standing-order-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/account-status/index.html b/api-reference/enums/account-status/index.html index db535d63cb0..d0d3c1173be 100644 --- a/api-reference/enums/account-status/index.html +++ b/api-reference/enums/account-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountStatus

No description

enum AccountStatus {
  Opened
  Suspended
  Closing
  Closed
}

Values​

AccountStatus.Opened​

When the account is opened

AccountStatus.Suspended​

When the account is suspended

AccountStatus.Closing​

When the account is currently closing

AccountStatus.Closed​

When the account is closed

Member of​

AccountClosedStatus object ● AccountClosingStatus object ● AccountFilterInput input ● AccountOpenedStatus object ● AccountStatusInfo interface ● AccountSuspendedStatus object

- + \ No newline at end of file diff --git a/api-reference/enums/account-verification-status/index.html b/api-reference/enums/account-verification-status/index.html index 8414f0a9cc4..bb937c969d1 100644 --- a/api-reference/enums/account-verification-status/index.html +++ b/api-reference/enums/account-verification-status/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountVerificationStatus

Account Verification Status

enum AccountVerificationStatus {
  PendingVerification
  PendingReview
  Verified
  Rejected
}

Values​

AccountVerificationStatus.PendingVerification​

We are waiting for the end user to send a credit transfer from his external iban to any Swan owned iban

AccountVerificationStatus.PendingReview​

We could not automatically match the external iban based on last received transfer. Manuel review process is underway

AccountVerificationStatus.Verified​

Account has been verified

AccountVerificationStatus.Rejected​

Account verification has been rejected

Member of​

AccountVerificationStatusInfo interface ● PendingReviewStatusInfo object ● PendingVerificationStatusInfo object ● RejectedVerificationStatusInfo object ● VerifiedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/aml-risk-level/index.html b/api-reference/enums/aml-risk-level/index.html index 8b98f454fc7..f0945745ab2 100644 --- a/api-reference/enums/aml-risk-level/index.html +++ b/api-reference/enums/aml-risk-level/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/authenticator-type/index.html b/api-reference/enums/authenticator-type/index.html index 00c33d27137..e7ad01f6925 100644 --- a/api-reference/enums/authenticator-type/index.html +++ b/api-reference/enums/authenticator-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/authorization-type/index.html b/api-reference/enums/authorization-type/index.html index 700337cf5e9..6ddca85637d 100644 --- a/api-reference/enums/authorization-type/index.html +++ b/api-reference/enums/authorization-type/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AuthorizationType

Type of the card authorization transaction

enum AuthorizationType {
  Classic
  PreAuthorization
  DataRequest
}

Values​

AuthorizationType.Classic​

Classic authorization, nominal use-case, in order to hold the amount in the available balance that will be debited in the following days

AuthorizationType.PreAuthorization​

Pre-authorization. Usually an authorization in order to hold the amount in the available balance that will be updated in a second time with the final amount (gaz station, car rent, etc)

AuthorizationType.DataRequest​

Usually an authorization used by a merchant to verify if the card exists and can successfully receive a future authorization

Member of​

CardTransaction object

- + \ No newline at end of file diff --git a/api-reference/enums/business-activity/index.html b/api-reference/enums/business-activity/index.html index 65ef279083a..ebec9b0ea30 100644 --- a/api-reference/enums/business-activity/index.html +++ b/api-reference/enums/business-activity/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

BusinessActivity

Business activity.

enum BusinessActivity {
  AdministrativeServices
  Agriculture
  Arts
  BusinessAndRetail
  Construction
  Education
  ElectricalDistributionAndWaterSupply
  FinancialAndInsuranceOperations
  Health
  Housekeeping
  InformationAndCommunication
  LodgingAndFoodServices
  ManufacturingAndMining
  Other
  PublicAdministration
  RealEstate
  ScientificActivities
  Transportation
}

Values​

BusinessActivity.AdministrativeServices​

BusinessActivity.Agriculture​

BusinessActivity.Arts​

BusinessActivity.BusinessAndRetail​

BusinessActivity.Construction​

BusinessActivity.Education​

BusinessActivity.ElectricalDistributionAndWaterSupply​

BusinessActivity.FinancialAndInsuranceOperations​

BusinessActivity.Health​

BusinessActivity.Housekeeping​

BusinessActivity.InformationAndCommunication​

BusinessActivity.LodgingAndFoodServices​

BusinessActivity.ManufacturingAndMining​

BusinessActivity.Other​

BusinessActivity.PublicAdministration​

BusinessActivity.RealEstate​

BusinessActivity.ScientificActivities​

BusinessActivity.Transportation​

Member of​

AccountHolderCompanyInfo object ● OnboardCompanyAccountHolderInput input ● OnboardingCompanyAccountHolderInfo object ● UpdateCompanyOnboardingInput input

- + \ No newline at end of file diff --git a/api-reference/enums/cancel-physical-card-reason/index.html b/api-reference/enums/cancel-physical-card-reason/index.html index e1ae385583b..151bcb17543 100644 --- a/api-reference/enums/cancel-physical-card-reason/index.html +++ b/api-reference/enums/cancel-physical-card-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CancelPhysicalCardReason

reason why the physical card is canceled

enum CancelPhysicalCardReason {
  NonReceived
  Lost
  Stolen
  Defected
  Blocked
}

Values​

CancelPhysicalCardReason.NonReceived​

When the card holder never received the card

CancelPhysicalCardReason.Lost​

When the card has been stolen

CancelPhysicalCardReason.Stolen​

When the card has been stolen

CancelPhysicalCardReason.Defected​

When the card doesn't work anymore

CancelPhysicalCardReason.Blocked​

When the card holder wants to block his card

Member of​

CancelPhysicalCardInput input

- + \ No newline at end of file diff --git a/api-reference/enums/canceled-funding-source-reason/index.html b/api-reference/enums/canceled-funding-source-reason/index.html index c19cecfb1c6..dd42a979533 100644 --- a/api-reference/enums/canceled-funding-source-reason/index.html +++ b/api-reference/enums/canceled-funding-source-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/capital-deposit-case-order-by-field-input/index.html b/api-reference/enums/capital-deposit-case-order-by-field-input/index.html index 9b68f0b2b05..95d444ed9fe 100644 --- a/api-reference/enums/capital-deposit-case-order-by-field-input/index.html +++ b/api-reference/enums/capital-deposit-case-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/capital-deposit-case-status/index.html b/api-reference/enums/capital-deposit-case-status/index.html index cf2f3ccf5df..d00e10454df 100644 --- a/api-reference/enums/capital-deposit-case-status/index.html +++ b/api-reference/enums/capital-deposit-case-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositCaseStatus

Status of a capital deposit case.

enum CapitalDepositCaseStatus {
  Initiated
  WaitingForRequirements
  WaitingForShareDepositCertificate
  WaitingForRegisterExtract
  WaitingForNotaryTransfer
  Completed
}

Values​

CapitalDepositCaseStatus.Initiated​

Technical state when the mutation to create a new capital deposit case is called.

CapitalDepositCaseStatus.WaitingForRequirements​

A new capital deposit case is created and Swan is waiting for the required information to be provided and each shareholder to wire their share of share capital.

CapitalDepositCaseStatus.WaitingForShareDepositCertificate​

Swan is waiting for the notary to provide the Share Deposit Certificate.

CapitalDepositCaseStatus.WaitingForRegisterExtract​

Swan is waiting for you to provide the Register Extract.

CapitalDepositCaseStatus.WaitingForNotaryTransfer​

Swan is waiting for the notary to wire the share capital on the account of the company being registered.

CapitalDepositCaseStatus.Completed​

The capital deposit case is completed.

Member of​

CapitalDepositCase object ● CapitalDepositCaseFiltersInput input

- + \ No newline at end of file diff --git a/api-reference/enums/capital-deposit-document-status/index.html b/api-reference/enums/capital-deposit-document-status/index.html index 2c95f12904b..bc66347ae6c 100644 --- a/api-reference/enums/capital-deposit-document-status/index.html +++ b/api-reference/enums/capital-deposit-document-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositDocumentStatus

Status of the Capital Deposit Case

enum CapitalDepositDocumentStatus {
  Pending
  Uploaded
  Validated
  Refused
}

Values​

CapitalDepositDocumentStatus.Pending​

Document is not uploaded yet.

CapitalDepositDocumentStatus.Uploaded​

Document has been uploaded but not verified by Swan yet.

CapitalDepositDocumentStatus.Validated​

Document has been uploaded and verified by Swan.

CapitalDepositDocumentStatus.Refused​

Document has been refused by Swan, it must be uploaded again.

Member of​

CapitalDepositDocument object ● CapitalDepositDocumentPendingStatusInfo object ● CapitalDepositDocumentRefusedStatusInfo object ● CapitalDepositDocumentStatusInfo interface ● CapitalDepositDocumentUploadedStatusInfo object ● CapitalDepositDocumentValidatedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/capital-deposit-document-type/index.html b/api-reference/enums/capital-deposit-document-type/index.html index a2de5a741bd..bb21ec47e1a 100644 --- a/api-reference/enums/capital-deposit-document-type/index.html +++ b/api-reference/enums/capital-deposit-document-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositDocumentType

Type of the document.

enum CapitalDepositDocumentType {
  ArticlesOfIncorporation
  RegisterExtract
  ProofOfIdentity
  CorporateIncomeTaxReturn
  ProofOfIndividualAddress
  CompanyLeaseAgreement
  CapitalShareDepositCertificate
  PowerOfAttorney
}

Values​

CapitalDepositDocumentType.ArticlesOfIncorporation​

Legal document required for company’s formation.

CapitalDepositDocumentType.RegisterExtract​

Commercial registry extract issued within the last 3 months.

CapitalDepositDocumentType.ProofOfIdentity​

Can be either passport, national id card or resident permit.

CapitalDepositDocumentType.CorporateIncomeTaxReturn​

Document submitted to your tax bureau at the end of the last business period.

CapitalDepositDocumentType.ProofOfIndividualAddress​

Can be a utility bill (water, electricity or gas), a telephone bill or a rental receipt. The document must have been issued within the last 3 months.

CapitalDepositDocumentType.CompanyLeaseAgreement​

Lease agreement in the name of the business or Proof of Individual Address if the company is hosted by one of the legal representative.

CapitalDepositDocumentType.CapitalShareDepositCertificate​

Created by the Notary, it certifies the capital of the company to have been deposited with the appropriate share for each shareholder.

CapitalDepositDocumentType.PowerOfAttorney​

Signed power of attorney document to give the power to act on behalf.

Member of​

CapitalDepositDocument object

- + \ No newline at end of file diff --git a/api-reference/enums/card-authorization-outcome/index.html b/api-reference/enums/card-authorization-outcome/index.html index 2ea9eb30eab..777548c633d 100644 --- a/api-reference/enums/card-authorization-outcome/index.html +++ b/api-reference/enums/card-authorization-outcome/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardAuthorizationOutcome

No description

enum CardAuthorizationOutcome {
  Accepted
  AccountClosed
  AccountSuspended
  AtmWithdrawalAmountLimitExceeded
  AtmWithdrawalNumberLimitExceeded
  AuthorizationConsumed
  AuthorizationUpdated
  AuthorizationValidityExceeded
  CardCanceled
  CardExpired
  CardholderCancelation
  CardLost
  CardNotProvidedToCardholderOrClosed
  CardNumberInvalid
  CardOpposedCardStolen
  CardOutOfOrder
  CardTemporarilyLocked
  CardUnknown
  DoNotHonor
  eMoneyAccount
  eMoneyAccountLimitExceeded
  IncorrectPinCodeAttemptsExceeded
  InsufficientFunds
  MerchantInvalid
  MerchantShouldResubmitAuthorization
  MiscellaneousReason
  OriginalTransactionNotFound
  PartialApproval
  PartialCancelation
  PeriodAmountLimitExceeded
  PeriodNumberTransactionLimitExceeded
  PinCodeInvalid
  PinCodeValidationImpossible
  SpendingLimitsReached
  TechnicalError
  TransactionAmountLimitExceeded
  TransactionCurrencyIncorrect
  TransactionInvalid
  TransactionNotAuthorizedForCardholder
  TransactionNotAuthorizedForPointOfSale
}

Values​

CardAuthorizationOutcome.Accepted​

CardAuthorizationOutcome.AccountClosed​

CardAuthorizationOutcome.AccountSuspended​

CardAuthorizationOutcome.AtmWithdrawalAmountLimitExceeded​

CardAuthorizationOutcome.AtmWithdrawalNumberLimitExceeded​

CardAuthorizationOutcome.AuthorizationConsumed​

CardAuthorizationOutcome.AuthorizationUpdated​

CardAuthorizationOutcome.AuthorizationValidityExceeded​

CardAuthorizationOutcome.CardCanceled​

CardAuthorizationOutcome.CardExpired​

CardAuthorizationOutcome.CardholderCancelation​

CardAuthorizationOutcome.CardLost​

CardAuthorizationOutcome.CardNotProvidedToCardholderOrClosed​

CardAuthorizationOutcome.CardNumberInvalid​

CardAuthorizationOutcome.CardOpposedCardStolen​

CardAuthorizationOutcome.CardOutOfOrder​

CardAuthorizationOutcome.CardTemporarilyLocked​

CardAuthorizationOutcome.CardUnknown​

CardAuthorizationOutcome.DoNotHonor​

CardAuthorizationOutcome.eMoneyAccount​

CardAuthorizationOutcome.eMoneyAccountLimitExceeded​

CardAuthorizationOutcome.IncorrectPinCodeAttemptsExceeded​

CardAuthorizationOutcome.InsufficientFunds​

CardAuthorizationOutcome.MerchantInvalid​

CardAuthorizationOutcome.MerchantShouldResubmitAuthorization​

CardAuthorizationOutcome.MiscellaneousReason​

CardAuthorizationOutcome.OriginalTransactionNotFound​

CardAuthorizationOutcome.PartialApproval​

CardAuthorizationOutcome.PartialCancelation​

CardAuthorizationOutcome.PeriodAmountLimitExceeded​

CardAuthorizationOutcome.PeriodNumberTransactionLimitExceeded​

CardAuthorizationOutcome.PinCodeInvalid​

CardAuthorizationOutcome.PinCodeValidationImpossible​

CardAuthorizationOutcome.SpendingLimitsReached​

CardAuthorizationOutcome.TechnicalError​

CardAuthorizationOutcome.TransactionAmountLimitExceeded​

CardAuthorizationOutcome.TransactionCurrencyIncorrect​

CardAuthorizationOutcome.TransactionInvalid​

CardAuthorizationOutcome.TransactionNotAuthorizedForCardholder​

CardAuthorizationOutcome.TransactionNotAuthorizedForPointOfSale​

- + \ No newline at end of file diff --git a/api-reference/enums/card-authorization-type/index.html b/api-reference/enums/card-authorization-type/index.html index 8d3cd9386eb..f4d5628718c 100644 --- a/api-reference/enums/card-authorization-type/index.html +++ b/api-reference/enums/card-authorization-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/card-design-background-type/index.html b/api-reference/enums/card-design-background-type/index.html index 1203400783e..bcb18c3d041 100644 --- a/api-reference/enums/card-design-background-type/index.html +++ b/api-reference/enums/card-design-background-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/card-design-status/index.html b/api-reference/enums/card-design-status/index.html index f5b3f61678e..a2383f600af 100644 --- a/api-reference/enums/card-design-status/index.html +++ b/api-reference/enums/card-design-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/card-order-by-field-input/index.html b/api-reference/enums/card-order-by-field-input/index.html index 451f0f71767..f87ba5679b7 100644 --- a/api-reference/enums/card-order-by-field-input/index.html +++ b/api-reference/enums/card-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/card-product-status/index.html b/api-reference/enums/card-product-status/index.html index 568540115df..543607b9a02 100644 --- a/api-reference/enums/card-product-status/index.html +++ b/api-reference/enums/card-product-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/card-settings-background-type/index.html b/api-reference/enums/card-settings-background-type/index.html index 3110a3a7de6..f1ab38c93cc 100644 --- a/api-reference/enums/card-settings-background-type/index.html +++ b/api-reference/enums/card-settings-background-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/card-status/index.html b/api-reference/enums/card-status/index.html index be85a5f2a4f..fa6f8c90336 100644 --- a/api-reference/enums/card-status/index.html +++ b/api-reference/enums/card-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardStatus

Card Status

enum CardStatus {
  ConsentPending
  Processing
  Enabled
  Canceled
  Canceling
}

Values​

CardStatus.ConsentPending​

when the consent to add this card is pending

CardStatus.Processing​

when the card is in the process of being ready to use

CardStatus.Enabled​

when the card is enabled

CardStatus.Canceled​

when the card is canceled

CardStatus.Canceling​

when the card is about to be canceled

Member of​

CardCanceledStatusInfo object ● CardCancelingStatusInfo object ● CardConsentPendingStatusInfo object ● CardEnabledStatusInfo object ● CardFiltersInput input ● CardProcessingStatusInfo object ● CardStatusInfo interface ● CardWrongStatusRejection object

- + \ No newline at end of file diff --git a/api-reference/enums/card-transaction-category/index.html b/api-reference/enums/card-transaction-category/index.html index bdcd3a841b1..dd18d6095bf 100644 --- a/api-reference/enums/card-transaction-category/index.html +++ b/api-reference/enums/card-transaction-category/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/card-type/index.html b/api-reference/enums/card-type/index.html index 54022e00bec..c9ecb322595 100644 --- a/api-reference/enums/card-type/index.html +++ b/api-reference/enums/card-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/cash-account-type/index.html b/api-reference/enums/cash-account-type/index.html index 76cae47f7fa..9d7e7c6984f 100644 --- a/api-reference/enums/cash-account-type/index.html +++ b/api-reference/enums/cash-account-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CashAccountType

Cash account type (Always Current)

enum CashAccountType {
  Current
  CashPayment
  Charges
  CashIncome
  Commission
  ClearingParticipantSettlementAccount
  LimitedLiquiditySavingsAccount
  Loan
  MarginalLending
  MoneyMarket
  NonResidentExternal
  Overdraft
  OverNightDeposit
  OtherAccount
  Settlement
  Salary
  Savings
  Tax
  TransactingAccount
  CashTrading
}

Values​

CashAccountType.Current​

When the account is a current account.

CashAccountType.CashPayment​

CashAccountType.Charges​

CashAccountType.CashIncome​

CashAccountType.Commission​

CashAccountType.ClearingParticipantSettlementAccount​

CashAccountType.LimitedLiquiditySavingsAccount​

CashAccountType.Loan​

CashAccountType.MarginalLending​

CashAccountType.MoneyMarket​

CashAccountType.NonResidentExternal​

CashAccountType.Overdraft​

CashAccountType.OverNightDeposit​

CashAccountType.OtherAccount​

CashAccountType.Settlement​

CashAccountType.Salary​

CashAccountType.Savings​

CashAccountType.Tax​

CashAccountType.TransactingAccount​

CashAccountType.CashTrading​

Member of​

Account object ● AddExternalAccountInput input ● ExternalAccount object

- + \ No newline at end of file diff --git a/api-reference/enums/category/index.html b/api-reference/enums/category/index.html index a737caeb4cc..2717ee8fc25 100644 --- a/api-reference/enums/category/index.html +++ b/api-reference/enums/category/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/close-account-reason-type/index.html b/api-reference/enums/close-account-reason-type/index.html index af2ce5945a2..43e30553aa6 100644 --- a/api-reference/enums/close-account-reason-type/index.html +++ b/api-reference/enums/close-account-reason-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/company-type/index.html b/api-reference/enums/company-type/index.html index e2bc16aaece..3d3495d866c 100644 --- a/api-reference/enums/company-type/index.html +++ b/api-reference/enums/company-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/complete-digital-card-status/index.html b/api-reference/enums/complete-digital-card-status/index.html index 499022ac7a7..22e76bb327c 100644 --- a/api-reference/enums/complete-digital-card-status/index.html +++ b/api-reference/enums/complete-digital-card-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CompleteDigitalCardStatus

Complete Digital Card Status

enum CompleteDigitalCardStatus {
  Enabled
  Suspended
  Canceled
}

Values​

CompleteDigitalCardStatus.Enabled​

when the digital card is enabled

CompleteDigitalCardStatus.Suspended​

when the digital card is suspended

the transactions will be blocked

CompleteDigitalCardStatus.Canceled​

when the digital card is canceled

this is a final state

Member of​

CompleteDigitalCardStatusInfo interface ● DigitalCardCanceledStatusInfo object ● DigitalCardEnabledStatusInfo object ● DigitalCardSuspendedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/consent-purpose/index.html b/api-reference/enums/consent-purpose/index.html index 305a26025f2..309079b9d2f 100644 --- a/api-reference/enums/consent-purpose/index.html +++ b/api-reference/enums/consent-purpose/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ConsentPurpose

Purpose of a consent

enum ConsentPurpose {
  AcceptPartnershipConditions
  AddAccountMembership
  AddAccountMemberships
  AddBeneficiary
  AddCard
  AddCards
  AddDigitalCard
  ActivatePhysicalCard
  CloseAccount
  InitPayment
  PrintPhysicalCard
  ResumeAccountMembership
  ResumePhysicalCard
  ScheduleStandingOrder
  UpdateAccountMembership
  UpdateCard
  UpdateServerConsentProjectSettings
  ViewCardNumbers
  ViewPhysicalCardPin
  EnableMandate
  AddDirectDebitPaymentMandate
  InitiateFundingRequest
  InitiateInstantFundingRequest
  InitiateInternationalCreditTransfer
  ConsentToMultipleConsents
}

Values​

ConsentPurpose.AcceptPartnershipConditions​

when accepting the partnership conditions

ConsentPurpose.AddAccountMembership​

when inviting a new account membership

ConsentPurpose.AddAccountMemberships​

when adding several account memberships

ConsentPurpose.AddBeneficiary​

when adding a beneficiary

ConsentPurpose.AddCard​

when adding a virtual card

ConsentPurpose.AddCards​

when adding multiple cards

ConsentPurpose.AddDigitalCard​

when adding a digital card

ConsentPurpose.ActivatePhysicalCard​

when activating a physical card

ConsentPurpose.CloseAccount​

when closing an account

ConsentPurpose.InitPayment​

when initiating a credit transfer

ConsentPurpose.PrintPhysicalCard​

when requesting to print physical card

ConsentPurpose.ResumeAccountMembership​

when resuming an account membership

ConsentPurpose.ResumePhysicalCard​

when resuming a physical card

ConsentPurpose.ScheduleStandingOrder​

when scheduling a standing order

ConsentPurpose.UpdateAccountMembership​

when updating an account membership

ConsentPurpose.UpdateCard​

when updating a card

ConsentPurpose.UpdateServerConsentProjectSettings​

when updating a server consent project settings

ConsentPurpose.ViewCardNumbers​

when viewing card confidential of a virtual card

ConsentPurpose.ViewPhysicalCardPin​

when requesting to view physical card PIN

ConsentPurpose.EnableMandate​

when enabling a mandate

ConsentPurpose.AddDirectDebitPaymentMandate​

when adding a payment direct debit mandate

ConsentPurpose.InitiateFundingRequest​

when initiating a funding request

ConsentPurpose.InitiateInstantFundingRequest​

when initiating an instant funding request

ConsentPurpose.InitiateInternationalCreditTransfer​

when initiating an international credit transfer

ConsentPurpose.ConsentToMultipleConsents​

when the consent is a multiple consent

Member of​

Consent object

- + \ No newline at end of file diff --git a/api-reference/enums/consent-status/index.html b/api-reference/enums/consent-status/index.html index 381c182b48e..5321d71c7cf 100644 --- a/api-reference/enums/consent-status/index.html +++ b/api-reference/enums/consent-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ConsentStatus

Status of a consent

enum ConsentStatus {
  Accepted
  CustomerRefused
  OperationCommitting
  CredentialRefused
  Created
  Started
  Expired
  Failed
  Canceled
}

Values​

ConsentStatus.Accepted​

when the user accepted

ConsentStatus.CustomerRefused​

when the user refused

ConsentStatus.OperationCommitting​

when the operation is committing

ConsentStatus.CredentialRefused​

when the user credentials were refused

ConsentStatus.Created​

when the consent is created

ConsentStatus.Started​

when the consentUrl has been requested

ConsentStatus.Expired​

when the consent is expired

ConsentStatus.Failed​

when something went wrong

ConsentStatus.Canceled​

when the user or the project decided to cancel the consent

Member of​

Consent object ● NotReachableConsentStatusRejection object

- + \ No newline at end of file diff --git a/api-reference/enums/credit-transfer-mode/index.html b/api-reference/enums/credit-transfer-mode/index.html index 82f5c981d07..1c70d2f489c 100644 --- a/api-reference/enums/credit-transfer-mode/index.html +++ b/api-reference/enums/credit-transfer-mode/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/digital-card-order-by-field-input/index.html b/api-reference/enums/digital-card-order-by-field-input/index.html index 467a9f18c13..9a24a30082f 100644 --- a/api-reference/enums/digital-card-order-by-field-input/index.html +++ b/api-reference/enums/digital-card-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/digitalization-type/index.html b/api-reference/enums/digitalization-type/index.html index e7b2480223b..8f2cbd194cb 100644 --- a/api-reference/enums/digitalization-type/index.html +++ b/api-reference/enums/digitalization-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DigitalizationType

Digitalization Type

enum DigitalizationType {
  Manual
  CardOnFile
  InApp
  Unknown
}

Values​

DigitalizationType.Manual​

This digital card was created by direct input of the PAN into a wallet application

This direct input can also be done using the device camera

DigitalizationType.CardOnFile​

This digital card was created based on a PAN stored into a merchant application (ex: iTunes)

DigitalizationType.InApp​

This digital card was created by an in app provisioning

DigitalizationType.Unknown​

We could not get the source of the digitalization

Member of​

CompleteDigitalCard object ● DigitalCard interface ● PendingDigitalCard object

- + \ No newline at end of file diff --git a/api-reference/enums/direct-debit-sequence/index.html b/api-reference/enums/direct-debit-sequence/index.html index 17fe3b28ecb..4c46384d6b7 100644 --- a/api-reference/enums/direct-debit-sequence/index.html +++ b/api-reference/enums/direct-debit-sequence/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/document-file-side/index.html b/api-reference/enums/document-file-side/index.html index 63ed71b0aaf..e277bef6bdc 100644 --- a/api-reference/enums/document-file-side/index.html +++ b/api-reference/enums/document-file-side/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/document-reason-code/index.html b/api-reference/enums/document-reason-code/index.html index 69a3f1a309c..7a89490030c 100644 --- a/api-reference/enums/document-reason-code/index.html +++ b/api-reference/enums/document-reason-code/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DocumentReasonCode

Reason code of the document.

enum DocumentReasonCode {
  CompanyNameMismatch
  DeclaredAmountMismatch
  ExpiredDocument
  InvalidAddress
  InvalidDocument
  InvalidOrMissingData
  MissingAccommodationProviderId
  MissingAccommodationProviderIdLetter
  MissingAccommodationProviderLetter
  UnacceptableDocument
}

Values​

DocumentReasonCode.CompanyNameMismatch​

Company name in document doesn’t match our records

DocumentReasonCode.DeclaredAmountMismatch​

Declared amount in document doesn’t match the amount received

DocumentReasonCode.ExpiredDocument​

Document must be dated less than 3 months ago

DocumentReasonCode.InvalidAddress​

Address in document doesn’t match our records

DocumentReasonCode.InvalidDocument​

Default value when none of the other values is appropriate

DocumentReasonCode.InvalidOrMissingData​

Name of shareholder is not clearly visible or is missing

DocumentReasonCode.MissingAccommodationProviderId​

Missing identity document of accommodation provider

DocumentReasonCode.MissingAccommodationProviderIdLetter​

Missing identity document and proof of accommodation from accommodation provider

DocumentReasonCode.MissingAccommodationProviderLetter​

Missing proof of accommodation from accommodation provider

DocumentReasonCode.UnacceptableDocument​

Document can’t be accepted as a proof of address

Member of​

CapitalDepositDocumentRefusedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/document-type/index.html b/api-reference/enums/document-type/index.html index ec76ca95f79..bb8048f7710 100644 --- a/api-reference/enums/document-type/index.html +++ b/api-reference/enums/document-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/employment-status/index.html b/api-reference/enums/employment-status/index.html index 88f993ed5d1..cb306dec791 100644 --- a/api-reference/enums/employment-status/index.html +++ b/api-reference/enums/employment-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

EmploymentStatus

Employment status.

enum EmploymentStatus {
  Craftsman
  Employee
  Entrepreneur
  Farmer
  Manager
  Practitioner
  Retiree
  ShopOwner
  Student
  Unemployed
}

Values​

EmploymentStatus.Craftsman​

EmploymentStatus.Employee​

EmploymentStatus.Entrepreneur​

EmploymentStatus.Farmer​

EmploymentStatus.Manager​

EmploymentStatus.Practitioner​

EmploymentStatus.Retiree​

EmploymentStatus.ShopOwner​

EmploymentStatus.Student​

EmploymentStatus.Unemployed​

Member of​

AccountHolderIndividualInfo object ● OnboardIndividualAccountHolderInput input ● OnboardingIndividualAccountHolderInfo object ● UpdateIndividualOnboardingInput input

- + \ No newline at end of file diff --git a/api-reference/enums/env-type/index.html b/api-reference/enums/env-type/index.html index 2973aca1b3e..e2fce35cad9 100644 --- a/api-reference/enums/env-type/index.html +++ b/api-reference/enums/env-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/external-account-balance-type/index.html b/api-reference/enums/external-account-balance-type/index.html index 3516578932a..7cf41ed1157 100644 --- a/api-reference/enums/external-account-balance-type/index.html +++ b/api-reference/enums/external-account-balance-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ExternalAccountBalanceType

No description

enum ExternalAccountBalanceType {
  ClosingBooked
  PreviouslyClosedBooked
  InterimAvailable
  Expected
  ValueDate
  Other
}

Values​

ExternalAccountBalanceType.ClosingBooked​

Balance of the account at the end of the pre-agreed account reporting period

ExternalAccountBalanceType.PreviouslyClosedBooked​

Balance of the account at the previously closed account reporting period

ExternalAccountBalanceType.InterimAvailable​

Available balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day

ExternalAccountBalanceType.Expected​

Balance composed of booked entries and pending items known at the time of calculation

ExternalAccountBalanceType.ValueDate​

Value-date balance

ExternalAccountBalanceType.Other​

Other balance

Member of​

AddExternalAccountBalanceInput input ● AddOrUpdateExternalAccountBalanceInput input ● ExternalAccountBalance object ● ExternalAccountBalanceAlreadyExistsRejection object ● ExternalAccountBalanceInput input

- + \ No newline at end of file diff --git a/api-reference/enums/external-account-data-source-type/index.html b/api-reference/enums/external-account-data-source-type/index.html index 00a8a72c916..6fd2ad5c7b6 100644 --- a/api-reference/enums/external-account-data-source-type/index.html +++ b/api-reference/enums/external-account-data-source-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/external-account-usage/index.html b/api-reference/enums/external-account-usage/index.html index 684b02e5b23..e6eebe4c3ac 100644 --- a/api-reference/enums/external-account-usage/index.html +++ b/api-reference/enums/external-account-usage/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/fees-type-enum/index.html b/api-reference/enums/fees-type-enum/index.html index 29f34d13e65..bca8a9c41b0 100644 --- a/api-reference/enums/fees-type-enum/index.html +++ b/api-reference/enums/fees-type-enum/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FeesTypeEnum

Fees type

enum FeesTypeEnum {
  BankingFee
  CardPaymentsOutsideSEPA
  CashWithdrawalsOutsideSEPA
  CashWithdrawalsWithinSEPA
  CheckDeposit
  CheckIncident
  CirculationLetterDraftingFee
  ConfirmationLetterDraftingFee
  DirectDebitRejection
  InternationalCreditTransferInGroup1
  InternationalCreditTransferInGroup2
  InternationalCreditTransferInGroup3
  InternationalCreditTransferInGroup4
  InternationalCreditTransferOutGroup1
  InternationalCreditTransferOutGroup2
  InternationalCreditTransferOutGroup3
  InternationalCreditTransferOutGroup4
  ImproperUseOfAccount
  PhysicalCardDeliveryExpress
  PhysicalCardDeliveryFrance
  PhysicalCardDeliveryIntl
  PhysicalCardPrinting
  ProcessingJudicialOrAdministrativeSeizure
  SepaDirectDebitInB2bLevel1
  SepaDirectDebitInB2bLevel2
  SepaDirectDebitInCoreLevel1
  SepaDirectDebitInCoreLevel2
  SepaDirectDebitInCoreReturn
  UnauthorizedOverdraft
}

Values​

FeesTypeEnum.BankingFee​

Other banking fee

FeesTypeEnum.CardPaymentsOutsideSEPA​

Card transaction in foreign currency

FeesTypeEnum.CashWithdrawalsOutsideSEPA​

Cash withdrawal in foreign currency

FeesTypeEnum.CashWithdrawalsWithinSEPA​

Cash withdrawal

FeesTypeEnum.CheckDeposit​

Deposit of a physical check

FeesTypeEnum.CheckIncident​

Rejection or return of a physical check

FeesTypeEnum.CirculationLetterDraftingFee​

Drafting circulation letter

FeesTypeEnum.ConfirmationLetterDraftingFee​

Drafting Confirmation letter

FeesTypeEnum.DirectDebitRejection​

Direct debit rejection

FeesTypeEnum.InternationalCreditTransferInGroup1​

Incoming credit transfers not denominated and executed in euros on group 1 currencies

FeesTypeEnum.InternationalCreditTransferInGroup2​

Incoming credit transfers not denominated and executed in euros on group 2 currencies

FeesTypeEnum.InternationalCreditTransferInGroup3​

Incoming credit transfers not denominated and executed in euros on group 3 currencies

FeesTypeEnum.InternationalCreditTransferInGroup4​

Incoming credit transfers not denominated and executed in euros on group 4 currencies

FeesTypeEnum.InternationalCreditTransferOutGroup1​

Outgoing credit transfers not denominated and executed in euros on group 1 currencies

FeesTypeEnum.InternationalCreditTransferOutGroup2​

Outgoing credit transfers not denominated and executed in euros on group 2 currencies

FeesTypeEnum.InternationalCreditTransferOutGroup3​

Outgoing credit transfers not denominated and executed in euros on group 3 currencies

FeesTypeEnum.InternationalCreditTransferOutGroup4​

Outgoing credit transfers not denominated and executed in euros on group 4 currencies

FeesTypeEnum.ImproperUseOfAccount​

Improper use of account

FeesTypeEnum.PhysicalCardDeliveryExpress​

Delivery of physical cards with an express delivery provider

FeesTypeEnum.PhysicalCardDeliveryFrance​

Delivery of physical cards within France

FeesTypeEnum.PhysicalCardDeliveryIntl​

Delivery of physical cards outside of France

FeesTypeEnum.PhysicalCardPrinting​

Process of printing physical cards

FeesTypeEnum.ProcessingJudicialOrAdministrativeSeizure​

Processing judicial or administrative seizure

FeesTypeEnum.SepaDirectDebitInB2bLevel1​

B2B SEPA Direct Debit up to 200€

FeesTypeEnum.SepaDirectDebitInB2bLevel2​

B2B SEPA Direct Debit more than 200€

FeesTypeEnum.SepaDirectDebitInCoreLevel1​

Core SEPA Direct Debit up to 200€

FeesTypeEnum.SepaDirectDebitInCoreLevel2​

Core SEPA Direct Debit more than 200€

FeesTypeEnum.SepaDirectDebitInCoreReturn​

Return of a Core SEPA Direct Debit

FeesTypeEnum.UnauthorizedOverdraft​

Unauthorized overdraft

Member of​

FeeTransaction object

- + \ No newline at end of file diff --git a/api-reference/enums/field-validation-error/index.html b/api-reference/enums/field-validation-error/index.html index 25d7a2970ed..85be602f351 100644 --- a/api-reference/enums/field-validation-error/index.html +++ b/api-reference/enums/field-validation-error/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/funding-limit-settings-change-request-order-by-field-input/index.html b/api-reference/enums/funding-limit-settings-change-request-order-by-field-input/index.html index c15ebadce09..e157a1366b0 100644 --- a/api-reference/enums/funding-limit-settings-change-request-order-by-field-input/index.html +++ b/api-reference/enums/funding-limit-settings-change-request-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestOrderByFieldInput

Field we can use when ordering that can be applied when listing funding limit settings change requests

enum FundingLimitSettingsChangeRequestOrderByFieldInput {
  id
  createdAt
  updatedAt
}

Values​

FundingLimitSettingsChangeRequestOrderByFieldInput.id​

FundingLimitSettingsChangeRequestOrderByFieldInput.createdAt​

FundingLimitSettingsChangeRequestOrderByFieldInput.updatedAt​

Member of​

FundingLimitSettingsChangeRequestOrderByInput input

- + \ No newline at end of file diff --git a/api-reference/enums/funding-limit-settings-change-request-status/index.html b/api-reference/enums/funding-limit-settings-change-request-status/index.html index 59f918badfe..0dd606dd956 100644 --- a/api-reference/enums/funding-limit-settings-change-request-status/index.html +++ b/api-reference/enums/funding-limit-settings-change-request-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestStatus

Funding Limit Settings Change Request Status

enum FundingLimitSettingsChangeRequestStatus {
  WaitingForInformation
  Pending
  Approved
  Refused
}

Values​

FundingLimitSettingsChangeRequestStatus.WaitingForInformation​

When the request is in waiting for information

FundingLimitSettingsChangeRequestStatus.Pending​

When the request is in pending

FundingLimitSettingsChangeRequestStatus.Approved​

When the request is approved

FundingLimitSettingsChangeRequestStatus.Refused​

When the request is refused

Member of​

FundingLimitSettingsChangeRequestApprovedStatusInfo object ● FundingLimitSettingsChangeRequestFiltersInput input ● FundingLimitSettingsChangeRequestPendingStatusInfo object ● FundingLimitSettingsChangeRequestRefusedStatusInfo object ● FundingLimitSettingsChangeRequestStatusInfo interface ● FundingLimitSettingsChangeRequestWaitingForInformationStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/funding-limit-settings-status/index.html b/api-reference/enums/funding-limit-settings-status/index.html index 8ae06afe795..8c7f834ef9b 100644 --- a/api-reference/enums/funding-limit-settings-status/index.html +++ b/api-reference/enums/funding-limit-settings-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsStatus

Possible values for funding limit settings status

enum FundingLimitSettingsStatus {
  Enabled
  Suspended
  Disabled
}

Values​

FundingLimitSettingsStatus.Enabled​

When the funding limit settings is enabled

FundingLimitSettingsStatus.Suspended​

When the funding limit settings is suspended

FundingLimitSettingsStatus.Disabled​

When the funding limit settings is disabled

Member of​

DisabledFundingLimitSettingsStatusInfo object ● EnabledFundingLimitSettingsStatusInfo object ● FundingLimitSettingsStatusInfo interface ● SuspendedFundingLimitSettingsStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/funding-source-order-by-field-input/index.html b/api-reference/enums/funding-source-order-by-field-input/index.html index e670daf74ce..818cba778b1 100644 --- a/api-reference/enums/funding-source-order-by-field-input/index.html +++ b/api-reference/enums/funding-source-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/funding-source-status/index.html b/api-reference/enums/funding-source-status/index.html index 6e3471a28e8..80f5c9c5d02 100644 --- a/api-reference/enums/funding-source-status/index.html +++ b/api-reference/enums/funding-source-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingSourceStatus

Funding Source Statuses

enum FundingSourceStatus {
  Pending
  Enabled
  Canceled
  Rejected
  Suspended
}

Values​

FundingSourceStatus.Pending​

FundingSourceStatus.Enabled​

FundingSourceStatus.Canceled​

FundingSourceStatus.Rejected​

FundingSourceStatus.Suspended​

Member of​

CanceledFundingSourceStatusInfo object ● EnabledFundingSourceStatusInfo object ● FundingSourceFiltersInput input ● FundingSourceStatusInfo interface ● FundingSourceWrongStatusRejection object ● PendingFundingSourceStatusInfo object ● RejectedFundingSourceStatusInfo object ● SuspendedFundingSourceStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/ibanstatus/index.html b/api-reference/enums/ibanstatus/index.html index 4dab97089a1..b4460de7447 100644 --- a/api-reference/enums/ibanstatus/index.html +++ b/api-reference/enums/ibanstatus/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/identification-invalid-reason/index.html b/api-reference/enums/identification-invalid-reason/index.html index d7eb7e69f85..adc3d86b31b 100644 --- a/api-reference/enums/identification-invalid-reason/index.html +++ b/api-reference/enums/identification-invalid-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IdentificationInvalidReason

The various reasons that can lead to an invalid identification level

enum IdentificationInvalidReason {
  AbsentOrIncompleteFace
  AlteredDevice
  BadDocumentLighting
  DamagedDocument
  ExpiredDocument
  FraudDetected
  InadequateVideo
  InsufficientApplicantLighting
  InsufficientApplicantLiveness
  InsufficientConnectionQuality
  InsufficientDocumentLiveness
  InsufficientDocumentReadability
  InsufficientFaceReadability
  InsufficientVideoReadability
  InternalError
  InvalidAddress
  InvalidOrMissingData
  InvoluntaryIdentification
  MissingGeolocationData
  NegativeNewsHit
  NonMatchingIdentity
  NonOriginalDocument
  SanctionListHit
  SecondDocumentRequired
  TechnicalSignatureError
  TimeoutSignatureFlow
  UnacceptableDocument
  UnderageApplicant
}

Values​

IdentificationInvalidReason.AbsentOrIncompleteFace​

Face must be fully present in the photo

IdentificationInvalidReason.AlteredDevice​

Applicant used a device that has been technically altered / modified

IdentificationInvalidReason.BadDocumentLighting​

Light on actual document is insufficient

IdentificationInvalidReason.DamagedDocument​

Something about the document is damaged (could be as tiny as a bent corner)

IdentificationInvalidReason.ExpiredDocument​

Expiry date of document has passed

IdentificationInvalidReason.FraudDetected​

Attempt to commit fraud detected

IdentificationInvalidReason.InadequateVideo​

Video quality isn’t sufficient or video is missing required information

IdentificationInvalidReason.InsufficientApplicantLighting​

Lighting on applicant’s face is insufficient

IdentificationInvalidReason.InsufficientApplicantLiveness​

Applicant isn’t meeting movement requirements

IdentificationInvalidReason.InsufficientConnectionQuality​

Internet connection quality is insufficient

IdentificationInvalidReason.InsufficientDocumentLiveness​

Video of document doesn’t meet movement requirements

IdentificationInvalidReason.InsufficientDocumentReadability​

Document is blurry or otherwise distorted

IdentificationInvalidReason.InsufficientFaceReadability​

Face is blurry or otherwise distorted

IdentificationInvalidReason.InsufficientVideoReadability​

Video is blurry or otherwise distorted

IdentificationInvalidReason.InternalError​

There was a technical error

IdentificationInvalidReason.InvalidAddress​

Address is not valid or accepted

IdentificationInvalidReason.InvalidOrMissingData​

Identification data is invalid or missing

IdentificationInvalidReason.InvoluntaryIdentification​

Applicant seems to be doing verification against their will

IdentificationInvalidReason.MissingGeolocationData​

Geolocation data is required but not available

IdentificationInvalidReason.NegativeNewsHit​

Applicant appears on unacceptable news list

IdentificationInvalidReason.NonMatchingIdentity​

Applicant’s identity does not match the expected ID info

IdentificationInvalidReason.NonOriginalDocument​

Applicant presented a duplicate of the document (digital or paper)

IdentificationInvalidReason.SanctionListHit​

Applicant appears on a sanctions list

IdentificationInvalidReason.SecondDocumentRequired​

Applicant required to provide a second document

IdentificationInvalidReason.TechnicalSignatureError​

There was a technical error with the electronic signature process

IdentificationInvalidReason.TimeoutSignatureFlow​

The time to complete the signature timed out

IdentificationInvalidReason.UnacceptableDocument​

Document not on list of acceptable document types

IdentificationInvalidReason.UnderageApplicant​

Applicant is under the minimum required age

Member of​

InvalidIdentificationLevelStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/identification-level-input/index.html b/api-reference/enums/identification-level-input/index.html index aa74c791007..bf01cc6014a 100644 --- a/api-reference/enums/identification-level-input/index.html +++ b/api-reference/enums/identification-level-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/identification-level/index.html b/api-reference/enums/identification-level/index.html index f8e846ea150..55338a53b8c 100644 --- a/api-reference/enums/identification-level/index.html +++ b/api-reference/enums/identification-level/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/identification-process/index.html b/api-reference/enums/identification-process/index.html index 07598c1127a..4a31feb4df5 100644 --- a/api-reference/enums/identification-process/index.html +++ b/api-reference/enums/identification-process/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/identification-status/index.html b/api-reference/enums/identification-status/index.html index a990c669e84..b1fac47ac15 100644 --- a/api-reference/enums/identification-status/index.html +++ b/api-reference/enums/identification-status/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ identity is valid because the quality of the provided documents was insufficient. The user will have to start a new identification, which will update this status to Processing.

IdentificationStatus.InvalidIdentity​

The user has gone through the identity verification process, but we have determined that their identity is invalid. The user will have to start a new identification, which will update this status to Processing.

Member of​

User object

- + \ No newline at end of file diff --git a/api-reference/enums/identifications-order-by-field/index.html b/api-reference/enums/identifications-order-by-field/index.html index 61922d075bf..d28cf7b6685 100644 --- a/api-reference/enums/identifications-order-by-field/index.html +++ b/api-reference/enums/identifications-order-by-field/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/identity-document-type/index.html b/api-reference/enums/identity-document-type/index.html index 48c8c550da7..a2f22ddb130 100644 --- a/api-reference/enums/identity-document-type/index.html +++ b/api-reference/enums/identity-document-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/individual-ultimate-beneficial-owner-type-enum/index.html b/api-reference/enums/individual-ultimate-beneficial-owner-type-enum/index.html index fac39360408..c0c28d556e7 100644 --- a/api-reference/enums/individual-ultimate-beneficial-owner-type-enum/index.html +++ b/api-reference/enums/individual-ultimate-beneficial-owner-type-enum/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IndividualUltimateBeneficialOwnerTypeEnum

Individual Ultimate beneficial owner nature

enum IndividualUltimateBeneficialOwnerTypeEnum {
  LegalRepresentative
  HasCapital
  Other
}

Values​

IndividualUltimateBeneficialOwnerTypeEnum.LegalRepresentative​

The Beneficial Owner is the representant legal

IndividualUltimateBeneficialOwnerTypeEnum.HasCapital​

The Beneficial Owner have shares

IndividualUltimateBeneficialOwnerTypeEnum.Other​

Other

Member of​

IndividualUltimateBeneficialOwnerInfo interface ● IndividualUltimateBeneficialOwnerInput input ● IndividualUltimateBeneficialOwnerTypeHasCapital object ● IndividualUltimateBeneficialOwnerTypeLegalRepresentative object ● IndividualUltimateBeneficialOwnerTypeOther object

- + \ No newline at end of file diff --git a/api-reference/enums/internal-direct-debit-sequence/index.html b/api-reference/enums/internal-direct-debit-sequence/index.html index 83100692184..c2da76afa1b 100644 --- a/api-reference/enums/internal-direct-debit-sequence/index.html +++ b/api-reference/enums/internal-direct-debit-sequence/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/internal-payment-mandate-scheme/index.html b/api-reference/enums/internal-payment-mandate-scheme/index.html index 0155d0c87af..66ddf8fb8b3 100644 --- a/api-reference/enums/internal-payment-mandate-scheme/index.html +++ b/api-reference/enums/internal-payment-mandate-scheme/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/internal-payment-mandate-sequence/index.html b/api-reference/enums/internal-payment-mandate-sequence/index.html index be9ac5a82cb..04f2c2de4a8 100644 --- a/api-reference/enums/internal-payment-mandate-sequence/index.html +++ b/api-reference/enums/internal-payment-mandate-sequence/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/internal-received-direct-debit-mandate-scheme/index.html b/api-reference/enums/internal-received-direct-debit-mandate-scheme/index.html index a19af738f8c..98375ba512b 100644 --- a/api-reference/enums/internal-received-direct-debit-mandate-scheme/index.html +++ b/api-reference/enums/internal-received-direct-debit-mandate-scheme/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalReceivedDirectDebitMandateScheme

Received internal direct debit mandate scheme

enum InternalReceivedDirectDebitMandateScheme {
  InternalDirectDebitB2b
  InternalDirectDebitStandard
}

Values​

InternalReceivedDirectDebitMandateScheme.InternalDirectDebitB2b​

When the received internal direct debit mandate can only be used for internal B2B direct debit transactions

InternalReceivedDirectDebitMandateScheme.InternalDirectDebitStandard​

When the received internal direct debit mandate can only be used for internal Standard direct debit transactions

Member of​

InternalReceivedDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/enums/internal-received-direct-debit-mandate-sequence/index.html b/api-reference/enums/internal-received-direct-debit-mandate-sequence/index.html index 60bfc15e4c8..6656e7aae34 100644 --- a/api-reference/enums/internal-received-direct-debit-mandate-sequence/index.html +++ b/api-reference/enums/internal-received-direct-debit-mandate-sequence/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalReceivedDirectDebitMandateSequence

Internal received direct debit mandate sequence

enum InternalReceivedDirectDebitMandateSequence {
  OneOff
  Recurrent
}

Values​

InternalReceivedDirectDebitMandateSequence.OneOff​

When the authorisation is given once by the Debtor to collect only one single internal direct debit

InternalReceivedDirectDebitMandateSequence.Recurrent​

When the authorisation by the Debtor can be used for regular internal direct debits initiated by the Creditor

Member of​

InternalReceivedDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/enums/international-credit-transfer-display-language/index.html b/api-reference/enums/international-credit-transfer-display-language/index.html index cdf43db24b3..ea084cdff19 100644 --- a/api-reference/enums/international-credit-transfer-display-language/index.html +++ b/api-reference/enums/international-credit-transfer-display-language/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternationalCreditTransferDisplayLanguage

Language: ISO 639-1 language code

enum InternationalCreditTransferDisplayLanguage {
  en
  nl
  fr
  de
  it
  pt
  es
}

Values​

InternationalCreditTransferDisplayLanguage.en​

British English

InternationalCreditTransferDisplayLanguage.nl​

Dutch

InternationalCreditTransferDisplayLanguage.fr​

French

InternationalCreditTransferDisplayLanguage.de​

German

InternationalCreditTransferDisplayLanguage.it​

Italian

InternationalCreditTransferDisplayLanguage.pt​

Portuguese

InternationalCreditTransferDisplayLanguage.es​

Spanish

Member of​

InitiateInternationalCreditTransferInput input ● internationalBeneficiaryDynamicForms query ● internationalCreditTransferQuote query ● internationalCreditTransferTransactionDetailsDynamicForm query

- + \ No newline at end of file diff --git a/api-reference/enums/international-credit-transfer-route-input/index.html b/api-reference/enums/international-credit-transfer-route-input/index.html index b609fac4cdc..297df5b5b81 100644 --- a/api-reference/enums/international-credit-transfer-route-input/index.html +++ b/api-reference/enums/international-credit-transfer-route-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternationalCreditTransferRouteInput

International Credit Transfer Route

enum InternationalCreditTransferRouteInput {
  Aba
  Argentina
  Australian
  AustralianBpay
  Brazil
  Canadian
  Chile
  CostaRica
  Czech
  Emirates
  FedwireLocal
  FijiMobile
  HongKongFps
  Hongkong
  Hungarian
  Iban
  Indian
  IndianUpi
  Interac
  IsraeliLocal
  KenyaLocal
  KenyaMobile
  Malaysian
  MalaysianDuitnow
  Mexican
  Morocco
  Nepal
  NewZealand
  Philippines
  PhilippinesMobile
  Polish
  PrivatBank
  Singapore
  SingaporePaynow
  SortCode
  SouthKoreanPaygate
  SouthKoreanPaygateBusiness
  SouthAfrica
  SwiftCode
  Thailand
  TurkishEarthport
}

Values​

InternationalCreditTransferRouteInput.Aba​

American ACH for low-value payments

InternationalCreditTransferRouteInput.Argentina​

Argentinian local route

InternationalCreditTransferRouteInput.Australian​

Australian local route

InternationalCreditTransferRouteInput.AustralianBpay​

Australian local route Bpay usually used for bill payments

InternationalCreditTransferRouteInput.Brazil​

Brazilian local route

InternationalCreditTransferRouteInput.Canadian​

Canadian local route

InternationalCreditTransferRouteInput.Chile​

Chilean local route

InternationalCreditTransferRouteInput.CostaRica​

Costa Rican local route

InternationalCreditTransferRouteInput.Czech​

Czech local route

InternationalCreditTransferRouteInput.Emirates​

Emirate local route

InternationalCreditTransferRouteInput.FedwireLocal​

American credit transfers service for large-value and time-critical payments

InternationalCreditTransferRouteInput.FijiMobile​

M-PAiSA

InternationalCreditTransferRouteInput.HongKongFps​

Faster Payment System

InternationalCreditTransferRouteInput.Hongkong​

Hong Kong's local route

InternationalCreditTransferRouteInput.Hungarian​

Hungarian local route

InternationalCreditTransferRouteInput.Iban​

Local route using an IBAN as recipient account identifier

InternationalCreditTransferRouteInput.Indian​

Indian local route

InternationalCreditTransferRouteInput.IndianUpi​

Indian instant payment system Unified Payments Interface

InternationalCreditTransferRouteInput.Interac​

Canadian payment network Interac

InternationalCreditTransferRouteInput.IsraeliLocal​

Israeli local route

InternationalCreditTransferRouteInput.KenyaLocal​

Kenyan local route

InternationalCreditTransferRouteInput.KenyaMobile​

Kenyan mobile payment network M-PESA

InternationalCreditTransferRouteInput.Malaysian​

Malaysian local route

InternationalCreditTransferRouteInput.MalaysianDuitnow​

Malaysian payment network DuitNow

InternationalCreditTransferRouteInput.Mexican​

Mexican local route

InternationalCreditTransferRouteInput.Morocco​

Moroccan local route

InternationalCreditTransferRouteInput.Nepal​

Nepalese local route

InternationalCreditTransferRouteInput.NewZealand​

New Zealand local route

InternationalCreditTransferRouteInput.Philippines​

Filipino local route

InternationalCreditTransferRouteInput.PhilippinesMobile​

Filipino mobile payment network

InternationalCreditTransferRouteInput.Polish​

Polish local route

InternationalCreditTransferRouteInput.PrivatBank​

Ukranian local route

InternationalCreditTransferRouteInput.Singapore​

Singapore local route

InternationalCreditTransferRouteInput.SingaporePaynow​

Singapore mobile payment network PayNow

InternationalCreditTransferRouteInput.SortCode​

British local route

InternationalCreditTransferRouteInput.SouthKoreanPaygate​

South Korean payment network Paygate

InternationalCreditTransferRouteInput.SouthKoreanPaygateBusiness​

South Korean payment network Paygate for corporates

InternationalCreditTransferRouteInput.SouthAfrica​

South African local route

InternationalCreditTransferRouteInput.SwiftCode​

Swift

InternationalCreditTransferRouteInput.Thailand​

Thai local route

InternationalCreditTransferRouteInput.TurkishEarthport​

Turkish local route

Member of​

InternationalBeneficiaryInput input ● Scheme object

- + \ No newline at end of file diff --git a/api-reference/enums/international-credit-transfer-route/index.html b/api-reference/enums/international-credit-transfer-route/index.html index 209d3d60e0f..e3fe31e2c6c 100644 --- a/api-reference/enums/international-credit-transfer-route/index.html +++ b/api-reference/enums/international-credit-transfer-route/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternationalCreditTransferRoute

International Credit Transfer Route

enum InternationalCreditTransferRoute {
  Unknown
  Aba
  Argentina
  Australian
  AustralianBpay
  Brazil
  Canadian
  Chile
  CostaRica
  Czech
  Emirates
  FedwireLocal
  FijiMobile
  HongKongFps
  Hongkong
  Hungarian
  Iban
  Indian
  IndianUpi
  Interac
  IsraeliLocal
  KenyaLocal
  KenyaMobile
  Malaysian
  MalaysianDuitnow
  Mexican
  Morocco
  Nepal
  NewZealand
  Philippines
  PhilippinesMobile
  Polish
  PrivatBank
  Singapore
  SingaporePaynow
  SortCode
  SouthAfrica
  SouthKoreanPaygate
  SouthKoreanPaygateBusiness
  SwiftCode
  Thailand
  TurkishEarthport
}

Values​

InternationalCreditTransferRoute.Unknown​

Unknown route

InternationalCreditTransferRoute.Aba​

American ACH for low-value payments

InternationalCreditTransferRoute.Argentina​

Argentinian local route

InternationalCreditTransferRoute.Australian​

Australian local route

InternationalCreditTransferRoute.AustralianBpay​

Australian local route Bpay usually used for bill payments

InternationalCreditTransferRoute.Brazil​

Brazilian local route

InternationalCreditTransferRoute.Canadian​

Canadian local route

InternationalCreditTransferRoute.Chile​

Chilean local route

InternationalCreditTransferRoute.CostaRica​

Costa Rican local route

InternationalCreditTransferRoute.Czech​

Czech local route

InternationalCreditTransferRoute.Emirates​

Emirate local route

InternationalCreditTransferRoute.FedwireLocal​

American credit transfers service for large-value and time-critical payments

InternationalCreditTransferRoute.FijiMobile​

M-PAiSA

InternationalCreditTransferRoute.HongKongFps​

Faster Payment System

InternationalCreditTransferRoute.Hongkong​

Hong Kong's local route

InternationalCreditTransferRoute.Hungarian​

Hungarian local route

InternationalCreditTransferRoute.Iban​

Local route using an IBAN as recipient account identifier

InternationalCreditTransferRoute.Indian​

Indian local route

InternationalCreditTransferRoute.IndianUpi​

Indian instant payment system Unified Payments Interface

InternationalCreditTransferRoute.Interac​

Canadian payment network Interac

InternationalCreditTransferRoute.IsraeliLocal​

Israeli local route

InternationalCreditTransferRoute.KenyaLocal​

Kenyan local route

InternationalCreditTransferRoute.KenyaMobile​

Kenyan mobile payment network M-PESA

InternationalCreditTransferRoute.Malaysian​

Malaysian local route

InternationalCreditTransferRoute.MalaysianDuitnow​

Malaysian payment network DuitNow

InternationalCreditTransferRoute.Mexican​

Mexican local route

InternationalCreditTransferRoute.Morocco​

Moroccan local route

InternationalCreditTransferRoute.Nepal​

Nepalese local route

InternationalCreditTransferRoute.NewZealand​

New Zealand local route

InternationalCreditTransferRoute.Philippines​

Filipino local route

InternationalCreditTransferRoute.PhilippinesMobile​

Filipino mobile payment network

InternationalCreditTransferRoute.Polish​

Polish local route

InternationalCreditTransferRoute.PrivatBank​

Ukranian local route

InternationalCreditTransferRoute.Singapore​

Singapore local route

InternationalCreditTransferRoute.SingaporePaynow​

Singapore mobile payment network PayNow

InternationalCreditTransferRoute.SortCode​

British local route

InternationalCreditTransferRoute.SouthAfrica​

South African local route

InternationalCreditTransferRoute.SouthKoreanPaygate​

South Korean payment network Paygate

InternationalCreditTransferRoute.SouthKoreanPaygateBusiness​

South Korean payment network Paygate for corporates

InternationalCreditTransferRoute.SwiftCode​

Swift

InternationalCreditTransferRoute.Thailand​

Thai local route

InternationalCreditTransferRoute.TurkishEarthport​

Turkish local route

Member of​

InternationalCreditTransferOutCreditor object

- + \ No newline at end of file diff --git a/api-reference/enums/invalid-argument-rejection-code/index.html b/api-reference/enums/invalid-argument-rejection-code/index.html index 67a4fecb361..40a2ef54f35 100644 --- a/api-reference/enums/invalid-argument-rejection-code/index.html +++ b/api-reference/enums/invalid-argument-rejection-code/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/invalid-iban-code/index.html b/api-reference/enums/invalid-iban-code/index.html index 9ba418ac58e..5035726dbf0 100644 --- a/api-reference/enums/invalid-iban-code/index.html +++ b/api-reference/enums/invalid-iban-code/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InvalidIbanCode

InvalidIbanCode

enum InvalidIbanCode {
  InvalidLength
  InvalidStructure
  InvalidChecksum
  InvalidBank
}

Values​

InvalidIbanCode.InvalidLength​

Iban is either too short (<2) or does not match this country's specified length

InvalidIbanCode.InvalidStructure​

We do not know this IBAN Structure (Meaning that the country code is probably wrong)

InvalidIbanCode.InvalidChecksum​

The IBAN does not verify the mod97 algorithm

InvalidIbanCode.InvalidBank​

We do not know the banking institution referenced in this IBAN.

Member of​

InvalidIban object

- + \ No newline at end of file diff --git a/api-reference/enums/invoice-status/index.html b/api-reference/enums/invoice-status/index.html index a2b254b1b4a..df75f3a3502 100644 --- a/api-reference/enums/invoice-status/index.html +++ b/api-reference/enums/invoice-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/invoice-type/index.html b/api-reference/enums/invoice-type/index.html index a04113031c3..a804b9c1a4d 100644 --- a/api-reference/enums/invoice-type/index.html +++ b/api-reference/enums/invoice-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/language/index.html b/api-reference/enums/language/index.html index c4a26cbc232..79016666044 100644 --- a/api-reference/enums/language/index.html +++ b/api-reference/enums/language/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/legal-document-status/index.html b/api-reference/enums/legal-document-status/index.html index d61129bb970..e8bb9a0b0b9 100644 --- a/api-reference/enums/legal-document-status/index.html +++ b/api-reference/enums/legal-document-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

LegalDocumentStatus

No description

enum LegalDocumentStatus {
  Upcoming
  Active
  Inactive
}

Values​

LegalDocumentStatus.Upcoming​

When the LegalDocument will be the next active on the account

LegalDocumentStatus.Active​

When the LegalDocument is currently active on the account

LegalDocumentStatus.Inactive​

When the LegalDocument is no more active on the account

Member of​

LegalDocumentActiveStatusInfo object ● LegalDocumentInactiveStatusInfo object ● LegalDocumentsFilterInput input ● LegalDocumentStatusInfo interface ● LegalDocumentUpcomingStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/legal-document-type/index.html b/api-reference/enums/legal-document-type/index.html index 422ee43a799..628db785871 100644 --- a/api-reference/enums/legal-document-type/index.html +++ b/api-reference/enums/legal-document-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/mandate-language/index.html b/api-reference/enums/mandate-language/index.html index 3dd953b6001..8937977a709 100644 --- a/api-reference/enums/mandate-language/index.html +++ b/api-reference/enums/mandate-language/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/merchant-category-description/index.html b/api-reference/enums/merchant-category-description/index.html index dc7d5b34e28..2b1de548e14 100644 --- a/api-reference/enums/merchant-category-description/index.html +++ b/api-reference/enums/merchant-category-description/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantCategoryDescription

MerchantCategoryDescription

enum MerchantCategoryDescription {
  AccessoryAndApparelStoresMiscellaneous
  AccountingAuditingAndBookkeepingServices
  AdvertisingServices
  AgriculturalCooperatives
  AirCarriersAirlinesNotElsewhereClassified
  AirConditioningAndRefrigerationRepairShops
  AirConditioningHeatingAndPlumbingContractors
  AirlinesAirCarriers
  AirportsAirportTerminalsFlyingFields
  AlterationsMendingSeamstressesTailors
  AmbulanceServices
  AmusementParksCarnivalsCircusesFortuneTellers
  AntiqueReproductionStores
  AntiqueShopsSalesRepairsAndRestorationServices
  ApplianceRepairShopsElectricalAndSmall
  AquariumsDolphinariumsZoosAndSeaquariums
  ArchitecturalEngineeringAndSurveyingServices
  ArtDealersAndGalleries
  ArtistSupplyStoresCraftShops
  AssociationsCivicSocialAndFraternal
  AthleticFieldsCommercialSportsProfessionalSportsClubsSportsPromoters
  AttorneysLegalServices
  AutomatedCashDisbursementsCustomerFinancialInstitution
  AutomobileAndTruckDealersSalesServiceRepairsPartsAndLeasing
  AutomobileAndTruckDealersUsedOnlySales
  AutomobileAssociations
  AutomobileParkingLotsAndGarages
  AutomobileRentalAgencyNotElsewhereClassified
  AutomotiveBodyRepairShops
  AutomotivePaintShops
  AutomotivePartsAccessoriesStores
  AutomotiveServiceShops
  AutomotiveTireStores
  AutoStoreHomeSupplyStores
  BailAndBondPayments
  Bakeries
  BandsOrchestrasAndMiscellaneousEntertainersNotElsewhereClassified
  BarberAndBeautyShops
  BarsCocktailLoungesDiscothequesNightclubsAndTavernsDrinkingPlacesAlcoholicBeverages
  BicycleShopsSalesAndService
  BoatDealers
  BoatLeasesAndBoatRentals
  BooksPeriodicalsAndNewspapers
  BookStores
  BowlingAlleys
  BridgeAndRoadFeesTolls
  BuildingMaterialsLumberStores
  BusinessServicesNotElsewhereClassified
  BusLines
  BuyingOrShoppingClubsServices
  CableSatelliteAndOtherPayTelevisionAndRadioServices
  CameraAndPhotographicSupplyStores
  CamperDealersRecreationalAndUtilityTrailers
  CampgroundsAndTrailerParks
  CandyNutConfectioneryStores
  CardGiftNoveltyAndSouvenirShops
  CarpentryContractors
  CarpetAndUpholsteryCleaning
  CarRentalAgencies
  CarWashes
  Caterers
  ChemicalsAndAlliedProductsNotElsewhereClassified
  ChildCareServices
  ChildrenAndInfantsWearStores
  ChiropodistsPodiatrists
  Chiropractors
  CigarStoresAndStands
  CleaningAndMaintenanceJanitorialServices
  CleaningGarmentAndLaundryServices
  ClockJewelryAndWatchRepairShops
  ClockJewelryWatchAndSilverwareStore
  ClothingRentalCostumesUniformsAndFormalWear
  ClubsCountryClubsMembershipAthleticRecreationSportsPrivateGolfCourses
  CollegesUniversitiesProfessionalSchoolsAndJuniorColleges
  CommercialArtGraphicsPhotography
  CommercialEquipmentNotElsewhereClassified
  CommercialFootwear
  ComputerMaintenanceRepairAndServicesNotElsewhereClassified
  ComputerNetworkOrInformationServices
  ComputerProgrammingDataProcessingAndIntegratedSystemsDesignServices
  ComputersComputerPeripheralEquipmentSoftware
  ComputerSoftwareStores
  ConcreteWorkContractors
  ConstructionMaterialsNotElsewhereClassified
  ConsultingManagementAndPublicRelationsServices
  ConsumerCreditReportingAgencies
  ContractorsSpecialTradeNotElsewhereClassified
  CosmeticStores
  CourierServiceAirAndGroundFreightForwarders
  CourtCostsIncludingAlimonyAndChildSupport
  CruiseLines
  CrystalAndGlasswareStores
  DairyProductsStores
  DanceHallsSchoolsAndStudios
  DatingServices
  DebtMarriagePersonalCounselingService
  DentalAndMedicalLaboratories
  DentalLaboratoryMedicalOphthalmicHospitalEquipmentAndSupplies
  DentistsOrthodontists
  DepartmentStores
  DetectiveAgenciesProtectiveAgenciesSecurityServicesIncludingArmoredCarsGuardDogs
  DigitalGoodsAudiovisualMediaIncludingBooksMoviesAndMusic
  DigitalGoodsGames
  DigitalGoodsMultiCategory
  DigitalGoodsSoftwareApplicationsExcludingGames
  DirectMarketingCatalogMerchants
  DirectMarketingCombinationCatalogAndRetailMerchants
  DirectMarketingContinuitySubscriptionMerchants
  DirectMarketingInboundTelemarketingMerchants
  DirectMarketingInsuranceServices
  DirectMarketingOtherDirectMarketersNotElsewhereClassified
  DirectMarketingOutboundTelemarketingMerchants
  DirectMarketingTravelRelatedArrangementServices
  DiscountStores
  DoctorsNotElsewhereClassified
  DoorToDoorSales
  DraperyUpholsteryAndWindowCoveringsStores
  DrugsDrugProprietorsAndDruggistsSundries
  DrugStoresPharmacies
  DryCleaners
  DurableGoodsNotElsewhereClassified
  DutyFreeStores
  EatingPlacesRestaurants
  ElectricalContractors
  ElectricalPartsAndEquipment
  ElectricRazorStoresSalesAndService
  ElectricVehicleCharging
  ElectronicRepairShops
  ElectronicSales
  EmploymentAgenciesTemporaryHelpServices
  EquipmentFurnitureAndHomeFurnishingsStoresExceptAppliances
  EquipmentRentalAndLeasingServicesFurnitureRentalToolRental
  ExterminatingAndDisinfectingServices
  FabricNeedleworkPieceGoodsAndSewingStores
  FamilyClothingStores
  FastFoodRestaurants
  Fines
  FireplaceFireplaceScreensAndAccessoriesStores
  FloorCoveringStores
  Florists
  FloristsSuppliesNurseryStockAndFlowers
  FreezerLockerMeatProvisioners
  FuelDealersCoalFuelOilLiquefiedPetroleumWood
  FuelDispenserAutomated
  FuneralServiceAndCrematories
  FurnitureReupholsteryAndRepairRefinishing
  FurriersAndFurShops
  GamblingTransactions
  GameToyAndHobbyShops
  GeneralContractorsResidentialAndCommercial
  GlassPaintWallpaperStores
  GolfCoursesPublic
  GovernmentLicensedHorseOrDogRacingUSRegionOnly
  GovernmentOwnedLotterySpecificCountries
  GovernmentOwnedLotteryUSRegionOnly
  GovernmentServicesNotElsewhereClassified
  GroceryStoresSupermarkets
  HardwareEquipmentAndSupplies
  HardwareStores
  HatCleaningShopsShoeRepairShopsShoeShineParlors
  HealthAndBeautySpas
  HealthPractitionersMedicalServicesNotElsewhereClassified
  HearingAidsSalesServiceSupplyStores
  HomeSupplyWarehouseStores
  HorticulturalAndLandscapingServices
  Hospitals
  HouseholdApplianceStores
  IndustrialSuppliesNotElsewhereClassified
  InformationRetrievalServices
  InsulationMasonryPlasteringStoneworkAndTileSettingContractors
  InsuranceSalesUnderwritingAndPremiums
  InternetGamblingUSRegionOnly
  IntraGovernmentPurchasesGovernmentOnly
  KeyEntryTelecomMerchantProvidingSingleLocalAndLongDistancePhoneCallsUsingACentralAccessNumberInANonFaceToFaceEnvironmentUsingKeyEntry
  LaundryServicesFamilyAndCommercial
  LawnAndGardenSupplyStores
  LeatherGoodsAndLuggageStores
  LimousinesAndTaxicabs
  LodgingHotelsMotelsResorts
  LodgingHotelsMotelsResortsNotElsewhereClassified
  ManualCashDisbursementsCustomerFinancialInstitution
  MarinasMarineServiceSupplies
  MassageParlors
  MenAndBoysClothingAndAccessoriesStores
  MenAndWomenClothingStores
  MenWomenAndChildrenUniformsAndCommercialClothing
  MerchandiseAndServicesCustomerFinancialInstitution
  MetalServiceCentersAndOffices
  MiscellaneousAndSpecialtyRetailStores
  MiscellaneousAutomotiveAircraftAndFarmEquipmentDealersNotElsewhereClassified
  MiscellaneousFoodStoresConvenienceStoresMarketsSpecialtyStores
  MiscellaneousGeneralMerchandiseStores
  MiscellaneousHouseFurnishingSpecialtyShops
  MiscellaneousPublishingAndPrinting
  MiscellaneousRepairShopsAndRelatedServices
  MobileHomeDealers
  MoneySendFunding
  MoneySendInterCountry
  MoneySendIntraCountry
  MoneyTransfer
  MotionPictureAndVideoTapeProductionAndDistribution
  MotionPictureTheaters
  MotorcycleShopsAndDealers
  MotorFreightCarriersTruckingLocalLongDistanceMovingAndStorageCompaniesLocalDelivery
  MotorHomeAndRecreationalVehicleRental
  MotorHomeDealers
  MotorVehicleSuppliesAndNewParts
  MusicStoresMusicalInstrumentsPianosSheetMusic
  NewsDealersAndNewsstands
  NondurableGoodsNotElsewhereClassified
  NursingAndPersonalCareFacilities
  OfficeAndCommercialFurniture
  OfficePhotographicPhotocopyAndMicrofilmEquipment
  OfficeSchoolSupplyAndStationeryStores
  OpticiansOpticalGoodsAndEyeglasses
  OptometristsOphthalmologists
  OrganizationsCharitableAndSocialService
  OrganizationsMembershipNotElsewhereClassified
  OrganizationsPolitical
  OrganizationsReligious
  OrthopedicGoodsArtificialLimbStores
  OsteopathicPhysicians
  OtherServicesNotElsewhereClassified
  PackageStoresBeerWineAndLiquor
  PaintsVarnishesAndSupplies
  PassengerRailways
  PawnShops
  PaymentTransactionCustomerFinancialInstitution
  PaymentTransactionMerchant
  PetroleumAndPetroleumProducts
  PetShopsPetFoodAndSupplies
  PhotoDevelopingPhotofinishingLaboratories
  PhotographicStudios
  PieceGoodsNotionsAndOtherDryGoods
  PlumbingAndHeatingEquipment
  PoiFundingTransactions
  PoolAndBilliardEstablishments
  PostalServicesGovernmentOnly
  PreciousStonesAndMetalsWatchesAndJewelry
  ProfessionalServicesNotElsewhereClassified
  PublicWarehousingFarmProductsRefrigeratedGoodsHouseholdGoodsStorage
  QuasiCashCustomerFinancialInstitution
  QuasiCashMerchant
  QuickCopyReproductionAndBlueprintingServices
  RailroadsFreight
  RealEstateAgentsAndManagersRentals
  RecordShops
  RecreationalAndSportingCamps
  RecreationServicesNotElsewhereClassified
  ReligiousGoodsStores
  RoofingAndSidingSheetMetalWorkContractors
  SalvageAndWreckingYards
  SanitationPolishingAndSpecialtyCleaningPreparations
  SchoolsAndEducationalServicesNotElsewhereClassified
  SchoolsBusinessAndSecretarial
  SchoolsCorrespondence
  SchoolsElementaryAndSecondary
  SchoolsTradeAndVocational
  SecondHandStoresUsedMerchandiseStores
  SecuritiesBrokersDealers
  ServiceStationsWithOrWithoutAncillaryServices
  ShoeStores
  SnowmobileDealers
  SportingGoodsStores
  SportsApparelRidingApparelStores
  StampAndCoinStoresPhilatelicAndNumismaticSupplies
  StationeryOfficeSuppliesPrintingAndWritingPaper
  StenographicAndSecretarialSupportServices
  SwimmingPoolsSalesAndSupplies
  TaxPayments
  TaxPreparationService
  TelecommunicationEquipmentIncludingTelephoneSales
  TelecommunicationServicesIncludingButNotLimitedToPrepaidPhoneServicesAndRecurringPhoneServices
  TelegraphServices
  TentAndAwningShops
  TestingLaboratoriesNonMedical
  TheatricalProducersExceptMotionPicturesAndTicketAgencies
  Timeshares
  TireRetreadingAndRepairShops
  TouristAttractionsAndExhibits
  TowingServices
  TransportationServicesNotElsewhereClassified
  TransportationSuburbanAndLocalCommuterPassengerIncludingFerries
  TravelAgenciesAndTourOperators
  TruckRental
  TypesettingPlateMakingAndRelatedServices
  TypewriterStoresRentalsSalesService
  Unknown
  UtilitiesElectricGasHeatingOilSanitaryWater
  VarietyStores
  VeterinaryServices
  VideoAmusementGameSupplies
  VideoEntertainmentRentalStores
  VideoGameArcadesOrEstablishments
  WeldingRepair
  WholesaleClubs
  WigAndToupeeShops
  WomenAccessoryAndSpecialtyStores
  WomenReadyToWearStores
}

Values​

MerchantCategoryDescription.AccessoryAndApparelStoresMiscellaneous​

MerchantCategoryDescription.AccountingAuditingAndBookkeepingServices​

MerchantCategoryDescription.AdvertisingServices​

MerchantCategoryDescription.AgriculturalCooperatives​

MerchantCategoryDescription.AirCarriersAirlinesNotElsewhereClassified​

MerchantCategoryDescription.AirConditioningAndRefrigerationRepairShops​

MerchantCategoryDescription.AirConditioningHeatingAndPlumbingContractors​

MerchantCategoryDescription.AirlinesAirCarriers​

MerchantCategoryDescription.AirportsAirportTerminalsFlyingFields​

MerchantCategoryDescription.AlterationsMendingSeamstressesTailors​

MerchantCategoryDescription.AmbulanceServices​

MerchantCategoryDescription.AmusementParksCarnivalsCircusesFortuneTellers​

MerchantCategoryDescription.AntiqueReproductionStores​

MerchantCategoryDescription.AntiqueShopsSalesRepairsAndRestorationServices​

MerchantCategoryDescription.ApplianceRepairShopsElectricalAndSmall​

MerchantCategoryDescription.AquariumsDolphinariumsZoosAndSeaquariums​

MerchantCategoryDescription.ArchitecturalEngineeringAndSurveyingServices​

MerchantCategoryDescription.ArtDealersAndGalleries​

MerchantCategoryDescription.ArtistSupplyStoresCraftShops​

MerchantCategoryDescription.AssociationsCivicSocialAndFraternal​

MerchantCategoryDescription.AthleticFieldsCommercialSportsProfessionalSportsClubsSportsPromoters​

MerchantCategoryDescription.AttorneysLegalServices​

MerchantCategoryDescription.AutomatedCashDisbursementsCustomerFinancialInstitution​

MerchantCategoryDescription.AutomobileAndTruckDealersSalesServiceRepairsPartsAndLeasing​

MerchantCategoryDescription.AutomobileAndTruckDealersUsedOnlySales​

MerchantCategoryDescription.AutomobileAssociations​

MerchantCategoryDescription.AutomobileParkingLotsAndGarages​

MerchantCategoryDescription.AutomobileRentalAgencyNotElsewhereClassified​

MerchantCategoryDescription.AutomotiveBodyRepairShops​

MerchantCategoryDescription.AutomotivePaintShops​

MerchantCategoryDescription.AutomotivePartsAccessoriesStores​

MerchantCategoryDescription.AutomotiveServiceShops​

MerchantCategoryDescription.AutomotiveTireStores​

MerchantCategoryDescription.AutoStoreHomeSupplyStores​

MerchantCategoryDescription.BailAndBondPayments​

MerchantCategoryDescription.Bakeries​

MerchantCategoryDescription.BandsOrchestrasAndMiscellaneousEntertainersNotElsewhereClassified​

MerchantCategoryDescription.BarberAndBeautyShops​

MerchantCategoryDescription.BarsCocktailLoungesDiscothequesNightclubsAndTavernsDrinkingPlacesAlcoholicBeverages​

MerchantCategoryDescription.BicycleShopsSalesAndService​

MerchantCategoryDescription.BoatDealers​

MerchantCategoryDescription.BoatLeasesAndBoatRentals​

MerchantCategoryDescription.BooksPeriodicalsAndNewspapers​

MerchantCategoryDescription.BookStores​

MerchantCategoryDescription.BowlingAlleys​

MerchantCategoryDescription.BridgeAndRoadFeesTolls​

MerchantCategoryDescription.BuildingMaterialsLumberStores​

MerchantCategoryDescription.BusinessServicesNotElsewhereClassified​

MerchantCategoryDescription.BusLines​

MerchantCategoryDescription.BuyingOrShoppingClubsServices​

MerchantCategoryDescription.CableSatelliteAndOtherPayTelevisionAndRadioServices​

MerchantCategoryDescription.CameraAndPhotographicSupplyStores​

MerchantCategoryDescription.CamperDealersRecreationalAndUtilityTrailers​

MerchantCategoryDescription.CampgroundsAndTrailerParks​

MerchantCategoryDescription.CandyNutConfectioneryStores​

MerchantCategoryDescription.CardGiftNoveltyAndSouvenirShops​

MerchantCategoryDescription.CarpentryContractors​

MerchantCategoryDescription.CarpetAndUpholsteryCleaning​

MerchantCategoryDescription.CarRentalAgencies​

MerchantCategoryDescription.CarWashes​

MerchantCategoryDescription.Caterers​

MerchantCategoryDescription.ChemicalsAndAlliedProductsNotElsewhereClassified​

MerchantCategoryDescription.ChildCareServices​

MerchantCategoryDescription.ChildrenAndInfantsWearStores​

MerchantCategoryDescription.ChiropodistsPodiatrists​

MerchantCategoryDescription.Chiropractors​

MerchantCategoryDescription.CigarStoresAndStands​

MerchantCategoryDescription.CleaningAndMaintenanceJanitorialServices​

MerchantCategoryDescription.CleaningGarmentAndLaundryServices​

MerchantCategoryDescription.ClockJewelryAndWatchRepairShops​

MerchantCategoryDescription.ClockJewelryWatchAndSilverwareStore​

MerchantCategoryDescription.ClothingRentalCostumesUniformsAndFormalWear​

MerchantCategoryDescription.ClubsCountryClubsMembershipAthleticRecreationSportsPrivateGolfCourses​

MerchantCategoryDescription.CollegesUniversitiesProfessionalSchoolsAndJuniorColleges​

MerchantCategoryDescription.CommercialArtGraphicsPhotography​

MerchantCategoryDescription.CommercialEquipmentNotElsewhereClassified​

MerchantCategoryDescription.CommercialFootwear​

MerchantCategoryDescription.ComputerMaintenanceRepairAndServicesNotElsewhereClassified​

MerchantCategoryDescription.ComputerNetworkOrInformationServices​

MerchantCategoryDescription.ComputerProgrammingDataProcessingAndIntegratedSystemsDesignServices​

MerchantCategoryDescription.ComputersComputerPeripheralEquipmentSoftware​

MerchantCategoryDescription.ComputerSoftwareStores​

MerchantCategoryDescription.ConcreteWorkContractors​

MerchantCategoryDescription.ConstructionMaterialsNotElsewhereClassified​

MerchantCategoryDescription.ConsultingManagementAndPublicRelationsServices​

MerchantCategoryDescription.ConsumerCreditReportingAgencies​

MerchantCategoryDescription.ContractorsSpecialTradeNotElsewhereClassified​

MerchantCategoryDescription.CosmeticStores​

MerchantCategoryDescription.CourierServiceAirAndGroundFreightForwarders​

MerchantCategoryDescription.CourtCostsIncludingAlimonyAndChildSupport​

MerchantCategoryDescription.CruiseLines​

MerchantCategoryDescription.CrystalAndGlasswareStores​

MerchantCategoryDescription.DairyProductsStores​

MerchantCategoryDescription.DanceHallsSchoolsAndStudios​

MerchantCategoryDescription.DatingServices​

MerchantCategoryDescription.DebtMarriagePersonalCounselingService​

MerchantCategoryDescription.DentalAndMedicalLaboratories​

MerchantCategoryDescription.DentalLaboratoryMedicalOphthalmicHospitalEquipmentAndSupplies​

MerchantCategoryDescription.DentistsOrthodontists​

MerchantCategoryDescription.DepartmentStores​

MerchantCategoryDescription.DetectiveAgenciesProtectiveAgenciesSecurityServicesIncludingArmoredCarsGuardDogs​

MerchantCategoryDescription.DigitalGoodsAudiovisualMediaIncludingBooksMoviesAndMusic​

MerchantCategoryDescription.DigitalGoodsGames​

MerchantCategoryDescription.DigitalGoodsMultiCategory​

MerchantCategoryDescription.DigitalGoodsSoftwareApplicationsExcludingGames​

MerchantCategoryDescription.DirectMarketingCatalogMerchants​

MerchantCategoryDescription.DirectMarketingCombinationCatalogAndRetailMerchants​

MerchantCategoryDescription.DirectMarketingContinuitySubscriptionMerchants​

MerchantCategoryDescription.DirectMarketingInboundTelemarketingMerchants​

MerchantCategoryDescription.DirectMarketingInsuranceServices​

MerchantCategoryDescription.DirectMarketingOtherDirectMarketersNotElsewhereClassified​

MerchantCategoryDescription.DirectMarketingOutboundTelemarketingMerchants​

MerchantCategoryDescription.DirectMarketingTravelRelatedArrangementServices​

MerchantCategoryDescription.DiscountStores​

MerchantCategoryDescription.DoctorsNotElsewhereClassified​

MerchantCategoryDescription.DoorToDoorSales​

MerchantCategoryDescription.DraperyUpholsteryAndWindowCoveringsStores​

MerchantCategoryDescription.DrugsDrugProprietorsAndDruggistsSundries​

MerchantCategoryDescription.DrugStoresPharmacies​

MerchantCategoryDescription.DryCleaners​

MerchantCategoryDescription.DurableGoodsNotElsewhereClassified​

MerchantCategoryDescription.DutyFreeStores​

MerchantCategoryDescription.EatingPlacesRestaurants​

MerchantCategoryDescription.ElectricalContractors​

MerchantCategoryDescription.ElectricalPartsAndEquipment​

MerchantCategoryDescription.ElectricRazorStoresSalesAndService​

MerchantCategoryDescription.ElectricVehicleCharging​

MerchantCategoryDescription.ElectronicRepairShops​

MerchantCategoryDescription.ElectronicSales​

MerchantCategoryDescription.EmploymentAgenciesTemporaryHelpServices​

MerchantCategoryDescription.EquipmentFurnitureAndHomeFurnishingsStoresExceptAppliances​

MerchantCategoryDescription.EquipmentRentalAndLeasingServicesFurnitureRentalToolRental​

MerchantCategoryDescription.ExterminatingAndDisinfectingServices​

MerchantCategoryDescription.FabricNeedleworkPieceGoodsAndSewingStores​

MerchantCategoryDescription.FamilyClothingStores​

MerchantCategoryDescription.FastFoodRestaurants​

MerchantCategoryDescription.Fines​

MerchantCategoryDescription.FireplaceFireplaceScreensAndAccessoriesStores​

MerchantCategoryDescription.FloorCoveringStores​

MerchantCategoryDescription.Florists​

MerchantCategoryDescription.FloristsSuppliesNurseryStockAndFlowers​

MerchantCategoryDescription.FreezerLockerMeatProvisioners​

MerchantCategoryDescription.FuelDealersCoalFuelOilLiquefiedPetroleumWood​

MerchantCategoryDescription.FuelDispenserAutomated​

MerchantCategoryDescription.FuneralServiceAndCrematories​

MerchantCategoryDescription.FurnitureReupholsteryAndRepairRefinishing​

MerchantCategoryDescription.FurriersAndFurShops​

MerchantCategoryDescription.GamblingTransactions​

MerchantCategoryDescription.GameToyAndHobbyShops​

MerchantCategoryDescription.GeneralContractorsResidentialAndCommercial​

MerchantCategoryDescription.GlassPaintWallpaperStores​

MerchantCategoryDescription.GolfCoursesPublic​

MerchantCategoryDescription.GovernmentLicensedHorseOrDogRacingUSRegionOnly​

MerchantCategoryDescription.GovernmentOwnedLotterySpecificCountries​

MerchantCategoryDescription.GovernmentOwnedLotteryUSRegionOnly​

MerchantCategoryDescription.GovernmentServicesNotElsewhereClassified​

MerchantCategoryDescription.GroceryStoresSupermarkets​

MerchantCategoryDescription.HardwareEquipmentAndSupplies​

MerchantCategoryDescription.HardwareStores​

MerchantCategoryDescription.HatCleaningShopsShoeRepairShopsShoeShineParlors​

MerchantCategoryDescription.HealthAndBeautySpas​

MerchantCategoryDescription.HealthPractitionersMedicalServicesNotElsewhereClassified​

MerchantCategoryDescription.HearingAidsSalesServiceSupplyStores​

MerchantCategoryDescription.HomeSupplyWarehouseStores​

MerchantCategoryDescription.HorticulturalAndLandscapingServices​

MerchantCategoryDescription.Hospitals​

MerchantCategoryDescription.HouseholdApplianceStores​

MerchantCategoryDescription.IndustrialSuppliesNotElsewhereClassified​

MerchantCategoryDescription.InformationRetrievalServices​

MerchantCategoryDescription.InsulationMasonryPlasteringStoneworkAndTileSettingContractors​

MerchantCategoryDescription.InsuranceSalesUnderwritingAndPremiums​

MerchantCategoryDescription.InternetGamblingUSRegionOnly​

MerchantCategoryDescription.IntraGovernmentPurchasesGovernmentOnly​

MerchantCategoryDescription.KeyEntryTelecomMerchantProvidingSingleLocalAndLongDistancePhoneCallsUsingACentralAccessNumberInANonFaceToFaceEnvironmentUsingKeyEntry​

MerchantCategoryDescription.LaundryServicesFamilyAndCommercial​

MerchantCategoryDescription.LawnAndGardenSupplyStores​

MerchantCategoryDescription.LeatherGoodsAndLuggageStores​

MerchantCategoryDescription.LimousinesAndTaxicabs​

MerchantCategoryDescription.LodgingHotelsMotelsResorts​

MerchantCategoryDescription.LodgingHotelsMotelsResortsNotElsewhereClassified​

MerchantCategoryDescription.ManualCashDisbursementsCustomerFinancialInstitution​

MerchantCategoryDescription.MarinasMarineServiceSupplies​

MerchantCategoryDescription.MassageParlors​

MerchantCategoryDescription.MenAndBoysClothingAndAccessoriesStores​

MerchantCategoryDescription.MenAndWomenClothingStores​

MerchantCategoryDescription.MenWomenAndChildrenUniformsAndCommercialClothing​

MerchantCategoryDescription.MerchandiseAndServicesCustomerFinancialInstitution​

MerchantCategoryDescription.MetalServiceCentersAndOffices​

MerchantCategoryDescription.MiscellaneousAndSpecialtyRetailStores​

MerchantCategoryDescription.MiscellaneousAutomotiveAircraftAndFarmEquipmentDealersNotElsewhereClassified​

MerchantCategoryDescription.MiscellaneousFoodStoresConvenienceStoresMarketsSpecialtyStores​

MerchantCategoryDescription.MiscellaneousGeneralMerchandiseStores​

MerchantCategoryDescription.MiscellaneousHouseFurnishingSpecialtyShops​

MerchantCategoryDescription.MiscellaneousPublishingAndPrinting​

MerchantCategoryDescription.MiscellaneousRepairShopsAndRelatedServices​

MerchantCategoryDescription.MobileHomeDealers​

MerchantCategoryDescription.MoneySendFunding​

MerchantCategoryDescription.MoneySendInterCountry​

MerchantCategoryDescription.MoneySendIntraCountry​

MerchantCategoryDescription.MoneyTransfer​

MerchantCategoryDescription.MotionPictureAndVideoTapeProductionAndDistribution​

MerchantCategoryDescription.MotionPictureTheaters​

MerchantCategoryDescription.MotorcycleShopsAndDealers​

MerchantCategoryDescription.MotorFreightCarriersTruckingLocalLongDistanceMovingAndStorageCompaniesLocalDelivery​

MerchantCategoryDescription.MotorHomeAndRecreationalVehicleRental​

MerchantCategoryDescription.MotorHomeDealers​

MerchantCategoryDescription.MotorVehicleSuppliesAndNewParts​

MerchantCategoryDescription.MusicStoresMusicalInstrumentsPianosSheetMusic​

MerchantCategoryDescription.NewsDealersAndNewsstands​

MerchantCategoryDescription.NondurableGoodsNotElsewhereClassified​

MerchantCategoryDescription.NursingAndPersonalCareFacilities​

MerchantCategoryDescription.OfficeAndCommercialFurniture​

MerchantCategoryDescription.OfficePhotographicPhotocopyAndMicrofilmEquipment​

MerchantCategoryDescription.OfficeSchoolSupplyAndStationeryStores​

MerchantCategoryDescription.OpticiansOpticalGoodsAndEyeglasses​

MerchantCategoryDescription.OptometristsOphthalmologists​

MerchantCategoryDescription.OrganizationsCharitableAndSocialService​

MerchantCategoryDescription.OrganizationsMembershipNotElsewhereClassified​

MerchantCategoryDescription.OrganizationsPolitical​

MerchantCategoryDescription.OrganizationsReligious​

MerchantCategoryDescription.OrthopedicGoodsArtificialLimbStores​

MerchantCategoryDescription.OsteopathicPhysicians​

MerchantCategoryDescription.OtherServicesNotElsewhereClassified​

MerchantCategoryDescription.PackageStoresBeerWineAndLiquor​

MerchantCategoryDescription.PaintsVarnishesAndSupplies​

MerchantCategoryDescription.PassengerRailways​

MerchantCategoryDescription.PawnShops​

MerchantCategoryDescription.PaymentTransactionCustomerFinancialInstitution​

MerchantCategoryDescription.PaymentTransactionMerchant​

MerchantCategoryDescription.PetroleumAndPetroleumProducts​

MerchantCategoryDescription.PetShopsPetFoodAndSupplies​

MerchantCategoryDescription.PhotoDevelopingPhotofinishingLaboratories​

MerchantCategoryDescription.PhotographicStudios​

MerchantCategoryDescription.PieceGoodsNotionsAndOtherDryGoods​

MerchantCategoryDescription.PlumbingAndHeatingEquipment​

MerchantCategoryDescription.PoiFundingTransactions​

MerchantCategoryDescription.PoolAndBilliardEstablishments​

MerchantCategoryDescription.PostalServicesGovernmentOnly​

MerchantCategoryDescription.PreciousStonesAndMetalsWatchesAndJewelry​

MerchantCategoryDescription.ProfessionalServicesNotElsewhereClassified​

MerchantCategoryDescription.PublicWarehousingFarmProductsRefrigeratedGoodsHouseholdGoodsStorage​

MerchantCategoryDescription.QuasiCashCustomerFinancialInstitution​

MerchantCategoryDescription.QuasiCashMerchant​

MerchantCategoryDescription.QuickCopyReproductionAndBlueprintingServices​

MerchantCategoryDescription.RailroadsFreight​

MerchantCategoryDescription.RealEstateAgentsAndManagersRentals​

MerchantCategoryDescription.RecordShops​

MerchantCategoryDescription.RecreationalAndSportingCamps​

MerchantCategoryDescription.RecreationServicesNotElsewhereClassified​

MerchantCategoryDescription.ReligiousGoodsStores​

MerchantCategoryDescription.RoofingAndSidingSheetMetalWorkContractors​

MerchantCategoryDescription.SalvageAndWreckingYards​

MerchantCategoryDescription.SanitationPolishingAndSpecialtyCleaningPreparations​

MerchantCategoryDescription.SchoolsAndEducationalServicesNotElsewhereClassified​

MerchantCategoryDescription.SchoolsBusinessAndSecretarial​

MerchantCategoryDescription.SchoolsCorrespondence​

MerchantCategoryDescription.SchoolsElementaryAndSecondary​

MerchantCategoryDescription.SchoolsTradeAndVocational​

MerchantCategoryDescription.SecondHandStoresUsedMerchandiseStores​

MerchantCategoryDescription.SecuritiesBrokersDealers​

MerchantCategoryDescription.ServiceStationsWithOrWithoutAncillaryServices​

MerchantCategoryDescription.ShoeStores​

MerchantCategoryDescription.SnowmobileDealers​

MerchantCategoryDescription.SportingGoodsStores​

MerchantCategoryDescription.SportsApparelRidingApparelStores​

MerchantCategoryDescription.StampAndCoinStoresPhilatelicAndNumismaticSupplies​

MerchantCategoryDescription.StationeryOfficeSuppliesPrintingAndWritingPaper​

MerchantCategoryDescription.StenographicAndSecretarialSupportServices​

MerchantCategoryDescription.SwimmingPoolsSalesAndSupplies​

MerchantCategoryDescription.TaxPayments​

MerchantCategoryDescription.TaxPreparationService​

MerchantCategoryDescription.TelecommunicationEquipmentIncludingTelephoneSales​

MerchantCategoryDescription.TelecommunicationServicesIncludingButNotLimitedToPrepaidPhoneServicesAndRecurringPhoneServices​

MerchantCategoryDescription.TelegraphServices​

MerchantCategoryDescription.TentAndAwningShops​

MerchantCategoryDescription.TestingLaboratoriesNonMedical​

MerchantCategoryDescription.TheatricalProducersExceptMotionPicturesAndTicketAgencies​

MerchantCategoryDescription.Timeshares​

MerchantCategoryDescription.TireRetreadingAndRepairShops​

MerchantCategoryDescription.TouristAttractionsAndExhibits​

MerchantCategoryDescription.TowingServices​

MerchantCategoryDescription.TransportationServicesNotElsewhereClassified​

MerchantCategoryDescription.TransportationSuburbanAndLocalCommuterPassengerIncludingFerries​

MerchantCategoryDescription.TravelAgenciesAndTourOperators​

MerchantCategoryDescription.TruckRental​

MerchantCategoryDescription.TypesettingPlateMakingAndRelatedServices​

MerchantCategoryDescription.TypewriterStoresRentalsSalesService​

MerchantCategoryDescription.Unknown​

MerchantCategoryDescription.UtilitiesElectricGasHeatingOilSanitaryWater​

MerchantCategoryDescription.VarietyStores​

MerchantCategoryDescription.VeterinaryServices​

MerchantCategoryDescription.VideoAmusementGameSupplies​

MerchantCategoryDescription.VideoEntertainmentRentalStores​

MerchantCategoryDescription.VideoGameArcadesOrEstablishments​

MerchantCategoryDescription.WeldingRepair​

MerchantCategoryDescription.WholesaleClubs​

MerchantCategoryDescription.WigAndToupeeShops​

MerchantCategoryDescription.WomenAccessoryAndSpecialtyStores​

MerchantCategoryDescription.WomenReadyToWearStores​

Member of​

CardTransaction object

- + \ No newline at end of file diff --git a/api-reference/enums/merchant-payment-link-status/index.html b/api-reference/enums/merchant-payment-link-status/index.html index e058a513aaf..e131146f1c3 100644 --- a/api-reference/enums/merchant-payment-link-status/index.html +++ b/api-reference/enums/merchant-payment-link-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantPaymentLinkStatus

No description

enum MerchantPaymentLinkStatus {
  Active
  Expired
  Completed
  Canceled
}

Values​

MerchantPaymentLinkStatus.Active​

Customers can still use the merchant payment link to pay.

MerchantPaymentLinkStatus.Expired​

The merchant payment link is expired.

MerchantPaymentLinkStatus.Completed​

The customer completed the payment.

MerchantPaymentLinkStatus.Canceled​

The customer cancel the payment.

Member of​

ActiveMerchantPaymentLinkStatusInfo object ● CanceledMerchantPaymentLinkStatusInfo object ● CompletedMerchantPaymentLinkStatusInfo object ● ExpiredMerchantPaymentLinkStatusInfo object ● MerchantPaymentLinkStatusInfo interface

- + \ No newline at end of file diff --git a/api-reference/enums/merchant-payment-method-status/index.html b/api-reference/enums/merchant-payment-method-status/index.html index 1d8c1c528a4..ea5c65cab44 100644 --- a/api-reference/enums/merchant-payment-method-status/index.html +++ b/api-reference/enums/merchant-payment-method-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantPaymentMethodStatus

The different statuses a MerchantPaymentMethod can have

enum MerchantPaymentMethodStatus {
  PendingReview
  Enabled
  Rejected
  Disabled
  Canceled
  Suspended
}

Values​

MerchantPaymentMethodStatus.PendingReview​

MerchantPaymentMethodStatus.Enabled​

MerchantPaymentMethodStatus.Rejected​

MerchantPaymentMethodStatus.Disabled​

MerchantPaymentMethodStatus.Canceled​

MerchantPaymentMethodStatus.Suspended​

Member of​

CanceledMerchantPaymentMethodStatusInfo object ● DisabledMerchantPaymentMethodStatusInfo object ● EnabledMerchantPaymentMethodStatusInfo object ● MerchantPaymentMethodStatusInfo interface ● PendingMerchantPaymentMethodStatusInfo object ● RejectedMerchantPaymentMethodStatusInfo object ● SuspendedMerchantPaymentMethodStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/merchant-payment-method-type/index.html b/api-reference/enums/merchant-payment-method-type/index.html index 8ce5b39a5a0..f718d1ec638 100644 --- a/api-reference/enums/merchant-payment-method-type/index.html +++ b/api-reference/enums/merchant-payment-method-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantPaymentMethodType

The different statuses a MerchantPaymentMethod can have

enum MerchantPaymentMethodType {
  InternalDirectDebitStandard
  InternalDirectDebitB2b
  SepaDirectDebitCore
  SepaDirectDebitB2b
  Check
}

Values​

MerchantPaymentMethodType.InternalDirectDebitStandard​

MerchantPaymentMethodType.InternalDirectDebitB2b​

MerchantPaymentMethodType.SepaDirectDebitCore​

MerchantPaymentMethodType.SepaDirectDebitB2b​

MerchantPaymentMethodType.Check​

Member of​

CheckMerchantPaymentMethod object ● InternalDirectDebitB2BMerchantPaymentMethod object ● InternalDirectDebitStandardMerchantPaymentMethod object ● MerchantPaymentMethod interface ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitCoreMerchantPaymentMethod object

- + \ No newline at end of file diff --git a/api-reference/enums/merchant-profile-order-by-field-input/index.html b/api-reference/enums/merchant-profile-order-by-field-input/index.html index 092a128c713..838379baa10 100644 --- a/api-reference/enums/merchant-profile-order-by-field-input/index.html +++ b/api-reference/enums/merchant-profile-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/merchant-profile-status/index.html b/api-reference/enums/merchant-profile-status/index.html index f15b46bd643..eaf1f9a34c4 100644 --- a/api-reference/enums/merchant-profile-status/index.html +++ b/api-reference/enums/merchant-profile-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantProfileStatus

Merchant Profile Statuses

enum MerchantProfileStatus {
  PendingReview
  Enabled
  Rejected
  Canceled
  Suspended
}

Values​

MerchantProfileStatus.PendingReview​

A Merchant Profile is created in the PendingReview status

MerchantProfileStatus.Enabled​

Enabled

MerchantProfileStatus.Rejected​

Rejected

MerchantProfileStatus.Canceled​

Canceled

MerchantProfileStatus.Suspended​

Suspended

Member of​

CanceledMerchantProfileStatusInfo object ● EnabledMerchantProfileStatusInfo object ● MerchantProfileFiltersInput input ● MerchantProfileStatusInfo interface ● MerchantProfileWrongStatusRejection object ● PendingReviewMerchantProfileStatusInfo object ● RejectedMerchantProfileStatusInfo object ● SuspendedMerchantProfileStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/monthly-income/index.html b/api-reference/enums/monthly-income/index.html index 2c59eb16a7d..ba3c25c933e 100644 --- a/api-reference/enums/monthly-income/index.html +++ b/api-reference/enums/monthly-income/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MonthlyIncome

Monthly income.

enum MonthlyIncome {
  LessThan500
  Between500And1500
  Between1500And3000
  Between3000And4500
  MoreThan4500
}

Values​

MonthlyIncome.LessThan500​

less than 500

MonthlyIncome.Between500And1500​

between 500 and 1500

MonthlyIncome.Between1500And3000​

between 1500 and 3000

MonthlyIncome.Between3000And4500​

between 3000 and 4500

MonthlyIncome.MoreThan4500​

more than 4500

Member of​

AccountHolderIndividualInfo object ● OnboardIndividualAccountHolderInput input ● OnboardingIndividualAccountHolderInfo object ● UpdateIndividualOnboardingInput input

- + \ No newline at end of file diff --git a/api-reference/enums/monthly-payment-volume/index.html b/api-reference/enums/monthly-payment-volume/index.html index 31a298f66c1..8b5bc5acfb2 100644 --- a/api-reference/enums/monthly-payment-volume/index.html +++ b/api-reference/enums/monthly-payment-volume/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MonthlyPaymentVolume

Monthly payment volume.

enum MonthlyPaymentVolume {
  Between10000And50000
  Between50000And100000
  LessThan10000
  MoreThan100000
}

Values​

MonthlyPaymentVolume.Between10000And50000​

MonthlyPaymentVolume.Between50000And100000​

MonthlyPaymentVolume.LessThan10000​

MonthlyPaymentVolume.MoreThan100000​

Member of​

AccountHolderCompanyInfo object ● OnboardCompanyAccountHolderInput input ● OnboardingCompanyAccountHolderInfo object ● UpdateCompanyOnboardingInput input

- + \ No newline at end of file diff --git a/api-reference/enums/onboarding-order-by-field-input/index.html b/api-reference/enums/onboarding-order-by-field-input/index.html index 494dea43b8a..850e55e857d 100644 --- a/api-reference/enums/onboarding-order-by-field-input/index.html +++ b/api-reference/enums/onboarding-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/onboarding-state/index.html b/api-reference/enums/onboarding-state/index.html index 535ce46120a..8a94ecad0fe 100644 --- a/api-reference/enums/onboarding-state/index.html +++ b/api-reference/enums/onboarding-state/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/onboarding-status/index.html b/api-reference/enums/onboarding-status/index.html index 82ca92c2972..714f09023d4 100644 --- a/api-reference/enums/onboarding-status/index.html +++ b/api-reference/enums/onboarding-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardingStatus

Possible values for onboarding status

enum OnboardingStatus {
  Finalized
  Invalid
  Valid
}

Values​

OnboardingStatus.Finalized​

When the onboarding is finalized

OnboardingStatus.Invalid​

when the onboarding is invalid. Final status

OnboardingStatus.Valid​

When the onboarding is valid. Final status

Member of​

OnboardingFiltersInput input ● OnboardingFinalizedStatusInfo object ● OnboardingInvalidStatusInfo object ● OnboardingStatusInfo interface ● OnboardingValidStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/order-by-direction/index.html b/api-reference/enums/order-by-direction/index.html index 1b45eebc281..21c2fe721f0 100644 --- a/api-reference/enums/order-by-direction/index.html +++ b/api-reference/enums/order-by-direction/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OrderByDirection

No description

enum OrderByDirection {
  Asc
  Desc
}

Values​

OrderByDirection.Asc​

OrderByDirection.Desc​

Member of​

AccountHolderOrderByInput input ● AccountMembershipOrderByInput input ● AccountOrderByInput input ● AccountReceivedDirectDebitOrderByInput input ● AccountStandingOrderOrderByInput input ● CapitalDepositCaseOrderByInput input ● CardOrderByInput input ● DigitalCardOrderByInput input ● FundingLimitSettingsChangeRequestOrderByInput input ● FundingSourceOrderByInput input ● IdentificationsOrderByInput input ● MerchantProfileOrderByInput input ● OnboardingOrderByInput input ● PaymentMandateOrderByInput input ● PaymentOrderByInput input ● TransactionsOrderByInput input ● UserOrderByInput input

- + \ No newline at end of file diff --git a/api-reference/enums/partner-close-account-reason-type/index.html b/api-reference/enums/partner-close-account-reason-type/index.html index 19948fd0bf4..bc488e5ea97 100644 --- a/api-reference/enums/partner-close-account-reason-type/index.html +++ b/api-reference/enums/partner-close-account-reason-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/partnership-status/index.html b/api-reference/enums/partnership-status/index.html index 5a0e79d1c05..5313e840a39 100644 --- a/api-reference/enums/partnership-status/index.html +++ b/api-reference/enums/partnership-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PartnershipStatus

No description

enum PartnershipStatus {
  Accepted
  Canceling
  Canceled
}

Values​

PartnershipStatus.Accepted​

When the partnership is accepted by the account holder for this account

PartnershipStatus.Canceling​

When you decide to stop the partnership, you have 2 months notice

PartnershipStatus.Canceled​

When the partnership was canceled by you or the account holder

Member of​

PartnershipAcceptedStatusInfo object ● PartnershipCanceledStatusInfo object ● PartnershipCancelingStatusInfo object ● PartnershipStatusInfo interface

- + \ No newline at end of file diff --git a/api-reference/enums/payment-account-type/index.html b/api-reference/enums/payment-account-type/index.html index a97cfab3b1f..1680b2b15bf 100644 --- a/api-reference/enums/payment-account-type/index.html +++ b/api-reference/enums/payment-account-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/payment-level/index.html b/api-reference/enums/payment-level/index.html index 1148aad9abc..baaf5225b91 100644 --- a/api-reference/enums/payment-level/index.html +++ b/api-reference/enums/payment-level/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/payment-link-sequence-type/index.html b/api-reference/enums/payment-link-sequence-type/index.html index 51e0f8ac757..99794ccc0e2 100644 --- a/api-reference/enums/payment-link-sequence-type/index.html +++ b/api-reference/enums/payment-link-sequence-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/payment-mandate-canceled-reason/index.html b/api-reference/enums/payment-mandate-canceled-reason/index.html index 3810b349470..483e4451205 100644 --- a/api-reference/enums/payment-mandate-canceled-reason/index.html +++ b/api-reference/enums/payment-mandate-canceled-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/payment-mandate-order-by-field-input/index.html b/api-reference/enums/payment-mandate-order-by-field-input/index.html index d74881c0db9..f9712b315eb 100644 --- a/api-reference/enums/payment-mandate-order-by-field-input/index.html +++ b/api-reference/enums/payment-mandate-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/payment-mandate-scheme/index.html b/api-reference/enums/payment-mandate-scheme/index.html index b7584636d28..12b2cbdde85 100644 --- a/api-reference/enums/payment-mandate-scheme/index.html +++ b/api-reference/enums/payment-mandate-scheme/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PaymentMandateScheme

No description

enum PaymentMandateScheme {
  SepaDirectDebitCore
  SepaDirectDebitB2b
  InternalDirectDebitStandard
  InternalDirectDebitB2b
}

Values​

PaymentMandateScheme.SepaDirectDebitCore​

SEPA Direct Debit Core

PaymentMandateScheme.SepaDirectDebitB2b​

SEPA Direct Debit B2B

PaymentMandateScheme.InternalDirectDebitStandard​

Internal Direct Debit Standard

PaymentMandateScheme.InternalDirectDebitB2b​

Internal Direct Debit B2B

Member of​

PaymentMandateFiltersInput input

- + \ No newline at end of file diff --git a/api-reference/enums/payment-mandate-sequence/index.html b/api-reference/enums/payment-mandate-sequence/index.html index 364e285378f..e07ee6eb9ff 100644 --- a/api-reference/enums/payment-mandate-sequence/index.html +++ b/api-reference/enums/payment-mandate-sequence/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/payment-mandate-status/index.html b/api-reference/enums/payment-mandate-status/index.html index 5d2ee77d51f..18ecd10921c 100644 --- a/api-reference/enums/payment-mandate-status/index.html +++ b/api-reference/enums/payment-mandate-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PaymentMandateStatus

Payment Mandate status

enum PaymentMandateStatus {
  ConsentPending
  Enabled
  Rejected
  Canceled
}

Values​

PaymentMandateStatus.ConsentPending​

PaymentMandateStatus.Enabled​

PaymentMandateStatus.Rejected​

PaymentMandateStatus.Canceled​

Member of​

PaymentMandateCanceledStatusInfo object ● PaymentMandateConsentPendingStatusInfo object ● PaymentMandateEnabledStatusInfo object ● PaymentMandateFiltersInput input ● PaymentMandateRejectedStatusInfo object ● PaymentMandateStatusInfo interface

- + \ No newline at end of file diff --git a/api-reference/enums/payment-order-by-field-input/index.html b/api-reference/enums/payment-order-by-field-input/index.html index 01570a50eb6..af65e064efb 100644 --- a/api-reference/enums/payment-order-by-field-input/index.html +++ b/api-reference/enums/payment-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/payment-product/index.html b/api-reference/enums/payment-product/index.html index deec0ce447a..3631b0a43c4 100644 --- a/api-reference/enums/payment-product/index.html +++ b/api-reference/enums/payment-product/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PaymentProduct

Payment product

enum PaymentProduct {
  InternalCreditTransfer
  SEPACreditTransfer
  SEPADirectDebit
  Card
  Fees
  InternalDirectDebit
  Check
  InternationalCreditTransfer
}

Values​

PaymentProduct.InternalCreditTransfer​

When the payment is an Internal Credit Transfer operation

PaymentProduct.SEPACreditTransfer​

When the payment is a Sepa Credit Transfer operation

PaymentProduct.SEPADirectDebit​

When the payment is a Sepa Direct Debit operation

PaymentProduct.Card​

When the payment is a Card operation

PaymentProduct.Fees​

When the payment is a Fees operation

PaymentProduct.InternalDirectDebit​

When the payment is an Internal Direct Debit operation

PaymentProduct.Check​

When the payment is a Check operation

PaymentProduct.InternationalCreditTransfer​

When the payment is an International Credit Transfer operation

Member of​

CardTransaction object ● CheckTransaction object ● FeeTransaction object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● InternationalCreditTransferTransaction object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object ● Transaction interface ● TransactionsFiltersInput input

- + \ No newline at end of file diff --git a/api-reference/enums/payment-status/index.html b/api-reference/enums/payment-status/index.html index c332d13728a..3476abae91a 100644 --- a/api-reference/enums/payment-status/index.html +++ b/api-reference/enums/payment-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/pending-digital-card-status/index.html b/api-reference/enums/pending-digital-card-status/index.html index c42299c3159..e83d20346cd 100644 --- a/api-reference/enums/pending-digital-card-status/index.html +++ b/api-reference/enums/pending-digital-card-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PendingDigitalCardStatus

Pending Digital Card Status

enum PendingDigitalCardStatus {
  ConsentPending
  Pending
  Declined
}

Values​

PendingDigitalCardStatus.ConsentPending​

when the digital card is waiting for the user to finish his consent

PendingDigitalCardStatus.Pending​

when the digital card is pending the end of the digitalization process

PendingDigitalCardStatus.Declined​

when the creation of a digital card is declined

this is a final state

Member of​

DigitalCardConsentPendingStatusInfo object ● DigitalCardDeclinedStatusInfo object ● DigitalCardPendingStatusInfo object ● PendingDigitalCardStatusInfo interface

- + \ No newline at end of file diff --git a/api-reference/enums/physical-card-status/index.html b/api-reference/enums/physical-card-status/index.html index a13af9125b0..e4571656722 100644 --- a/api-reference/enums/physical-card-status/index.html +++ b/api-reference/enums/physical-card-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardStatus

Physical Card Status

enum PhysicalCardStatus {
  ConsentPending
  Processing
  Activated
  Suspended
  Canceled
  Canceling
  ToActivate
  Renewed
}

Values​

PhysicalCardStatus.ConsentPending​

when the consent to authorize physical card production is pending

PhysicalCardStatus.Processing​

when the physical card is in the process of being ready to use

PhysicalCardStatus.Activated​

when the physical card is activated

PhysicalCardStatus.Suspended​

when the physical card is suspended

PhysicalCardStatus.Canceled​

when the physical card is canceled

PhysicalCardStatus.Canceling​

when the physical card is about to be canceled

PhysicalCardStatus.ToActivate​

when the physical card is not yet activated

PhysicalCardStatus.Renewed​

when the physical card is renewed

Member of​

PhysicalCardActivatedStatusInfo object ● PhysicalCardCanceledStatusInfo object ● PhysicalCardCancelingStatusInfo object ● PhysicalCardConsentPendingStatusInfo object ● PhysicalCardProcessingStatusInfo object ● PhysicalCardRenewedStatusInfo object ● PhysicalCardStatusInfo interface ● PhysicalCardSuspendedStatusInfo object ● PhysicalCardToActivateStatusInfo object ● PhysicalCardWrongStatusRejection object

- + \ No newline at end of file diff --git a/api-reference/enums/preferred-notification-channel/index.html b/api-reference/enums/preferred-notification-channel/index.html index 5112aee68fc..2a868a8c491 100644 --- a/api-reference/enums/preferred-notification-channel/index.html +++ b/api-reference/enums/preferred-notification-channel/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/product-type/index.html b/api-reference/enums/product-type/index.html index 1aac5b8e63d..02c3ab30ffc 100644 --- a/api-reference/enums/product-type/index.html +++ b/api-reference/enums/product-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ProductType

Type of product sold. Gifts and donations can be club subscription or collection of donations (for associations), tips collection, contributions for local authorities

enum ProductType {
  Goods
  Services
  VirtualGoods
  GiftsAndDonations
}

Values​

ProductType.Goods​

ProductType.Services​

ProductType.VirtualGoods​

ProductType.GiftsAndDonations​

Member of​

AddMerchantProfileInput input ● MerchantProfile object ● RequestMerchantProfileUpdate object ● RequestMerchantProfileUpdateInput input

- + \ No newline at end of file diff --git a/api-reference/enums/project-card-settings-background-type/index.html b/api-reference/enums/project-card-settings-background-type/index.html index 31890cd7b17..47e44f82d5d 100644 --- a/api-reference/enums/project-card-settings-background-type/index.html +++ b/api-reference/enums/project-card-settings-background-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/project-card-status/index.html b/api-reference/enums/project-card-status/index.html index 9fce9cc5812..dad8fb547d6 100644 --- a/api-reference/enums/project-card-status/index.html +++ b/api-reference/enums/project-card-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ProjectCardStatus

Card Status

enum ProjectCardStatus {
  Initiated
  Enabled
  Disabled
  ToReview
  Suspended
  Rejected
}

Values​

ProjectCardStatus.Initiated​

when project's card settings are Initiated

ProjectCardStatus.Enabled​

when project's card settings are Enabled

ProjectCardStatus.Disabled​

when project's card settings are Disabled

ProjectCardStatus.ToReview​

when project's card settings are ToReview

ProjectCardStatus.Suspended​

when project's card settings are Suspended

ProjectCardStatus.Rejected​

when project's card settings are Rejected

Member of​

CardSettings object

- + \ No newline at end of file diff --git a/api-reference/enums/project-status/index.html b/api-reference/enums/project-status/index.html index 45d1007fb09..61673e9ff3b 100644 --- a/api-reference/enums/project-status/index.html +++ b/api-reference/enums/project-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ProjectStatus

No description

enum ProjectStatus {
  Initiated
  MeetingScheduled
  ToReview
  PendingCompliance
  LimitedLiveAccess
  BetaLiveAccess
  Enabled
  FullLiveAccess
  Disabled
  Suspended
  Rejected
  PendingLiveReview
}

Values​

ProjectStatus.Initiated​

ProjectStatus.MeetingScheduled​

ProjectStatus.ToReview​

ProjectStatus.PendingCompliance​

ProjectStatus.LimitedLiveAccess​

ProjectStatus.BetaLiveAccess​

ProjectStatus.Enabled​

ProjectStatus.FullLiveAccess​

ProjectStatus.Disabled​

ProjectStatus.Suspended​

ProjectStatus.Rejected​

ProjectStatus.PendingLiveReview​

Member of​

ProjectInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/project-type/index.html b/api-reference/enums/project-type/index.html index e9518fe0e7c..4d37349367c 100644 --- a/api-reference/enums/project-type/index.html +++ b/api-reference/enums/project-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/received-direct-debit-mandate-scheme/index.html b/api-reference/enums/received-direct-debit-mandate-scheme/index.html index d79af165e48..d37698bed8c 100644 --- a/api-reference/enums/received-direct-debit-mandate-scheme/index.html +++ b/api-reference/enums/received-direct-debit-mandate-scheme/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateScheme

Received Direct Debit Mandate Scheme

enum ReceivedDirectDebitMandateScheme {
  SepaDirectDebitB2b
  SepaDirectDebitCore
}

Values​

ReceivedDirectDebitMandateScheme.SepaDirectDebitB2b​

When the received direct debit mandate can only be used for SEPA B2B direct debit transactions

ReceivedDirectDebitMandateScheme.SepaDirectDebitCore​

When the received direct debit mandate can only be used for SEPA Core direct debit transactions

Member of​

AccountReceivedDirectDebitMandateFiltersInput input

- + \ No newline at end of file diff --git a/api-reference/enums/received-direct-debit-mandate-status/index.html b/api-reference/enums/received-direct-debit-mandate-status/index.html index 6bf9df33ecd..1db35f51868 100644 --- a/api-reference/enums/received-direct-debit-mandate-status/index.html +++ b/api-reference/enums/received-direct-debit-mandate-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateStatus

Received Direct Debit Mandate Statuses

enum ReceivedDirectDebitMandateStatus {
  Enabled
  Suspended
  Canceled
  ConsentInitiationPending
  ConsentPending
}

Values​

ReceivedDirectDebitMandateStatus.Enabled​

When the received direct debit mandate is enabled

ReceivedDirectDebitMandateStatus.Suspended​

When the received direct debit mandate is suspended

ReceivedDirectDebitMandateStatus.Canceled​

When the received direct debit mandate is canceled

ReceivedDirectDebitMandateStatus.ConsentInitiationPending​

When the received direct debit mandate requires the initiation of a consent process

ReceivedDirectDebitMandateStatus.ConsentPending​

When the received direct debit mandate is pending consent completion

Member of​

AccountReceivedDirectDebitMandateFiltersInput input ● ReceivedDirectDebitMandateStatusInfo interface ● ReceivedDirectDebitMandateStatusInfoCanceled object ● ReceivedDirectDebitMandateStatusInfoConsentInitiationPending object ● ReceivedDirectDebitMandateStatusInfoConsentPending object ● ReceivedDirectDebitMandateStatusInfoEnabled object ● ReceivedDirectDebitMandateStatusInfoSuspended object

- + \ No newline at end of file diff --git a/api-reference/enums/refund-rejection-code/index.html b/api-reference/enums/refund-rejection-code/index.html index ed54a9242f9..e8659f97810 100644 --- a/api-reference/enums/refund-rejection-code/index.html +++ b/api-reference/enums/refund-rejection-code/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RefundRejectionCode

Reason code that explains why we can't refund the transactions

enum RefundRejectionCode {
  TransactionNotFound
  TransactionNonRefundable
  ServerError
}

Values​

RefundRejectionCode.TransactionNotFound​

The transaction couldn't be found or the user doesn't have the 'canInitiatePayment' rights on the account

RefundRejectionCode.TransactionNonRefundable​

The transaction status is not Booked

RefundRejectionCode.ServerError​

Error server

Member of​

RefundRejection object

- + \ No newline at end of file diff --git a/api-reference/enums/rejected-funding-source-reason/index.html b/api-reference/enums/rejected-funding-source-reason/index.html index 5c951c3d927..fc75a14f885 100644 --- a/api-reference/enums/rejected-funding-source-reason/index.html +++ b/api-reference/enums/rejected-funding-source-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/rejected-reason-code/index.html b/api-reference/enums/rejected-reason-code/index.html index 3a238fe5ad8..c7ded573b01 100644 --- a/api-reference/enums/rejected-reason-code/index.html +++ b/api-reference/enums/rejected-reason-code/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RejectedReasonCode

The following reason code for a rejected transaction are defined:

enum RejectedReasonCode {
  AccountClosed
  AccountHolderDeceased
  AccountMembershipRefused
  AccountSuspended
  AccountUnknown
  BankRefused
  BeneficiaryBankNotReachable
  CardExpired
  CardPermanentlyBlocked
  CardSuspended
  CreditorBankOffline
  CreditorBankTechnicalErrorOccurred
  CreditorBankTimeout
  DebtorAccountClosed
  DebtorAccountConsumer
  DebtorAccountUnknown
  DebtorBankOffline
  DebtorBankTechnicalErrorOccurred
  DebtorBankTimeout
  DebtorDeceased
  FraudSuspected
  IbanInvalid
  IbanSuspended
  InsufficientFunds
  InvalidTransferDate
  MandateInvalid
  NoMandate
  PartnerRefused
  PartnerTechnicalErrorOccurred
  PeriodAmountLimitExceeded
  PeriodNbTransactionLimitExceeded
  ReasonNotSpecifiedByBank
  ReasonNotSpecifiedByDebtor
  RegulatoryReason
  SwanOffline
  SwanRefused
  SwanTechnicalErrorOccurred
  SwanTimeout
  TermsAndConditionsLimitExceeded
  TransactionAmountLimitExceeded
  TransactionDuplicated
  TransactionOnAccountTypeNotAllowed
  TransactionTypeNotAllowed
  CardNotActivated
  InvalidPin
  InvalidPinAttemptsExceeded
  MerchantShouldResubmitAuthorization
  InvalidExpirationDate
  InvalidSecurityNumber
  PinRequiredForFurtherTransaction
  RetryWithChipAndPin
}

Values​

RejectedReasonCode.AccountClosed​

Rejected because the account is closed

RejectedReasonCode.AccountHolderDeceased​

Rejected because the account holder is deceased

RejectedReasonCode.AccountMembershipRefused​

Rejected by the account membership

RejectedReasonCode.AccountSuspended​

Rejected because the account is suspended

RejectedReasonCode.AccountUnknown​

Rejected because the account is unknown

RejectedReasonCode.BankRefused​

Rejected by the bank

RejectedReasonCode.BeneficiaryBankNotReachable​

Rejected because the creditor bank is not reachable

RejectedReasonCode.CardExpired​

Rejected because the card is expired

RejectedReasonCode.CardPermanentlyBlocked​

Rejected because the card has been permanently blocked

RejectedReasonCode.CardSuspended​

Rejected because the card is suspended

RejectedReasonCode.CreditorBankOffline​

Rejected because the creditor bank is offline

RejectedReasonCode.CreditorBankTechnicalErrorOccurred​

Rejected following an error from the creditor bank

RejectedReasonCode.CreditorBankTimeout​

Rejected following a timeout from the creditor bank

RejectedReasonCode.DebtorAccountClosed​

Rejected because the debtor account is closed

RejectedReasonCode.DebtorAccountConsumer​

Rejected because the debtor is a non business account and the transaction is a B2B SEPA Direct Debit transaction

RejectedReasonCode.DebtorAccountUnknown​

Rejected because the debtor account is unknown

RejectedReasonCode.DebtorBankOffline​

Rejected because the debtor bank is offline

RejectedReasonCode.DebtorBankTechnicalErrorOccurred​

Rejected following an error from the debtor bank

RejectedReasonCode.DebtorBankTimeout​

Rejected following a timeout from the debtor bank

RejectedReasonCode.DebtorDeceased​

Rejected because the debtor account holder is dead

RejectedReasonCode.FraudSuspected​

Rejected because of a fraud suspicion

RejectedReasonCode.IbanInvalid​

Rejected because the beneficiary IBAN is invalid

RejectedReasonCode.IbanSuspended​

Rejected because the beneficiary IBAN is suspended

RejectedReasonCode.InsufficientFunds​

Rejected because of insufficient funds on the account

RejectedReasonCode.InvalidTransferDate​

Rejected because of invalid transfer date

RejectedReasonCode.MandateInvalid​

Rejected by debtor because the mandate is invalid

RejectedReasonCode.NoMandate​

Rejected because the mandate has been revoked or does not exist

RejectedReasonCode.PartnerRefused​

Rejected by the partner (you)

RejectedReasonCode.PartnerTechnicalErrorOccurred​

Rejected following an error or a timeout from the partner

RejectedReasonCode.PeriodAmountLimitExceeded​

Rejected because the maximum amount allowed on the given period has been exceeded

RejectedReasonCode.PeriodNbTransactionLimitExceeded​

Rejected because the maximum number of transactions on the given period has been exceeded

RejectedReasonCode.ReasonNotSpecifiedByBank​

Rejected by bank with no specified reason

RejectedReasonCode.ReasonNotSpecifiedByDebtor​

Rejected by debtor with no specified reason

RejectedReasonCode.RegulatoryReason​

Rejected by bank for regulatory reason

RejectedReasonCode.SwanOffline​

Rejected because the debtor or the creditor bank is offline

RejectedReasonCode.SwanRefused​

Rejected by Swan

RejectedReasonCode.SwanTechnicalErrorOccurred​

Rejected because of a Swan technical error

RejectedReasonCode.SwanTimeout​

Rejected because of a Swan timeout

RejectedReasonCode.TermsAndConditionsLimitExceeded​

Rejected because the terms and conditions limit has been exceeded

RejectedReasonCode.TransactionAmountLimitExceeded​

Rejected because the maximum amount for a transaction has been exceeded

RejectedReasonCode.TransactionDuplicated​

Rejected by bank because this transaction is duplicated

RejectedReasonCode.TransactionOnAccountTypeNotAllowed​

Rejected because the transaction is forbidden on this type of account

RejectedReasonCode.TransactionTypeNotAllowed​

Rejected because the type of transaction is forbidden on the account

RejectedReasonCode.CardNotActivated​

Rejected because the card is not activated yet

RejectedReasonCode.InvalidPin​

Rejected because the PIN is invalid

RejectedReasonCode.InvalidPinAttemptsExceeded​

Rejected because there were too many invalid tries on the PIN validation

RejectedReasonCode.MerchantShouldResubmitAuthorization​

Rejected because the merchant must request a new transaction with authorisation

RejectedReasonCode.InvalidExpirationDate​

Rejected because the expiration date entered does not match the one on the card

RejectedReasonCode.InvalidSecurityNumber​

Rejected because the security number entered does not match the one on the card

RejectedReasonCode.PinRequiredForFurtherTransaction​

Rejected because a transaction with PIN code is required to continue to using the card

RejectedReasonCode.RetryWithChipAndPin​

Rejected because the Swipe method is not supported, a retry using the Chip and PIN method is necessary

Member of​

RejectedTransactionStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/rejected-verification-reason/index.html b/api-reference/enums/rejected-verification-reason/index.html index 0ad643e0886..4cfc0ecbf68 100644 --- a/api-reference/enums/rejected-verification-reason/index.html +++ b/api-reference/enums/rejected-verification-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/released-reason/index.html b/api-reference/enums/released-reason/index.html index 13e81c86603..852eba644d9 100644 --- a/api-reference/enums/released-reason/index.html +++ b/api-reference/enums/released-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReleasedReason

No description

enum ReleasedReason {
  Captured
  Expired
  AdviceReceived
  MerchantReleased
  ManuallyReleased
  Other
}

Values​

ReleasedReason.Captured​

Authorization fully captured by one or more debits

ReleasedReason.Expired​

Authorization expired

ReleasedReason.AdviceReceived​

Authorization has been superseded by an advice

ReleasedReason.MerchantReleased​

Authorization released by the merchant

ReleasedReason.ManuallyReleased​

Authorization manually released by Swan

ReleasedReason.Other​

Authorization released for other/undefined reasons

Member of​

ReleasedTransactionStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/request-merchant-profile-update-status/index.html b/api-reference/enums/request-merchant-profile-update-status/index.html index 300a6c1e0d3..089597163d4 100644 --- a/api-reference/enums/request-merchant-profile-update-status/index.html +++ b/api-reference/enums/request-merchant-profile-update-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/sepadirect-debit-scheme/index.html b/api-reference/enums/sepadirect-debit-scheme/index.html index 03708d0515e..521aab533cf 100644 --- a/api-reference/enums/sepadirect-debit-scheme/index.html +++ b/api-reference/enums/sepadirect-debit-scheme/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/sepapayment-mandate-scheme/index.html b/api-reference/enums/sepapayment-mandate-scheme/index.html index 7a63e38518a..516df5c4f29 100644 --- a/api-reference/enums/sepapayment-mandate-scheme/index.html +++ b/api-reference/enums/sepapayment-mandate-scheme/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/sepapayment-mandate-sequence/index.html b/api-reference/enums/sepapayment-mandate-sequence/index.html index eff1b732cdb..b119d167ab8 100644 --- a/api-reference/enums/sepapayment-mandate-sequence/index.html +++ b/api-reference/enums/sepapayment-mandate-sequence/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/separeceived-direct-debit-mandate-scheme/index.html b/api-reference/enums/separeceived-direct-debit-mandate-scheme/index.html index 3e076875f66..1f221403788 100644 --- a/api-reference/enums/separeceived-direct-debit-mandate-scheme/index.html +++ b/api-reference/enums/separeceived-direct-debit-mandate-scheme/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPAReceivedDirectDebitMandateScheme

Received SEPA direct debit mandate scheme

enum SEPAReceivedDirectDebitMandateScheme {
  SepaDirectDebitB2b
  SepaDirectDebitCore
}

Values​

SEPAReceivedDirectDebitMandateScheme.SepaDirectDebitB2b​

When the received SEPA direct debit mandate can only be used for SEPA B2B direct debit transactions

SEPAReceivedDirectDebitMandateScheme.SepaDirectDebitCore​

When the received SEPA direct debit mandate can only be used for SEPA Core direct debit transactions

Member of​

SEPAReceivedDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/enums/separeceived-direct-debit-mandate-sequence/index.html b/api-reference/enums/separeceived-direct-debit-mandate-sequence/index.html index 33e69d5e8b0..0e8a428d347 100644 --- a/api-reference/enums/separeceived-direct-debit-mandate-sequence/index.html +++ b/api-reference/enums/separeceived-direct-debit-mandate-sequence/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPAReceivedDirectDebitMandateSequence

SEPA received direct debit mandate sequence

enum SEPAReceivedDirectDebitMandateSequence {
  OneOff
  Recurrent
}

Values​

SEPAReceivedDirectDebitMandateSequence.OneOff​

When the authorisation is given once by the SEPA Debtor to collect only one single SEPA direct debit

SEPAReceivedDirectDebitMandateSequence.Recurrent​

When the authorisation by the Debtor can be used for regular SEPA direct debits initiated by the Creditor

Member of​

AddReceivedSepaDirectDebitB2bMandateInput input ● SEPAReceivedDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/enums/sequence-type/index.html b/api-reference/enums/sequence-type/index.html index 8042a2a202e..25fd51ba96f 100644 --- a/api-reference/enums/sequence-type/index.html +++ b/api-reference/enums/sequence-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/shareholder-status/index.html b/api-reference/enums/shareholder-status/index.html index 48a87c697e5..3fff86900b0 100644 --- a/api-reference/enums/shareholder-status/index.html +++ b/api-reference/enums/shareholder-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ShareholderStatus

Status of the shareholder during the process with Swan.

enum ShareholderStatus {
  PendingOnboarding
  WaitingForVerification
  WaitingForTransfer
  CapitalTransferred
  CapitalFundsWiredToNotary
}

Values​

ShareholderStatus.PendingOnboarding​

Waiting for the shareholder to finalize their onboarding.

ShareholderStatus.WaitingForVerification​

Waiting for Swan compliance team to verify the shareholder.

ShareholderStatus.WaitingForTransfer​

Waiting for the shareholder to wire their share of the capital on their temporary Swan account.

ShareholderStatus.CapitalTransferred​

When the shareholder has wired their share of the capital.

ShareholderStatus.CapitalFundsWiredToNotary​

When the shareholder's capital is wired to the notary.

Member of​

Shareholder object

- + \ No newline at end of file diff --git a/api-reference/enums/shareholder-type/index.html b/api-reference/enums/shareholder-type/index.html index 566ce1d2d9c..ca780a53e1a 100644 --- a/api-reference/enums/shareholder-type/index.html +++ b/api-reference/enums/shareholder-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/simulation-card-type/index.html b/api-reference/enums/simulation-card-type/index.html index 7e5f8d073f1..a7d5cf42070 100644 --- a/api-reference/enums/simulation-card-type/index.html +++ b/api-reference/enums/simulation-card-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/spending-limit-period-input/index.html b/api-reference/enums/spending-limit-period-input/index.html index 5e8de4526e3..76631a69acd 100644 --- a/api-reference/enums/spending-limit-period-input/index.html +++ b/api-reference/enums/spending-limit-period-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/spending-limit-period/index.html b/api-reference/enums/spending-limit-period/index.html index 6407cc6a8a9..7e07890ae97 100644 --- a/api-reference/enums/spending-limit-period/index.html +++ b/api-reference/enums/spending-limit-period/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/spending-limit-type/index.html b/api-reference/enums/spending-limit-type/index.html index a4907d366db..813177f5605 100644 --- a/api-reference/enums/spending-limit-type/index.html +++ b/api-reference/enums/spending-limit-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/standing-order-period/index.html b/api-reference/enums/standing-order-period/index.html index f5963240959..94850644ed0 100644 --- a/api-reference/enums/standing-order-period/index.html +++ b/api-reference/enums/standing-order-period/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/standing-order-status/index.html b/api-reference/enums/standing-order-status/index.html index f6c25a8c96e..1f83d9876cc 100644 --- a/api-reference/enums/standing-order-status/index.html +++ b/api-reference/enums/standing-order-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/statement-period/index.html b/api-reference/enums/statement-period/index.html index 285a3c5aed5..a2c571763c0 100644 --- a/api-reference/enums/statement-period/index.html +++ b/api-reference/enums/statement-period/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/statement-status/index.html b/api-reference/enums/statement-status/index.html index 4db3d600949..884fa651285 100644 --- a/api-reference/enums/statement-status/index.html +++ b/api-reference/enums/statement-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/statement-type/index.html b/api-reference/enums/statement-type/index.html index 21a699c2561..cd093c99901 100644 --- a/api-reference/enums/statement-type/index.html +++ b/api-reference/enums/statement-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/supporting-document-collect-mode/index.html b/api-reference/enums/supporting-document-collect-mode/index.html index 1f9f987bfe9..6e303c8520b 100644 --- a/api-reference/enums/supporting-document-collect-mode/index.html +++ b/api-reference/enums/supporting-document-collect-mode/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/supporting-document-collection-status/index.html b/api-reference/enums/supporting-document-collection-status/index.html index 14f32bf2efe..bcc1d5c9318 100644 --- a/api-reference/enums/supporting-document-collection-status/index.html +++ b/api-reference/enums/supporting-document-collection-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionStatus

Verification status of a supporting document collection

enum SupportingDocumentCollectionStatus {
  WaitingForDocument
  PendingReview
  Approved
  Canceled
  Rejected
}

Values​

SupportingDocumentCollectionStatus.WaitingForDocument​

When the supporting document collection is created and on going

SupportingDocumentCollectionStatus.PendingReview​

When the supporting document collection is completed and in compliance review

SupportingDocumentCollectionStatus.Approved​

When the supporting document collection is approved. Final status

SupportingDocumentCollectionStatus.Canceled​

When the supporting document collection is canceled. Final status

SupportingDocumentCollectionStatus.Rejected​

When the supporting document collection is rejected. Final status

Member of​

SupportingDocumentCollectionApprovedStatusInfo object ● SupportingDocumentCollectionCanceledStatusInfo object ● SupportingDocumentCollectionPendingReviewStatusInfo object ● SupportingDocumentCollectionRejectedStatusInfo object ● SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection object ● SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection object ● SupportingDocumentCollectionStatusInfo interface ● SupportingDocumentCollectionStatusNotAllowedRejection object ● SupportingDocumentCollectionWaitingForDocumentStatusInfo object ● SupportingDocumentUploadNotAllowedRejection object

- + \ No newline at end of file diff --git a/api-reference/enums/supporting-document-communication-language-settings/index.html b/api-reference/enums/supporting-document-communication-language-settings/index.html index ad4d126b38c..e71c17ab733 100644 --- a/api-reference/enums/supporting-document-communication-language-settings/index.html +++ b/api-reference/enums/supporting-document-communication-language-settings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/supporting-document-purpose-enum/index.html b/api-reference/enums/supporting-document-purpose-enum/index.html index 0a461bf281a..cafcf7998e3 100644 --- a/api-reference/enums/supporting-document-purpose-enum/index.html +++ b/api-reference/enums/supporting-document-purpose-enum/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentPurposeEnum

Supporting document purpose

enum SupportingDocumentPurposeEnum {
  AssociationRegistration
  Banking
  CompanyRegistration
  GeneralAssemblyMinutes
  Other
  PowerOfAttorney
  ProofOfCompanyAddress
  ProofOfCompanyIncome
  ProofOfIdentity
  ProofOfIndividualAddress
  ProofOfIndividualIncome
  ProofOfOriginOfFunds
  SignedStatus
  UBODeclaration
  SwornStatement
}

Values​

SupportingDocumentPurposeEnum.AssociationRegistration​

Proof of association registration

SupportingDocumentPurposeEnum.Banking​

Banking

SupportingDocumentPurposeEnum.CompanyRegistration​

Proof of company registration

SupportingDocumentPurposeEnum.GeneralAssemblyMinutes​

Minutes Of The General Assembly

SupportingDocumentPurposeEnum.Other​

Other

SupportingDocumentPurposeEnum.PowerOfAttorney​

Signed power of attorney document to give the power to act on behalf.

SupportingDocumentPurposeEnum.ProofOfCompanyAddress​

Proof of company address

SupportingDocumentPurposeEnum.ProofOfCompanyIncome​

Proof of company income

SupportingDocumentPurposeEnum.ProofOfIdentity​

Proof of identity

SupportingDocumentPurposeEnum.ProofOfIndividualAddress​

Proof of individual address

SupportingDocumentPurposeEnum.ProofOfIndividualIncome​

Proof of individual income

SupportingDocumentPurposeEnum.ProofOfOriginOfFunds​

Proof of origin of funds

SupportingDocumentPurposeEnum.SignedStatus​

Signed status

SupportingDocumentPurposeEnum.UBODeclaration​

UBO Declaration

SupportingDocumentPurposeEnum.SwornStatement​

Sworn statement

Member of​

GenerateSupportingDocumentUploadUrlInput input ● SupportingDocument object ● SupportingDocumentPurpose object ● UpdateSupportingDocumentInput input

- + \ No newline at end of file diff --git a/api-reference/enums/supporting-document-status/index.html b/api-reference/enums/supporting-document-status/index.html index 31e226a92a4..b3c53d35790 100644 --- a/api-reference/enums/supporting-document-status/index.html +++ b/api-reference/enums/supporting-document-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentStatus

Verification status of a document

enum SupportingDocumentStatus {
  WaitingForUpload
  Uploaded
  Validated
  Refused
  NotUploaded
}

Values​

SupportingDocumentStatus.WaitingForUpload​

Document is not uploaded yet.

SupportingDocumentStatus.Uploaded​

Document has been uploaded but not verified by Swan yet.

SupportingDocumentStatus.Validated​

Document has been uploaded and verified by Swan.

SupportingDocumentStatus.Refused​

Document has been refused by Swan.

SupportingDocumentStatus.NotUploaded​

Document has not been uploaded on time.

Member of​

SupportingDocumentNotUploadedStatusInfo object ● SupportingDocumentRefusedStatusInfo object ● SupportingDocumentStatusDoesNotAllowDeletionRejection object ● SupportingDocumentStatusDoesNotAllowUpdateRejection object ● SupportingDocumentStatusInfo interface ● SupportingDocumentStatusNotAllowedRejection object ● SupportingDocumentUploadedStatusInfo object ● SupportingDocumentValidatedStatusInfo object ● SupportingDocumentWaitingForUploadStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/supporting-document-type/index.html b/api-reference/enums/supporting-document-type/index.html index a826f1aee72..23dbc4288b5 100644 --- a/api-reference/enums/supporting-document-type/index.html +++ b/api-reference/enums/supporting-document-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentType

Specific type for document

enum SupportingDocumentType {
  Selfie
  Passport
  NationalIdCard
  ResidentPermit
  DrivingLicense
  UtilityBill
  PhoneBill
  RentReceipt
  HomeInsurance
  IncomeTaxReturn
  PaySlip
  RegisterExtract
  ArticlesOfIncorporation
  CapitalShareDepositCertificate
  UBODeclaration
  JOAFFEExtract
  CompanyLeaseAgreement
  BankStatement
  BankAccountDetails
  PowerOfAttorney
  CorporateIncomeTaxReturn
  Other
  ByLaws
  AccountStatement
  DeedOfDonation
  DeedOfSale
  DeedOfSuccession
  LoanContract
  NotarialDeed
  SwornStatement
  MeetingMinutes
}

Values​

SupportingDocumentType.Selfie​

Selfie

SupportingDocumentType.Passport​

Passport

SupportingDocumentType.NationalIdCard​

NationalIdCard

SupportingDocumentType.ResidentPermit​

Resident permit

SupportingDocumentType.DrivingLicense​

Driving license

SupportingDocumentType.UtilityBill​

Water, Electricity or Gas Bill issued within the last 3 months

SupportingDocumentType.PhoneBill​

Telephone Bill issued within the last 3 months

SupportingDocumentType.RentReceipt​

Rental Receipt issued within the last 3 months

SupportingDocumentType.HomeInsurance​

Home Insurance contract

SupportingDocumentType.IncomeTaxReturn​

Income Tax return or tax-exemption certificate dating less than 2 years

SupportingDocumentType.PaySlip​

A pay slip dating less than 3 months

SupportingDocumentType.RegisterExtract​

Commercial registry extract issued within the last 3 months

SupportingDocumentType.ArticlesOfIncorporation​

Legal document required for company’s formation

SupportingDocumentType.CapitalShareDepositCertificate​

Share Deposit Certificate

SupportingDocumentType.UBODeclaration​

Ultimate Beneficial Owner Declaration

SupportingDocumentType.JOAFFEExtract​

Association registration proof for french association

SupportingDocumentType.CompanyLeaseAgreement​

Lease agreement in the name of the business or Proof of Individual Address if the company is hosted by one of the legal representative

SupportingDocumentType.BankStatement​

Bank Statement

SupportingDocumentType.BankAccountDetails​

Document with details such as bank name, address, account number and account holder

SupportingDocumentType.PowerOfAttorney​

Signed power of attorney document to give the power to act on behalf

SupportingDocumentType.CorporateIncomeTaxReturn​

Document submitted to your tax bureau at the end of the last business period

SupportingDocumentType.Other​

Other

SupportingDocumentType.ByLaws​

By Laws

SupportingDocumentType.AccountStatement​

Account statement

SupportingDocumentType.DeedOfDonation​

Deed of donation

SupportingDocumentType.DeedOfSale​

Deed of sale

SupportingDocumentType.DeedOfSuccession​

Deed of succession

SupportingDocumentType.LoanContract​

Loan contract

SupportingDocumentType.NotarialDeed​

Notarial deed

SupportingDocumentType.SwornStatement​

Sworn statement

SupportingDocumentType.MeetingMinutes​

Meeting's minutes

Member of​

GenerateSupportingDocumentUploadUrlInput input ● SupportingDocument object ● SupportingDocumentPurpose object ● UpdateSupportingDocumentInput input

- + \ No newline at end of file diff --git a/api-reference/enums/suspend-account-reason-type/index.html b/api-reference/enums/suspend-account-reason-type/index.html index 0e4699ce79e..85ca7532116 100644 --- a/api-reference/enums/suspend-account-reason-type/index.html +++ b/api-reference/enums/suspend-account-reason-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/suspend-received-direct-debit-mandated-rejection-reason/index.html b/api-reference/enums/suspend-received-direct-debit-mandated-rejection-reason/index.html index e86b7d8465d..b9a1321d53c 100644 --- a/api-reference/enums/suspend-received-direct-debit-mandated-rejection-reason/index.html +++ b/api-reference/enums/suspend-received-direct-debit-mandated-rejection-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/swan-identification-status/index.html b/api-reference/enums/swan-identification-status/index.html index b622d103e5a..7a9456389ec 100644 --- a/api-reference/enums/swan-identification-status/index.html +++ b/api-reference/enums/swan-identification-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SwanIdentificationStatus

Status values of an identification

enum SwanIdentificationStatus {
  Pending
  Valid
  Invalid
  Canceled
  Expired
  NotSupported
  NotStarted
  Started
}

Values​

SwanIdentificationStatus.Pending​

When the identification process is currently being treated by a manual or automatic process

SwanIdentificationStatus.Valid​

When the identification is valid

SwanIdentificationStatus.Invalid​

When the identification is invalid

SwanIdentificationStatus.Canceled​

When the user canceled the identification process or the identification service was unavailable

SwanIdentificationStatus.Expired​

When the identification is no longer valid

SwanIdentificationStatus.NotSupported​

When the identification does not support an identification level

SwanIdentificationStatus.NotStarted​

When the identification hasn't been started yet

SwanIdentificationStatus.Started​

When the identification has been started

Member of​

CanceledIdentificationLevelStatusInfo object ● ExpiredIdentificationLevelStatusInfo object ● Identification object ● IdentificationFiltersInput input ● InvalidIdentificationLevelStatusInfo object ● NotStartedIdentificationLevelStatusInfo object ● NotSupportedIdentificationLevelStatusInfo object ● PendingIdentificationLevelStatusInfo object ● StartedIdentificationLevelStatusInfo object ● ValidIdentificationLevelStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/title-enum/index.html b/api-reference/enums/title-enum/index.html index f28d7d2aba2..733638fdd2a 100644 --- a/api-reference/enums/title-enum/index.html +++ b/api-reference/enums/title-enum/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/transaction-reason-code/index.html b/api-reference/enums/transaction-reason-code/index.html index dd3bf584298..f59e30819ac 100644 --- a/api-reference/enums/transaction-reason-code/index.html +++ b/api-reference/enums/transaction-reason-code/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

TransactionReasonCode

The following reason codes for a r-transaction are defined:

enum TransactionReasonCode {
  AccountClosed
  AccountHolderDeceased
  AccountSuspended
  AccountUnknown
  BankRefused
  BeneficiaryAccountBlocked
  BeneficiaryAccountClosed
  BeneficiaryAccountIncorrect
  BeneficiaryAccountUnknown
  BeneficiaryBankNotReachable
  BeneficiaryDeceased
  CardExpired
  CardNotActivated
  CardPermanentlyBlocked
  CardSuspended
  CheckInvalid
  CheckNumberInvalid
  CreditorBankOffline
  CreditorBankTechnicalErrorOccurred
  CreditorBankTimeout
  DebtorAccountBlocked
  DebtorAccountClosed
  DebtorAccountConsumer
  DebtorAccountUnknown
  DebtorBankOffline
  DebtorBankTechnicalErrorOccurred
  DebtorBankTimeout
  DebtorDeceased
  FundsAlreadyTransferredBack
  InsufficientFunds
  InvalidExpirationDate
  InvalidPin
  InvalidPinAttemptsExceeded
  InvalidSecurityNumber
  LegalOrBankDecision
  MandateInvalid
  MerchantShouldResubmitAuthorization
  NoAnswerFromBeneficiary
  NoOriginalTransactionReceived
  PartnerRefused
  PartnerTechnicalErrorOccurred
  PeriodAmountLimitExceeded
  PeriodNbTransactionLimitExceeded
  PinRequiredForFurtherTransaction
  ReasonNotSpecifiedByBank
  ReasonNotSpecifiedByBeneficiary
  ReasonNotSpecifiedByDebtor
  ReasonNotSpecifiedByOriginator
  RecallAccepted
  RefundRequestedByDebtor
  RegulatoryReason
  RlmcKeyInvalid
  SwanOffline
  SwanRefused
  SwanTechnicalErrorOccurred
  SwanTimeout
  TechnicalIssue
  TermsAndConditionsLimitExceeded
  TransactionAmountIncorrect
  TransactionAmountLimitExceeded
  TransactionDuplicated
  TransactionOnAccountTypeNotAllowed
  TransactionTypeNotAllowed
}

Values​

TransactionReasonCode.AccountClosed​

Rejected because the account is closed

TransactionReasonCode.AccountHolderDeceased​

Rejected because the account holder is deceased

TransactionReasonCode.AccountSuspended​

Rejected because the account is suspended

TransactionReasonCode.AccountUnknown​

Rejected because the account is unknown

TransactionReasonCode.BankRefused​

Rejected by the bank

TransactionReasonCode.BeneficiaryAccountBlocked​

Creditor account is blocked

TransactionReasonCode.BeneficiaryAccountClosed​

Creditor account is closed

TransactionReasonCode.BeneficiaryAccountIncorrect​

Creditor account number is incorrect

TransactionReasonCode.BeneficiaryAccountUnknown​

Creditor account number does not exist

TransactionReasonCode.BeneficiaryBankNotReachable​

Rejected because the creditor bank is not reachable

TransactionReasonCode.BeneficiaryDeceased​

Customer is deceased

TransactionReasonCode.CardExpired​

Rejected because the card is expired

TransactionReasonCode.CardNotActivated​

Rejected because the card is not activated yet

TransactionReasonCode.CardPermanentlyBlocked​

Rejected because the card has been permanently blocked

TransactionReasonCode.CardSuspended​

Rejected because the card is suspended

TransactionReasonCode.CheckInvalid​

Invalid check

TransactionReasonCode.CheckNumberInvalid​

Invalid check number

TransactionReasonCode.CreditorBankOffline​

Rejected because the creditor bank is offline

TransactionReasonCode.CreditorBankTechnicalErrorOccurred​

Rejected following an error from the creditor bank

TransactionReasonCode.CreditorBankTimeout​

Rejected following a timeout from the creditor bank

TransactionReasonCode.DebtorAccountBlocked​

Debtor Account Blocked

TransactionReasonCode.DebtorAccountClosed​

Rejected because the debtor account is closed

TransactionReasonCode.DebtorAccountConsumer​

Rejected because the debtor is a non business account and the transaction is a B2B SEPA Direct Debit transaction

TransactionReasonCode.DebtorAccountUnknown​

Rejected because the debtor account is unknown

TransactionReasonCode.DebtorBankOffline​

Rejected because the debtor bank is offline

TransactionReasonCode.DebtorBankTechnicalErrorOccurred​

Rejected following an error from the debtor bank

TransactionReasonCode.DebtorBankTimeout​

Rejected following a timeout from the debtor bank

TransactionReasonCode.DebtorDeceased​

Rejected because the debtor account holder is dead

TransactionReasonCode.FundsAlreadyTransferredBack​

Funds already transferred back to the originator

TransactionReasonCode.InsufficientFunds​

Rejected because of insufficient funds on the account

TransactionReasonCode.InvalidExpirationDate​

Rejected because the expiration date entered does not match the one on the card

TransactionReasonCode.InvalidPin​

Rejected because the PIN is invalid

TransactionReasonCode.InvalidPinAttemptsExceeded​

Rejected because there were too many invalid tries on the PIN validation

TransactionReasonCode.InvalidSecurityNumber​

Rejected because the security number entered does not match the one on the card

TransactionReasonCode.LegalOrBankDecision​

Funds cannot be reimbursed by beneficiary bank/legal decision

TransactionReasonCode.MandateInvalid​

Rejected by debtor because the mandate is invalid

TransactionReasonCode.MerchantShouldResubmitAuthorization​

Rejected because the merchant must request a new transaction with authorisation

TransactionReasonCode.NoAnswerFromBeneficiary​

No answer from customer

TransactionReasonCode.NoOriginalTransactionReceived​

No original transaction received

TransactionReasonCode.PartnerRefused​

Rejected by the partner (you)

TransactionReasonCode.PartnerTechnicalErrorOccurred​

Rejected following an error or a timeout from the partner

TransactionReasonCode.PeriodAmountLimitExceeded​

Rejected because the maximum amount allowed on the given period has been exceeded

TransactionReasonCode.PeriodNbTransactionLimitExceeded​

Rejected because the maximum number of transactions on the given period has been exceeded

TransactionReasonCode.PinRequiredForFurtherTransaction​

Rejected because a transaction with PIN code is required to continue to using the card

TransactionReasonCode.ReasonNotSpecifiedByBank​

Rejected by bank with no specified reason

TransactionReasonCode.ReasonNotSpecifiedByBeneficiary​

Reason unspecified

TransactionReasonCode.ReasonNotSpecifiedByDebtor​

Rejected by debtor with no specified reason

TransactionReasonCode.ReasonNotSpecifiedByOriginator​

Customer request

TransactionReasonCode.RecallAccepted​

Recall request accepted by beneficiary bank or beneficiary

TransactionReasonCode.RefundRequestedByDebtor​

Refund requested by end customer

TransactionReasonCode.RegulatoryReason​

Rejected by bank for regulatory reason

TransactionReasonCode.RlmcKeyInvalid​

Invalid RLMC key, please control the key and the check number

TransactionReasonCode.SwanOffline​

Rejected because the debtor or the creditor bank is offline

TransactionReasonCode.SwanRefused​

Rejected by Swan

TransactionReasonCode.SwanTechnicalErrorOccurred​

Rejected because of a Swan technical error

TransactionReasonCode.SwanTimeout​

Rejected because of a Swan timeout

TransactionReasonCode.TechnicalIssue​

Technical issue resulting in incorrect transactions sent out

TransactionReasonCode.TermsAndConditionsLimitExceeded​

Rejected because the terms and conditions limit has been exceeded

TransactionReasonCode.TransactionAmountIncorrect​

Wrong transaction amount

TransactionReasonCode.TransactionAmountLimitExceeded​

Rejected because the maximum amount for a transaction has been exceeded

TransactionReasonCode.TransactionDuplicated​

Rejected by bank because this transaction is duplicated

TransactionReasonCode.TransactionOnAccountTypeNotAllowed​

Rejected because the transaction is forbidden on this type of account

TransactionReasonCode.TransactionTypeNotAllowed​

Rejected because the type of transaction is forbidden on the account

Member of​

CheckTransaction object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object

- + \ No newline at end of file diff --git a/api-reference/enums/transaction-side/index.html b/api-reference/enums/transaction-side/index.html index 3687307e775..a6d7d415a25 100644 --- a/api-reference/enums/transaction-side/index.html +++ b/api-reference/enums/transaction-side/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

TransactionSide

Transaction side

enum TransactionSide {
  Debit
  Credit
}

Values​

TransactionSide.Debit​

when the transaction debit the account

TransactionSide.Credit​

when the transaction credit the account

Member of​

CardTransaction object ● CheckTransaction object ● FeeTransaction object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● InternationalCreditTransferTransaction object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object ● Transaction interface

- + \ No newline at end of file diff --git a/api-reference/enums/transaction-status/index.html b/api-reference/enums/transaction-status/index.html index 3836d65b8f4..74bdb9c95da 100644 --- a/api-reference/enums/transaction-status/index.html +++ b/api-reference/enums/transaction-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

TransactionStatus

Transaction status

enum TransactionStatus {
  Booked
  Rejected
  Pending
  Canceled
  Upcoming
  Released
}

Values​

TransactionStatus.Booked​

when the transaction is posted to the Swan book and impact the booked balance

TransactionStatus.Rejected​

when the transaction is rejected

TransactionStatus.Pending​

when the transaction is pending and the amount impact the available balance

TransactionStatus.Canceled​

when a pending transaction is canceled and the amount is released on the available balance

TransactionStatus.Upcoming​

when the transaction is upcoming (scheduled credit transfer, direct debit ...)

TransactionStatus.Released​

when a card authorization is released after X days or fully consumed by X debits

Member of​

BookedTransactionStatusInfo object ● CanceledTransactionStatusInfo object ● PendingTransactionStatusInfo object ● RejectedTransactionStatusInfo object ● ReleasedTransactionStatusInfo object ● TransactionsFiltersInput input ● TransactionStatusInfo interface ● UpcomingTransactionStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/enums/transaction-type-enum/index.html b/api-reference/enums/transaction-type-enum/index.html index c434c80fb28..ac072ec4a42 100644 --- a/api-reference/enums/transaction-type-enum/index.html +++ b/api-reference/enums/transaction-type-enum/index.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@ When an International Credit Transfer debited a Swan account.

TransactionTypeEnum.InternationalCreditTransferInReturn​

COMING SOON When an International Credit Transfer credited a Swan account and Swan or the Swan debtor returned the funds.

TransactionTypeEnum.InternationalCreditTransferOutReturn​

COMING SOON When an International Credit Transfer debited a Swan account and Swan or the Swan debtor returned it.

Member of​

CardTransaction object ● CheckTransaction object ● FeeTransaction object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● InternationalCreditTransferTransaction object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object ● Transaction interface ● TransactionsFiltersInput input

- + \ No newline at end of file diff --git a/api-reference/enums/transactions-order-by-field/index.html b/api-reference/enums/transactions-order-by-field/index.html index 2575ce61305..f3d14f2d5c7 100644 --- a/api-reference/enums/transactions-order-by-field/index.html +++ b/api-reference/enums/transactions-order-by-field/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/type-of-representation/index.html b/api-reference/enums/type-of-representation/index.html index 2b9376c8397..36b01b4bfc5 100644 --- a/api-reference/enums/type-of-representation/index.html +++ b/api-reference/enums/type-of-representation/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/ultimate-beneficial-owner-type/index.html b/api-reference/enums/ultimate-beneficial-owner-type/index.html index 320ce7ec375..16b5a460fa1 100644 --- a/api-reference/enums/ultimate-beneficial-owner-type/index.html +++ b/api-reference/enums/ultimate-beneficial-owner-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UltimateBeneficialOwnerType

Ultimate Beneficial Owner type.

enum UltimateBeneficialOwnerType {
  DirectIndividual
  DirectCompany
  IndirectIndividual
  IndirectCompany
}

Values​

UltimateBeneficialOwnerType.DirectIndividual​

Direct Individual Owner (Natural person) .

UltimateBeneficialOwnerType.DirectCompany​

Direct Company Owner (Legal person).

UltimateBeneficialOwnerType.IndirectIndividual​

Indirect Individual Owner (Natural person).

UltimateBeneficialOwnerType.IndirectCompany​

Indirect Company Owner (Legal person).

Member of​

UltimateBeneficialDirectOwnerCompanyInfo object ● UltimateBeneficialDirectOwnerIndividualInfo object ● UltimateBeneficialIndirectOwnerCompanyInfo object ● UltimateBeneficialIndirectOwnerIndividualInfo object ● UltimateBeneficialOwnerInfo interface

- + \ No newline at end of file diff --git a/api-reference/enums/user-order-by-field-input/index.html b/api-reference/enums/user-order-by-field-input/index.html index a8c133a0ad0..fc56eff24eb 100644 --- a/api-reference/enums/user-order-by-field-input/index.html +++ b/api-reference/enums/user-order-by-field-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/validation-field-error-code/index.html b/api-reference/enums/validation-field-error-code/index.html index a1c9ea52dad..cb1510ec071 100644 --- a/api-reference/enums/validation-field-error-code/index.html +++ b/api-reference/enums/validation-field-error-code/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/verification-flow/index.html b/api-reference/enums/verification-flow/index.html index a951fd09582..6ed15247fb3 100644 --- a/api-reference/enums/verification-flow/index.html +++ b/api-reference/enums/verification-flow/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/enums/verification-status/index.html b/api-reference/enums/verification-status/index.html index 09bb3f7db58..bf1e77752a4 100644 --- a/api-reference/enums/verification-status/index.html +++ b/api-reference/enums/verification-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

VerificationStatus

Verification status of an account holder

enum VerificationStatus {
  NotStarted
  WaitingForInformation
  Pending
  Verified
  Refused
}

Values​

VerificationStatus.NotStarted​

When the account holder has not started to answer the verification process.

VerificationStatus.WaitingForInformation​

When Swan is waiting for information about the account holder to continue the verification process.

VerificationStatus.Pending​

When the verification process is pending.

VerificationStatus.Verified​

When the account holder is verified.

VerificationStatus.Refused​

When the account holder is refused.

Member of​

AccountHolder object ● AccountHolderFilterInput input

- + \ No newline at end of file diff --git a/api-reference/enums/wallet-provider-type/index.html b/api-reference/enums/wallet-provider-type/index.html index bacc2db96ea..f65a78b876b 100644 --- a/api-reference/enums/wallet-provider-type/index.html +++ b/api-reference/enums/wallet-provider-type/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/index.html b/api-reference/index.html index 745df160f00..a2565db43e9 100644 --- a/api-reference/index.html +++ b/api-reference/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Schema Documentation

This documentation has been automatically generated from the GraphQL schema.

Use the docs in the sidebar to find out how to use the schema:

  • Allowed operations: queries and mutations.
  • Schema-defined types: scalars, objects, enums, interfaces, unions, and input objects.
Generated on 12/5/2023, 12:17:51 AM.
- +
Skip to main content

Schema Documentation

This documentation has been automatically generated from the GraphQL schema.

Use the docs in the sidebar to find out how to use the schema:

  • Allowed operations: queries and mutations.
  • Schema-defined types: scalars, objects, enums, interfaces, unions, and input objects.
Generated on 12/6/2023, 12:18:01 AM.
+ \ No newline at end of file diff --git a/api-reference/inputs/account-filter-input/index.html b/api-reference/inputs/account-filter-input/index.html index 436e591d81c..313aa3ba5ad 100644 --- a/api-reference/inputs/account-filter-input/index.html +++ b/api-reference/inputs/account-filter-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/account-holder-filter-input/index.html b/api-reference/inputs/account-holder-filter-input/index.html index 682a4cafc40..224ce01e378 100644 --- a/api-reference/inputs/account-holder-filter-input/index.html +++ b/api-reference/inputs/account-holder-filter-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountHolderFilterInput

No description

input AccountHolderFilterInput {
  status: [AccountHolderStatus!]
  types: [AccountHolderType!]
  verificationStatus: [VerificationStatus!]
  search: String
  firstName: String
  lastName: String
  birthDate: String
  registrationNumber: String
}

Fields​

AccountHolderFilterInput.status ● [AccountHolderStatus!] list enum​

AccountHolderFilterInput.types ● [AccountHolderType!] list enum​

AccountHolderFilterInput.verificationStatus ● [VerificationStatus!] list enum​

AccountHolderFilterInput.search ● String scalar​

Searches company name, first name, last name

AccountHolderFilterInput.firstName ● String scalar​

AccountHolderFilterInput.lastName ● String scalar​

AccountHolderFilterInput.birthDate ● String scalar​

AccountHolderFilterInput.registrationNumber ● String scalar​

Member of​

accountHolders query

- + \ No newline at end of file diff --git a/api-reference/inputs/account-holder-order-by-input/index.html b/api-reference/inputs/account-holder-order-by-input/index.html index 5f5ac627eb5..0845e9f9916 100644 --- a/api-reference/inputs/account-holder-order-by-input/index.html +++ b/api-reference/inputs/account-holder-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/account-membership-order-by-input/index.html b/api-reference/inputs/account-membership-order-by-input/index.html index 40694575359..56d8b33f68c 100644 --- a/api-reference/inputs/account-membership-order-by-input/index.html +++ b/api-reference/inputs/account-membership-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/account-memberships-filter-input/index.html b/api-reference/inputs/account-memberships-filter-input/index.html index 2591ee891f3..0c7875c15b4 100644 --- a/api-reference/inputs/account-memberships-filter-input/index.html +++ b/api-reference/inputs/account-memberships-filter-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipsFilterInput

Filters that can be applied when listing accounts (Only applied in user context)

input AccountMembershipsFilterInput {
  canManageCards: Boolean
  canInitiatePayments: Boolean
  canManageAccountMembership: Boolean
  canManageBeneficiaries: Boolean
  canViewAccount: Boolean
  status: [AccountMembershipStatus!]
  email: String
  firstName: String
  lastName: String
  search: String
}

Fields​

AccountMembershipsFilterInput.canManageCards ● Boolean scalar​

true if this account membership can manage cards for himself or to the memberships he manages

AccountMembershipsFilterInput.canInitiatePayments ● Boolean scalar​

Can the user initiate payments on this account

AccountMembershipsFilterInput.canManageAccountMembership ● Boolean scalar​

Can the user manage account membership

AccountMembershipsFilterInput.canManageBeneficiaries ● Boolean scalar​

Can the user manage beneficiaries

AccountMembershipsFilterInput.canViewAccount ● Boolean scalar​

Can the user view account

AccountMembershipsFilterInput.status ● [AccountMembershipStatus!] list enum​

Account memberships status/statuses we're looking for

AccountMembershipsFilterInput.email ● String scalar​

Filtered by email

AccountMembershipsFilterInput.firstName ● String scalar​

Filtered by first name

AccountMembershipsFilterInput.lastName ● String scalar​

Filtered by last name

AccountMembershipsFilterInput.search ● String scalar​

Searches email, first name, last name, and id

Member of​

accountMemberships query

- + \ No newline at end of file diff --git a/api-reference/inputs/account-order-by-input/index.html b/api-reference/inputs/account-order-by-input/index.html index 72f42ab1bb6..5718b34da4c 100644 --- a/api-reference/inputs/account-order-by-input/index.html +++ b/api-reference/inputs/account-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/account-received-direct-debit-mandate-filters-input/index.html b/api-reference/inputs/account-received-direct-debit-mandate-filters-input/index.html index c2074d7752e..ef329326b13 100644 --- a/api-reference/inputs/account-received-direct-debit-mandate-filters-input/index.html +++ b/api-reference/inputs/account-received-direct-debit-mandate-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountReceivedDirectDebitMandateFiltersInput

Filter that can be passed to get the received direct debit mandate in a specific data range

input AccountReceivedDirectDebitMandateFiltersInput {
  status: [ReceivedDirectDebitMandateStatus!]
  scheme: [ReceivedDirectDebitMandateScheme!]
}

Fields​

AccountReceivedDirectDebitMandateFiltersInput.status ● [ReceivedDirectDebitMandateStatus!] list enum​

To filter on status values

AccountReceivedDirectDebitMandateFiltersInput.scheme ● [ReceivedDirectDebitMandateScheme!] list enum​

To filter on scheme values

- + \ No newline at end of file diff --git a/api-reference/inputs/account-received-direct-debit-order-by-input/index.html b/api-reference/inputs/account-received-direct-debit-order-by-input/index.html index 873bfc5969c..5a88c13a27b 100644 --- a/api-reference/inputs/account-received-direct-debit-order-by-input/index.html +++ b/api-reference/inputs/account-received-direct-debit-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/account-standing-order-filters-input/index.html b/api-reference/inputs/account-standing-order-filters-input/index.html index 1135fb50a4d..1a70bd2ce02 100644 --- a/api-reference/inputs/account-standing-order-filters-input/index.html +++ b/api-reference/inputs/account-standing-order-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/account-standing-order-order-by-input/index.html b/api-reference/inputs/account-standing-order-order-by-input/index.html index bdb99f4fd22..1f5d1200da9 100644 --- a/api-reference/inputs/account-standing-order-order-by-input/index.html +++ b/api-reference/inputs/account-standing-order-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/activate-physical-card-input/index.html b/api-reference/inputs/activate-physical-card-input/index.html index 97a4922e610..227237f1001 100644 --- a/api-reference/inputs/activate-physical-card-input/index.html +++ b/api-reference/inputs/activate-physical-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/add-account-membership-input/index.html b/api-reference/inputs/add-account-membership-input/index.html index 7eea5ef0cf0..23782768f9f 100644 --- a/api-reference/inputs/add-account-membership-input/index.html +++ b/api-reference/inputs/add-account-membership-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddAccountMembershipInput

Inputs to add a new account membership

input AddAccountMembershipInput {
  accountId: ID!
  email: String!
  restrictedTo: RestrictedToInput!
  canViewAccount: Boolean!
  canManageBeneficiaries: Boolean!
  canInitiatePayments: Boolean!
  canManageAccountMembership: Boolean!
  canManageCards: Boolean
  consentRedirectUrl: String!
  residencyAddress: ResidencyAddressInput
  taxIdentificationNumber: String
}

Fields​

AddAccountMembershipInput.accountId ● ID! non-null scalar​

Unique identifier of a given account

AddAccountMembershipInput.email ● String! non-null scalar​

Email address

AddAccountMembershipInput.restrictedTo ● RestrictedToInput! non-null input​

Restricted to a user if necessary

AddAccountMembershipInput.canViewAccount ● Boolean! non-null scalar​

true if this account membership can view account balances and transactions history

AddAccountMembershipInput.canManageBeneficiaries ● Boolean! non-null scalar​

true if this account membership can add or canceled beneficiaries

AddAccountMembershipInput.canInitiatePayments ● Boolean! non-null scalar​

true if this account membership can initiate payments

AddAccountMembershipInput.canManageAccountMembership ● Boolean! non-null scalar​

true if this account membership can invite, update, suspend or resume account membership

AddAccountMembershipInput.canManageCards ● Boolean scalar​

true if this account membership can manage cards for himself or to the memberships he manages

AddAccountMembershipInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

AddAccountMembershipInput.residencyAddress ● ResidencyAddressInput input​

Residency address of the member to be added

AddAccountMembershipInput.taxIdentificationNumber ● String scalar​

Tax Identification Number of the user added

Member of​

addAccountMembership mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-account-memberships-input/index.html b/api-reference/inputs/add-account-memberships-input/index.html index 502e5ab31c2..8994e6c5535 100644 --- a/api-reference/inputs/add-account-memberships-input/index.html +++ b/api-reference/inputs/add-account-memberships-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddAccountMembershipsInput

Inputs to add a new account membership

input AddAccountMembershipsInput {
  accountId: ID!
  memberships: [MembershipInfoInput!]!
  consentRedirectUrl: String!
}

Fields​

AddAccountMembershipsInput.accountId ● ID! non-null scalar​

Unique identifier of a given account

AddAccountMembershipsInput.memberships ● [MembershipInfoInput!]! non-null input​

Memberships to add to the account

AddAccountMembershipsInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

Member of​

addAccountMemberships mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-card-input/index.html b/api-reference/inputs/add-card-input/index.html index cd87afecea2..0f221ae1bb5 100644 --- a/api-reference/inputs/add-card-input/index.html +++ b/api-reference/inputs/add-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddCardInput

Inputs to add a new card

input AddCardInput {
  accountMembershipId: ID!
  cardContractExpiryDate: DateTime
  withdrawal: Boolean!
  international: Boolean!
  nonMainCurrencyTransactions: Boolean!
  eCommerce: Boolean!
  consentRedirectUrl: String!
  name: String
  viewCardNumber: Boolean
  cardProductId: ID
  spendingLimit: SpendingLimitInput
}

Fields​

AddCardInput.accountMembershipId ● ID! non-null scalar​

Unique identifier of a given account membership

AddCardInput.cardContractExpiryDate ● DateTime scalar​

Card expiration date if null it does not have an expiration date

AddCardInput.withdrawal ● Boolean! non-null scalar​

true if this card allows cash withdrawals

AddCardInput.international ● Boolean! non-null scalar​

true if this card allows payments outside of the country

AddCardInput.nonMainCurrencyTransactions ● Boolean! non-null scalar​

true if this card allows transactions outside of the card's main currency

AddCardInput.eCommerce ● Boolean! non-null scalar​

true if this card allows transactions at eCommerce sites

AddCardInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

AddCardInput.name ● String scalar​

Card name

AddCardInput.viewCardNumber ● Boolean scalar​

true to show the card confidential information in the same request

AddCardInput.cardProductId ● ID scalar​

The id of the card product to use to create the new card.

AddCardInput.spendingLimit ● SpendingLimitInput input​

Spending limit

Member of​

addCard mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-cards-input/index.html b/api-reference/inputs/add-cards-input/index.html index bf2c5c3a2e3..7cf8f3a54d6 100644 --- a/api-reference/inputs/add-cards-input/index.html +++ b/api-reference/inputs/add-cards-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddCardsInput

Input to add a new cards

input AddCardsInput {
  cards: [CardConfigInput!]!
  consentRedirectUrl: String!
  cardProductId: ID
}

Fields​

AddCardsInput.cards ● [CardConfigInput!]! non-null input​

The configuration of all the cards you want to add

AddCardsInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

AddCardsInput.cardProductId ● ID scalar​

The id of the card product to use to create the new cards.

Member of​

addCards mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-cards-with-group-delivery-input/index.html b/api-reference/inputs/add-cards-with-group-delivery-input/index.html index 706eca57137..6a981a89f1f 100644 --- a/api-reference/inputs/add-cards-with-group-delivery-input/index.html +++ b/api-reference/inputs/add-cards-with-group-delivery-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddCardsWithGroupDeliveryInput

Input to add a new cards

input AddCardsWithGroupDeliveryInput {
  groupDeliveryAddress: CompleteAddressWithContactInput!
  cards: [CardConfigWithGroupDeliveryInput!]!
  consentRedirectUrl: String!
  cardProductId: ID
}

Fields​

AddCardsWithGroupDeliveryInput.groupDeliveryAddress ● CompleteAddressWithContactInput! non-null input​

Address to deliver the printed physical cards

AddCardsWithGroupDeliveryInput.cards ● [CardConfigWithGroupDeliveryInput!]! non-null input​

The configuration of all the cards you want to add

AddCardsWithGroupDeliveryInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

AddCardsWithGroupDeliveryInput.cardProductId ● ID scalar​

The id of the card product to use to create the new cards.

Member of​

addCardsWithGroupDelivery mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-digital-card-input/index.html b/api-reference/inputs/add-digital-card-input/index.html index e4a21ea267a..a50e094aa56 100644 --- a/api-reference/inputs/add-digital-card-input/index.html +++ b/api-reference/inputs/add-digital-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddDigitalCardInput

Inputs to add a new digital card

input AddDigitalCardInput {
  cardId: ID!
  walletProvider: WalletProviderType!
  consentRedirectUrl: String!
}

Fields​

AddDigitalCardInput.cardId ● ID! non-null scalar​

Unique identifier of a card

AddDigitalCardInput.walletProvider ● WalletProviderType! non-null enum​

Provider for which to generate a digitalCard

AddDigitalCardInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

Member of​

addDigitalCard mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-direct-debit-funding-source-input/index.html b/api-reference/inputs/add-direct-debit-funding-source-input/index.html index dafbd8ff2c6..de1700d4066 100644 --- a/api-reference/inputs/add-direct-debit-funding-source-input/index.html +++ b/api-reference/inputs/add-direct-debit-funding-source-input/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

AddDirectDebitFundingSourceInput

Input to add a Direct Debit Funding Source

input AddDirectDebitFundingSourceInput {
  scheme: SEPADirectDebitScheme!
  accountId: ID!
  iban: IBAN!
  consentRedirectUrl: String!
  name: String
}

Fields​

AddDirectDebitFundingSourceInput.scheme ● SEPADirectDebitScheme! non-null enum​

Scheme of the underlying payment mandate

AddDirectDebitFundingSourceInput.accountId ● ID! non-null scalar​

Id of the account on which to create a funding source. Money will be funded to this account when an initiateFundingRequest is done using this funding source

AddDirectDebitFundingSourceInput.iban ● IBAN! non-null scalar​

IBAN to use in the direct debit transaction that will be triggered when funding the account. Money will be debited from this IBAN when an initiateFundingRequest is done using this funding source

AddDirectDebitFundingSourceInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

AddDirectDebitFundingSourceInput.name ● String scalar​

Name to give to this funding source

Member of​

addDirectDebitFundingSource mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-external-account-balance-input/index.html b/api-reference/inputs/add-external-account-balance-input/index.html index 9784f6e2bab..07c499f635b 100644 --- a/api-reference/inputs/add-external-account-balance-input/index.html +++ b/api-reference/inputs/add-external-account-balance-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddExternalAccountBalanceInput

No description

input AddExternalAccountBalanceInput {
  externalAccountId: ID!
  amount: AmountInput!
  type: ExternalAccountBalanceType!
  lastChangedAt: DateTime!
}

Fields​

AddExternalAccountBalanceInput.externalAccountId ● ID! non-null scalar​

Unique identifier of a given external account

AddExternalAccountBalanceInput.amount ● AmountInput! non-null input​

Amount of the balance

AddExternalAccountBalanceInput.type ● ExternalAccountBalanceType! non-null enum​

Type of the balance

AddExternalAccountBalanceInput.lastChangedAt ● DateTime! non-null scalar​

Last changed Date

Member of​

addExternalAccountBalance mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-external-account-input/index.html b/api-reference/inputs/add-external-account-input/index.html index 204e30036ee..7082228f86a 100644 --- a/api-reference/inputs/add-external-account-input/index.html +++ b/api-reference/inputs/add-external-account-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddExternalAccountInput

No description

input AddExternalAccountInput {
  accountHolderId: ID!
  externalId: String!
  name: String
  cashAccountType: CashAccountType!
  BIC: BIC!
  IBAN: IBAN!
  currency: Currency!
  holderName: String!
  country: CCA3!
  originalCreatedAt: DateTime!
  usage: ExternalAccountUsage!
  source: String!
  balances: [ExternalAccountBalanceInput!]
}

Fields​

AddExternalAccountInput.accountHolderId ● ID! non-null scalar​

Unique identifier of a given account holder

AddExternalAccountInput.externalId ● String! non-null scalar​

External account identifier

AddExternalAccountInput.name ● String scalar​

Name of the account

AddExternalAccountInput.cashAccountType ● CashAccountType! non-null enum​

Type of account

AddExternalAccountInput.BIC ● BIC! non-null scalar​

Bank Identifier Code

AddExternalAccountInput.IBAN ● IBAN! non-null scalar​

International Bank Account Number

AddExternalAccountInput.currency ● Currency! non-null scalar​

Currency

AddExternalAccountInput.holderName ● String! non-null scalar​

Account Holder name

AddExternalAccountInput.country ● CCA3! non-null scalar​

Country

AddExternalAccountInput.originalCreatedAt ● DateTime! non-null scalar​

Original Created date

AddExternalAccountInput.usage ● ExternalAccountUsage! non-null enum​

Usage information of the account

AddExternalAccountInput.source ● String! non-null scalar​

Source of the account information

AddExternalAccountInput.balances ● [ExternalAccountBalanceInput!] list input​

Balances

Member of​

addExternalAccount mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-funding-limit-settings-change-request-input/index.html b/api-reference/inputs/add-funding-limit-settings-change-request-input/index.html index c5c7826aed5..be7c0afd6dd 100644 --- a/api-reference/inputs/add-funding-limit-settings-change-request-input/index.html +++ b/api-reference/inputs/add-funding-limit-settings-change-request-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddFundingLimitSettingsChangeRequestInput

Inputs to add a new request for funding limit settings change

input AddFundingLimitSettingsChangeRequestInput {
  instantFundingLimit: FundingLimitAmountInput!
  fundingLimit: FundingLimitAmountInput!
  accountHolderId: ID!
}

Fields​

AddFundingLimitSettingsChangeRequestInput.instantFundingLimit ● FundingLimitAmountInput! non-null input​

Requested amount settings for the instant funding limit

AddFundingLimitSettingsChangeRequestInput.fundingLimit ● FundingLimitAmountInput! non-null input​

Requested amount settings for the funding limit

AddFundingLimitSettingsChangeRequestInput.accountHolderId ● ID! non-null scalar​

Unique identifier of a given account holder

Member of​

addFundingLimitSettingsChangeRequest mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-internal-direct-debit-payment-mandate-input/index.html b/api-reference/inputs/add-internal-direct-debit-payment-mandate-input/index.html index 232f2bc8021..59df547c73a 100644 --- a/api-reference/inputs/add-internal-direct-debit-payment-mandate-input/index.html +++ b/api-reference/inputs/add-internal-direct-debit-payment-mandate-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddInternalDirectDebitPaymentMandateInput

Inputs to add an Internal Direct Debit Payment Mandate

input AddInternalDirectDebitPaymentMandateInput {
  paymentMethodId: ID!
  sequence: InternalDirectDebitSequence
  reference: String
  language: MandateLanguage
  debtorAccountId: ID!
  signatureDate: Date
  name: String
}

Fields​

AddInternalDirectDebitPaymentMandateInput.paymentMethodId ● ID! non-null scalar​

The ID of the concerned merchant payment method

AddInternalDirectDebitPaymentMandateInput.sequence ● InternalDirectDebitSequence enum​

Determines whether the payment mandate is a one-off or recurring

AddInternalDirectDebitPaymentMandateInput.reference ● String scalar​

Reference of the payment mandate

AddInternalDirectDebitPaymentMandateInput.language ● MandateLanguage enum​

Language that will be used to produce the mandate PDF document

AddInternalDirectDebitPaymentMandateInput.debtorAccountId ● ID! non-null scalar​

ID of the Swan account of the debtor

AddInternalDirectDebitPaymentMandateInput.signatureDate ● Date scalar​

Signature date of the Internal Direct Debit mandate

AddInternalDirectDebitPaymentMandateInput.name ● String scalar​

Custom name of the Internal Direct Debit mandate

Member of​

addInternalDirectDebitPaymentMandate mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-merchant-profile-input/index.html b/api-reference/inputs/add-merchant-profile-input/index.html index 2ab79606f3f..163c46c6db6 100644 --- a/api-reference/inputs/add-merchant-profile-input/index.html +++ b/api-reference/inputs/add-merchant-profile-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddMerchantProfileInput

Input to add a Merchant Profile

input AddMerchantProfileInput {
  accountId: ID!
  merchantName: String!
  merchantWebsite: String
  merchantLogo: String
  productType: ProductType!
  expectedMonthlyPaymentVolume: AmountInput!
  expectedAverageBasket: AmountInput!
}

Fields​

AddMerchantProfileInput.accountId ● ID! non-null scalar​

ID of the Swan account which the merchantProfile is associated to

AddMerchantProfileInput.merchantName ● String! non-null scalar​

Business name of the merchant, i.e. name that will be displayed on debtors' bank statements

AddMerchantProfileInput.merchantWebsite ● String scalar​

Url of the merchant's website

AddMerchantProfileInput.merchantLogo ● String scalar​

base64 encoded merchant's logo

AddMerchantProfileInput.productType ● ProductType! non-null enum​

Type of product sold. Gifts and donations can be club subscription or collection of donations (for associations), tips collection, contributions for local authorities

AddMerchantProfileInput.expectedMonthlyPaymentVolume ● AmountInput! non-null input​

Expected annual activity volumes for all payment methods.

AddMerchantProfileInput.expectedAverageBasket ● AmountInput! non-null input​

expected average basket value.

Member of​

addMerchantProfile mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-or-update-external-account-balance-input/index.html b/api-reference/inputs/add-or-update-external-account-balance-input/index.html index 13edc513fd2..dece367ba39 100644 --- a/api-reference/inputs/add-or-update-external-account-balance-input/index.html +++ b/api-reference/inputs/add-or-update-external-account-balance-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddOrUpdateExternalAccountBalanceInput

No description

input AddOrUpdateExternalAccountBalanceInput {
  externalAccountId: ID!
  amount: AmountInput!
  type: ExternalAccountBalanceType!
  lastChangedAt: DateTime!
}

Fields​

AddOrUpdateExternalAccountBalanceInput.externalAccountId ● ID! non-null scalar​

Unique identifier of a given external account

AddOrUpdateExternalAccountBalanceInput.amount ● AmountInput! non-null input​

Amount of the balance

AddOrUpdateExternalAccountBalanceInput.type ● ExternalAccountBalanceType! non-null enum​

Type of the balance

AddOrUpdateExternalAccountBalanceInput.lastChangedAt ● DateTime! non-null scalar​

Last changed Date

Member of​

addOrUpdateExternalAccountBalance mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-received-internal-direct-debit-b2-b-mandate-input/index.html b/api-reference/inputs/add-received-internal-direct-debit-b2-b-mandate-input/index.html index 0f92860e2db..3bf1f74dcc7 100644 --- a/api-reference/inputs/add-received-internal-direct-debit-b2-b-mandate-input/index.html +++ b/api-reference/inputs/add-received-internal-direct-debit-b2-b-mandate-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddReceivedInternalDirectDebitB2bMandateInput

Inputs to add a received internal direct debit mandate B2b.

input AddReceivedInternalDirectDebitB2bMandateInput {
  paymentMandateId: ID!
  consentRedirectUrl: String!
  name: String
}

Fields​

AddReceivedInternalDirectDebitB2bMandateInput.paymentMandateId ● ID! non-null scalar​

The associated Payment Mandate ID

AddReceivedInternalDirectDebitB2bMandateInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

AddReceivedInternalDirectDebitB2bMandateInput.name ● String scalar​

Label that will be displayed along with this received direct debit mandate in the web banking

Member of​

addReceivedInternalDirectDebitB2bMandate mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-received-sepa-direct-debit-b2-b-mandate-input/index.html b/api-reference/inputs/add-received-sepa-direct-debit-b2-b-mandate-input/index.html index e1f56c0650d..915d1bf3651 100644 --- a/api-reference/inputs/add-received-sepa-direct-debit-b2-b-mandate-input/index.html +++ b/api-reference/inputs/add-received-sepa-direct-debit-b2-b-mandate-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddReceivedSepaDirectDebitB2bMandateInput

Inputs to add a received sepa direct debit mandate B2b.

input AddReceivedSepaDirectDebitB2bMandateInput {
  mandateReference: String!
  creditorIdentifier: String!
  creditorName: String!
  iban: String!
  name: String
  sequence: SEPAReceivedDirectDebitMandateSequence!
  signatureDate: Date
  consentRedirectUrl: String!
}

Fields​

AddReceivedSepaDirectDebitB2bMandateInput.mandateReference ● String! non-null scalar​

The unique identifier of the received direct debit mandate

AddReceivedSepaDirectDebitB2bMandateInput.creditorIdentifier ● String! non-null scalar​

The Sepa Creditor Identifier of the creditor

AddReceivedSepaDirectDebitB2bMandateInput.creditorName ● String! non-null scalar​

The name of the creditor

AddReceivedSepaDirectDebitB2bMandateInput.iban ● String! non-null scalar​

The Swan Iban of the debtor

AddReceivedSepaDirectDebitB2bMandateInput.name ● String scalar​

Label that will be displayed along with this received direct debit mandate in the web banking

AddReceivedSepaDirectDebitB2bMandateInput.sequence ● SEPAReceivedDirectDebitMandateSequence! non-null enum​

Sequence of the mandate

AddReceivedSepaDirectDebitB2bMandateInput.signatureDate ● Date scalar​

Date of signature of the mandate

AddReceivedSepaDirectDebitB2bMandateInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

Member of​

addReceivedSepaDirectDebitB2bMandate mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-sepa-direct-debit-payment-mandate-input/index.html b/api-reference/inputs/add-sepa-direct-debit-payment-mandate-input/index.html index 380a8a631cb..02b48f5e12b 100644 --- a/api-reference/inputs/add-sepa-direct-debit-payment-mandate-input/index.html +++ b/api-reference/inputs/add-sepa-direct-debit-payment-mandate-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddSepaDirectDebitPaymentMandateInput

No description

input AddSepaDirectDebitPaymentMandateInput {
  paymentMethodId: ID!
  sequence: DirectDebitSequence!
  reference: String
  language: MandateLanguage!
  signatureDate: Date!
  debtor: SepaPaymentMandateDebtorInput!
  name: String
}

Fields​

AddSepaDirectDebitPaymentMandateInput.paymentMethodId ● ID! non-null scalar​

Specifies payment ID of a SEPA Direct Debit CORE or B2B payment method.

AddSepaDirectDebitPaymentMandateInput.sequence ● DirectDebitSequence! non-null enum​

Determines whether the payment mandate is a one-off or recurring

AddSepaDirectDebitPaymentMandateInput.reference ● String scalar​

Unique reference of the SEPA Direct Debit Payment Mandate.

AddSepaDirectDebitPaymentMandateInput.language ● MandateLanguage! non-null enum​

Language that will be used to produce the mandate PDF document

AddSepaDirectDebitPaymentMandateInput.signatureDate ● Date! non-null scalar​

Signature date of the SEPA Direct Debit Payment Mandate

AddSepaDirectDebitPaymentMandateInput.debtor ● SepaPaymentMandateDebtorInput! non-null input​

Debtor of the SEPA Direct Debit Payment Mandate

AddSepaDirectDebitPaymentMandateInput.name ● String scalar​

Custom name of the SEPA Direct Debit Payment Mandate

Member of​

addSepaDirectDebitPaymentMandate mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-single-use-virtual-card-input/index.html b/api-reference/inputs/add-single-use-virtual-card-input/index.html index 518b22cf785..65b9aefab7c 100644 --- a/api-reference/inputs/add-single-use-virtual-card-input/index.html +++ b/api-reference/inputs/add-single-use-virtual-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddSingleUseVirtualCardInput

Inputs to add a new card

input AddSingleUseVirtualCardInput {
  accountMembershipId: ID!
  spendingLimit: SpendingLimitInput!
  consentRedirectUrl: String!
  name: String
  viewCardNumber: Boolean
  cardProductId: ID
}

Fields​

AddSingleUseVirtualCardInput.accountMembershipId ● ID! non-null scalar​

Unique identifier of a given account membership

AddSingleUseVirtualCardInput.spendingLimit ● SpendingLimitInput! non-null input​

Spending limit

AddSingleUseVirtualCardInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

AddSingleUseVirtualCardInput.name ● String scalar​

Card name

AddSingleUseVirtualCardInput.viewCardNumber ● Boolean scalar​

true to show the card confidential information in the same request

AddSingleUseVirtualCardInput.cardProductId ● ID scalar​

The id of the card product to use to create the new card.

Member of​

addSingleUseVirtualCard mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-single-use-virtual-cards-input/index.html b/api-reference/inputs/add-single-use-virtual-cards-input/index.html index 16745b84e49..e15638e4b11 100644 --- a/api-reference/inputs/add-single-use-virtual-cards-input/index.html +++ b/api-reference/inputs/add-single-use-virtual-cards-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddSingleUseVirtualCardsInput

Input to add a new single-use virtual cards

input AddSingleUseVirtualCardsInput {
  cards: [SingleUseVirtualCardConfigInput!]!
  consentRedirectUrl: String!
  cardProductId: ID
}

Fields​

AddSingleUseVirtualCardsInput.cards ● [SingleUseVirtualCardConfigInput!]! non-null input​

The configuration of all the cards you want to add

AddSingleUseVirtualCardsInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

AddSingleUseVirtualCardsInput.cardProductId ● ID scalar​

The id of the card product to use to create the new cards.

Member of​

addSingleUseVirtualCards mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/add-virtual-iban-input/index.html b/api-reference/inputs/add-virtual-iban-input/index.html index ade0fecadbb..720ccea5526 100644 --- a/api-reference/inputs/add-virtual-iban-input/index.html +++ b/api-reference/inputs/add-virtual-iban-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/address-information-input/index.html b/api-reference/inputs/address-information-input/index.html index 0ef0f810823..ca0c75994b8 100644 --- a/api-reference/inputs/address-information-input/index.html +++ b/api-reference/inputs/address-information-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddressInformationInput

Address

input AddressInformationInput {
  addressLine1: String!
  addressLine2: String
  city: String!
  country: CCA3!
  postalCode: String!
  state: String
}

Fields​

AddressInformationInput.addressLine1 ● String! non-null scalar​

Address

AddressInformationInput.addressLine2 ● String scalar​

Address

AddressInformationInput.city ● String! non-null scalar​

City

AddressInformationInput.country ● CCA3! non-null scalar​

Country

AddressInformationInput.postalCode ● String! non-null scalar​

Postal code

AddressInformationInput.state ● String scalar​

State

Member of​

IndividualUltimateBeneficialOwnerInput input ● OnboardCompanyAccountHolderInput input ● UpdateCompanyOnboardingInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/address-input/index.html b/api-reference/inputs/address-input/index.html index 5641df5a59b..9ce8623828d 100644 --- a/api-reference/inputs/address-input/index.html +++ b/api-reference/inputs/address-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddressInput

Address Information

input AddressInput {
  addressLine1: String
  addressLine2: String
  city: String
  postalCode: String
  state: String
  country: CCA3!
}

Fields​

AddressInput.addressLine1 ● String scalar​

address line 1 (max 100 characters)

AddressInput.addressLine2 ● String scalar​

address line 2 (max 100 characters)

AddressInput.city ● String scalar​

city (max 100 characters)

AddressInput.postalCode ● String scalar​

postal code (max 10 characters)

AddressInput.state ● String scalar​

state (max 100 characters)

AddressInput.country ● CCA3! non-null scalar​

country code

Member of​

CreateMerchantPaymentLinkInput input ● SepaBeneficiaryInput input ● SepaPaymentMandateDebtorInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/allow-sdd-input/index.html b/api-reference/inputs/allow-sdd-input/index.html index 55029ebcdc9..bce76daae2f 100644 --- a/api-reference/inputs/allow-sdd-input/index.html +++ b/api-reference/inputs/allow-sdd-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/allow-sdd-virtual-iban-entry-input/index.html b/api-reference/inputs/allow-sdd-virtual-iban-entry-input/index.html index 26730b256e6..8d211b60adf 100644 --- a/api-reference/inputs/allow-sdd-virtual-iban-entry-input/index.html +++ b/api-reference/inputs/allow-sdd-virtual-iban-entry-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/amount-input/index.html b/api-reference/inputs/amount-input/index.html index 33361f8abad..21c5419a95e 100644 --- a/api-reference/inputs/amount-input/index.html +++ b/api-reference/inputs/amount-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AmountInput

Amount with its currency

input AmountInput {
  value: AmountValue!
  currency: Currency!
}

Fields​

AmountInput.value ● AmountValue! non-null scalar​

value of the amount

AmountInput.currency ● Currency! non-null scalar​

currency

Member of​

AddExternalAccountBalanceInput input ● AddMerchantProfileInput input ● AddOrUpdateExternalAccountBalanceInput input ● CreateCapitalDepositCaseInput input ● CreateMerchantPaymentLinkInput input ● CreditTransferInput input ● ExternalAccountBalanceInput input ● FundingLimitAmountInput input ● InitiateFundingRequestInput input ● InitiateInternationalCreditTransferInput input ● InitiateMerchantPaymentCollectionInput input ● internationalBeneficiaryDynamicForms query ● internationalCreditTransferQuote query ● internationalCreditTransferTransactionDetailsDynamicForm query ● OnboardCompanyShareholderInput input ● OnboardIndividualShareholderInput input ● RefundTransaction input ● RequestMerchantProfileUpdateInput input ● ScheduleStandingOrderInput input ● SpendingLimitInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/bind-account-membership-input/index.html b/api-reference/inputs/bind-account-membership-input/index.html index f4c3cbde7ac..218bacfddae 100644 --- a/api-reference/inputs/bind-account-membership-input/index.html +++ b/api-reference/inputs/bind-account-membership-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/cancel-card-input/index.html b/api-reference/inputs/cancel-card-input/index.html index 3c098738a63..e5e9c502f86 100644 --- a/api-reference/inputs/cancel-card-input/index.html +++ b/api-reference/inputs/cancel-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/cancel-consent-input/index.html b/api-reference/inputs/cancel-consent-input/index.html index 87bee388190..eb2b0ddd0f3 100644 --- a/api-reference/inputs/cancel-consent-input/index.html +++ b/api-reference/inputs/cancel-consent-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/cancel-digital-card-input/index.html b/api-reference/inputs/cancel-digital-card-input/index.html index 925ccb54a15..ac1e6665aeb 100644 --- a/api-reference/inputs/cancel-digital-card-input/index.html +++ b/api-reference/inputs/cancel-digital-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/cancel-funding-source-input/index.html b/api-reference/inputs/cancel-funding-source-input/index.html index b57550c3955..27fa222a697 100644 --- a/api-reference/inputs/cancel-funding-source-input/index.html +++ b/api-reference/inputs/cancel-funding-source-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/cancel-physical-card-input/index.html b/api-reference/inputs/cancel-physical-card-input/index.html index 3c869c39fb1..09edfc5bb84 100644 --- a/api-reference/inputs/cancel-physical-card-input/index.html +++ b/api-reference/inputs/cancel-physical-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/cancel-standing-order-input/index.html b/api-reference/inputs/cancel-standing-order-input/index.html index 833cb88f4a1..952449977fc 100644 --- a/api-reference/inputs/cancel-standing-order-input/index.html +++ b/api-reference/inputs/cancel-standing-order-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/cancel-transaction-input/index.html b/api-reference/inputs/cancel-transaction-input/index.html index 26c14e69187..b6f345ff155 100644 --- a/api-reference/inputs/cancel-transaction-input/index.html +++ b/api-reference/inputs/cancel-transaction-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/cancel-virtual-iban-entry-input/index.html b/api-reference/inputs/cancel-virtual-iban-entry-input/index.html index 644f0e9a57e..2674365b669 100644 --- a/api-reference/inputs/cancel-virtual-iban-entry-input/index.html +++ b/api-reference/inputs/cancel-virtual-iban-entry-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/capital-deposit-case-filters-input/index.html b/api-reference/inputs/capital-deposit-case-filters-input/index.html index a8c43509e0a..aecf78d4642 100644 --- a/api-reference/inputs/capital-deposit-case-filters-input/index.html +++ b/api-reference/inputs/capital-deposit-case-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositCaseFiltersInput

Filters that can be applied when listing capital deposit cases

input CapitalDepositCaseFiltersInput {
  search: String
  status: [CapitalDepositCaseStatus!]
}

Fields​

CapitalDepositCaseFiltersInput.search ● String scalar​

Searches company shareholder name, individual shareholder first name, last name, and id

CapitalDepositCaseFiltersInput.status ● [CapitalDepositCaseStatus!] list enum​

Status we want to filter on

Member of​

capitalDepositCases query

- + \ No newline at end of file diff --git a/api-reference/inputs/capital-deposit-case-order-by-input/index.html b/api-reference/inputs/capital-deposit-case-order-by-input/index.html index bf928529d72..e6d89e998f6 100644 --- a/api-reference/inputs/capital-deposit-case-order-by-input/index.html +++ b/api-reference/inputs/capital-deposit-case-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/card-config-input/index.html b/api-reference/inputs/card-config-input/index.html index d204801d426..11bd99a8d55 100644 --- a/api-reference/inputs/card-config-input/index.html +++ b/api-reference/inputs/card-config-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardConfigInput

No description

input CardConfigInput {
  accountMembershipId: ID!
  cardContractExpiryDate: DateTime
  withdrawal: Boolean!
  international: Boolean!
  nonMainCurrencyTransactions: Boolean!
  eCommerce: Boolean!
  name: String
  spendingLimit: SpendingLimitInput!
  physicalCard: PhysicalCardConfigInput
}

Fields​

CardConfigInput.accountMembershipId ● ID! non-null scalar​

Unique identifier of a given account membership

CardConfigInput.cardContractExpiryDate ● DateTime scalar​

Card expiration date if null it does not have an expiration date

CardConfigInput.withdrawal ● Boolean! non-null scalar​

true if this card allows cash withdrawals

CardConfigInput.international ● Boolean! non-null scalar​

true if this card allows payments outside of the country

CardConfigInput.nonMainCurrencyTransactions ● Boolean! non-null scalar​

true if this card allows transactions outside of the card's main currency

CardConfigInput.eCommerce ● Boolean! non-null scalar​

true if this card allows transactions at eCommerce sites

CardConfigInput.name ● String scalar​

Card name

CardConfigInput.spendingLimit ● SpendingLimitInput! non-null input​

Spending limit

CardConfigInput.physicalCard ● PhysicalCardConfigInput input​

If used a physical card will be printed and sent to the given address

Member of​

AddCardsInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/card-config-with-group-delivery-input/index.html b/api-reference/inputs/card-config-with-group-delivery-input/index.html index b20385f915e..6aae7e9f552 100644 --- a/api-reference/inputs/card-config-with-group-delivery-input/index.html +++ b/api-reference/inputs/card-config-with-group-delivery-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardConfigWithGroupDeliveryInput

No description

input CardConfigWithGroupDeliveryInput {
  accountMembershipId: ID!
  cardContractExpiryDate: DateTime
  withdrawal: Boolean!
  international: Boolean!
  nonMainCurrencyTransactions: Boolean!
  eCommerce: Boolean!
  name: String
  spendingLimit: SpendingLimitInput!
  printPhysicalCard: Boolean!
  physicalCardCustomOptions: PhysicalCardCustomOptionsForGroupDeliveryInput
}

Fields​

CardConfigWithGroupDeliveryInput.accountMembershipId ● ID! non-null scalar​

Unique identifier of a given account membership

CardConfigWithGroupDeliveryInput.cardContractExpiryDate ● DateTime scalar​

Card expiration date if null it does not have an expiration date

CardConfigWithGroupDeliveryInput.withdrawal ● Boolean! non-null scalar​

true if this card allows cash withdrawals

CardConfigWithGroupDeliveryInput.international ● Boolean! non-null scalar​

true if this card allows payments outside of the country

CardConfigWithGroupDeliveryInput.nonMainCurrencyTransactions ● Boolean! non-null scalar​

true if this card allows transactions outside of the card's main currency

CardConfigWithGroupDeliveryInput.eCommerce ● Boolean! non-null scalar​

true if this card allows transactions at eCommerce sites

CardConfigWithGroupDeliveryInput.name ● String scalar​

Card name

CardConfigWithGroupDeliveryInput.spendingLimit ● SpendingLimitInput! non-null input​

Spending limit

CardConfigWithGroupDeliveryInput.printPhysicalCard ● Boolean! non-null scalar​

true when you wish for print an associated physical card

CardConfigWithGroupDeliveryInput.physicalCardCustomOptions ● PhysicalCardCustomOptionsForGroupDeliveryInput input​

Custom options to use for physical cards.

Member of​

AddCardsWithGroupDeliveryInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/card-filters-input/index.html b/api-reference/inputs/card-filters-input/index.html index dd2ceb8be38..c35900c9376 100644 --- a/api-reference/inputs/card-filters-input/index.html +++ b/api-reference/inputs/card-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardFiltersInput

Filters that can be applied when listing cards

input CardFiltersInput {
  status: CardStatus
  statuses: [CardStatus!]
  type: CardType
  types: [CardType!]
  search: String
  accountId: String
}

Fields​

CardFiltersInput.status ● CardStatus enum​

The status of the card.

@deprecated(reason: "use statuses instead")

CardFiltersInput.statuses ● [CardStatus!] list enum​

Statuses of the card.

CardFiltersInput.type ● CardType enum​

Type of card

@deprecated(reason: "use types instead")

CardFiltersInput.types ● [CardType!] list enum​

Types of card

CardFiltersInput.search ● String scalar​

String searched

CardFiltersInput.accountId ● String scalar​

Account identifier

This filter is only available for User Access Token, for the moment

Member of​

cards query

- + \ No newline at end of file diff --git a/api-reference/inputs/card-order-by-input/index.html b/api-reference/inputs/card-order-by-input/index.html index e351f104e7b..57cd55771e9 100644 --- a/api-reference/inputs/card-order-by-input/index.html +++ b/api-reference/inputs/card-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/certificate/index.html b/api-reference/inputs/certificate/index.html index fa15e66c3eb..8cea37b79a2 100644 --- a/api-reference/inputs/certificate/index.html +++ b/api-reference/inputs/certificate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/check-payment-collection-input/index.html b/api-reference/inputs/check-payment-collection-input/index.html index 3bf1b35a49c..f2a132c1c27 100644 --- a/api-reference/inputs/check-payment-collection-input/index.html +++ b/api-reference/inputs/check-payment-collection-input/index.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@ CMC7 is composed of 3 sections (check number (7 char.), check issuing bank code (12 char.), check holder account number (12 char.)). Combined with RLMC key, it allows the check traceability.

CheckPaymentCollectionInput.rlmcKey ● String! non-null scalar​

2-digit key used to check the integrity of the CMC7 line, located at the bottom right of the check. Combined with CMC7 line, it allows the check traceability.

Member of​

InitiateMerchantPaymentCollectionInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/check-payment-method-input/index.html b/api-reference/inputs/check-payment-method-input/index.html index 9cdffcf39eb..b5c5791c99a 100644 --- a/api-reference/inputs/check-payment-method-input/index.html +++ b/api-reference/inputs/check-payment-method-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/close-account-input/index.html b/api-reference/inputs/close-account-input/index.html index ab7e5cb58e3..32ef02fd740 100644 --- a/api-reference/inputs/close-account-input/index.html +++ b/api-reference/inputs/close-account-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/complete-address-input/index.html b/api-reference/inputs/complete-address-input/index.html index 3db45dff4a9..439849196b2 100644 --- a/api-reference/inputs/complete-address-input/index.html +++ b/api-reference/inputs/complete-address-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CompleteAddressInput

Complete Address Information

input CompleteAddressInput {
  addressLine1: String!
  addressLine2: String
  city: String!
  postalCode: String!
  state: String
  country: CCA3!
}

Fields​

CompleteAddressInput.addressLine1 ● String! non-null scalar​

address line 1 (max 38 characters)

CompleteAddressInput.addressLine2 ● String scalar​

address line 2 (max 38 characters)

CompleteAddressInput.city ● String! non-null scalar​

city (max 30 characters)

CompleteAddressInput.postalCode ● String! non-null scalar​

postal code (max 10 characters)

CompleteAddressInput.state ● String scalar​

state (max 30 characters)

CompleteAddressInput.country ● CCA3! non-null scalar​

country code

Member of​

PhysicalCardConfigInput input ● PrintPhysicalCardInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/complete-address-with-contact-input/index.html b/api-reference/inputs/complete-address-with-contact-input/index.html index 92db011fa15..7ff7e882827 100644 --- a/api-reference/inputs/complete-address-with-contact-input/index.html +++ b/api-reference/inputs/complete-address-with-contact-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CompleteAddressWithContactInput

Complete Address Information with a contact

input CompleteAddressWithContactInput {
  addressLine1: String!
  addressLine2: String
  city: String!
  postalCode: String!
  state: String
  country: CCA3!
  firstName: String!
  lastName: String!
  phoneNumber: PhoneNumber!
  companyName: String
}

Fields​

CompleteAddressWithContactInput.addressLine1 ● String! non-null scalar​

address line 1 (max 38 characters)

CompleteAddressWithContactInput.addressLine2 ● String scalar​

address line 2 (max 38 characters)

CompleteAddressWithContactInput.city ● String! non-null scalar​

city (max 30 characters)

CompleteAddressWithContactInput.postalCode ● String! non-null scalar​

postal code (max 10 characters)

CompleteAddressWithContactInput.state ● String scalar​

state (max 30 characters)

CompleteAddressWithContactInput.country ● CCA3! non-null scalar​

country code

CompleteAddressWithContactInput.firstName ● String! non-null scalar​

contact first name

CompleteAddressWithContactInput.lastName ● String! non-null scalar​

contact last name

CompleteAddressWithContactInput.phoneNumber ● PhoneNumber! non-null scalar​

contact phone number

CompleteAddressWithContactInput.companyName ● String scalar​

contact company name (max 38 characters)

Member of​

AddCardsWithGroupDeliveryInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/consent-id-with-order/index.html b/api-reference/inputs/consent-id-with-order/index.html index f3f90b06565..84fcd92d71b 100644 --- a/api-reference/inputs/consent-id-with-order/index.html +++ b/api-reference/inputs/consent-id-with-order/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/consents-filters-input/index.html b/api-reference/inputs/consents-filters-input/index.html index 86cffadc79d..a1e3a21fcaf 100644 --- a/api-reference/inputs/consents-filters-input/index.html +++ b/api-reference/inputs/consents-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/create-capital-deposit-case-input/index.html b/api-reference/inputs/create-capital-deposit-case-input/index.html index ae701924f64..d9beeed2f20 100644 --- a/api-reference/inputs/create-capital-deposit-case-input/index.html +++ b/api-reference/inputs/create-capital-deposit-case-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CreateCapitalDepositCaseInput

Inputs to create a capital deposit case.

input CreateCapitalDepositCaseInput {
  companyName: String!
  companyShareholders: [OnboardCompanyShareholderInput]!
  individualShareholders: [OnboardIndividualShareholderInput]!
  totalCapitalDepositAmount: AmountInput!
  onboardingCapitalDepositCompany: OnboardCompanyAccountHolderInput!
}

Fields​

CreateCapitalDepositCaseInput.companyName ● String! non-null scalar​

Name ("Dénomination sociale") of the company being registered and for which the capital is being deposited.

CreateCapitalDepositCaseInput.companyShareholders ● [OnboardCompanyShareholderInput]! non-null input​

Array of shareholders of type company ("personne morale").

CreateCapitalDepositCaseInput.individualShareholders ● [OnboardIndividualShareholderInput]! non-null input​

Array of shareholders of type individual ("personne physique").

CreateCapitalDepositCaseInput.totalCapitalDepositAmount ● AmountInput! non-null input​

Amount of the capital deposit.

CreateCapitalDepositCaseInput.onboardingCapitalDepositCompany ● OnboardCompanyAccountHolderInput! non-null input​

Information required for the onboarding of a company.

Member of​

createCapitalDepositCase mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/create-merchant-payment-link-input/index.html b/api-reference/inputs/create-merchant-payment-link-input/index.html index ed759838188..5760867aa90 100644 --- a/api-reference/inputs/create-merchant-payment-link-input/index.html +++ b/api-reference/inputs/create-merchant-payment-link-input/index.html @@ -7,7 +7,7 @@ - + @@ -25,7 +25,7 @@ Keep in mind that your end customer will be able to edit these fields.

CreateMerchantPaymentLinkInput.paymentMethodIds ● [String!] list scalar​

List of payment methods enabled for this payment link. If the array is empty, Swan will allow all the payment methods that are enabled for the merchant profile (except for Check and Internal Direct Debit) If you want to make payment possible via SEPA Direct Debit, the list should be populated either by a SEPA Direct Debit CORE or B2B.

Member of​

createMerchantPaymentLink mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/create-multi-consent-input/index.html b/api-reference/inputs/create-multi-consent-input/index.html index 8583a01e926..e1b9e258404 100644 --- a/api-reference/inputs/create-multi-consent-input/index.html +++ b/api-reference/inputs/create-multi-consent-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CreateMultiConsentInput

Input of the createMultiConsent mutation

input CreateMultiConsentInput {
  orderedConsentIds: [ConsentIdWithOrder!]!
  redirectUrl: String!
}

Fields​

CreateMultiConsentInput.orderedConsentIds ● [ConsentIdWithOrder!]! non-null input​

A list of consent IDs with their related execution orders

CreateMultiConsentInput.redirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

Member of​

createMultiConsent mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/credit-transfer-input/index.html b/api-reference/inputs/credit-transfer-input/index.html index ddcc503034a..502bb57b2ef 100644 --- a/api-reference/inputs/credit-transfer-input/index.html +++ b/api-reference/inputs/credit-transfer-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CreditTransferInput

Credit transfer

input CreditTransferInput {
  beneficiaryId: ID
  swanAccountBeneficiary: SwanAccountBeneficiaryInput
  sepaBeneficiary: SepaBeneficiaryInput
  amount: AmountInput!
  reference: String
  label: String
  requestedExecutionAt: DateTime
  externalReference: String
  mode: CreditTransferMode
}

Fields​

CreditTransferInput.beneficiaryId ● ID scalar​

if the transfer will credit a beneficiary already created

CreditTransferInput.swanAccountBeneficiary ● SwanAccountBeneficiaryInput input​

if the transfer will credit a new swan account beneficiary

CreditTransferInput.sepaBeneficiary ● SepaBeneficiaryInput input​

if the transfer will credit a new SEPA beneficiary

CreditTransferInput.amount ● AmountInput! non-null input​

amount of the transfer

CreditTransferInput.reference ● String scalar​

reference assigned by the initiating party, to unambiguously identify the transaction. This reference is passed on, unchanged, throughout the entire end-to-end chain. (regex [A-Za-z0-9(\-)(\_)(\?)(\.)(\+),' ]{1,35})

CreditTransferInput.label ● String scalar​

label (max 140 characters)

CreditTransferInput.requestedExecutionAt ● DateTime scalar​

requested date at which the credit transfer will try to be executed, if null the credit transfer is executed right away

CreditTransferInput.externalReference ● String scalar​

an arbitrary identifier that you can define to easily identify this transaction later

CreditTransferInput.mode ● CreditTransferMode enum​

if the transfer will execute as instant and fallbacked to a regular one if an error happend during the instant transfer

Member of​

InitiateCreditTransfersInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/customer-input/index.html b/api-reference/inputs/customer-input/index.html index 1d3f645ff29..10b666999f1 100644 --- a/api-reference/inputs/customer-input/index.html +++ b/api-reference/inputs/customer-input/index.html @@ -7,14 +7,14 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/delete-supporting-document-input/index.html b/api-reference/inputs/delete-supporting-document-input/index.html index ca141fb8b18..3bdc0d402e0 100644 --- a/api-reference/inputs/delete-supporting-document-input/index.html +++ b/api-reference/inputs/delete-supporting-document-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/deny-sdd-input/index.html b/api-reference/inputs/deny-sdd-input/index.html index c117e48528a..342a6572e63 100644 --- a/api-reference/inputs/deny-sdd-input/index.html +++ b/api-reference/inputs/deny-sdd-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/deny-sdd-virtual-iban-entry-input/index.html b/api-reference/inputs/deny-sdd-virtual-iban-entry-input/index.html index 4f407714adc..8bf8fc657b6 100644 --- a/api-reference/inputs/deny-sdd-virtual-iban-entry-input/index.html +++ b/api-reference/inputs/deny-sdd-virtual-iban-entry-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/digital-card-filters-input/index.html b/api-reference/inputs/digital-card-filters-input/index.html index 15ae36852f6..922ad15d164 100644 --- a/api-reference/inputs/digital-card-filters-input/index.html +++ b/api-reference/inputs/digital-card-filters-input/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

DigitalCardFiltersInput

Filters that can be applied when listing digitalCards

input DigitalCardFiltersInput {
  id: String
  status: String
  SEID: String
  cardMaskedNumber: String
  walletProviderId: String
  walletProviderName: String
  walletId: String
}

Fields​

DigitalCardFiltersInput.id ● String scalar​

The id of the digitalCard

DigitalCardFiltersInput.status ● String scalar​

The status of the digital card. It can be a CompleteDigitalCardStatus or a PendingDigitalCardStatus

DigitalCardFiltersInput.SEID ● String scalar​

The Secure Element ID Mostly present on APple Devices

DigitalCardFiltersInput.cardMaskedNumber ● String scalar​

The digital card masker number

DigitalCardFiltersInput.walletProviderId ● String scalar​

The ID of the wallet provider in the scheme system

DigitalCardFiltersInput.walletProviderName ● String scalar​

Either ApplePay, GooglePay or Merchant

DigitalCardFiltersInput.walletId ● String scalar​

The wallet application ID in the user phone

- + \ No newline at end of file diff --git a/api-reference/inputs/digital-card-order-by-input/index.html b/api-reference/inputs/digital-card-order-by-input/index.html index 44342fecf5a..adbc5196f04 100644 --- a/api-reference/inputs/digital-card-order-by-input/index.html +++ b/api-reference/inputs/digital-card-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/disable-account-membership-input/index.html b/api-reference/inputs/disable-account-membership-input/index.html index 3b41e696ad7..fb72cb2b458 100644 --- a/api-reference/inputs/disable-account-membership-input/index.html +++ b/api-reference/inputs/disable-account-membership-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/enable-received-direct-debit-mandate-input/index.html b/api-reference/inputs/enable-received-direct-debit-mandate-input/index.html index 43e663605a6..2aaa6fc384d 100644 --- a/api-reference/inputs/enable-received-direct-debit-mandate-input/index.html +++ b/api-reference/inputs/enable-received-direct-debit-mandate-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

EnableReceivedDirectDebitMandateInput

Inputs to enable a received direct debit mandate, i.e. to move its status back from suspended.

input EnableReceivedDirectDebitMandateInput {
  receivedDirectDebitMandateId: ID!
  consentRedirectUrl: String
}

Fields​

EnableReceivedDirectDebitMandateInput.receivedDirectDebitMandateId ● ID! non-null scalar​

The received direct debit id to enable

EnableReceivedDirectDebitMandateInput.consentRedirectUrl ● String scalar​

URL the user is redirected to after consent has been given

Member of​

enableReceivedDirectDebitMandate mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/external-account-balance-input/index.html b/api-reference/inputs/external-account-balance-input/index.html index 3e56222050c..edd09b20b60 100644 --- a/api-reference/inputs/external-account-balance-input/index.html +++ b/api-reference/inputs/external-account-balance-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ExternalAccountBalanceInput

No description

input ExternalAccountBalanceInput {
  amount: AmountInput!
  type: ExternalAccountBalanceType!
  lastChangedAt: DateTime!
}

Fields​

ExternalAccountBalanceInput.amount ● AmountInput! non-null input​

Amount with currency

ExternalAccountBalanceInput.type ● ExternalAccountBalanceType! non-null enum​

Type of Balance

ExternalAccountBalanceInput.lastChangedAt ● DateTime! non-null scalar​

Last changed Date

Member of​

AddExternalAccountInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/finalize-onboarding-input/index.html b/api-reference/inputs/finalize-onboarding-input/index.html index bf824dbec78..7da780d5aa9 100644 --- a/api-reference/inputs/finalize-onboarding-input/index.html +++ b/api-reference/inputs/finalize-onboarding-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/funding-limit-amount-input/index.html b/api-reference/inputs/funding-limit-amount-input/index.html index 697ed12152b..a48fe209e26 100644 --- a/api-reference/inputs/funding-limit-amount-input/index.html +++ b/api-reference/inputs/funding-limit-amount-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/funding-limit-settings-change-request-filters-input/index.html b/api-reference/inputs/funding-limit-settings-change-request-filters-input/index.html index 3aa30b7adfd..7b74efc97e0 100644 --- a/api-reference/inputs/funding-limit-settings-change-request-filters-input/index.html +++ b/api-reference/inputs/funding-limit-settings-change-request-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestFiltersInput

Filters that can be applied when listing funding limit settings change requests

input FundingLimitSettingsChangeRequestFiltersInput {
  id: [String!]
  status: [FundingLimitSettingsChangeRequestStatus!]
}

Fields​

FundingLimitSettingsChangeRequestFiltersInput.id ● [String!] list scalar​

The ids of the funding limit settings change requests

FundingLimitSettingsChangeRequestFiltersInput.status ● [FundingLimitSettingsChangeRequestStatus!] list enum​

Status we want to filter on

- + \ No newline at end of file diff --git a/api-reference/inputs/funding-limit-settings-change-request-order-by-input/index.html b/api-reference/inputs/funding-limit-settings-change-request-order-by-input/index.html index 5c0cb5d5388..5e15bbf2384 100644 --- a/api-reference/inputs/funding-limit-settings-change-request-order-by-input/index.html +++ b/api-reference/inputs/funding-limit-settings-change-request-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/funding-source-filters-input/index.html b/api-reference/inputs/funding-source-filters-input/index.html index 789867f2670..6c3d5e7a9b4 100644 --- a/api-reference/inputs/funding-source-filters-input/index.html +++ b/api-reference/inputs/funding-source-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/funding-source-order-by-input/index.html b/api-reference/inputs/funding-source-order-by-input/index.html index fb225384e09..57ec3015d4f 100644 --- a/api-reference/inputs/funding-source-order-by-input/index.html +++ b/api-reference/inputs/funding-source-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/generate-account-statement-input/index.html b/api-reference/inputs/generate-account-statement-input/index.html index 57f42b0dbeb..b2b5674cf6e 100644 --- a/api-reference/inputs/generate-account-statement-input/index.html +++ b/api-reference/inputs/generate-account-statement-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

GenerateAccountStatementInput

Inputs to generate an account

input GenerateAccountStatementInput {
  accountId: ID!
  openingDate: DateTime!
  closingDate: DateTime!
  language: AccountLanguage
  statementType: StatementType
}

Fields​

GenerateAccountStatementInput.accountId ● ID! non-null scalar​

Unique identifier of an account

GenerateAccountStatementInput.openingDate ● DateTime! non-null scalar​

starting date of the date window

GenerateAccountStatementInput.closingDate ● DateTime! non-null scalar​

ending date of the date window

GenerateAccountStatementInput.language ● AccountLanguage enum​

language to generate the statement in (default to account's language)

GenerateAccountStatementInput.statementType ● StatementType enum​

Type of statement to generate

Member of​

generateAccountStatement mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/generate-capital-deposit-document-upload-url-input/index.html b/api-reference/inputs/generate-capital-deposit-document-upload-url-input/index.html index d4a050874ee..c619d9bb720 100644 --- a/api-reference/inputs/generate-capital-deposit-document-upload-url-input/index.html +++ b/api-reference/inputs/generate-capital-deposit-document-upload-url-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

GenerateCapitalDepositDocumentUploadUrlInput

No description

input GenerateCapitalDepositDocumentUploadUrlInput {
  documentId: ID!
  capitalDepositCaseId: ID!
  filename: String!
}

Fields​

GenerateCapitalDepositDocumentUploadUrlInput.documentId ● ID! non-null scalar​

Unique identifier of the document.

GenerateCapitalDepositDocumentUploadUrlInput.capitalDepositCaseId ● ID! non-null scalar​

Unique identifier of the capitalDepositCase associated to the document.

GenerateCapitalDepositDocumentUploadUrlInput.filename ● String! non-null scalar​

Filename of the document.

Member of​

generateCapitalDepositDocumentUploadUrl mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/generate-supporting-document-upload-url-input/index.html b/api-reference/inputs/generate-supporting-document-upload-url-input/index.html index 7af187c4e7e..df719457d68 100644 --- a/api-reference/inputs/generate-supporting-document-upload-url-input/index.html +++ b/api-reference/inputs/generate-supporting-document-upload-url-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

GenerateSupportingDocumentUploadUrlInput

No description

input GenerateSupportingDocumentUploadUrlInput {
  supportingDocumentCollectionId: ID!
  supportingDocumentType: SupportingDocumentType
  filename: String!
  supportingDocumentPurpose: SupportingDocumentPurposeEnum
}

Fields​

GenerateSupportingDocumentUploadUrlInput.supportingDocumentCollectionId ● ID! non-null scalar​

Unique identifier of a supporting document collection

GenerateSupportingDocumentUploadUrlInput.supportingDocumentType ● SupportingDocumentType enum​

Type of document

GenerateSupportingDocumentUploadUrlInput.filename ● String! non-null scalar​

Name of the document which will be sent

GenerateSupportingDocumentUploadUrlInput.supportingDocumentPurpose ● SupportingDocumentPurposeEnum enum​

Purpose of document

Member of​

generateSupportingDocumentUploadUrl mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/grant-consent-with-server-signature-input/index.html b/api-reference/inputs/grant-consent-with-server-signature-input/index.html index c0cd78c08c0..f98e438634d 100644 --- a/api-reference/inputs/grant-consent-with-server-signature-input/index.html +++ b/api-reference/inputs/grant-consent-with-server-signature-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/iban-validation-input/index.html b/api-reference/inputs/iban-validation-input/index.html index 481ee7e777c..4f8785fb8d5 100644 --- a/api-reference/inputs/iban-validation-input/index.html +++ b/api-reference/inputs/iban-validation-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/identification-filters-input/index.html b/api-reference/inputs/identification-filters-input/index.html index d60977b2b14..e8b9c1cf137 100644 --- a/api-reference/inputs/identification-filters-input/index.html +++ b/api-reference/inputs/identification-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IdentificationFiltersInput

Filter that can be passed to get the identifications in specific data ranges

input IdentificationFiltersInput {
  statuses: [SwanIdentificationStatus!]
  levels: [IdentificationLevel!]
  processes: [IdentificationProcess!]
}

Fields​

IdentificationFiltersInput.statuses ● [SwanIdentificationStatus!] list enum​

To filter on status values

IdentificationFiltersInput.levels ● [IdentificationLevel!] list enum​

To filter on level values

IdentificationFiltersInput.processes ● [IdentificationProcess!] list enum​

To filter on process values

- + \ No newline at end of file diff --git a/api-reference/inputs/identifications-order-by-input/index.html b/api-reference/inputs/identifications-order-by-input/index.html index 654b44eef30..2ef70631d43 100644 --- a/api-reference/inputs/identifications-order-by-input/index.html +++ b/api-reference/inputs/identifications-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/individual-ultimate-beneficial-owner-input/index.html b/api-reference/inputs/individual-ultimate-beneficial-owner-input/index.html index 68d13137864..66f9faf167e 100644 --- a/api-reference/inputs/individual-ultimate-beneficial-owner-input/index.html +++ b/api-reference/inputs/individual-ultimate-beneficial-owner-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IndividualUltimateBeneficialOwnerInput

No description

input IndividualUltimateBeneficialOwnerInput {
  firstName: String
  lastName: String
  birthDate: String
  birthCity: String
  birthCityPostalCode: String
  birthCountryCode: CCA3
  indirect: Boolean
  direct: Boolean
  totalCapitalPercentage: Float
  type: IndividualUltimateBeneficialOwnerTypeEnum!
  taxIdentificationNumber: String
  residencyAddress: AddressInformationInput
  title: TitleEnum
}

Fields​

IndividualUltimateBeneficialOwnerInput.firstName ● String scalar​

Individual beneficial owner first name. Length must be from 0 to 100 characters

IndividualUltimateBeneficialOwnerInput.lastName ● String scalar​

Individual beneficial owner last name. Length must be from 0 to 100 characters

IndividualUltimateBeneficialOwnerInput.birthDate ● String scalar​

Individual birth date. Must be a valid date

IndividualUltimateBeneficialOwnerInput.birthCity ● String scalar​

Individual birth city. Length must be from 0 to 100 characters

IndividualUltimateBeneficialOwnerInput.birthCityPostalCode ● String scalar​

Individual birth city postal code. Length must be from 0 to 50 characters

IndividualUltimateBeneficialOwnerInput.birthCountryCode ● CCA3 scalar​

Individual birth country code

IndividualUltimateBeneficialOwnerInput.indirect ● Boolean scalar​

Define UBO is an Indirect Owner

IndividualUltimateBeneficialOwnerInput.direct ● Boolean scalar​

Define UBO is an Direct Owner

IndividualUltimateBeneficialOwnerInput.totalCapitalPercentage ● Float scalar​

Total of capital (in percentage, ex: 50 = 50%). Must be between 1 and 100.

IndividualUltimateBeneficialOwnerInput.type ● IndividualUltimateBeneficialOwnerTypeEnum! non-null enum​

Define UBO is a Legal Representative

IndividualUltimateBeneficialOwnerInput.taxIdentificationNumber ● String scalar​

Individual beneficial owner Tax or Identification Number

IndividualUltimateBeneficialOwnerInput.residencyAddress ● AddressInformationInput input​

Individual beneficial owner residency Address

IndividualUltimateBeneficialOwnerInput.title ● TitleEnum enum​

Individual ultimate beneficial owner title (Mr/Ms)

Member of​

OnboardCompanyAccountHolderInput input ● UpdateCompanyOnboardingInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/initiate-credit-transfers-input/index.html b/api-reference/inputs/initiate-credit-transfers-input/index.html index 86a29879ff8..56a578b6b96 100644 --- a/api-reference/inputs/initiate-credit-transfers-input/index.html +++ b/api-reference/inputs/initiate-credit-transfers-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InitiateCreditTransfersInput

Initiate credit transfers

input InitiateCreditTransfersInput {
  accountNumber: AccountNumber
  accountId: ID
  creditTransfers: [CreditTransferInput!]!
  consentRedirectUrl: String!
}

Fields​

InitiateCreditTransfersInput.accountNumber ● AccountNumber scalar​

account to be debited identified by number

InitiateCreditTransfersInput.accountId ● ID scalar​

account id to be debited identified by id

InitiateCreditTransfersInput.creditTransfers ● [CreditTransferInput!]! non-null input​

credit transfers (max 250 records)

InitiateCreditTransfersInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

Member of​

initiateCreditTransfers mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/initiate-funding-request-input/index.html b/api-reference/inputs/initiate-funding-request-input/index.html index c92a6c8ba67..c802ea3345e 100644 --- a/api-reference/inputs/initiate-funding-request-input/index.html +++ b/api-reference/inputs/initiate-funding-request-input/index.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@ It is not possible to define this value when the option isInstant is set to true.

InitiateFundingRequestInput.isInstant ● Boolean scalar​

SOON TO BE DEPRECATED If true the funds should be available immediately. If false or null, the funds will be available after the resolution of the credit transaction.

Member of​

initiateFundingRequest mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/initiate-international-credit-transfer-input/index.html b/api-reference/inputs/initiate-international-credit-transfer-input/index.html index 1796a30b912..692f8a5106d 100644 --- a/api-reference/inputs/initiate-international-credit-transfer-input/index.html +++ b/api-reference/inputs/initiate-international-credit-transfer-input/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

InitiateInternationalCreditTransferInput

COMING SOON Input to create a quote and an international beneficiary

input InitiateInternationalCreditTransferInput {
  accountId: ID
  accountNumber: AccountNumber
  targetAmount: AmountInput!
  internationalBeneficiary: InternationalBeneficiaryInput!
  internationalCreditTransferDetails: [InternationalCreditTransferDetailsInput!]!
  consentRedirectUrl: String!
  externalReference: String
  language: InternationalCreditTransferDisplayLanguage
}

Fields​

InitiateInternationalCreditTransferInput.accountId ● ID scalar​

Account ID of the originator of the international credit transfer

InitiateInternationalCreditTransferInput.accountNumber ● AccountNumber scalar​

Account number if the beneficiary is a swan account

InitiateInternationalCreditTransferInput.targetAmount ● AmountInput! non-null input​

Target amount of the international credit transfer

InitiateInternationalCreditTransferInput.internationalBeneficiary ● InternationalBeneficiaryInput! non-null input​

Beneficiary of the international credit transfer

InitiateInternationalCreditTransferInput.internationalCreditTransferDetails ● [InternationalCreditTransferDetailsInput!]! non-null input​

Transfer details

InitiateInternationalCreditTransferInput.consentRedirectUrl ● String! non-null scalar​

When the consent flow is finished the user is redirected to this URL

InitiateInternationalCreditTransferInput.externalReference ● String scalar​

External reference

InitiateInternationalCreditTransferInput.language ● InternationalCreditTransferDisplayLanguage enum​

Language used to output errors

Member of​

initiateInternationalCreditTransfer mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/initiate-merchant-payment-collection-input/index.html b/api-reference/inputs/initiate-merchant-payment-collection-input/index.html index a4d50eb652c..50dcfc452c7 100644 --- a/api-reference/inputs/initiate-merchant-payment-collection-input/index.html +++ b/api-reference/inputs/initiate-merchant-payment-collection-input/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

InitiateMerchantPaymentCollectionInput

No description

input InitiateMerchantPaymentCollectionInput {
  amount: AmountInput!
  label: String
  reference: String
  externalReference: String
  internalDirectDebit: InternalDirectDebitPaymentCollectionInput
  check: CheckPaymentCollectionInput
  sepaDirectDebit: SepaDirectDebitPaymentCollectionInput
}

Fields​

InitiateMerchantPaymentCollectionInput.amount ● AmountInput! non-null input​

Amount of the concerned payment collection. For check deposit, the amount should not exceed 10 000€.

InitiateMerchantPaymentCollectionInput.label ● String scalar​

Label of the concerned payment collection, which will be displayed on Swan bank statement - For checks transaction, if empty, default label will be set as "Check N° [1st part of CMC7 - 7 char.]

InitiateMerchantPaymentCollectionInput.reference ● String scalar​

end-to-end reference of the concerned payment collection

InitiateMerchantPaymentCollectionInput.externalReference ● String scalar​

external reference (JSON) that can be used by the Swan merchant for reconciliation purposes

InitiateMerchantPaymentCollectionInput.internalDirectDebit ● InternalDirectDebitPaymentCollectionInput input​

Internal direct debit type of payment collection

InitiateMerchantPaymentCollectionInput.check ● CheckPaymentCollectionInput input​

Check type of payment collection

InitiateMerchantPaymentCollectionInput.sepaDirectDebit ● SepaDirectDebitPaymentCollectionInput input​

Sepa Direct Debit type of payment collection

Member of​

initiateMerchantPaymentCollection mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/internal-direct-debit-b2-bpayment-method-input/index.html b/api-reference/inputs/internal-direct-debit-b2-bpayment-method-input/index.html index 6396d4ff8ae..fd7e157fabc 100644 --- a/api-reference/inputs/internal-direct-debit-b2-bpayment-method-input/index.html +++ b/api-reference/inputs/internal-direct-debit-b2-bpayment-method-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/internal-direct-debit-payment-collection-input/index.html b/api-reference/inputs/internal-direct-debit-payment-collection-input/index.html index 60b9a21e8b6..c809da9a6a2 100644 --- a/api-reference/inputs/internal-direct-debit-payment-collection-input/index.html +++ b/api-reference/inputs/internal-direct-debit-payment-collection-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalDirectDebitPaymentCollectionInput

No description

input InternalDirectDebitPaymentCollectionInput {
  mandateId: ID!
  requestedExecutionAt: DateTime
}

Fields​

InternalDirectDebitPaymentCollectionInput.mandateId ● ID! non-null scalar​

ID of the concerned payment mandate

InternalDirectDebitPaymentCollectionInput.requestedExecutionAt ● DateTime scalar​

Date at which the Swan merchant wishes the payment to be executed

Member of​

InitiateMerchantPaymentCollectionInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/internal-direct-debit-standard-payment-method-input/index.html b/api-reference/inputs/internal-direct-debit-standard-payment-method-input/index.html index 85e7553bb0b..1b6253775e6 100644 --- a/api-reference/inputs/internal-direct-debit-standard-payment-method-input/index.html +++ b/api-reference/inputs/internal-direct-debit-standard-payment-method-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/international-address-input/index.html b/api-reference/inputs/international-address-input/index.html index b9a65fa7522..5d0d97c7ff2 100644 --- a/api-reference/inputs/international-address-input/index.html +++ b/api-reference/inputs/international-address-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternationalAddressInput

Address of an international beneficiary

input InternationalAddressInput {
  address1: String
  city: String
  country: String
  zipCode: String
  state: String
}

Fields​

InternationalAddressInput.address1 ● String scalar​

Address 1

InternationalAddressInput.city ● String scalar​

City

InternationalAddressInput.country ● String scalar​

Country

InternationalAddressInput.zipCode ● String scalar​

Zip Code

InternationalAddressInput.state ● String scalar​

State

- + \ No newline at end of file diff --git a/api-reference/inputs/international-beneficiary-details-input/index.html b/api-reference/inputs/international-beneficiary-details-input/index.html index a21a759605f..f8aebe02eb4 100644 --- a/api-reference/inputs/international-beneficiary-details-input/index.html +++ b/api-reference/inputs/international-beneficiary-details-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/international-beneficiary-input/index.html b/api-reference/inputs/international-beneficiary-input/index.html index 642fcf78c05..945897c51d7 100644 --- a/api-reference/inputs/international-beneficiary-input/index.html +++ b/api-reference/inputs/international-beneficiary-input/index.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@ International Beneficiary

input InternationalBeneficiaryInput {
  name: String!
  currency: Currency!
  details: [InternationalBeneficiaryDetailsInput!]!
  route: InternationalCreditTransferRouteInput!
}

Fields​

InternationalBeneficiaryInput.name ● String! non-null scalar​

Account holder name

InternationalBeneficiaryInput.currency ● Currency! non-null scalar​

Currency of the international beneficiary account

InternationalBeneficiaryInput.details ● [InternationalBeneficiaryDetailsInput!]! non-null input​

COMING SOON Currency-specific details of the beneficiary

InternationalBeneficiaryInput.route ● InternationalCreditTransferRouteInput! non-null enum​

COMING SOON Route that Wise will use to transfer the funds

Member of​

InitiateInternationalCreditTransferInput input ● internationalCreditTransferTransactionDetailsDynamicForm query

- + \ No newline at end of file diff --git a/api-reference/inputs/international-credit-transfer-details-input/index.html b/api-reference/inputs/international-credit-transfer-details-input/index.html index 9b353e9cb80..be8e5cb73d1 100644 --- a/api-reference/inputs/international-credit-transfer-details-input/index.html +++ b/api-reference/inputs/international-credit-transfer-details-input/index.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@ International Credit Transfer Details

input InternationalCreditTransferDetailsInput {
  key: String!
  value: String!
}

Fields​

InternationalCreditTransferDetailsInput.key ● String! non-null scalar​

COMING SOON Key

InternationalCreditTransferDetailsInput.value ● String! non-null scalar​

COMING SOON Value

Member of​

InitiateInternationalCreditTransferInput input ● internationalCreditTransferTransactionDetailsDynamicForm query

- + \ No newline at end of file diff --git a/api-reference/inputs/legal-documents-filter-input/index.html b/api-reference/inputs/legal-documents-filter-input/index.html index 00ebbe2ef28..1ba7417818c 100644 --- a/api-reference/inputs/legal-documents-filter-input/index.html +++ b/api-reference/inputs/legal-documents-filter-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/membership-info-input/index.html b/api-reference/inputs/membership-info-input/index.html index 8e8bd928ad7..216f181b895 100644 --- a/api-reference/inputs/membership-info-input/index.html +++ b/api-reference/inputs/membership-info-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MembershipInfoInput

No description

input MembershipInfoInput {
  email: String!
  restrictedTo: RestrictedToInput!
  canViewAccount: Boolean!
  canManageBeneficiaries: Boolean!
  canInitiatePayments: Boolean!
  canManageAccountMembership: Boolean!
  canManageCards: Boolean
  residencyAddress: ResidencyAddressInput
  taxIdentificationNumber: String
}

Fields​

MembershipInfoInput.email ● String! non-null scalar​

Email address

MembershipInfoInput.restrictedTo ● RestrictedToInput! non-null input​

Restricted to a user if necessary

MembershipInfoInput.canViewAccount ● Boolean! non-null scalar​

true if this account membership can view account balances and transactions history

MembershipInfoInput.canManageBeneficiaries ● Boolean! non-null scalar​

true if this account membership can add or canceled beneficiaries

MembershipInfoInput.canInitiatePayments ● Boolean! non-null scalar​

true if this account membership can initiate payments

MembershipInfoInput.canManageAccountMembership ● Boolean! non-null scalar​

true if this account membership can invite, update, suspend or resume account membership

MembershipInfoInput.canManageCards ● Boolean scalar​

true if this account membership can manage cards for himself or to the memberships he manages

MembershipInfoInput.residencyAddress ● ResidencyAddressInput input​

Residency address of the member to be added

MembershipInfoInput.taxIdentificationNumber ● String scalar​

Tax Identification Number of the user added

Member of​

AddAccountMembershipsInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/memberships-filter-input/index.html b/api-reference/inputs/memberships-filter-input/index.html index 41f9d6d4c7c..061045f1ebb 100644 --- a/api-reference/inputs/memberships-filter-input/index.html +++ b/api-reference/inputs/memberships-filter-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MembershipsFilterInput

Filters that can be applied when listing accounts (Only applied in user context)

input MembershipsFilterInput {
  canManageCards: Boolean
  canInitiatePayments: Boolean
  canManageAccountMembership: Boolean
  canManageBeneficiaries: Boolean
  canViewAccount: Boolean
  status: [AccountMembershipStatus!]
  email: String
  firstName: String
  lastName: String
  search: String
}

Fields​

MembershipsFilterInput.canManageCards ● Boolean scalar​

true if this account membership can manage cards for himself or to the memberships he manages

MembershipsFilterInput.canInitiatePayments ● Boolean scalar​

Can the user initiate payments on this account

MembershipsFilterInput.canManageAccountMembership ● Boolean scalar​

Can the user manage account membership

MembershipsFilterInput.canManageBeneficiaries ● Boolean scalar​

Can the user manage beneficiaries

MembershipsFilterInput.canViewAccount ● Boolean scalar​

Can the user view account

MembershipsFilterInput.status ● [AccountMembershipStatus!] list enum​

Account memberships status/statuses we're looking for

MembershipsFilterInput.email ● String scalar​

Filtered by email

MembershipsFilterInput.firstName ● String scalar​

Filtered by first name

MembershipsFilterInput.lastName ● String scalar​

Filtered by last name

MembershipsFilterInput.search ● String scalar​

Searches email, first name, last name, and id

- + \ No newline at end of file diff --git a/api-reference/inputs/merchant-profile-filters-input/index.html b/api-reference/inputs/merchant-profile-filters-input/index.html index 835aa86bafe..35ae9e47209 100644 --- a/api-reference/inputs/merchant-profile-filters-input/index.html +++ b/api-reference/inputs/merchant-profile-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/merchant-profile-order-by-input/index.html b/api-reference/inputs/merchant-profile-order-by-input/index.html index 071133ab60f..7cbbbfc25a9 100644 --- a/api-reference/inputs/merchant-profile-order-by-input/index.html +++ b/api-reference/inputs/merchant-profile-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/oauth-redirect-parameters-input/index.html b/api-reference/inputs/oauth-redirect-parameters-input/index.html index f732abd3275..e1d09280087 100644 --- a/api-reference/inputs/oauth-redirect-parameters-input/index.html +++ b/api-reference/inputs/oauth-redirect-parameters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OAuthRedirectParametersInput

No description

input OAuthRedirectParametersInput {
  state: String
  redirectUrl: String
}

Fields​

OAuthRedirectParametersInput.state ● String scalar​

Custom state provided by partner to prevent XSRF attack, will be filled by onBoardingId in case of nullity. Length must be from 0 to 255 characters

OAuthRedirectParametersInput.redirectUrl ● String scalar​

URL used to redirect the user at the end of the onboarding process. If null the user is redirected to the white label web banking. Length must be from 0 to 255 characters

Member of​

OnboardCompanyAccountHolderInput input ● OnboardIndividualAccountHolderInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/onboard-company-account-holder-input/index.html b/api-reference/inputs/onboard-company-account-holder-input/index.html index b7ea2aca20a..9be5ff29a26 100644 --- a/api-reference/inputs/onboard-company-account-holder-input/index.html +++ b/api-reference/inputs/onboard-company-account-holder-input/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

OnboardCompanyAccountHolderInput

Inputs to onboard a new company account holder

input OnboardCompanyAccountHolderInput {
  accountName: String
  name: String
  registrationNumber: String
  companyType: CompanyType
  businessActivity: BusinessActivity
  businessActivityDescription: String
  accountCountry: AccountCountry
  monthlyPaymentVolume: MonthlyPaymentVolume
  individualUltimateBeneficialOwners: [IndividualUltimateBeneficialOwnerInput!]
  residencyAddress: ResidencyAddressInput
  email: String
  language: String
  redirectUrl: String
  isRegistered: Boolean
  oAuthRedirectParameters: OAuthRedirectParametersInput
  vatNumber: String
  taxIdentificationNumber: String
  legalRepresentativePersonalAddress: AddressInformationInput
  typeOfRepresentation: TypeOfRepresentation
}

Fields​

OnboardCompanyAccountHolderInput.accountName ● String scalar​

Account name of the company account holder. Length must be from 0 to 100 characters

OnboardCompanyAccountHolderInput.name ● String scalar​

Name of the company. Length must be from 0 to 255 characters

OnboardCompanyAccountHolderInput.registrationNumber ● String scalar​

Registration number of the company (SIRET, ...). Length must be from 0 to 50 characters

OnboardCompanyAccountHolderInput.companyType ● CompanyType enum​

Type of the company (Association ...)

OnboardCompanyAccountHolderInput.businessActivity ● BusinessActivity enum​

Business activity

OnboardCompanyAccountHolderInput.businessActivityDescription ● String scalar​

Business activity description. Length must be from 0 to 1024 characters

OnboardCompanyAccountHolderInput.accountCountry ● AccountCountry enum​

Country of the account that will be created at the end of the onboarding process

OnboardCompanyAccountHolderInput.monthlyPaymentVolume ● MonthlyPaymentVolume enum​

Estimated monthly payment volume (euro)

OnboardCompanyAccountHolderInput.individualUltimateBeneficialOwners ● [IndividualUltimateBeneficialOwnerInput!] list input​

The ultimate beneficial owner is defined as the natural person (s) who own or control, directly and/or indirectly, the reporting company.

The ultimate beneficial owner is :

  • either the natural person (s) who hold, directly or indirectly, more than 25% of the capital or the rights of vote of the reporting company;
  • either the natural person (s) who exercise, by other means, a power of control of the company;

OnboardCompanyAccountHolderInput.residencyAddress ● ResidencyAddressInput input​

Residency address of the head office (Must be in a European country)

OnboardCompanyAccountHolderInput.email ● String scalar​

Email of the legal representative. Length must be from 0 to 255 characters

OnboardCompanyAccountHolderInput.language ● String scalar​

Language of the onboarding process. Must be compliant with RFC 5646

OnboardCompanyAccountHolderInput.redirectUrl ● String scalar​

URL used to redirect the user at the end of the onboarding process. If null the user is redirected to the white label web banking. Length must be from 0 to 255 characters

OnboardCompanyAccountHolderInput.isRegistered ● Boolean scalar​

Is company registered at RCS in its country

OnboardCompanyAccountHolderInput.oAuthRedirectParameters ● OAuthRedirectParametersInput input​

Extra parameters provided by partner

OnboardCompanyAccountHolderInput.vatNumber ● String scalar​

VAT number

OnboardCompanyAccountHolderInput.taxIdentificationNumber ● String scalar​

Tax Identification Number

OnboardCompanyAccountHolderInput.legalRepresentativePersonalAddress ● AddressInformationInput input​

Legal representative personal address

OnboardCompanyAccountHolderInput.typeOfRepresentation ● TypeOfRepresentation enum​

Type of representation (legal representative or power of attorney)

Member of​

CreateCapitalDepositCaseInput input ● onboardCompanyAccountHolder mutation ● OnboardCompanyShareholderInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/onboard-company-shareholder-input/index.html b/api-reference/inputs/onboard-company-shareholder-input/index.html index 0fe844905d4..d396ef7e18e 100644 --- a/api-reference/inputs/onboard-company-shareholder-input/index.html +++ b/api-reference/inputs/onboard-company-shareholder-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardCompanyShareholderInput

Information on the shareholder.

input OnboardCompanyShareholderInput {
  capitalDepositAmount: AmountInput!
  name: String!
  onboardingInfo: OnboardCompanyAccountHolderInput!
}

Fields​

OnboardCompanyShareholderInput.capitalDepositAmount ● AmountInput! non-null input​

Amount the shareholder has to deposit.

OnboardCompanyShareholderInput.name ● String! non-null scalar​

Name ("Dénomination sociale") of the shareholder.

OnboardCompanyShareholderInput.onboardingInfo ● OnboardCompanyAccountHolderInput! non-null input​

Information required for the onboarding of a company shareholder.

Member of​

CreateCapitalDepositCaseInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/onboard-individual-account-holder-input/index.html b/api-reference/inputs/onboard-individual-account-holder-input/index.html index 8ae96c79015..0bfbdc47f5e 100644 --- a/api-reference/inputs/onboard-individual-account-holder-input/index.html +++ b/api-reference/inputs/onboard-individual-account-holder-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardIndividualAccountHolderInput

Inputs to onboard a new individual account holder

input OnboardIndividualAccountHolderInput {
  accountName: String
  accountCountry: AccountCountry
  employmentStatus: EmploymentStatus
  monthlyIncome: MonthlyIncome
  residencyAddress: ResidencyAddressInput
  email: String
  language: String
  redirectUrl: String
  oAuthRedirectParameters: OAuthRedirectParametersInput
  taxIdentificationNumber: String
}

Fields​

OnboardIndividualAccountHolderInput.accountName ● String scalar​

Account name of the individual account holder. Length must be from 0 to 255 characters

OnboardIndividualAccountHolderInput.accountCountry ● AccountCountry enum​

Country of the account that will be created at the end of the onboarding process

OnboardIndividualAccountHolderInput.employmentStatus ● EmploymentStatus enum​

Employment status of the individual account holder

OnboardIndividualAccountHolderInput.monthlyIncome ● MonthlyIncome enum​

Monthly income of the individual account holder

OnboardIndividualAccountHolderInput.residencyAddress ● ResidencyAddressInput input​

Residency address of the individual account holder (must be in a European country)

OnboardIndividualAccountHolderInput.email ● String scalar​

Email. Length must be from 0 to 255 characters

OnboardIndividualAccountHolderInput.language ● String scalar​

Language of the onboarding process. Must be compliant with RFC 5646

OnboardIndividualAccountHolderInput.redirectUrl ● String scalar​

URL used to redirect the user at the end of the onboarding process. If null the user is redirected to the white label web banking. Length must be from 0 to 255 characters

OnboardIndividualAccountHolderInput.oAuthRedirectParameters ● OAuthRedirectParametersInput input​

Extra parameters provided by partner

OnboardIndividualAccountHolderInput.taxIdentificationNumber ● String scalar​

Tax Identification Number

Member of​

onboardIndividualAccountHolder mutation ● OnboardIndividualShareholderInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/onboard-individual-shareholder-input/index.html b/api-reference/inputs/onboard-individual-shareholder-input/index.html index 6817385abcf..13fd6ae0e14 100644 --- a/api-reference/inputs/onboard-individual-shareholder-input/index.html +++ b/api-reference/inputs/onboard-individual-shareholder-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardIndividualShareholderInput

Information on the shareholder.

input OnboardIndividualShareholderInput {
  firstName: String!
  lastName: String!
  birthDate: String!
  nationality: CCA3!
  capitalDepositAmount: AmountInput!
  onboardingInfo: OnboardIndividualAccountHolderInput!
}

Fields​

OnboardIndividualShareholderInput.firstName ● String! non-null scalar​

First name of the shareholder.

OnboardIndividualShareholderInput.lastName ● String! non-null scalar​

Last name of the shareholder.

OnboardIndividualShareholderInput.birthDate ● String! non-null scalar​

Birthdate of the shareholder in the YYYY/MM/DD format.

OnboardIndividualShareholderInput.nationality ● CCA3! non-null scalar​

CCA3 code for the country of nationality of the shareholder.

OnboardIndividualShareholderInput.capitalDepositAmount ● AmountInput! non-null input​

Amount the shareholder has to deposit.

OnboardIndividualShareholderInput.onboardingInfo ● OnboardIndividualAccountHolderInput! non-null input​

Information required for the onboarding of a individual shareholder.

Member of​

CreateCapitalDepositCaseInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/onboarding-filters-input/index.html b/api-reference/inputs/onboarding-filters-input/index.html index 68cbe66280c..4e0ac655f07 100644 --- a/api-reference/inputs/onboarding-filters-input/index.html +++ b/api-reference/inputs/onboarding-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardingFiltersInput

Filters that can be applied when listing onboardings

input OnboardingFiltersInput {
  types: [AccountHolderType!]
  email: String
  search: String
  status: [OnboardingStatus!]
}

Fields​

OnboardingFiltersInput.types ● [AccountHolderType!] list enum​

Type/Types we want to filter on

OnboardingFiltersInput.email ● String scalar​

Email we want to filter on

OnboardingFiltersInput.search ● String scalar​

Searches company name, first name, last name

OnboardingFiltersInput.status ● [OnboardingStatus!] list enum​

Status we want to filter on

Member of​

onboardings query

- + \ No newline at end of file diff --git a/api-reference/inputs/onboarding-order-by-input/index.html b/api-reference/inputs/onboarding-order-by-input/index.html index d859b6a6629..37b90d06cce 100644 --- a/api-reference/inputs/onboarding-order-by-input/index.html +++ b/api-reference/inputs/onboarding-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/partner-close-account-reason-input/index.html b/api-reference/inputs/partner-close-account-reason-input/index.html index f26c5c32366..9b70aa1521f 100644 --- a/api-reference/inputs/partner-close-account-reason-input/index.html +++ b/api-reference/inputs/partner-close-account-reason-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/payment-filters-input/index.html b/api-reference/inputs/payment-filters-input/index.html index ba4514d4f70..da02ac83135 100644 --- a/api-reference/inputs/payment-filters-input/index.html +++ b/api-reference/inputs/payment-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/payment-mandate-filters-input/index.html b/api-reference/inputs/payment-mandate-filters-input/index.html index 4fad185e3c6..573cda229ce 100644 --- a/api-reference/inputs/payment-mandate-filters-input/index.html +++ b/api-reference/inputs/payment-mandate-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/payment-mandate-order-by-input/index.html b/api-reference/inputs/payment-mandate-order-by-input/index.html index fb7aa696595..2a6b4f5cefd 100644 --- a/api-reference/inputs/payment-mandate-order-by-input/index.html +++ b/api-reference/inputs/payment-mandate-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/payment-order-by-input/index.html b/api-reference/inputs/payment-order-by-input/index.html index 77eca65f63c..51a7e3b7ad4 100644 --- a/api-reference/inputs/payment-order-by-input/index.html +++ b/api-reference/inputs/payment-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/physical-card-config-input/index.html b/api-reference/inputs/physical-card-config-input/index.html index d4f50f9afcd..c2aaa39575f 100644 --- a/api-reference/inputs/physical-card-config-input/index.html +++ b/api-reference/inputs/physical-card-config-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/physical-card-custom-options-for-group-delivery-input/index.html b/api-reference/inputs/physical-card-custom-options-for-group-delivery-input/index.html index e7e7bd1ae50..9c03f40971a 100644 --- a/api-reference/inputs/physical-card-custom-options-for-group-delivery-input/index.html +++ b/api-reference/inputs/physical-card-custom-options-for-group-delivery-input/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

PhysicalCardCustomOptionsForGroupDeliveryInput

No description

input PhysicalCardCustomOptionsForGroupDeliveryInput {
  additionalPrintedLine: String
}

Fields​

PhysicalCardCustomOptionsForGroupDeliveryInput.additionalPrintedLine ● String scalar​

Additional line to be embossed on the card.

This field will only be taken into account for custom card design that include it. (Learn More)

Max length allowed: 26 characters. Characters allowed: alphanumeric’*’ ‘.’ ‘-’ ‘/’ apostrophe

Member of​

CardConfigWithGroupDeliveryInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/physical-card-custom-options-for-print-input/index.html b/api-reference/inputs/physical-card-custom-options-for-print-input/index.html index 5091925a0ef..26bdc794e4c 100644 --- a/api-reference/inputs/physical-card-custom-options-for-print-input/index.html +++ b/api-reference/inputs/physical-card-custom-options-for-print-input/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

PhysicalCardCustomOptionsForPrintInput

No description

input PhysicalCardCustomOptionsForPrintInput {
  additionalPrintedLine: String
}

Fields​

PhysicalCardCustomOptionsForPrintInput.additionalPrintedLine ● String scalar​

Additional line to be printed on the card.

This field will only be taken into account for custom card design that include it. (Learn More)

Max length allowed: 26 characters. Characters allowed: alphanumeric’*’ ‘.’ ‘-’ ‘/’ apostrophe

Member of​

PrintPhysicalCardInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/physical-card-custom-options-input/index.html b/api-reference/inputs/physical-card-custom-options-input/index.html index d6d6fe908fd..534ce89ccd6 100644 --- a/api-reference/inputs/physical-card-custom-options-input/index.html +++ b/api-reference/inputs/physical-card-custom-options-input/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

PhysicalCardCustomOptionsInput

No description

input PhysicalCardCustomOptionsInput {
  additionalPrintedLine: String
}

Fields​

PhysicalCardCustomOptionsInput.additionalPrintedLine ● String scalar​

Additional line to be embossed on the card.

This field will only be taken into account for custom card design that include it. (Learn More)

Max length allowed: 26 characters. Characters allowed: alphanumeric’*’ ‘.’ ‘-’ ‘/’ apostrophe

Member of​

PhysicalCardConfigInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/print-physical-card-input/index.html b/api-reference/inputs/print-physical-card-input/index.html index c6440cd0cdc..943a5a95c15 100644 --- a/api-reference/inputs/print-physical-card-input/index.html +++ b/api-reference/inputs/print-physical-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PrintPhysicalCardInput

Inputs to print a physical card

input PrintPhysicalCardInput {
  cardId: ID!
  address: CompleteAddressInput!
  choosePINCode: Boolean!
  consentRedirectUrl: String!
  physicalCardCustomOptions: PhysicalCardCustomOptionsForPrintInput
}

Fields​

PrintPhysicalCardInput.cardId ● ID! non-null scalar​

Unique identifier of a card

PrintPhysicalCardInput.address ● CompleteAddressInput! non-null input​

Address to deliver the physical card

PrintPhysicalCardInput.choosePINCode ● Boolean! non-null scalar​

true if the user must choose their PIN Code

PrintPhysicalCardInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

PrintPhysicalCardInput.physicalCardCustomOptions ● PhysicalCardCustomOptionsForPrintInput input​

Custom options to use for physical cards.

Member of​

printPhysicalCard mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/reason-input/index.html b/api-reference/inputs/reason-input/index.html index eb999d53e1c..3eb35b0b49e 100644 --- a/api-reference/inputs/reason-input/index.html +++ b/api-reference/inputs/reason-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/refund-input/index.html b/api-reference/inputs/refund-input/index.html index 888b8558b71..cc39b85b81c 100644 --- a/api-reference/inputs/refund-input/index.html +++ b/api-reference/inputs/refund-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/refund-transaction/index.html b/api-reference/inputs/refund-transaction/index.html index e65ec4ce437..b456f4c52d5 100644 --- a/api-reference/inputs/refund-transaction/index.html +++ b/api-reference/inputs/refund-transaction/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

RefundTransaction

Information about the transaction to refund

input RefundTransaction {
  originTransactionId: String!
  amount: AmountInput!
  reference: String
  label: String
  executionDate: DateTime
}

Fields​

RefundTransaction.originTransactionId ● String! non-null scalar​

id of the transaction to refund

RefundTransaction.amount ● AmountInput! non-null input​

amount to refund in the same currency as the account

RefundTransaction.reference ● String scalar​

reference assigned by the initiating party, to unambiguously identify the transaction. This reference is passed on, unchanged, throughout the entire end-to-end chain for credit transfers. (regex [A-Za-z0-9(\-)(\_)(\?)(\.)(\+),' ]{1,35})

RefundTransaction.label ● String scalar​

label for the refund transaction (max 140 characters)

RefundTransaction.executionDate ● DateTime scalar​

only used when the transaction was a credit transfer

date when the credit transfer will be executed, if null the credit transfer is executed today

Member of​

RefundInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/request-merchant-payment-methods-input/index.html b/api-reference/inputs/request-merchant-payment-methods-input/index.html index 5cb9a090614..0d3fbd50463 100644 --- a/api-reference/inputs/request-merchant-payment-methods-input/index.html +++ b/api-reference/inputs/request-merchant-payment-methods-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RequestMerchantPaymentMethodsInput

No description

input RequestMerchantPaymentMethodsInput {
  merchantProfileId: ID!
  internalDirectDebitStandard: InternalDirectDebitStandardPaymentMethodInput
  internalDirectDebitB2B: InternalDirectDebitB2BPaymentMethodInput
  sepaDirectDebitCore: SepaDirectDebitCorePaymentMethodInput
  sepaDirectDebitB2B: SepaDirectDebitB2BPaymentMethodInput
  check: CheckPaymentMethodInput
}

Fields​

RequestMerchantPaymentMethodsInput.merchantProfileId ● ID! non-null scalar​

ID of the Merchant Profile

RequestMerchantPaymentMethodsInput.internalDirectDebitStandard ● InternalDirectDebitStandardPaymentMethodInput input​

Input for the Internal Direct Debit Standard payment method

RequestMerchantPaymentMethodsInput.internalDirectDebitB2B ● InternalDirectDebitB2BPaymentMethodInput input​

Input for the Internal Direct Debit B2B payment method

RequestMerchantPaymentMethodsInput.sepaDirectDebitCore ● SepaDirectDebitCorePaymentMethodInput input​

Input for the Sepa Direct Debit Core payment method

RequestMerchantPaymentMethodsInput.sepaDirectDebitB2B ● SepaDirectDebitB2BPaymentMethodInput input​

Input for the Sepa Direct Debit B2B payment method

RequestMerchantPaymentMethodsInput.check ● CheckPaymentMethodInput input​

Input for Check payment method

Member of​

requestMerchantPaymentMethods mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/request-merchant-profile-update-input/index.html b/api-reference/inputs/request-merchant-profile-update-input/index.html index fa504924cc4..6525a86caaf 100644 --- a/api-reference/inputs/request-merchant-profile-update-input/index.html +++ b/api-reference/inputs/request-merchant-profile-update-input/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

RequestMerchantProfileUpdateInput

Input to update a Merchant Profile

input RequestMerchantProfileUpdateInput {
  merchantProfileId: ID!
  merchantName: String!
  merchantWebsite: String
  productType: ProductType!
  expectedMonthlyPaymentVolume: AmountInput!
  expectedAverageBasket: AmountInput!
  merchantLogo: String
}

Fields​

RequestMerchantProfileUpdateInput.merchantProfileId ● ID! non-null scalar​

ID of the MerchantProfile to update

RequestMerchantProfileUpdateInput.merchantName ● String! non-null scalar​

Business name of the merchant, i.e. name that will be displayed on debtors' bank statements

RequestMerchantProfileUpdateInput.merchantWebsite ● String scalar​

Url of the merchant's website. Use '' to delete the field. Don't add the field to the mutation if you want to keep the existing value.

RequestMerchantProfileUpdateInput.productType ● ProductType! non-null enum​

Type of product sold. Gifts and donations can be club subscription or collection of donations (for associations), tips collection, contributions for local authorities

RequestMerchantProfileUpdateInput.expectedMonthlyPaymentVolume ● AmountInput! non-null input​

Expected annual activity volumes for all payment methods.

RequestMerchantProfileUpdateInput.expectedAverageBasket ● AmountInput! non-null input​

expected average basket value.

RequestMerchantProfileUpdateInput.merchantLogo ● String scalar​

base64 encoded merchant's logo. Use '' to delete the field. Don't add the field to the mutation if you want to keep the existing value.

Member of​

requestMerchantProfileUpdate mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/request-supporting-document-collection-review-input/index.html b/api-reference/inputs/request-supporting-document-collection-review-input/index.html index 78b41790acb..4c671e17e2a 100644 --- a/api-reference/inputs/request-supporting-document-collection-review-input/index.html +++ b/api-reference/inputs/request-supporting-document-collection-review-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/residency-address-input/index.html b/api-reference/inputs/residency-address-input/index.html index 968ae850035..e2c3d6a62d1 100644 --- a/api-reference/inputs/residency-address-input/index.html +++ b/api-reference/inputs/residency-address-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ResidencyAddressInput

No description

input ResidencyAddressInput {
  addressLine1: String
  addressLine2: String
  city: String
  postalCode: String
  state: String
  country: CCA3
}

Fields​

ResidencyAddressInput.addressLine1 ● String scalar​

Address line 1. Length must be from 0 to 255 characters

ResidencyAddressInput.addressLine2 ● String scalar​

AddressLine2. Length must be from 0 to 255 characters

ResidencyAddressInput.city ● String scalar​

City. Length must be from 0 to 100 characters

ResidencyAddressInput.postalCode ● String scalar​

Postal code. Length must be from 0 to 50 characters

ResidencyAddressInput.state ● String scalar​

State of residency. Length must be from 0 to 100 characters

ResidencyAddressInput.country ● CCA3 scalar​

Country

Member of​

AddAccountMembershipInput input ● MembershipInfoInput input ● OnboardCompanyAccountHolderInput input ● OnboardIndividualAccountHolderInput input ● UpdateAccountMembershipInput input ● UpdateCompanyOnboardingInput input ● UpdateIndividualOnboardingInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/restricted-to-input/index.html b/api-reference/inputs/restricted-to-input/index.html index 681aad1d232..184a3492885 100644 --- a/api-reference/inputs/restricted-to-input/index.html +++ b/api-reference/inputs/restricted-to-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RestrictedToInput

Input when the account membership is restricted to a verified user

input RestrictedToInput {
  firstName: String!
  lastName: String!
  birthDate: Date
  phoneNumber: PhoneNumber!
}

Fields​

RestrictedToInput.firstName ● String! non-null scalar​

Account member first name

RestrictedToInput.lastName ● String! non-null scalar​

Account member last name

RestrictedToInput.birthDate ● Date scalar​

Account member birth date

RestrictedToInput.phoneNumber ● PhoneNumber! non-null scalar​

Account member phone number

Member of​

AddAccountMembershipInput input ● MembershipInfoInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/resume-account-membership-input/index.html b/api-reference/inputs/resume-account-membership-input/index.html index e9167e58557..ed8e72c0818 100644 --- a/api-reference/inputs/resume-account-membership-input/index.html +++ b/api-reference/inputs/resume-account-membership-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/resume-physical-card-input/index.html b/api-reference/inputs/resume-physical-card-input/index.html index 94dfdb85d6a..d760a14d061 100644 --- a/api-reference/inputs/resume-physical-card-input/index.html +++ b/api-reference/inputs/resume-physical-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/schedule-standing-order-input/index.html b/api-reference/inputs/schedule-standing-order-input/index.html index 4fe8ba8f126..488874911d0 100644 --- a/api-reference/inputs/schedule-standing-order-input/index.html +++ b/api-reference/inputs/schedule-standing-order-input/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

ScheduleStandingOrderInput

No description

input ScheduleStandingOrderInput {
  amount: AmountInput
  targetAvailableBalance: AmountInput
  period: StandingOrderPeriod!
  firstExecutionDate: DateTime
  lastExecutionDate: DateTime
  sepaBeneficiary: SepaBeneficiaryInput
  accountId: String!
  consentRedirectUrl: String!
  reference: String
  label: String
  creditTransferMode: CreditTransferMode
}

Fields​

ScheduleStandingOrderInput.amount ● AmountInput input​

Fix Amount that will be periodically transferred the value must be empty when targetAvailableBalance is defined

ScheduleStandingOrderInput.targetAvailableBalance ● AmountInput input​

Target available balance that will be used for periodically clipping the account the value must be empty when amount is defined

ScheduleStandingOrderInput.period ● StandingOrderPeriod! non-null enum​

Scheduled period of Standing Order

ScheduleStandingOrderInput.firstExecutionDate ● DateTime scalar​

Earlier date the Standing Order will be executed

ScheduleStandingOrderInput.lastExecutionDate ● DateTime scalar​

Latest date the Standing Order will be executed

ScheduleStandingOrderInput.sepaBeneficiary ● SepaBeneficiaryInput input​

SEPA beneficiary of the Standing ORder

ScheduleStandingOrderInput.accountId ● String! non-null scalar​

Account the Standing Order will be attached to

ScheduleStandingOrderInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

ScheduleStandingOrderInput.reference ● String scalar​

reference assigned by the initiating party, to unambiguously identify the transaction. This reference is passed on, unchanged, throughout the entire end-to-end chain. (regex [A-Za-z0-9(\-)(\_)(\?)(\.)(\+),' ]{1,35})

ScheduleStandingOrderInput.label ● String scalar​

label (max 140 characters)

ScheduleStandingOrderInput.creditTransferMode ● CreditTransferMode enum​

Transfer mode of the Standing Order

Member of​

scheduleStandingOrder mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/sepa-beneficiary-input/index.html b/api-reference/inputs/sepa-beneficiary-input/index.html index 2f04bb69c35..30bbfafea8f 100644 --- a/api-reference/inputs/sepa-beneficiary-input/index.html +++ b/api-reference/inputs/sepa-beneficiary-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SepaBeneficiaryInput

Sepa beneficiary account

input SepaBeneficiaryInput {
  iban: IBAN!
  name: String!
  address: AddressInput
  isMyOwnIban: Boolean!
  save: Boolean!
}

Fields​

SepaBeneficiaryInput.iban ● IBAN! non-null scalar​

International Bank Account Number

SepaBeneficiaryInput.name ● String! non-null scalar​

Full name of the beneficiary (min 2 characters, max 70 characters). The name should not include any special characters.

SepaBeneficiaryInput.address ● AddressInput input​

beneficiary address

SepaBeneficiaryInput.isMyOwnIban ● Boolean! non-null scalar​

true if this new beneficiary is the account holder himself in another financial institution.

SepaBeneficiaryInput.save ● Boolean! non-null scalar​

true if this new beneficiary will be saved to the beneficiary list of the debited account.

Member of​

CreditTransferInput input ● ScheduleStandingOrderInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/sepa-direct-debit-b2-bpayment-method-input/index.html b/api-reference/inputs/sepa-direct-debit-b2-bpayment-method-input/index.html index c014d55dc0c..c4eb3e14580 100644 --- a/api-reference/inputs/sepa-direct-debit-b2-bpayment-method-input/index.html +++ b/api-reference/inputs/sepa-direct-debit-b2-bpayment-method-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SepaDirectDebitB2BPaymentMethodInput

No description

input SepaDirectDebitB2BPaymentMethodInput {
  activate: Boolean
  useSwanSepaCreditorIdentifier: Boolean!
  sepaCreditorIdentifier: String
}

Fields​

SepaDirectDebitB2BPaymentMethodInput.activate ● Boolean scalar​

If true, the Payment Method will be Enabled

SepaDirectDebitB2BPaymentMethodInput.useSwanSepaCreditorIdentifier ● Boolean! non-null scalar​

If true, the transaction will be created with the Swan Creditor Identifier

SepaDirectDebitB2BPaymentMethodInput.sepaCreditorIdentifier ● String scalar​

Your own SCI - Mandatory if the useSwanCreditorIdentifier is set to false, otherwise Swan does not take this input into account (even if not empty)

Member of​

RequestMerchantPaymentMethodsInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/sepa-direct-debit-core-payment-method-input/index.html b/api-reference/inputs/sepa-direct-debit-core-payment-method-input/index.html index c042f763f84..f6864f3c39a 100644 --- a/api-reference/inputs/sepa-direct-debit-core-payment-method-input/index.html +++ b/api-reference/inputs/sepa-direct-debit-core-payment-method-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SepaDirectDebitCorePaymentMethodInput

No description

input SepaDirectDebitCorePaymentMethodInput {
  activate: Boolean
  useSwanSepaCreditorIdentifier: Boolean!
  sepaCreditorIdentifier: String
}

Fields​

SepaDirectDebitCorePaymentMethodInput.activate ● Boolean scalar​

If true, the Payment Method will be Pending Review

SepaDirectDebitCorePaymentMethodInput.useSwanSepaCreditorIdentifier ● Boolean! non-null scalar​

If true, the transaction will be created with the Swan Creditor Identifier

SepaDirectDebitCorePaymentMethodInput.sepaCreditorIdentifier ● String scalar​

Your own SCI - Mandatory if the useSwanCreditorIdentifier is set to false, otherwise Swan does not take this input into account (even if not empty)

Member of​

RequestMerchantPaymentMethodsInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/sepa-direct-debit-payment-collection-input/index.html b/api-reference/inputs/sepa-direct-debit-payment-collection-input/index.html index 59220e6d841..48f2a472e01 100644 --- a/api-reference/inputs/sepa-direct-debit-payment-collection-input/index.html +++ b/api-reference/inputs/sepa-direct-debit-payment-collection-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/sepa-payment-mandate-debtor-input/index.html b/api-reference/inputs/sepa-payment-mandate-debtor-input/index.html index 4a6cdd97a99..e5f0e8b6088 100644 --- a/api-reference/inputs/sepa-payment-mandate-debtor-input/index.html +++ b/api-reference/inputs/sepa-payment-mandate-debtor-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SepaPaymentMandateDebtorInput

No description

input SepaPaymentMandateDebtorInput {
  name: String!
  IBAN: String!
  address: AddressInput!
}

Fields​

SepaPaymentMandateDebtorInput.name ● String! non-null scalar​

SEPA Direct Debit Payment Mandate debtor name

SepaPaymentMandateDebtorInput.IBAN ● String! non-null scalar​

SEPA Direct Debit Payment Mandate debtor IBAN

SepaPaymentMandateDebtorInput.address ● AddressInput! non-null input​

Member of​

AddSepaDirectDebitPaymentMandateInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/signature-data/index.html b/api-reference/inputs/signature-data/index.html index 2a1fd9749aa..1f27e18acd0 100644 --- a/api-reference/inputs/signature-data/index.html +++ b/api-reference/inputs/signature-data/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/single-use-virtual-card-config-input/index.html b/api-reference/inputs/single-use-virtual-card-config-input/index.html index 11049bb03c2..53639de7ca5 100644 --- a/api-reference/inputs/single-use-virtual-card-config-input/index.html +++ b/api-reference/inputs/single-use-virtual-card-config-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SingleUseVirtualCardConfigInput

No description

input SingleUseVirtualCardConfigInput {
  accountMembershipId: ID!
  name: String
  spendingLimit: SpendingLimitInput!
}

Fields​

SingleUseVirtualCardConfigInput.accountMembershipId ● ID! non-null scalar​

Unique identifier of a given account membership

SingleUseVirtualCardConfigInput.name ● String scalar​

Card name

SingleUseVirtualCardConfigInput.spendingLimit ● SpendingLimitInput! non-null input​

Spending limit

Member of​

AddSingleUseVirtualCardsInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/spending-limit-input/index.html b/api-reference/inputs/spending-limit-input/index.html index 524d3f6153a..e5cf0170977 100644 --- a/api-reference/inputs/spending-limit-input/index.html +++ b/api-reference/inputs/spending-limit-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SpendingLimitInput

Inputs when editing spending limit configuration

input SpendingLimitInput {
  period: SpendingLimitPeriodInput!
  amount: AmountInput!
}

Fields​

SpendingLimitInput.period ● SpendingLimitPeriodInput! non-null enum​

period concerned

SpendingLimitInput.amount ● AmountInput! non-null input​

sum of amount of spending authorized during the period

Member of​

AddCardInput input ● AddSingleUseVirtualCardInput input ● CardConfigInput input ● CardConfigWithGroupDeliveryInput input ● SingleUseVirtualCardConfigInput input ● UpdateAccountMembershipInput input ● UpdateCardInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/statement-filters-input/index.html b/api-reference/inputs/statement-filters-input/index.html index 636924d6c07..fb0e8300c80 100644 --- a/api-reference/inputs/statement-filters-input/index.html +++ b/api-reference/inputs/statement-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

StatementFiltersInput

Filter that can be given to give the statement in a specific data range

input StatementFiltersInput {
  isAfterUpdatedAt: DateTime
  isBeforeUpdatedAt: DateTime
  period: StatementPeriod
}

Fields​

StatementFiltersInput.isAfterUpdatedAt ● DateTime scalar​

To filter after an updatedAt value

StatementFiltersInput.isBeforeUpdatedAt ● DateTime scalar​

To filter before an updatedAt value

StatementFiltersInput.period ● StatementPeriod enum​

To filter on a specific period of statement (either custom or monthly)

- + \ No newline at end of file diff --git a/api-reference/inputs/suspend-account-membership-input/index.html b/api-reference/inputs/suspend-account-membership-input/index.html index 75e63af614e..b390e9cdae6 100644 --- a/api-reference/inputs/suspend-account-membership-input/index.html +++ b/api-reference/inputs/suspend-account-membership-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/suspend-account-reason-input/index.html b/api-reference/inputs/suspend-account-reason-input/index.html index d2952d2afdb..4b84c694f0e 100644 --- a/api-reference/inputs/suspend-account-reason-input/index.html +++ b/api-reference/inputs/suspend-account-reason-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/suspend-physical-card-input/index.html b/api-reference/inputs/suspend-physical-card-input/index.html index 7b612f98467..32dc9dcf330 100644 --- a/api-reference/inputs/suspend-physical-card-input/index.html +++ b/api-reference/inputs/suspend-physical-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/suspend-received-direct-debit-mandate-input/index.html b/api-reference/inputs/suspend-received-direct-debit-mandate-input/index.html index 4501a336191..c9c87edecbf 100644 --- a/api-reference/inputs/suspend-received-direct-debit-mandate-input/index.html +++ b/api-reference/inputs/suspend-received-direct-debit-mandate-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/swan-account-beneficiary-input/index.html b/api-reference/inputs/swan-account-beneficiary-input/index.html index a5cfb41e8ae..97627c4e102 100644 --- a/api-reference/inputs/swan-account-beneficiary-input/index.html +++ b/api-reference/inputs/swan-account-beneficiary-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SwanAccountBeneficiaryInput

Swan account beneficiary

input SwanAccountBeneficiaryInput {
  accountNumber: AccountNumber!
  name: String!
  save: Boolean!
}

Fields​

SwanAccountBeneficiaryInput.accountNumber ● AccountNumber! non-null scalar​

account number to be credited

SwanAccountBeneficiaryInput.name ● String! non-null scalar​

full name of the beneficiary (max 70 characters)

SwanAccountBeneficiaryInput.save ● Boolean! non-null scalar​

true if this new beneficiary will be saved to the beneficiary list of the debited account.

Member of​

CreditTransferInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/transactions-filters-input/index.html b/api-reference/inputs/transactions-filters-input/index.html index 8bcaae2072b..5d17d26d1d3 100644 --- a/api-reference/inputs/transactions-filters-input/index.html +++ b/api-reference/inputs/transactions-filters-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

TransactionsFiltersInput

the criteria to filter transactions

input TransactionsFiltersInput {
  status: [TransactionStatus!]
  paymentProduct: [PaymentProduct!]
  isAfterUpdatedAt: DateTime
  isBeforeUpdatedAt: DateTime
  search: String
  type: [TransactionTypeEnum!]
  includeRejectedWithFallback: Boolean
}

Fields​

TransactionsFiltersInput.status ● [TransactionStatus!] list enum​

To filter on some Transaction Status (all if empty)

TransactionsFiltersInput.paymentProduct ● [PaymentProduct!] list enum​

To filter on some Payment Products (all if empty)

TransactionsFiltersInput.isAfterUpdatedAt ● DateTime scalar​

To filter after an updatedAt value

TransactionsFiltersInput.isBeforeUpdatedAt ● DateTime scalar​

To filter before an updatedAt value

TransactionsFiltersInput.search ● String scalar​

To filter on some text occurrences (words or ids)

TransactionsFiltersInput.type ● [TransactionTypeEnum!] list enum​

To filter on some transaction types

TransactionsFiltersInput.includeRejectedWithFallback ● Boolean scalar​

To filter so it includes rejected transactions that had a fallback (true by default)

Member of​

transactions query

- + \ No newline at end of file diff --git a/api-reference/inputs/transactions-order-by-input/index.html b/api-reference/inputs/transactions-order-by-input/index.html index b0425bcccd0..0816975e073 100644 --- a/api-reference/inputs/transactions-order-by-input/index.html +++ b/api-reference/inputs/transactions-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/update-account-holder-input/index.html b/api-reference/inputs/update-account-holder-input/index.html index bb3b7fc441b..3fa2bb68004 100644 --- a/api-reference/inputs/update-account-holder-input/index.html +++ b/api-reference/inputs/update-account-holder-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/update-account-input/index.html b/api-reference/inputs/update-account-input/index.html index 1e6d1f5a277..5ebde7986c1 100644 --- a/api-reference/inputs/update-account-input/index.html +++ b/api-reference/inputs/update-account-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/update-account-membership-input/index.html b/api-reference/inputs/update-account-membership-input/index.html index ed823d7a544..b81410a0f9b 100644 --- a/api-reference/inputs/update-account-membership-input/index.html +++ b/api-reference/inputs/update-account-membership-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateAccountMembershipInput

Inputs to update an account membership

input UpdateAccountMembershipInput {
  accountMembershipId: ID!
  email: String
  restrictedTo: UpdatedRestrictedToInput
  canViewAccount: Boolean
  canManageBeneficiaries: Boolean
  canInitiatePayments: Boolean
  canManageAccountMembership: Boolean
  canManageCards: Boolean
  spendingLimit: SpendingLimitInput
  consentRedirectUrl: String!
  residencyAddress: ResidencyAddressInput
  taxIdentificationNumber: String
}

Fields​

UpdateAccountMembershipInput.accountMembershipId ● ID! non-null scalar​

Unique identifier of an account membership

UpdateAccountMembershipInput.email ● String scalar​

Email address

UpdateAccountMembershipInput.restrictedTo ● UpdatedRestrictedToInput input​

Restricted to a user if necessary

UpdateAccountMembershipInput.canViewAccount ● Boolean scalar​

true if this account membership can view account balances and transactions history

UpdateAccountMembershipInput.canManageBeneficiaries ● Boolean scalar​

true if this account membership can add or canceled beneficiaries

UpdateAccountMembershipInput.canInitiatePayments ● Boolean scalar​

true if this account membership can initiate payments

UpdateAccountMembershipInput.canManageAccountMembership ● Boolean scalar​

true if this account membership can invite, update, suspend or resume memberships

UpdateAccountMembershipInput.canManageCards ● Boolean scalar​

true if this account membership can manage cards for himself or to the memberships he manages

UpdateAccountMembershipInput.spendingLimit ● SpendingLimitInput input​

Periodic Spending limit

UpdateAccountMembershipInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

UpdateAccountMembershipInput.residencyAddress ● ResidencyAddressInput input​

Residency address of the member to be added

UpdateAccountMembershipInput.taxIdentificationNumber ● String scalar​

Tax Identification Number of the user added

Member of​

updateAccountMembership mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/update-card-input/index.html b/api-reference/inputs/update-card-input/index.html index da50f865975..7595c5520a5 100644 --- a/api-reference/inputs/update-card-input/index.html +++ b/api-reference/inputs/update-card-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateCardInput

Input to Update Card

input UpdateCardInput {
  cardId: ID!
  cardContractExpiryDate: DateTime
  withdrawal: Boolean!
  international: Boolean!
  nonMainCurrencyTransactions: Boolean!
  eCommerce: Boolean!
  spendingLimit: SpendingLimitInput
  consentRedirectUrl: String!
  name: String
}

Fields​

UpdateCardInput.cardId ● ID! non-null scalar​

Unique identifier of the card to update

UpdateCardInput.cardContractExpiryDate ● DateTime scalar​

Card expiration date if null it does not have an expiration date

UpdateCardInput.withdrawal ● Boolean! non-null scalar​

true if this card allows cash withdrawals

UpdateCardInput.international ● Boolean! non-null scalar​

true if this card allows payments outside of the country

UpdateCardInput.nonMainCurrencyTransactions ● Boolean! non-null scalar​

true if this card allows transactions outside of the card's main currency

UpdateCardInput.eCommerce ● Boolean! non-null scalar​

true if this card allows transactions at eCommerce sites

UpdateCardInput.spendingLimit ● SpendingLimitInput input​

Periodic Spending limit

UpdateCardInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

UpdateCardInput.name ● String scalar​

Card name

Member of​

updateCard mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/update-company-onboarding-input/index.html b/api-reference/inputs/update-company-onboarding-input/index.html index 93b8e637512..5fe0acbabbf 100644 --- a/api-reference/inputs/update-company-onboarding-input/index.html +++ b/api-reference/inputs/update-company-onboarding-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateCompanyOnboardingInput

No description

input UpdateCompanyOnboardingInput {
  accountName: String
  accountCountry: AccountCountry
  name: String
  registrationNumber: String
  companyType: CompanyType
  businessActivity: BusinessActivity
  businessActivityDescription: String
  monthlyPaymentVolume: MonthlyPaymentVolume
  individualUltimateBeneficialOwners: [IndividualUltimateBeneficialOwnerInput!]
  residencyAddress: ResidencyAddressInput
  email: String
  language: String
  isRegistered: Boolean
  onboardingId: ID!
  vatNumber: String
  taxIdentificationNumber: String
  legalRepresentativePersonalAddress: AddressInformationInput
  typeOfRepresentation: TypeOfRepresentation
}

Fields​

UpdateCompanyOnboardingInput.accountName ● String scalar​

Account name of the company account holder. Length must be from 0 to 100 characters

UpdateCompanyOnboardingInput.accountCountry ● AccountCountry enum​

Country of the account that will be created at the end of the onboarding process

UpdateCompanyOnboardingInput.name ● String scalar​

Name of the company. Length must be from 0 to 255 characters

UpdateCompanyOnboardingInput.registrationNumber ● String scalar​

Registration number of the company (SIRET, ...). Length must be from 0 to 50 characters

UpdateCompanyOnboardingInput.companyType ● CompanyType enum​

Type of the company (Association ...)

UpdateCompanyOnboardingInput.businessActivity ● BusinessActivity enum​

Business activity

UpdateCompanyOnboardingInput.businessActivityDescription ● String scalar​

Business activity description. Length must be from 0 to 1024 characters

UpdateCompanyOnboardingInput.monthlyPaymentVolume ● MonthlyPaymentVolume enum​

Estimated monthly payment volume (euro)

UpdateCompanyOnboardingInput.individualUltimateBeneficialOwners ● [IndividualUltimateBeneficialOwnerInput!] list input​

The ultimate beneficial owner is defined as the natural person (s) who own or control, directly and/or indirectly, the reporting company.

The ultimate beneficial owner is :

  • either the natural person (s) who hold, directly or indirectly, more than 25% of the capital or the rights of vote of the reporting company;
  • either the natural person (s) who exercise, by other means, a power of control of the company;

UpdateCompanyOnboardingInput.residencyAddress ● ResidencyAddressInput input​

Residency address of the head office (Must be in a European country)

UpdateCompanyOnboardingInput.email ● String scalar​

Email of the legal representative. Length must be from 0 to 255 characters

UpdateCompanyOnboardingInput.language ● String scalar​

Language of the onboarding process. Must be compliant with RFC 5646

UpdateCompanyOnboardingInput.isRegistered ● Boolean scalar​

Is company registered at RCS in its country

UpdateCompanyOnboardingInput.onboardingId ● ID! non-null scalar​

Id of onboarding to be updated. Must be a valid UUID v4. Required

UpdateCompanyOnboardingInput.vatNumber ● String scalar​

VAT number

UpdateCompanyOnboardingInput.taxIdentificationNumber ● String scalar​

Tax Identification Number

UpdateCompanyOnboardingInput.legalRepresentativePersonalAddress ● AddressInformationInput input​

Legal representative personal address

UpdateCompanyOnboardingInput.typeOfRepresentation ● TypeOfRepresentation enum​

Type of representation (legal representative or power of attorney)

Member of​

updateCompanyOnboarding mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/update-individual-onboarding-input/index.html b/api-reference/inputs/update-individual-onboarding-input/index.html index 8eb06604f9c..d7c61baefcc 100644 --- a/api-reference/inputs/update-individual-onboarding-input/index.html +++ b/api-reference/inputs/update-individual-onboarding-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateIndividualOnboardingInput

No description

input UpdateIndividualOnboardingInput {
  accountName: String
  accountCountry: AccountCountry
  employmentStatus: EmploymentStatus
  monthlyIncome: MonthlyIncome
  residencyAddress: ResidencyAddressInput
  email: String
  language: String
  onboardingId: ID!
  taxIdentificationNumber: String
}

Fields​

UpdateIndividualOnboardingInput.accountName ● String scalar​

Account name of the individual account holder. Length must be from 0 to 255 characters

UpdateIndividualOnboardingInput.accountCountry ● AccountCountry enum​

Country of the account that will be created at the end of the onboarding process

UpdateIndividualOnboardingInput.employmentStatus ● EmploymentStatus enum​

Employment status of the individual account holder

UpdateIndividualOnboardingInput.monthlyIncome ● MonthlyIncome enum​

Monthly income of the individual account holder

UpdateIndividualOnboardingInput.residencyAddress ● ResidencyAddressInput input​

Residency address of the individual account holder (must be in a European country)

UpdateIndividualOnboardingInput.email ● String scalar​

Email. Length must be from 0 to 255 characters

UpdateIndividualOnboardingInput.language ● String scalar​

Language of the onboarding process. Must be compliant with RFC 5646

UpdateIndividualOnboardingInput.onboardingId ● ID! non-null scalar​

Id of onboarding to be updated. Must be a valid UUID v4. Required

UpdateIndividualOnboardingInput.taxIdentificationNumber ● String scalar​

Tax Identification Number

Member of​

updateIndividualOnboarding mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/update-received-sepa-direct-debit-b2-b-mandate-input/index.html b/api-reference/inputs/update-received-sepa-direct-debit-b2-b-mandate-input/index.html index 8121e2be6a7..4357a1ecc6e 100644 --- a/api-reference/inputs/update-received-sepa-direct-debit-b2-b-mandate-input/index.html +++ b/api-reference/inputs/update-received-sepa-direct-debit-b2-b-mandate-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateReceivedSepaDirectDebitB2bMandateInput

Inputs to update a received sepa direct debit mandate B2b.

input UpdateReceivedSepaDirectDebitB2bMandateInput {
  receivedDirectDebitMandateId: ID!
  mandateReference: String
  creditorIdentifier: String
  creditorName: String
  iban: String
  name: String
  consentRedirectUrl: String!
}

Fields​

UpdateReceivedSepaDirectDebitB2bMandateInput.receivedDirectDebitMandateId ● ID! non-null scalar​

The unique mandate id

UpdateReceivedSepaDirectDebitB2bMandateInput.mandateReference ● String scalar​

The unique identifier of the received direct debit mandate

UpdateReceivedSepaDirectDebitB2bMandateInput.creditorIdentifier ● String scalar​

The Sepa Creditor Identifier of the creditor

UpdateReceivedSepaDirectDebitB2bMandateInput.creditorName ● String scalar​

The name of the creditor

UpdateReceivedSepaDirectDebitB2bMandateInput.iban ● String scalar​

The Swan Iban of the debtor

UpdateReceivedSepaDirectDebitB2bMandateInput.name ● String scalar​

Label that will be displayed along with this received direct debit mandate in the web banking

UpdateReceivedSepaDirectDebitB2bMandateInput.consentRedirectUrl ● String! non-null scalar​

URL the user is redirected to after consent has been given

Member of​

updateReceivedSepaDirectDebitB2bMandate mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/update-supporting-document-input/index.html b/api-reference/inputs/update-supporting-document-input/index.html index 145e828a9b7..96cf86cb551 100644 --- a/api-reference/inputs/update-supporting-document-input/index.html +++ b/api-reference/inputs/update-supporting-document-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateSupportingDocumentInput

No description

input UpdateSupportingDocumentInput {
  supportingDocumentId: ID!
  supportingDocumentType: SupportingDocumentType
  supportingDocumentPurpose: SupportingDocumentPurposeEnum
}

Fields​

UpdateSupportingDocumentInput.supportingDocumentId ● ID! non-null scalar​

UpdateSupportingDocumentInput.supportingDocumentType ● SupportingDocumentType enum​

UpdateSupportingDocumentInput.supportingDocumentPurpose ● SupportingDocumentPurposeEnum enum​

Member of​

updateSupportingDocument mutation

- + \ No newline at end of file diff --git a/api-reference/inputs/update-user-consent-settings-input/index.html b/api-reference/inputs/update-user-consent-settings-input/index.html index 84b8c225cdc..fd7bca60f87 100644 --- a/api-reference/inputs/update-user-consent-settings-input/index.html +++ b/api-reference/inputs/update-user-consent-settings-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/updated-restricted-to-input/index.html b/api-reference/inputs/updated-restricted-to-input/index.html index bf6d4c1ed30..4b4d5e4149f 100644 --- a/api-reference/inputs/updated-restricted-to-input/index.html +++ b/api-reference/inputs/updated-restricted-to-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdatedRestrictedToInput

Input when the account membership is restricted to a verified user

input UpdatedRestrictedToInput {
  firstName: String
  lastName: String
  birthDate: Date
  phoneNumber: String
}

Fields​

UpdatedRestrictedToInput.firstName ● String scalar​

Account member first name

UpdatedRestrictedToInput.lastName ● String scalar​

Account member last name

UpdatedRestrictedToInput.birthDate ● Date scalar​

Account member birth date

UpdatedRestrictedToInput.phoneNumber ● String scalar​

Account member phone number

Member of​

UpdateAccountMembershipInput input

- + \ No newline at end of file diff --git a/api-reference/inputs/user-filter-input/index.html b/api-reference/inputs/user-filter-input/index.html index d574a6e6722..639a0f93beb 100644 --- a/api-reference/inputs/user-filter-input/index.html +++ b/api-reference/inputs/user-filter-input/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

UserFilterInput

No description

input UserFilterInput {
  birthDate: Date
  firstName: String
  identificationLevel: IdentificationLevelInput
  lastName: String
  mobilePhoneNumber: String
  nationalityCCA3: CCA3
  preferredNotificationChannel: PreferredNotificationChannel
  search: String
}

Fields​

UserFilterInput.birthDate ● Date scalar​

UserFilterInput.firstName ● String scalar​

UserFilterInput.identificationLevel ● IdentificationLevelInput enum​

UserFilterInput.lastName ● String scalar​

UserFilterInput.mobilePhoneNumber ● String scalar​

UserFilterInput.nationalityCCA3 ● CCA3 scalar​

UserFilterInput.preferredNotificationChannel ● PreferredNotificationChannel enum​

UserFilterInput.search ● String scalar​

Searches first name, last name, phone number and id Min length : 3 characters

Member of​

users query

- + \ No newline at end of file diff --git a/api-reference/inputs/user-order-by-input/index.html b/api-reference/inputs/user-order-by-input/index.html index 35e880c1383..a9f1765fe26 100644 --- a/api-reference/inputs/user-order-by-input/index.html +++ b/api-reference/inputs/user-order-by-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/view-card-numbers-input/index.html b/api-reference/inputs/view-card-numbers-input/index.html index b1333b3c99f..0d5a3e96669 100644 --- a/api-reference/inputs/view-card-numbers-input/index.html +++ b/api-reference/inputs/view-card-numbers-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/view-physical-card-numbers-input/index.html b/api-reference/inputs/view-physical-card-numbers-input/index.html index 02264d5ae5b..c47750a4178 100644 --- a/api-reference/inputs/view-physical-card-numbers-input/index.html +++ b/api-reference/inputs/view-physical-card-numbers-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/inputs/view-physical-card-pin-input/index.html b/api-reference/inputs/view-physical-card-pin-input/index.html index 29f0fa16942..203d18634df 100644 --- a/api-reference/inputs/view-physical-card-pin-input/index.html +++ b/api-reference/inputs/view-physical-card-pin-input/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/account-holder-info/index.html b/api-reference/interfaces/account-holder-info/index.html index 7e3849f4f7c..47dc2d5212d 100644 --- a/api-reference/interfaces/account-holder-info/index.html +++ b/api-reference/interfaces/account-holder-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/account-holder-status-info/index.html b/api-reference/interfaces/account-holder-status-info/index.html index cc88d5294cb..47fca58704c 100644 --- a/api-reference/interfaces/account-holder-status-info/index.html +++ b/api-reference/interfaces/account-holder-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/account-membership-status-info/index.html b/api-reference/interfaces/account-membership-status-info/index.html index dca269b492c..6cb71c809b8 100644 --- a/api-reference/interfaces/account-membership-status-info/index.html +++ b/api-reference/interfaces/account-membership-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipStatusInfo

here are the different account membership status:

interface AccountMembershipStatusInfo {
  status: AccountMembershipStatus!
}

Fields​

AccountMembershipStatusInfo.status ● AccountMembershipStatus! non-null enum​

AccountMembership status

Member of​

AccountMembership object

Implemented by​

AccountMembershipBindingUserErrorStatusInfo object ● AccountMembershipConsentPendingStatusInfo object ● AccountMembershipDisabledStatusInfo object ● AccountMembershipEnabledStatusInfo object ● AccountMembershipInvitationSentStatusInfo object ● AccountMembershipSuspendedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/account-status-info/index.html b/api-reference/interfaces/account-status-info/index.html index c6c91ee3c44..1631a5d9ee9 100644 --- a/api-reference/interfaces/account-status-info/index.html +++ b/api-reference/interfaces/account-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/account-verification-status-info/index.html b/api-reference/interfaces/account-verification-status-info/index.html index eb2f391c51e..487f6470314 100644 --- a/api-reference/interfaces/account-verification-status-info/index.html +++ b/api-reference/interfaces/account-verification-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountVerificationStatusInfo

Account Verification Status Information

interface AccountVerificationStatusInfo {
  status: AccountVerificationStatus!
}

Fields​

AccountVerificationStatusInfo.status ● AccountVerificationStatus! non-null enum​

Account verification status

Member of​

AccountVerification interface ● DirectDebitAccountVerification object

Implemented by​

PendingReviewStatusInfo object ● PendingVerificationStatusInfo object ● RejectedVerificationStatusInfo object ● VerifiedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/account-verification/index.html b/api-reference/interfaces/account-verification/index.html index 1dc5a30e04d..e36ac323430 100644 --- a/api-reference/interfaces/account-verification/index.html +++ b/api-reference/interfaces/account-verification/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountVerification

Account Verification

interface AccountVerification {
  createdAt: DateTime!
  id: ID!
  statusInfo: AccountVerificationStatusInfo!
  updatedAt: DateTime!
}

Fields​

AccountVerification.createdAt ● DateTime! non-null scalar​

Creation date of the account verification

AccountVerification.id ● ID! non-null scalar​

Unique identifier of the Account Verification

AccountVerification.statusInfo ● AccountVerificationStatusInfo! non-null interface​

Account Verification Status Information

AccountVerification.updatedAt ● DateTime! non-null scalar​

Last update date of the account verification

Implemented by​

DirectDebitAccountVerification object

- + \ No newline at end of file diff --git a/api-reference/interfaces/beneficiary/index.html b/api-reference/interfaces/beneficiary/index.html index b292469a565..62dd58eabc7 100644 --- a/api-reference/interfaces/beneficiary/index.html +++ b/api-reference/interfaces/beneficiary/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

Beneficiary

SOON TO BE DEPRECATED Beneficiary

interface Beneficiary {
  id: ID
  name: String!
  isMyOwnIban: Boolean!
}

Fields​

Beneficiary.id ● ID scalar​

unique identifier of a beneficiary

Beneficiary.name ● String! non-null scalar​

full name of the beneficiary

Beneficiary.isMyOwnIban ● Boolean! non-null scalar​

true if this new beneficiary is the account holder himself in an other financial institution.

Implemented by​

InternalBeneficiary object ● SEPABeneficiary object

- + \ No newline at end of file diff --git a/api-reference/interfaces/capital-deposit-document-status-info/index.html b/api-reference/interfaces/capital-deposit-document-status-info/index.html index 40762c30a2b..41bb1b673ed 100644 --- a/api-reference/interfaces/capital-deposit-document-status-info/index.html +++ b/api-reference/interfaces/capital-deposit-document-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositDocumentStatusInfo

Status info of the document.

interface CapitalDepositDocumentStatusInfo {
  status: CapitalDepositDocumentStatus!
}

Fields​

CapitalDepositDocumentStatusInfo.status ● CapitalDepositDocumentStatus! non-null enum​

Status of the document.

Member of​

CapitalDepositDocument object

Implemented by​

CapitalDepositDocumentPendingStatusInfo object ● CapitalDepositDocumentRefusedStatusInfo object ● CapitalDepositDocumentUploadedStatusInfo object ● CapitalDepositDocumentValidatedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/card-status-info/index.html b/api-reference/interfaces/card-status-info/index.html index e12834f628c..16a5ce9f258 100644 --- a/api-reference/interfaces/card-status-info/index.html +++ b/api-reference/interfaces/card-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/complete-digital-card-status-info/index.html b/api-reference/interfaces/complete-digital-card-status-info/index.html index ba7f2085567..bf0cf95c60b 100644 --- a/api-reference/interfaces/complete-digital-card-status-info/index.html +++ b/api-reference/interfaces/complete-digital-card-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/connection/index.html b/api-reference/interfaces/connection/index.html index 96c502ad1c4..47ffe851b30 100644 --- a/api-reference/interfaces/connection/index.html +++ b/api-reference/interfaces/connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Connection

Relay Connection type, used to paginate list of element (Learn More)

interface Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [Edge!]!
}

Fields​

Connection.totalCount ● Int! non-null scalar​

Total number of element in the list

Connection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

Connection.edges ● [Edge!]! non-null interface​

Edge list

Implemented by​

AccountConnection object ● AccountHolderConnection object ● AccountMembershipConnection object ● CapitalDepositCaseConnection object ● CardConnection object ● ConsentConnection object ● DigitalCardConnection object ● ExternalAccountConnection object ● ExternalBalanceConnection object ● FundingLimitSettingsChangeRequestConnection object ● FundingSourceConnection object ● InvoiceConnection object ● LegalDocumentConnection object ● MerchantProfileConnection object ● OnboardingConnection object ● PaymentConnection object ● PaymentMandateConnection object ● ReceivedDirectDebitMandateConnection object ● StandingOrderConnection object ● StatementConnection object ● SupportingDocumentCollectionConnection object ● TransactionConnection object ● UserConnection object ● VirtualIBANEntryConnection object

- + \ No newline at end of file diff --git a/api-reference/interfaces/digital-card/index.html b/api-reference/interfaces/digital-card/index.html index c0f2571dd3f..ae333d19f6f 100644 --- a/api-reference/interfaces/digital-card/index.html +++ b/api-reference/interfaces/digital-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DigitalCard

Digital Card used for ApplePay or GooglePay

interface DigitalCard {
  id: ID!
  type: DigitalizationType!
  createdAt: DateTime!
  updatedAt: DateTime!
  walletProvider: WalletProvider!
}

Fields​

DigitalCard.id ● ID! non-null scalar​

Unique identifier of a digital card

DigitalCard.type ● DigitalizationType! non-null enum​

The type of digitalization that created this digital card.

DigitalCard.createdAt ● DateTime! non-null scalar​

Created date

DigitalCard.updatedAt ● DateTime! non-null scalar​

Updated date

DigitalCard.walletProvider ● WalletProvider! non-null object​

Wallet Provider (ApplePay, GooglePay ...)

Member of​

CancelDigitalCardSuccessPayload object ● DigitalCardEdge object

Implemented by​

CompleteDigitalCard object ● PendingDigitalCard object

- + \ No newline at end of file diff --git a/api-reference/interfaces/document-file/index.html b/api-reference/interfaces/document-file/index.html index 88d78f096dc..1e397a0833f 100644 --- a/api-reference/interfaces/document-file/index.html +++ b/api-reference/interfaces/document-file/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/edge/index.html b/api-reference/interfaces/edge/index.html index 0aa8156f064..5a97f07392b 100644 --- a/api-reference/interfaces/edge/index.html +++ b/api-reference/interfaces/edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

Edge

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

interface Edge {
  cursor: String!
}

Fields​

Edge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

Member of​

Connection interface

Implemented by​

AccountEdge object ● AccountHolderEdge object ● AccountMembershipEdge object ● CapitalDepositCaseEdge object ● CardEdge object ● ConsentEdge object ● DigitalCardEdge object ● ExternalAccountEdge object ● ExternalBalanceEdge object ● FundingLimitSettingsChangeRequestEdge object ● FundingSourceEdge object ● IdentificationEdge object ● InvoiceEdge object ● LegalDocumentEdge object ● MerchantProfileEdge object ● OnboardingEdge object ● PaymentEdge object ● PaymentMandateEdge object ● ReceivedDirectDebitMandateEdge object ● StandingOrderEdge object ● StatementEdge object ● SupportingDocumentCollectionEdge object ● TransactionEdge object ● UserEdge object ● VirtualIBANEntryEdge object

- + \ No newline at end of file diff --git a/api-reference/interfaces/fee-creditor/index.html b/api-reference/interfaces/fee-creditor/index.html index 4db76ee9e07..7eb37fbffc4 100644 --- a/api-reference/interfaces/fee-creditor/index.html +++ b/api-reference/interfaces/fee-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/fee-debtor/index.html b/api-reference/interfaces/fee-debtor/index.html index 29efa9424ff..3963385c893 100644 --- a/api-reference/interfaces/fee-debtor/index.html +++ b/api-reference/interfaces/fee-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/field/index.html b/api-reference/interfaces/field/index.html index 83b93c1177c..d6f6737c652 100644 --- a/api-reference/interfaces/field/index.html +++ b/api-reference/interfaces/field/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/funding-limit-settings-change-request-status-info/index.html b/api-reference/interfaces/funding-limit-settings-change-request-status-info/index.html index 7af6d9cffc7..5b711501451 100644 --- a/api-reference/interfaces/funding-limit-settings-change-request-status-info/index.html +++ b/api-reference/interfaces/funding-limit-settings-change-request-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestStatusInfo

Object containing details about funding limit settings change request status

interface FundingLimitSettingsChangeRequestStatusInfo {
  status: FundingLimitSettingsChangeRequestStatus!
}

Fields​

FundingLimitSettingsChangeRequestStatusInfo.status ● FundingLimitSettingsChangeRequestStatus! non-null enum​

Current limit settings change request status.

Member of​

FundingLimitSettingsChangeRequest object

Implemented by​

FundingLimitSettingsChangeRequestApprovedStatusInfo object ● FundingLimitSettingsChangeRequestPendingStatusInfo object ● FundingLimitSettingsChangeRequestRefusedStatusInfo object ● FundingLimitSettingsChangeRequestWaitingForInformationStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/funding-limit-settings-status-info/index.html b/api-reference/interfaces/funding-limit-settings-status-info/index.html index 1c47cbc8285..1ad9eead2c0 100644 --- a/api-reference/interfaces/funding-limit-settings-status-info/index.html +++ b/api-reference/interfaces/funding-limit-settings-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsStatusInfo

Object containing details about funding limit settings status

interface FundingLimitSettingsStatusInfo {
  status: FundingLimitSettingsStatus!
}

Fields​

FundingLimitSettingsStatusInfo.status ● FundingLimitSettingsStatus! non-null enum​

Current funding limit settings.

Member of​

FundingLimitSettings object

Implemented by​

DisabledFundingLimitSettingsStatusInfo object ● EnabledFundingLimitSettingsStatusInfo object ● SuspendedFundingLimitSettingsStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/funding-source-status-info/index.html b/api-reference/interfaces/funding-source-status-info/index.html index c78ff8d51ac..ce5d61a80d6 100644 --- a/api-reference/interfaces/funding-source-status-info/index.html +++ b/api-reference/interfaces/funding-source-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingSourceStatusInfo

Funding Source status information

interface FundingSourceStatusInfo {
  status: FundingSourceStatus!
}

Fields​

FundingSourceStatusInfo.status ● FundingSourceStatus! non-null enum​

Funding Source Pending status

Member of​

DirectDebitFundingSource object ● FundingSource interface

Implemented by​

CanceledFundingSourceStatusInfo object ● EnabledFundingSourceStatusInfo object ● PendingFundingSourceStatusInfo object ● RejectedFundingSourceStatusInfo object ● SuspendedFundingSourceStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/funding-source/index.html b/api-reference/interfaces/funding-source/index.html index 8bc15fca56b..2d7e1037f40 100644 --- a/api-reference/interfaces/funding-source/index.html +++ b/api-reference/interfaces/funding-source/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingSource

Funding Source

interface FundingSource {
  id: ID!
  name: String
  statusInfo: FundingSourceStatusInfo!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

FundingSource.id ● ID! non-null scalar​

ID of the Funding Source

FundingSource.name ● String scalar​

Name of the Funding Source

FundingSource.statusInfo ● FundingSourceStatusInfo! non-null interface​

Funding Source status information

FundingSource.createdAt ● DateTime! non-null scalar​

Created date

FundingSource.updatedAt ● DateTime! non-null scalar​

Last updated date

Returned by​

fundingSource query

Member of​

AddDirectDebitFundingSourceSuccessPayload object ● CancelFundingSourceSuccessPayload object ● FundingSourceEdge object

Implemented by​

DirectDebitFundingSource object

- + \ No newline at end of file diff --git a/api-reference/interfaces/individual-ultimate-beneficial-owner-info/index.html b/api-reference/interfaces/individual-ultimate-beneficial-owner-info/index.html index d3340171a1c..d4c9a9e255c 100644 --- a/api-reference/interfaces/individual-ultimate-beneficial-owner-info/index.html +++ b/api-reference/interfaces/individual-ultimate-beneficial-owner-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IndividualUltimateBeneficialOwnerInfo

Define the type of the UBO

interface IndividualUltimateBeneficialOwnerInfo {
  type: IndividualUltimateBeneficialOwnerTypeEnum!
}

Fields​

IndividualUltimateBeneficialOwnerInfo.type ● IndividualUltimateBeneficialOwnerTypeEnum! non-null enum​

Individual type

Member of​

IndividualUltimateBeneficialOwner object

Implemented by​

IndividualUltimateBeneficialOwnerTypeHasCapital object ● IndividualUltimateBeneficialOwnerTypeLegalRepresentative object ● IndividualUltimateBeneficialOwnerTypeOther object

- + \ No newline at end of file diff --git a/api-reference/interfaces/internal-credit-transfer-creditor/index.html b/api-reference/interfaces/internal-credit-transfer-creditor/index.html index a5930e2f538..788bf69d5ce 100644 --- a/api-reference/interfaces/internal-credit-transfer-creditor/index.html +++ b/api-reference/interfaces/internal-credit-transfer-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalCreditTransferCreditor

Internal Credit Transfer creditor

interface InternalCreditTransferCreditor {
  name: String!
  accountNumber: AccountNumber!
}

Fields​

InternalCreditTransferCreditor.name ● String! non-null scalar​

full name of the Creditor

InternalCreditTransferCreditor.accountNumber ● AccountNumber! non-null scalar​

account number

Member of​

InternalCreditTransfer object

Implemented by​

InternalCreditTransferInCreditor object ● InternalCreditTransferOutCreditor object

- + \ No newline at end of file diff --git a/api-reference/interfaces/internal-credit-transfer-debtor/index.html b/api-reference/interfaces/internal-credit-transfer-debtor/index.html index b5a98b54c22..49a279533c6 100644 --- a/api-reference/interfaces/internal-credit-transfer-debtor/index.html +++ b/api-reference/interfaces/internal-credit-transfer-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalCreditTransferDebtor

Internal Credit Transfer debtor

interface InternalCreditTransferDebtor {
  name: String!
  accountNumber: AccountNumber!
}

Fields​

InternalCreditTransferDebtor.name ● String! non-null scalar​

full name of the debtor

InternalCreditTransferDebtor.accountNumber ● AccountNumber! non-null scalar​

account number

Member of​

InternalCreditTransfer object

Implemented by​

InternalCreditTransferInDebtor object ● InternalCreditTransferOutDebtor object

- + \ No newline at end of file diff --git a/api-reference/interfaces/internal-direct-debit-mandate/index.html b/api-reference/interfaces/internal-direct-debit-mandate/index.html index 85dd3bae076..40aa6bfe294 100644 --- a/api-reference/interfaces/internal-direct-debit-mandate/index.html +++ b/api-reference/interfaces/internal-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/legal-document-status-info/index.html b/api-reference/interfaces/legal-document-status-info/index.html index c99eafe5dac..35cb567d9be 100644 --- a/api-reference/interfaces/legal-document-status-info/index.html +++ b/api-reference/interfaces/legal-document-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/merchant-payment-link-status-info/index.html b/api-reference/interfaces/merchant-payment-link-status-info/index.html index a4905daa4c8..0db6392f2dd 100644 --- a/api-reference/interfaces/merchant-payment-link-status-info/index.html +++ b/api-reference/interfaces/merchant-payment-link-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/merchant-payment-method-status-info/index.html b/api-reference/interfaces/merchant-payment-method-status-info/index.html index e2108957d05..4ecff5d6438 100644 --- a/api-reference/interfaces/merchant-payment-method-status-info/index.html +++ b/api-reference/interfaces/merchant-payment-method-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantPaymentMethodStatusInfo

The payment method status information

interface MerchantPaymentMethodStatusInfo {
  status: MerchantPaymentMethodStatus!
}

Fields​

MerchantPaymentMethodStatusInfo.status ● MerchantPaymentMethodStatus! non-null enum​

Merchant Payment Method Status

Member of​

CheckMerchantPaymentMethod object ● InternalDirectDebitB2BMerchantPaymentMethod object ● InternalDirectDebitStandardMerchantPaymentMethod object ● MerchantPaymentMethod interface ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitCoreMerchantPaymentMethod object

Implemented by​

CanceledMerchantPaymentMethodStatusInfo object ● DisabledMerchantPaymentMethodStatusInfo object ● EnabledMerchantPaymentMethodStatusInfo object ● PendingMerchantPaymentMethodStatusInfo object ● RejectedMerchantPaymentMethodStatusInfo object ● SuspendedMerchantPaymentMethodStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/merchant-payment-method/index.html b/api-reference/interfaces/merchant-payment-method/index.html index 4f528e456af..1850b0faba1 100644 --- a/api-reference/interfaces/merchant-payment-method/index.html +++ b/api-reference/interfaces/merchant-payment-method/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantPaymentMethod

Base object for the different Payment Methods available

interface MerchantPaymentMethod {
  id: ID!
  type: MerchantPaymentMethodType!
  methodId: ID!
  statusInfo: MerchantPaymentMethodStatusInfo!
  version: Int!
  updatedAt: Date!
  rollingReserve: RollingReserve
}

Fields​

MerchantPaymentMethod.id ● ID! non-null scalar​

Unique identifier tied to every version of a given Merchant Payment Method

MerchantPaymentMethod.type ● MerchantPaymentMethodType! non-null enum​

The Merchant Payment Method Type

MerchantPaymentMethod.methodId ● ID! non-null scalar​

Unique identifier for a given merchant Payment Method, identical for every version of a given Merchant Payment Method Type

MerchantPaymentMethod.statusInfo ● MerchantPaymentMethodStatusInfo! non-null interface​

Status of the Merchant Payment Method

MerchantPaymentMethod.version ● Int! non-null scalar​

Version of the Merchant Payment Method

MerchantPaymentMethod.updatedAt ● Date! non-null scalar​

Date at which the Merchant Payment Method was last updated

MerchantPaymentMethod.rollingReserve ● RollingReserve object​

Rolling Reserve applied to the Merchant Payment Method

Member of​

MerchantPaymentLink object ● MerchantProfile object

Implemented by​

CheckMerchantPaymentMethod object ● InternalDirectDebitB2BMerchantPaymentMethod object ● InternalDirectDebitStandardMerchantPaymentMethod object ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitCoreMerchantPaymentMethod object

- + \ No newline at end of file diff --git a/api-reference/interfaces/merchant-profile-status-info/index.html b/api-reference/interfaces/merchant-profile-status-info/index.html index 0a367b3b549..db407bab9ac 100644 --- a/api-reference/interfaces/merchant-profile-status-info/index.html +++ b/api-reference/interfaces/merchant-profile-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantProfileStatusInfo

Merchant Profile Status Information

interface MerchantProfileStatusInfo {
  status: MerchantProfileStatus!
}

Fields​

MerchantProfileStatusInfo.status ● MerchantProfileStatus! non-null enum​

Member of​

MerchantProfile object

Implemented by​

CanceledMerchantProfileStatusInfo object ● EnabledMerchantProfileStatusInfo object ● PendingReviewMerchantProfileStatusInfo object ● RejectedMerchantProfileStatusInfo object ● SuspendedMerchantProfileStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/onboarding-account-holder-info/index.html b/api-reference/interfaces/onboarding-account-holder-info/index.html index c9eb9688020..8aef136865c 100644 --- a/api-reference/interfaces/onboarding-account-holder-info/index.html +++ b/api-reference/interfaces/onboarding-account-holder-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/onboarding-status-info/index.html b/api-reference/interfaces/onboarding-status-info/index.html index 8b6ecc9d40a..dcb84533a5a 100644 --- a/api-reference/interfaces/onboarding-status-info/index.html +++ b/api-reference/interfaces/onboarding-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardingStatusInfo

Object containing details about onboarding status (valid/invalid and why it is invalid/already finalized)

interface OnboardingStatusInfo {
  status: OnboardingStatus!
}

Fields​

OnboardingStatusInfo.status ● OnboardingStatus! non-null enum​

Current onboarding status. Onboarding can only be finalized if status is "valid"

Member of​

Onboarding object ● OnboardingInfo object

Implemented by​

OnboardingFinalizedStatusInfo object ● OnboardingInvalidStatusInfo object ● OnboardingValidStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/partnership-status-info/index.html b/api-reference/interfaces/partnership-status-info/index.html index 6d68ea93707..269c8359fcb 100644 --- a/api-reference/interfaces/partnership-status-info/index.html +++ b/api-reference/interfaces/partnership-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/payment-direct-debit-mandate/index.html b/api-reference/interfaces/payment-direct-debit-mandate/index.html index dd16f3b8598..e23a9274e47 100644 --- a/api-reference/interfaces/payment-direct-debit-mandate/index.html +++ b/api-reference/interfaces/payment-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/payment-mandate-creditor/index.html b/api-reference/interfaces/payment-mandate-creditor/index.html index 32b57616ead..867f3cd93ce 100644 --- a/api-reference/interfaces/payment-mandate-creditor/index.html +++ b/api-reference/interfaces/payment-mandate-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/payment-mandate-debtor/index.html b/api-reference/interfaces/payment-mandate-debtor/index.html index ad5a62f0911..e95df229160 100644 --- a/api-reference/interfaces/payment-mandate-debtor/index.html +++ b/api-reference/interfaces/payment-mandate-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/payment-mandate-status-info/index.html b/api-reference/interfaces/payment-mandate-status-info/index.html index 6e9a1cf26cf..257822bcd0b 100644 --- a/api-reference/interfaces/payment-mandate-status-info/index.html +++ b/api-reference/interfaces/payment-mandate-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PaymentMandateStatusInfo

Payment Mandate status information

interface PaymentMandateStatusInfo {
  status: PaymentMandateStatus!
}

Fields​

PaymentMandateStatusInfo.status ● PaymentMandateStatus! non-null enum​

Status of the payment mandate.

Member of​

InternalPaymentDirectDebitMandate object ● SEPAPaymentDirectDebitMandate object

Implemented by​

PaymentMandateCanceledStatusInfo object ● PaymentMandateConsentPendingStatusInfo object ● PaymentMandateEnabledStatusInfo object ● PaymentMandateRejectedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/payment-mandate/index.html b/api-reference/interfaces/payment-mandate/index.html index f8ac2b3d13c..46671c4ad84 100644 --- a/api-reference/interfaces/payment-mandate/index.html +++ b/api-reference/interfaces/payment-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/payment-status-info/index.html b/api-reference/interfaces/payment-status-info/index.html index b397a90ad27..0aaee3ba18d 100644 --- a/api-reference/interfaces/payment-status-info/index.html +++ b/api-reference/interfaces/payment-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/pending-digital-card-status-info/index.html b/api-reference/interfaces/pending-digital-card-status-info/index.html index a5665b54c48..736483d4f87 100644 --- a/api-reference/interfaces/pending-digital-card-status-info/index.html +++ b/api-reference/interfaces/pending-digital-card-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/physical-card-status-info/index.html b/api-reference/interfaces/physical-card-status-info/index.html index 71e35956e98..4f9961b2661 100644 --- a/api-reference/interfaces/physical-card-status-info/index.html +++ b/api-reference/interfaces/physical-card-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardStatusInfo

Physical Card Status Information

interface PhysicalCardStatusInfo {
  status: PhysicalCardStatus!
}

Fields​

PhysicalCardStatusInfo.status ● PhysicalCardStatus! non-null enum​

Status of the physical card.

Member of​

PhysicalCard object

Implemented by​

PhysicalCardActivatedStatusInfo object ● PhysicalCardCanceledStatusInfo object ● PhysicalCardCancelingStatusInfo object ● PhysicalCardConsentPendingStatusInfo object ● PhysicalCardProcessingStatusInfo object ● PhysicalCardRenewedStatusInfo object ● PhysicalCardSuspendedStatusInfo object ● PhysicalCardToActivateStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/reason/index.html b/api-reference/interfaces/reason/index.html index fe538ea31dc..0ca73c95a7c 100644 --- a/api-reference/interfaces/reason/index.html +++ b/api-reference/interfaces/reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/received-direct-debit-mandate-status-info/index.html b/api-reference/interfaces/received-direct-debit-mandate-status-info/index.html index aaf1c88dc95..d3bd92f47bd 100644 --- a/api-reference/interfaces/received-direct-debit-mandate-status-info/index.html +++ b/api-reference/interfaces/received-direct-debit-mandate-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateStatusInfo

Received Direct Debit Mandate status information

interface ReceivedDirectDebitMandateStatusInfo {
  status: ReceivedDirectDebitMandateStatus!
}

Fields​

ReceivedDirectDebitMandateStatusInfo.status ● ReceivedDirectDebitMandateStatus! non-null enum​

Received Direct Debit Mandate status

Member of​

InternalReceivedDirectDebitMandate object ● ReceivedDirectDebitMandate interface ● SEPAReceivedDirectDebitMandate object

Implemented by​

ReceivedDirectDebitMandateStatusInfoCanceled object ● ReceivedDirectDebitMandateStatusInfoConsentInitiationPending object ● ReceivedDirectDebitMandateStatusInfoConsentPending object ● ReceivedDirectDebitMandateStatusInfoEnabled object ● ReceivedDirectDebitMandateStatusInfoSuspended object

- + \ No newline at end of file diff --git a/api-reference/interfaces/received-direct-debit-mandate/index.html b/api-reference/interfaces/received-direct-debit-mandate/index.html index 53fa139dbea..a9ba94a7cbb 100644 --- a/api-reference/interfaces/received-direct-debit-mandate/index.html +++ b/api-reference/interfaces/received-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandate

Interface for Received Direct Debit Mandate

interface ReceivedDirectDebitMandate {
  id: ID!
  version: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  signatureDate: Date
  executedAt: DateTime
  expiredAt: Date
  statusInfo: ReceivedDirectDebitMandateStatusInfo!
  name: String
}

Fields​

ReceivedDirectDebitMandate.id ● ID! non-null scalar​

Unique identifier of the received direct debit mandate, generated by Swan

ReceivedDirectDebitMandate.version ● String! non-null scalar​

Version of the received direct debit mandate

ReceivedDirectDebitMandate.createdAt ● DateTime! non-null scalar​

Creation date of the received direct debit mandate

ReceivedDirectDebitMandate.updatedAt ● DateTime! non-null scalar​

Last Update date of the received direct debit mandate

ReceivedDirectDebitMandate.signatureDate ● Date scalar​

Date of signature of the received direct debit mandate

ReceivedDirectDebitMandate.executedAt ● DateTime scalar​

Date of the last direct debit transaction executed for the concerned received direct debit mandate

ReceivedDirectDebitMandate.expiredAt ● Date scalar​

Expiry date of the received direct debit mandate

ReceivedDirectDebitMandate.statusInfo ● ReceivedDirectDebitMandateStatusInfo! non-null interface​

Mandate status information of the received direct debit mandate

ReceivedDirectDebitMandate.name ● String scalar​

Mandate name

Returned by​

receivedDirectDebitMandate query

Member of​

AddReceivedInternalDirectDebitB2bMandateSuccessPayload object ● AddReceivedSepaDirectDebitB2bMandateSuccessPayload object ● EnableReceivedDirectDebitMandateSuccessPayload object ● ReceivedDirectDebitMandateEdge object ● SuspendReceivedDirectDebitMandateSuccessPayload object ● UpdateReceivedSepaDirectDebitB2bMandateSuccessPayload object

Implemented by​

InternalReceivedDirectDebitMandate object ● SEPAReceivedDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/interfaces/rejection/index.html b/api-reference/interfaces/rejection/index.html index 7bcd5ec79c0..1af4b81e702 100644 --- a/api-reference/interfaces/rejection/index.html +++ b/api-reference/interfaces/rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Rejection

No description

interface Rejection {
  message: String!
}

Fields​

Rejection.message ● String! non-null scalar​

Implemented by​

AccountHolderNotFoundRejection object ● AccountHolderTypeIndividualRejection object ● AccountMembershipCannotBeDisabledRejection object ● AccountMembershipCannotBeUpdatedRejection object ● AccountMembershipNotAllowedRejection object ● AccountMembershipNotFoundRejection object ● AccountMembershipNotReadyToBeBoundRejection object ● AccountNotEligibleRejection object ● AccountNotFoundRejection object ● AccountVerificationAlreadyRejectedRejection object ● AccountVerificationWrongStatusRejection object ● AddingCardsToDifferentAccountsRejection object ● AlreadyValidPhysicalCardRejection object ● ApplePayNotAllowedForProjectRejection object ● BadAccountStatusRejection object ● BadRequestRejection object ● CannotActivatePhysicalCardRejection object ● CapitalDepositDocumentCanNotBeUploaded object ● CapitalDepositDocumentCanNotBeUploadedRejection object ● CardCanNotBeDigitalizedRejection object ● CardNotFoundRejection object ● CardProductDisabledRejection object ● CardProductNotApplicableToPhysicalCardsRejection object ● CardProductNotFoundRejection object ● CardProductSuspendedRejection object ● CardProductUsedRejection object ● CardWrongStatusRejection object ● ConsentNotFoundRejection object ● ConsentsAlreadyLinkedToMultiConsentRejection object ● ConsentsNotAllInCreatedStatusRejection object ● ConsentsNotFoundRejection object ● ConsentTypeNotSupportedByServerConsentRejection object ● DebtorAccountClosedRejection object ● DebtorAccountNotAllowedRejection object ● DigitalCardNotFoundRejection object ● EnabledCardDesignNotFoundRejection object ● ExternalAccountAlreadyExistsRejection object ● ExternalAccountBalanceAlreadyExistsRejection object ● FeeSettingsNotFoundRejection object ● ForbiddenRejection object ● FundingLimitExceededRejection object ● FundingLimitSettingsChangeRequestBadAmountRejection object ● FundingSourceNotFoundRejection object ● FundingSourceWrongStatusRejection object ● GlobalFundingLimitExceededRejection object ● GlobalInstantFundingLimitExceededRejection object ● IBANNotReachableRejection object ● IBANNotValidRejection object ● IbanValidationRejection object ● IdentityAlreadyBindToAccountMembershipRejection object ● InstantFundingLimitExceededRejection object ● InsufficientFundsRejection object ● InternalErrorRejection object ● InvalidArgumentRejection object ● InvalidPhoneNumberRejection object ● InvalidSirenNumberRejection object ● LegalRepresentativeAccountMembershipCannotBeDisabledRejection object ● LegalRepresentativeAccountMembershipCannotBeSuspendedRejection object ● MerchantPaymentMethodNotActiveRejection object ● MerchantProfileWrongStatusRejection object ● MissingMandatoryFieldRejection object ● NotFoundRejection object ● NotReachableConsentStatusRejection object ● NotSupportedCountryRejection object ● OnboardingNotCompletedRejection object ● PaymentMandateMandateNotFoundRejection object ● PaymentMandateReferenceAlreadyUsedRejection object ● PaymentMethodNotCompatibleRejection object ● PermissionCannotBeGrantedRejection object ● PhysicalCardNotFoundRejection object ● PhysicalCardWrongStatusRejection object ● PINNotReadyRejection object ● ProjectForbiddenRejection object ● ProjectFundingLimitExceededRejection object ● ProjectInstantFundingLimitExceededRejection object ● ProjectInvalidStatusRejection object ● ProjectNotFound object ● ProjectNotFoundRejection object ● ProjectSettingsForbiddenError object ● ProjectSettingsNotFound object ● ProjectSettingsStatusNotReachable object ● PublicOnboardingDisabledRejection object ● ReceivedDirectDebitMandateAlreadyExistRejection object ● ReceivedDirectDebitMandateCanceledRejection object ● ReceivedDirectDebitMandateNotB2bRejection object ● ReceivedDirectDebitMandateNotFoundRejection object ● RefundRejection object ● RestrictedToUserRejection object ● SchemeWrongRejection object ● ServerConsentCredentialsNotValidOrOutdatedRejection object ● ServerConsentNotAllowedForConsentOperationRejection object ● ServerConsentNotAllowedForProjectRejection object ● ServerConsentProjectCredentialMissingRejection object ● ServerConsentProjectCredentialNotFoundRejection object ● ServerConsentProjectSettingsNotFoundRejection object ● ServerConsentSignatureNotValidRejection object ● StandingOrderNotFoundRejection object ● SupportingDocumentCollectionNotFoundRejection object ● SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection object ● SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection object ● SupportingDocumentCollectionStatusNotAllowedRejection object ● SupportingDocumentNotFoundRejection object ● SupportingDocumentStatusDoesNotAllowDeletionRejection object ● SupportingDocumentStatusDoesNotAllowUpdateRejection object ● SupportingDocumentStatusNotAllowedRejection object ● SupportingDocumentUploadNotAllowedRejection object ● SuspendReceivedDirectDebitMandatedRejection object ● SwanTCUDocumentNotFoundRejection object ● SwanTCUDocumentStatusNotAllowedRejection object ● TooManyChildConsentsRejection object ● TooManyItemsRejection object ● TransactionNotFoundRejection object ● UpdateUserConsentSettingsTokenRejection object ● UserNotAllowedToDisableItsOwnAccountMembershipRejection object ● UserNotAllowedToManageAccountMembershipRejection object ● UserNotAllowedToSuspendItsOwnAccountMembershipRejection object ● UserNotCardHolderRejection object ● ValidationRejection object ● WrongValueProvidedRejection object

- + \ No newline at end of file diff --git a/api-reference/interfaces/sepacredit-transfer-creditor/index.html b/api-reference/interfaces/sepacredit-transfer-creditor/index.html index 3859d4f842a..73ac3577f44 100644 --- a/api-reference/interfaces/sepacredit-transfer-creditor/index.html +++ b/api-reference/interfaces/sepacredit-transfer-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPACreditTransferCreditor

Sepa Credit Transfer Creditor

interface SEPACreditTransferCreditor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
}

Fields​

SEPACreditTransferCreditor.name ● String! non-null scalar​

full name of the creditor

SEPACreditTransferCreditor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPACreditTransferCreditor.IBAN ● String scalar​

IBAN

SEPACreditTransferCreditor.BIC ● String scalar​

BIC

Member of​

SEPACreditTransferTransaction object

Implemented by​

SEPACreditTransferInCreditor object ● SEPACreditTransferInternalOutCreditor object ● SEPACreditTransferOutCreditor object

- + \ No newline at end of file diff --git a/api-reference/interfaces/sepacredit-transfer-debtor/index.html b/api-reference/interfaces/sepacredit-transfer-debtor/index.html index d17203142db..3aaf06491be 100644 --- a/api-reference/interfaces/sepacredit-transfer-debtor/index.html +++ b/api-reference/interfaces/sepacredit-transfer-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPACreditTransferDebtor

Sepa Credit Transfer Debtor

interface SEPACreditTransferDebtor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
}

Fields​

SEPACreditTransferDebtor.name ● String! non-null scalar​

full name of the debtor

SEPACreditTransferDebtor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPACreditTransferDebtor.IBAN ● String scalar​

IBAN

SEPACreditTransferDebtor.BIC ● String scalar​

BIC

Member of​

SEPACreditTransferTransaction object

Implemented by​

SEPACreditTransferInDebtor object ● SEPACreditTransferInternalInDebtor object ● SEPACreditTransferOutDebtor object

- + \ No newline at end of file diff --git a/api-reference/interfaces/sepadirect-debit-creditor/index.html b/api-reference/interfaces/sepadirect-debit-creditor/index.html index b48af7eb475..3b29022d71f 100644 --- a/api-reference/interfaces/sepadirect-debit-creditor/index.html +++ b/api-reference/interfaces/sepadirect-debit-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPADirectDebitCreditor

Sepa Direct Debit Creditor

interface SEPADirectDebitCreditor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
}

Fields​

SEPADirectDebitCreditor.name ● String! non-null scalar​

full name of the creditor

SEPADirectDebitCreditor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPADirectDebitCreditor.IBAN ● String scalar​

IBAN

SEPADirectDebitCreditor.BIC ● String scalar​

BIC

Member of​

SEPADirectDebitTransaction object

Implemented by​

SEPADirectDebitInCreditor object ● SEPADirectDebitOutCreditor object

- + \ No newline at end of file diff --git a/api-reference/interfaces/sepadirect-debit-debtor/index.html b/api-reference/interfaces/sepadirect-debit-debtor/index.html index 15d9f1bf3d5..4eb26dd75c8 100644 --- a/api-reference/interfaces/sepadirect-debit-debtor/index.html +++ b/api-reference/interfaces/sepadirect-debit-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPADirectDebitDebtor

Sepa Direct Debit Debtor

interface SEPADirectDebitDebtor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
}

Fields​

SEPADirectDebitDebtor.name ● String! non-null scalar​

full name of the debtor

SEPADirectDebitDebtor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPADirectDebitDebtor.IBAN ● String scalar​

IBAN

SEPADirectDebitDebtor.BIC ● String scalar​

BIC

Member of​

SEPADirectDebitTransaction object

Implemented by​

SEPADirectDebitInDebtor object ● SEPADirectDebitOutDebtor object

- + \ No newline at end of file diff --git a/api-reference/interfaces/sepadirect-debit-mandate/index.html b/api-reference/interfaces/sepadirect-debit-mandate/index.html index c4850f3c8ec..e5755254f3a 100644 --- a/api-reference/interfaces/sepadirect-debit-mandate/index.html +++ b/api-reference/interfaces/sepadirect-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/standing-order-status-info/index.html b/api-reference/interfaces/standing-order-status-info/index.html index 52d63f4b261..e6b10012678 100644 --- a/api-reference/interfaces/standing-order-status-info/index.html +++ b/api-reference/interfaces/standing-order-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/statement-info/index.html b/api-reference/interfaces/statement-info/index.html index 7c9b5e1bdd6..67ada3215e7 100644 --- a/api-reference/interfaces/statement-info/index.html +++ b/api-reference/interfaces/statement-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/interfaces/supporting-document-collection-status-info/index.html b/api-reference/interfaces/supporting-document-collection-status-info/index.html index 43caca14df8..b825e3d8ea8 100644 --- a/api-reference/interfaces/supporting-document-collection-status-info/index.html +++ b/api-reference/interfaces/supporting-document-collection-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionStatusInfo

No description

interface SupportingDocumentCollectionStatusInfo {
  status: SupportingDocumentCollectionStatus!
}

Fields​

SupportingDocumentCollectionStatusInfo.status ● SupportingDocumentCollectionStatus! non-null enum​

Status of the supporting document collection

Member of​

SupportingDocumentCollection object

Implemented by​

SupportingDocumentCollectionApprovedStatusInfo object ● SupportingDocumentCollectionCanceledStatusInfo object ● SupportingDocumentCollectionPendingReviewStatusInfo object ● SupportingDocumentCollectionRejectedStatusInfo object ● SupportingDocumentCollectionWaitingForDocumentStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/supporting-document-status-info/index.html b/api-reference/interfaces/supporting-document-status-info/index.html index 6a2ab524e6e..3511a93a6ef 100644 --- a/api-reference/interfaces/supporting-document-status-info/index.html +++ b/api-reference/interfaces/supporting-document-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentStatusInfo

No description

interface SupportingDocumentStatusInfo {
  status: SupportingDocumentStatus!
}

Fields​

SupportingDocumentStatusInfo.status ● SupportingDocumentStatus! non-null enum​

Status of the supporting document

Member of​

SupportingDocument object

Implemented by​

SupportingDocumentNotUploadedStatusInfo object ● SupportingDocumentRefusedStatusInfo object ● SupportingDocumentUploadedStatusInfo object ● SupportingDocumentValidatedStatusInfo object ● SupportingDocumentWaitingForUploadStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/transaction-status-info/index.html b/api-reference/interfaces/transaction-status-info/index.html index 932be70a654..230edea37e7 100644 --- a/api-reference/interfaces/transaction-status-info/index.html +++ b/api-reference/interfaces/transaction-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

TransactionStatusInfo

Transaction Status information

interface TransactionStatusInfo {
  status: TransactionStatus!
}

Fields​

TransactionStatusInfo.status ● TransactionStatus! non-null enum​

status of the transaction

Member of​

CardTransaction object ● CheckTransaction object ● FeeTransaction object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● InternationalCreditTransferTransaction object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object ● Transaction interface

Implemented by​

BookedTransactionStatusInfo object ● CanceledTransactionStatusInfo object ● PendingTransactionStatusInfo object ● RejectedTransactionStatusInfo object ● ReleasedTransactionStatusInfo object ● UpcomingTransactionStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/interfaces/transaction/index.html b/api-reference/interfaces/transaction/index.html index 9838da19bdb..450da40f425 100644 --- a/api-reference/interfaces/transaction/index.html +++ b/api-reference/interfaces/transaction/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Transaction

Transaction

interface Transaction {
  id: ID!
  reference: String!
  paymentMethodIdentifier: String!
  side: TransactionSide!
  type: TransactionTypeEnum!
  amount: Amount!
  label: String!
  statusInfo: TransactionStatusInfo!
  paymentId: String
  payment: Payment
  createdAt: DateTime!
  updatedAt: DateTime!
  counterparty: String!
  bookedBalanceAfter: Amount
  paymentProduct: PaymentProduct!
  account: Account
  externalReference: String
  executionDate: DateTime!
  requestedExecutionAt: DateTime
  originTransactionId: String
  originTransaction: Transaction
}

Fields​

Transaction.id ● ID! non-null scalar​

unique identifier of the transaction

Transaction.reference ● String! non-null scalar​

external identifier of the transaction

Transaction.paymentMethodIdentifier ● String! non-null scalar​

payment method identifier used for this transaction. e.g masked PAN or IBAN or accountNumber

Transaction.side ● TransactionSide! non-null enum​

side (Credit or Debit)

Transaction.type ● TransactionTypeEnum! non-null enum​

type

Transaction.amount ● Amount! non-null object​

amount

Transaction.label ● String! non-null scalar​

label

Transaction.statusInfo ● TransactionStatusInfo! non-null interface​

status information

Transaction.paymentId ● String scalar​

ID of the payment associated to this transaction

Transaction.payment ● Payment object​

payment associated to this transaction

Transaction.createdAt ● DateTime! non-null scalar​

created date

Transaction.updatedAt ● DateTime! non-null scalar​

updated date

Transaction.counterparty ● String! non-null scalar​

name of the counterparty. e.g Merchant name, Creditor name, Beneficiary Name ...

Transaction.bookedBalanceAfter ● Amount object​

booked balance after this transaction

Transaction.paymentProduct ● PaymentProduct! non-null enum​

payment product used for this transaction

Transaction.account ● Account object​

matching account for this transaction

Transaction.externalReference ● String scalar​

an arbitrary identifier that was defined by you when you created this transaction.

For example, you can define it in the CreditTransferInput mutation.

Transaction.executionDate ● DateTime! non-null scalar​

a date that reflects the execution date of a transaction from a user viewpoint. Can be used for sorting transactions.

Transaction.requestedExecutionAt ● DateTime scalar​

a date that reflects the time at which the user asked the transaction to be executed

Transaction.originTransactionId ● String scalar​

ID of the origin transaction associated to this transaction

Transaction.originTransaction ● Transaction interface​

origin transaction associated to this transaction

Returned by​

transaction query

Member of​

CardTransaction object ● CheckTransaction object ● FeeTransaction object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● InternationalCreditTransferTransaction object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object ● Transaction interface ● TransactionEdge object

Implemented by​

CardTransaction object ● CheckTransaction object ● FeeTransaction object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● InternationalCreditTransferTransaction object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object

- + \ No newline at end of file diff --git a/api-reference/interfaces/ultimate-beneficial-owner-info/index.html b/api-reference/interfaces/ultimate-beneficial-owner-info/index.html index ca86fc0d36b..4745013f530 100644 --- a/api-reference/interfaces/ultimate-beneficial-owner-info/index.html +++ b/api-reference/interfaces/ultimate-beneficial-owner-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UltimateBeneficialOwnerInfo

The Ultimate Beneficial Owner could be for an Individual or a Company and these can Direct or Indirect

interface UltimateBeneficialOwnerInfo {
  id: ID!
  type: UltimateBeneficialOwnerType!
  parentCompanyShareRatio: Float!
}

Fields​

UltimateBeneficialOwnerInfo.id ● ID! non-null scalar​

Ultimate Beneficial Owner Unique Identifier .

UltimateBeneficialOwnerInfo.type ● UltimateBeneficialOwnerType! non-null enum​

Ultimate beneficial owner type.

UltimateBeneficialOwnerInfo.parentCompanyShareRatio ● Float! non-null scalar​

Shares ratio of the parent company. Example: 50 if the share ratio is 50%.

Implemented by​

UltimateBeneficialDirectOwnerCompanyInfo object ● UltimateBeneficialDirectOwnerIndividualInfo object ● UltimateBeneficialIndirectOwnerCompanyInfo object ● UltimateBeneficialIndirectOwnerIndividualInfo object

- + \ No newline at end of file diff --git a/api-reference/mutations/activate-physical-card/index.html b/api-reference/mutations/activate-physical-card/index.html index 1ca8edf4365..e9039f6da38 100644 --- a/api-reference/mutations/activate-physical-card/index.html +++ b/api-reference/mutations/activate-physical-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/add-account-membership/index.html b/api-reference/mutations/add-account-membership/index.html index 4890c1b0ff0..ec29274d50b 100644 --- a/api-reference/mutations/add-account-membership/index.html +++ b/api-reference/mutations/add-account-membership/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addAccountMembership

Add a new account membership to an account.

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership for this account with the attribute canManageAccountMembership=true.

addAccountMembership(
  input: AddAccountMembershipInput!
): AddAccountMembershipPayload!

Arguments​

addAccountMembership.input ● AddAccountMembershipInput! non-null input​

Type​

AddAccountMembershipPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/add-account-memberships/index.html b/api-reference/mutations/add-account-memberships/index.html index 613c7b159a0..2b9e889be9d 100644 --- a/api-reference/mutations/add-account-memberships/index.html +++ b/api-reference/mutations/add-account-memberships/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addAccountMemberships

Add multiple new account memberships to account

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership for this account with the attribute canManageAccountMembership=true.

addAccountMemberships(
  input: AddAccountMembershipsInput!
): AddAccountMembershipsPayload!

Arguments​

addAccountMemberships.input ● AddAccountMembershipsInput! non-null input​

Type​

AddAccountMembershipsPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/add-card/index.html b/api-reference/mutations/add-card/index.html index 9a92d7f5319..ed9f6aa3e0b 100644 --- a/api-reference/mutations/add-card/index.html +++ b/api-reference/mutations/add-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addCard

Add a new card to an account membership.

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership for this account with the attribute canManageAccountMembership=true.

addCard(
  input: AddCardInput!
): AddCardPayload!

Arguments​

addCard.input ● AddCardInput! non-null input​

Type​

AddCardPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/add-cards-with-group-delivery/index.html b/api-reference/mutations/add-cards-with-group-delivery/index.html index f99a97ef23a..d71e4476264 100644 --- a/api-reference/mutations/add-cards-with-group-delivery/index.html +++ b/api-reference/mutations/add-cards-with-group-delivery/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addCardsWithGroupDelivery

Add several cards with Group Delivery

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership for this account with the attribute canManageAccountMembership=true.

addCardsWithGroupDelivery(
  input: AddCardsWithGroupDeliveryInput!
): AddCardsWithGroupDeliveryPayload!

Arguments​

addCardsWithGroupDelivery.input ● AddCardsWithGroupDeliveryInput! non-null input​

Type​

AddCardsWithGroupDeliveryPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/add-cards/index.html b/api-reference/mutations/add-cards/index.html index 93760fb2031..c78e6d990a6 100644 --- a/api-reference/mutations/add-cards/index.html +++ b/api-reference/mutations/add-cards/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addCards

Add several cards

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership for this account with the attribute canManageAccountMembership=true.

addCards(
  input: AddCardsInput!
): AddCardsPayload!

Arguments​

addCards.input ● AddCardsInput! non-null input​

Type​

AddCardsPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/add-digital-card/index.html b/api-reference/mutations/add-digital-card/index.html index 78156e9c9bf..18a33f0fa63 100644 --- a/api-reference/mutations/add-digital-card/index.html +++ b/api-reference/mutations/add-digital-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addDigitalCard

Add a Digital Card to push to ApplePay or GooglePay

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must be the card holder

A digital card will only be valid for 1 hour after consent validation

addDigitalCard(
  input: AddDigitalCardInput
): AddDigitalCardPayload!

Arguments​

addDigitalCard.input ● AddDigitalCardInput input​

Type​

AddDigitalCardPayload union​

Payload returned on mutation completion

- + \ No newline at end of file diff --git a/api-reference/mutations/add-direct-debit-funding-source/index.html b/api-reference/mutations/add-direct-debit-funding-source/index.html index 0bbc77754e1..c186f02100b 100644 --- a/api-reference/mutations/add-direct-debit-funding-source/index.html +++ b/api-reference/mutations/add-direct-debit-funding-source/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addDirectDebitFundingSource

Add a funding source to an account

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership for this account with the attribute canManageAccountMembership=true.

addDirectDebitFundingSource(
  input: AddDirectDebitFundingSourceInput!
): AddDirectDebitFundingSourcePayload

Arguments​

addDirectDebitFundingSource.input ● AddDirectDebitFundingSourceInput! non-null input​

Type​

AddDirectDebitFundingSourcePayload union​

Add Direct Debit Funding Source Payload

- + \ No newline at end of file diff --git a/api-reference/mutations/add-external-account-balance/index.html b/api-reference/mutations/add-external-account-balance/index.html index ca7a39e12d2..ace32451948 100644 --- a/api-reference/mutations/add-external-account-balance/index.html +++ b/api-reference/mutations/add-external-account-balance/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/add-external-account/index.html b/api-reference/mutations/add-external-account/index.html index 706fda911c8..04ee55a0a63 100644 --- a/api-reference/mutations/add-external-account/index.html +++ b/api-reference/mutations/add-external-account/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/add-funding-limit-settings-change-request/index.html b/api-reference/mutations/add-funding-limit-settings-change-request/index.html index ab42e41dfae..cb871b094d1 100644 --- a/api-reference/mutations/add-funding-limit-settings-change-request/index.html +++ b/api-reference/mutations/add-funding-limit-settings-change-request/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addFundingLimitSettingsChangeRequest

Add a new request for funding limit settings change.

This mutation is restricted to a Project access token (Learn More).

addFundingLimitSettingsChangeRequest(
  input: AddFundingLimitSettingsChangeRequestInput!
): AddFundingLimitSettingsChangeRequestPayload!

Arguments​

addFundingLimitSettingsChangeRequest.input ● AddFundingLimitSettingsChangeRequestInput! non-null input​

Type​

AddFundingLimitSettingsChangeRequestPayload union​

Payload returned on mutation completion

- + \ No newline at end of file diff --git a/api-reference/mutations/add-internal-direct-debit-payment-mandate/index.html b/api-reference/mutations/add-internal-direct-debit-payment-mandate/index.html index 4b1560ad017..549019a01cb 100644 --- a/api-reference/mutations/add-internal-direct-debit-payment-mandate/index.html +++ b/api-reference/mutations/add-internal-direct-debit-payment-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addInternalDirectDebitPaymentMandate

Allows to add an internal direct debit payment mandate.

addInternalDirectDebitPaymentMandate(
  input: AddInternalDirectDebitPaymentMandateInput!
): AddInternalDirectDebitPaymentMandatePayload!

Arguments​

addInternalDirectDebitPaymentMandate.input ● AddInternalDirectDebitPaymentMandateInput! non-null input​

Type​

AddInternalDirectDebitPaymentMandatePayload union​

Union type return by the addInternalDirectDebitPaymentMandate mutation

- + \ No newline at end of file diff --git a/api-reference/mutations/add-merchant-profile/index.html b/api-reference/mutations/add-merchant-profile/index.html index e12bcc74c21..db55eb31ee1 100644 --- a/api-reference/mutations/add-merchant-profile/index.html +++ b/api-reference/mutations/add-merchant-profile/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/add-or-update-external-account-balance/index.html b/api-reference/mutations/add-or-update-external-account-balance/index.html index 572bc669de7..e5db34aed00 100644 --- a/api-reference/mutations/add-or-update-external-account-balance/index.html +++ b/api-reference/mutations/add-or-update-external-account-balance/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

addOrUpdateExternalAccountBalance

Add an external balance to an external account. If a balance already exist for the day, the balance amount will be updated.

This mutation is restricted to a Project access token (Learn More).

addOrUpdateExternalAccountBalance(
  input: AddOrUpdateExternalAccountBalanceInput!
): AddOrUpdateExternalAccountBalancePayload!

Arguments​

addOrUpdateExternalAccountBalance.input ● AddOrUpdateExternalAccountBalanceInput! non-null input​

Type​

AddOrUpdateExternalAccountBalancePayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/add-received-internal-direct-debit-b2-b-mandate/index.html b/api-reference/mutations/add-received-internal-direct-debit-b2-b-mandate/index.html index 6bc9b8134de..09da6364958 100644 --- a/api-reference/mutations/add-received-internal-direct-debit-b2-b-mandate/index.html +++ b/api-reference/mutations/add-received-internal-direct-debit-b2-b-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addReceivedInternalDirectDebitB2bMandate

Allows to add a received internal direct debit mandate B2b.

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request with the Swan app.

The user must be able to initiate payments for this account.

addReceivedInternalDirectDebitB2bMandate(
  input: AddReceivedInternalDirectDebitB2bMandateInput!
): AddReceivedInternalDirectDebitB2bMandatePayload!

Arguments​

addReceivedInternalDirectDebitB2bMandate.input ● AddReceivedInternalDirectDebitB2bMandateInput! non-null input​

Type​

AddReceivedInternalDirectDebitB2bMandatePayload union​

Union type return by the addReceivedInternalDirectDebitB2bMandate mutation

- + \ No newline at end of file diff --git a/api-reference/mutations/add-received-sepa-direct-debit-b2-b-mandate/index.html b/api-reference/mutations/add-received-sepa-direct-debit-b2-b-mandate/index.html index 528bd9cc312..ec82eaca901 100644 --- a/api-reference/mutations/add-received-sepa-direct-debit-b2-b-mandate/index.html +++ b/api-reference/mutations/add-received-sepa-direct-debit-b2-b-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addReceivedSepaDirectDebitB2bMandate

Allows to add a received sepa direct debit mandate B2b.

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request with the Swan app.

The user must be able to initiate payments for this account.

addReceivedSepaDirectDebitB2bMandate(
  input: AddReceivedSepaDirectDebitB2bMandateInput!
): AddReceivedSepaDirectDebitB2bMandatePayload!

Arguments​

addReceivedSepaDirectDebitB2bMandate.input ● AddReceivedSepaDirectDebitB2bMandateInput! non-null input​

Type​

AddReceivedSepaDirectDebitB2bMandatePayload union​

Union type return by the addReceivedSepaDirectDebitB2bMandate mutation

- + \ No newline at end of file diff --git a/api-reference/mutations/add-sepa-direct-debit-payment-mandate/index.html b/api-reference/mutations/add-sepa-direct-debit-payment-mandate/index.html index 903b0607437..810c4411159 100644 --- a/api-reference/mutations/add-sepa-direct-debit-payment-mandate/index.html +++ b/api-reference/mutations/add-sepa-direct-debit-payment-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/add-single-use-virtual-card/index.html b/api-reference/mutations/add-single-use-virtual-card/index.html index aa1f5ef4106..8baf99a89f0 100644 --- a/api-reference/mutations/add-single-use-virtual-card/index.html +++ b/api-reference/mutations/add-single-use-virtual-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/add-single-use-virtual-cards/index.html b/api-reference/mutations/add-single-use-virtual-cards/index.html index bf22cc19e02..74f715e5175 100644 --- a/api-reference/mutations/add-single-use-virtual-cards/index.html +++ b/api-reference/mutations/add-single-use-virtual-cards/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

addSingleUseVirtualCards

Add several single-use virtual cards

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership for this account with the attribute canManageAccountMembership=true.

addSingleUseVirtualCards(
  input: AddSingleUseVirtualCardsInput!
): AddSingleUseVirtualCardsPayload!

Arguments​

addSingleUseVirtualCards.input ● AddSingleUseVirtualCardsInput! non-null input​

Type​

AddSingleUseVirtualCardsPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/add-virtual-iban-entry/index.html b/api-reference/mutations/add-virtual-iban-entry/index.html index e39a5f87246..be622508c6a 100644 --- a/api-reference/mutations/add-virtual-iban-entry/index.html +++ b/api-reference/mutations/add-virtual-iban-entry/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/allow-sdd-virtual-iban-entry/index.html b/api-reference/mutations/allow-sdd-virtual-iban-entry/index.html index debe5baf070..d380a973c64 100644 --- a/api-reference/mutations/allow-sdd-virtual-iban-entry/index.html +++ b/api-reference/mutations/allow-sdd-virtual-iban-entry/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/allow-sdd/index.html b/api-reference/mutations/allow-sdd/index.html index 209b24a2440..48d67ca5d42 100644 --- a/api-reference/mutations/allow-sdd/index.html +++ b/api-reference/mutations/allow-sdd/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/bind-account-membership/index.html b/api-reference/mutations/bind-account-membership/index.html index 9578156c8ef..a379323a600 100644 --- a/api-reference/mutations/bind-account-membership/index.html +++ b/api-reference/mutations/bind-account-membership/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/cancel-card/index.html b/api-reference/mutations/cancel-card/index.html index 7522c118795..34a3e367e83 100644 --- a/api-reference/mutations/cancel-card/index.html +++ b/api-reference/mutations/cancel-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/cancel-consent/index.html b/api-reference/mutations/cancel-consent/index.html index 1a22663deb9..205008e1fd9 100644 --- a/api-reference/mutations/cancel-consent/index.html +++ b/api-reference/mutations/cancel-consent/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/cancel-digital-card/index.html b/api-reference/mutations/cancel-digital-card/index.html index b5a7e98e095..ff29e342b2c 100644 --- a/api-reference/mutations/cancel-digital-card/index.html +++ b/api-reference/mutations/cancel-digital-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/cancel-funding-source/index.html b/api-reference/mutations/cancel-funding-source/index.html index 1fcc0e6a703..5e3a66ca6ae 100644 --- a/api-reference/mutations/cancel-funding-source/index.html +++ b/api-reference/mutations/cancel-funding-source/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/cancel-physical-card/index.html b/api-reference/mutations/cancel-physical-card/index.html index 78354362d88..f108eeb2360 100644 --- a/api-reference/mutations/cancel-physical-card/index.html +++ b/api-reference/mutations/cancel-physical-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/cancel-standing-order/index.html b/api-reference/mutations/cancel-standing-order/index.html index 743e6c87f78..aa1e26f6078 100644 --- a/api-reference/mutations/cancel-standing-order/index.html +++ b/api-reference/mutations/cancel-standing-order/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/cancel-transaction/index.html b/api-reference/mutations/cancel-transaction/index.html index 355ffb116fa..a0e718ef5a3 100644 --- a/api-reference/mutations/cancel-transaction/index.html +++ b/api-reference/mutations/cancel-transaction/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/cancel-virtual-iban-entry/index.html b/api-reference/mutations/cancel-virtual-iban-entry/index.html index 78ab4b5efee..e57d5081e52 100644 --- a/api-reference/mutations/cancel-virtual-iban-entry/index.html +++ b/api-reference/mutations/cancel-virtual-iban-entry/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/close-account/index.html b/api-reference/mutations/close-account/index.html index b754c4f0e79..968ff9948db 100644 --- a/api-reference/mutations/close-account/index.html +++ b/api-reference/mutations/close-account/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/create-capital-deposit-case/index.html b/api-reference/mutations/create-capital-deposit-case/index.html index b70a04b639d..f9cf8871ae5 100644 --- a/api-reference/mutations/create-capital-deposit-case/index.html +++ b/api-reference/mutations/create-capital-deposit-case/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/create-merchant-payment-link/index.html b/api-reference/mutations/create-merchant-payment-link/index.html index d1f2cbe1516..a3b65f2ca67 100644 --- a/api-reference/mutations/create-merchant-payment-link/index.html +++ b/api-reference/mutations/create-merchant-payment-link/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/create-multi-consent/index.html b/api-reference/mutations/create-multi-consent/index.html index 313fead36b1..fd0f4c5f8a3 100644 --- a/api-reference/mutations/create-multi-consent/index.html +++ b/api-reference/mutations/create-multi-consent/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

createMultiConsent

Create a multi consent, which represents a consent of several other consents, executed in parallel or sequentially depending on the order input value

This mutation is restricted to a User access token (Learn More) and ask the user to consent to this request.

createMultiConsent(
  input: CreateMultiConsentInput!
): CreateMultiConsentPayload

Arguments​

createMultiConsent.input ● CreateMultiConsentInput! non-null input​

Type​

CreateMultiConsentPayload union​

Payload of the createMultiConsent mutation

- + \ No newline at end of file diff --git a/api-reference/mutations/delete-supporting-document/index.html b/api-reference/mutations/delete-supporting-document/index.html index 422fc862d88..947c2ed4888 100644 --- a/api-reference/mutations/delete-supporting-document/index.html +++ b/api-reference/mutations/delete-supporting-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

deleteSupportingDocument

Delete a supporting document, in case uploaded file is not what was wanted. This action can not be undone.

This mutation can only be used on an "Uploaded" supporting document of a "WaitingForDocument" supporting document collection.

This mutation is restricted to a Project access token (Learn More)

deleteSupportingDocument(
  input: DeleteSupportingDocumentInput!
): DeleteSupportingDocumentPayload!

Arguments​

deleteSupportingDocument.input ● DeleteSupportingDocumentInput! non-null input​

Type​

DeleteSupportingDocumentPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/deny-sdd-virtual-iban-entry/index.html b/api-reference/mutations/deny-sdd-virtual-iban-entry/index.html index f714fe5613f..fa8e6b4a79d 100644 --- a/api-reference/mutations/deny-sdd-virtual-iban-entry/index.html +++ b/api-reference/mutations/deny-sdd-virtual-iban-entry/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/deny-sdd/index.html b/api-reference/mutations/deny-sdd/index.html index 61d763f4ed2..44e41365536 100644 --- a/api-reference/mutations/deny-sdd/index.html +++ b/api-reference/mutations/deny-sdd/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/disable-account-membership/index.html b/api-reference/mutations/disable-account-membership/index.html index dc29ed74582..ff5a7408507 100644 --- a/api-reference/mutations/disable-account-membership/index.html +++ b/api-reference/mutations/disable-account-membership/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

disableAccountMembership

Disable an account membership

This mutation is callable with a User access token and a Project access token (Learn More)

With a User access token, the user must have the permission to manage account membership of the account

disableAccountMembership(
  input: DisableAccountMembershipInput
): DisableAccountMembershipPayload!

Arguments​

disableAccountMembership.input ● DisableAccountMembershipInput input​

Type​

DisableAccountMembershipPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/enable-received-direct-debit-mandate/index.html b/api-reference/mutations/enable-received-direct-debit-mandate/index.html index 4bbce0f3785..6b53467f6d4 100644 --- a/api-reference/mutations/enable-received-direct-debit-mandate/index.html +++ b/api-reference/mutations/enable-received-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

enableReceivedDirectDebitMandate

Allows to enable a received mandate in the Suspended status.

For B2b received direct debit mandate, this mutation is restricted to an User access token(Learn More) and ask the user to consent to this request with the Swan app.

The user must be able to initiate payments for this account.

enableReceivedDirectDebitMandate(
  input: EnableReceivedDirectDebitMandateInput!
): EnableReceivedDirectDebitMandatePayload!

Arguments​

enableReceivedDirectDebitMandate.input ● EnableReceivedDirectDebitMandateInput! non-null input​

Type​

EnableReceivedDirectDebitMandatePayload union​

Union type return by the enableReceivedDirectDebitMandate mutation

- + \ No newline at end of file diff --git a/api-reference/mutations/finalize-onboarding/index.html b/api-reference/mutations/finalize-onboarding/index.html index 8d7e1974c4f..110958ee85e 100644 --- a/api-reference/mutations/finalize-onboarding/index.html +++ b/api-reference/mutations/finalize-onboarding/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/generate-account-statement/index.html b/api-reference/mutations/generate-account-statement/index.html index 792c28eed7d..a172b1c1b1e 100644 --- a/api-reference/mutations/generate-account-statement/index.html +++ b/api-reference/mutations/generate-account-statement/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/generate-capital-deposit-document-upload-url/index.html b/api-reference/mutations/generate-capital-deposit-document-upload-url/index.html index 6aaddc3ac7f..e5cf8fe9185 100644 --- a/api-reference/mutations/generate-capital-deposit-document-upload-url/index.html +++ b/api-reference/mutations/generate-capital-deposit-document-upload-url/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

generateCapitalDepositDocumentUploadUrl

Generate an url allowing the upload of a document which unique identifier is specified in parameters.

This mutation is restricted to an Project access token (Learn More).

generateCapitalDepositDocumentUploadUrl(
  input: GenerateCapitalDepositDocumentUploadUrlInput!
): GenerateCapitalDepositDocumentUploadUrlPayload!

Arguments​

generateCapitalDepositDocumentUploadUrl.input ● GenerateCapitalDepositDocumentUploadUrlInput! non-null input​

Type​

GenerateCapitalDepositDocumentUploadUrlPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/generate-supporting-document-upload-url/index.html b/api-reference/mutations/generate-supporting-document-upload-url/index.html index c4357edf336..4baf6e40fdf 100644 --- a/api-reference/mutations/generate-supporting-document-upload-url/index.html +++ b/api-reference/mutations/generate-supporting-document-upload-url/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

generateSupportingDocumentUploadUrl

Generate and return a presigned URL to upload a unique file for the supporting document collection

This mutation is restricted to a Project access token (Learn More)

generateSupportingDocumentUploadUrl(
  input: GenerateSupportingDocumentUploadUrlInput!
): GenerateSupportingDocumentUploadUrlPayload!

Arguments​

generateSupportingDocumentUploadUrl.input ● GenerateSupportingDocumentUploadUrlInput! non-null input​

Type​

GenerateSupportingDocumentUploadUrlPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/grant-consent-with-server-signature/index.html b/api-reference/mutations/grant-consent-with-server-signature/index.html index 738f7ec2c37..b1abdd52306 100644 --- a/api-reference/mutations/grant-consent-with-server-signature/index.html +++ b/api-reference/mutations/grant-consent-with-server-signature/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/initiate-credit-transfers/index.html b/api-reference/mutations/initiate-credit-transfers/index.html index ccc2d04b6b4..2925fb3a548 100644 --- a/api-reference/mutations/initiate-credit-transfers/index.html +++ b/api-reference/mutations/initiate-credit-transfers/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

initiateCreditTransfers

Initiates a credit transfer to an other Swan account or to an IBAN

This mutation is restricted to an User access token (Learn More) and if necessary ask the user to consent to this request.

The user must have an account membership for this account with the attribute canInitiatePayments=true.

initiateCreditTransfers(
  input: InitiateCreditTransfersInput!
): InitiateCreditTransfersPayload!

Arguments​

initiateCreditTransfers.input ● InitiateCreditTransfersInput! non-null input​

Type​

InitiateCreditTransfersPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/initiate-funding-request/index.html b/api-reference/mutations/initiate-funding-request/index.html index 3ebe537b92a..35a1ee3a6d4 100644 --- a/api-reference/mutations/initiate-funding-request/index.html +++ b/api-reference/mutations/initiate-funding-request/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

initiateFundingRequest

Initiate a funding request. This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request. The user must have an account membership for this account with the attribute canInitiateCreditTransfer=true.

initiateFundingRequest(
  input: InitiateFundingRequestInput!
): InitiateFundingRequestPayload

Arguments​

initiateFundingRequest.input ● InitiateFundingRequestInput! non-null input​

Type​

InitiateFundingRequestPayload union​

Initiate A Funding Request Payload

- + \ No newline at end of file diff --git a/api-reference/mutations/initiate-international-credit-transfer/index.html b/api-reference/mutations/initiate-international-credit-transfer/index.html index d6228709229..d31c7c7db4f 100644 --- a/api-reference/mutations/initiate-international-credit-transfer/index.html +++ b/api-reference/mutations/initiate-international-credit-transfer/index.html @@ -7,14 +7,14 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/initiate-merchant-payment-collection/index.html b/api-reference/mutations/initiate-merchant-payment-collection/index.html index fb637bdf832..2211f5528f5 100644 --- a/api-reference/mutations/initiate-merchant-payment-collection/index.html +++ b/api-reference/mutations/initiate-merchant-payment-collection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/onboard-company-account-holder/index.html b/api-reference/mutations/onboard-company-account-holder/index.html index 3e2146a95b9..bfbfdf48a9f 100644 --- a/api-reference/mutations/onboard-company-account-holder/index.html +++ b/api-reference/mutations/onboard-company-account-holder/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/onboard-individual-account-holder/index.html b/api-reference/mutations/onboard-individual-account-holder/index.html index bfebb49cfaf..e10db6e4e9e 100644 --- a/api-reference/mutations/onboard-individual-account-holder/index.html +++ b/api-reference/mutations/onboard-individual-account-holder/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/print-physical-card/index.html b/api-reference/mutations/print-physical-card/index.html index ef71ee82eaa..f6a0c2366b6 100644 --- a/api-reference/mutations/print-physical-card/index.html +++ b/api-reference/mutations/print-physical-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/refund/index.html b/api-reference/mutations/refund/index.html index 2479b8f2f66..02a7a4feac3 100644 --- a/api-reference/mutations/refund/index.html +++ b/api-reference/mutations/refund/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

refund

initiates a refund for a list of booked transaction

This mutation is restricted to an User access token (Learn More) and if necessary ask the user to consent to this request.

The user must have an account membership on the accounts that are beneficiary of the transaction with the attribute canInitiatePayments=true.

refund(
  input: RefundInput!
): RefundPayload!

Arguments​

refund.input ● RefundInput! non-null input​

Type​

RefundPayload union​

The respond body to a refund mutation

- + \ No newline at end of file diff --git a/api-reference/mutations/request-merchant-payment-methods/index.html b/api-reference/mutations/request-merchant-payment-methods/index.html index e120da30d94..bb101b3aa10 100644 --- a/api-reference/mutations/request-merchant-payment-methods/index.html +++ b/api-reference/mutations/request-merchant-payment-methods/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/request-merchant-profile-update/index.html b/api-reference/mutations/request-merchant-profile-update/index.html index d52d3338393..0dd103dd303 100644 --- a/api-reference/mutations/request-merchant-profile-update/index.html +++ b/api-reference/mutations/request-merchant-profile-update/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/request-supporting-document-collection-review/index.html b/api-reference/mutations/request-supporting-document-collection-review/index.html index 35000a390ec..828ad65af11 100644 --- a/api-reference/mutations/request-supporting-document-collection-review/index.html +++ b/api-reference/mutations/request-supporting-document-collection-review/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

requestSupportingDocumentCollectionReview

Ask for Swan's compliance team to review given supporting document collection.

This mutation is restricted to a Project access token (Learn More)

requestSupportingDocumentCollectionReview(
  input: RequestSupportingDocumentCollectionReviewInput
): RequestSupportingDocumentCollectionReviewPayload!

Arguments​

requestSupportingDocumentCollectionReview.input ● RequestSupportingDocumentCollectionReviewInput input​

Type​

RequestSupportingDocumentCollectionReviewPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/resume-account-membership/index.html b/api-reference/mutations/resume-account-membership/index.html index fdc23c6185c..d9c3807bf07 100644 --- a/api-reference/mutations/resume-account-membership/index.html +++ b/api-reference/mutations/resume-account-membership/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

resumeAccountMembership

Resumes an account membership already suspended.

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership for this account with the attribute canManageAccountMembership=true.

resumeAccountMembership(
  input: ResumeAccountMembershipInput
): ResumeAccountMembershipPayload!

Arguments​

resumeAccountMembership.input ● ResumeAccountMembershipInput input​

Type​

ResumeAccountMembershipPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/resume-physical-card/index.html b/api-reference/mutations/resume-physical-card/index.html index 7d4d8e7a653..697a8ffe503 100644 --- a/api-reference/mutations/resume-physical-card/index.html +++ b/api-reference/mutations/resume-physical-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/schedule-standing-order/index.html b/api-reference/mutations/schedule-standing-order/index.html index 714b11bae60..db675d6f46f 100644 --- a/api-reference/mutations/schedule-standing-order/index.html +++ b/api-reference/mutations/schedule-standing-order/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

scheduleStandingOrder

Schedule a standing Order

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership to the account and the permission to initiate credit transfer

scheduleStandingOrder(
  input: ScheduleStandingOrderInput!
): ScheduleStandingOrderPayload!

Arguments​

scheduleStandingOrder.input ● ScheduleStandingOrderInput! non-null input​

Type​

ScheduleStandingOrderPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/suspend-account-membership/index.html b/api-reference/mutations/suspend-account-membership/index.html index d46c73dbc44..1764e955590 100644 --- a/api-reference/mutations/suspend-account-membership/index.html +++ b/api-reference/mutations/suspend-account-membership/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/suspend-physical-card/index.html b/api-reference/mutations/suspend-physical-card/index.html index 784ac683ab6..ebd4f27d271 100644 --- a/api-reference/mutations/suspend-physical-card/index.html +++ b/api-reference/mutations/suspend-physical-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/suspend-received-direct-debit-mandate/index.html b/api-reference/mutations/suspend-received-direct-debit-mandate/index.html index 64f3aff0f12..6bfec1a5657 100644 --- a/api-reference/mutations/suspend-received-direct-debit-mandate/index.html +++ b/api-reference/mutations/suspend-received-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

suspendReceivedDirectDebitMandate

Allows to suspend a received direct debit mandate in the Enabled status.

The user must be able to initiate payments for this account.

suspendReceivedDirectDebitMandate(
  input: SuspendReceivedDirectDebitMandateInput!
): SuspendReceivedDirectDebitMandatePayload!

Arguments​

suspendReceivedDirectDebitMandate.input ● SuspendReceivedDirectDebitMandateInput! non-null input​

Type​

SuspendReceivedDirectDebitMandatePayload union​

Union type returned by the suspendReceivedDirectDebitMandate mutation

- + \ No newline at end of file diff --git a/api-reference/mutations/update-account-holder/index.html b/api-reference/mutations/update-account-holder/index.html index 654053ee98a..1517ed1f39a 100644 --- a/api-reference/mutations/update-account-holder/index.html +++ b/api-reference/mutations/update-account-holder/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/update-account-membership/index.html b/api-reference/mutations/update-account-membership/index.html index bafea1ad5d4..deecba73f9c 100644 --- a/api-reference/mutations/update-account-membership/index.html +++ b/api-reference/mutations/update-account-membership/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

updateAccountMembership

Updates an account membership.

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have an account membership for this account with the attribute canManageAccountMembership=true.

updateAccountMembership(
  input: UpdateAccountMembershipInput!
): UpdateAccountMembershipPayload!

Arguments​

updateAccountMembership.input ● UpdateAccountMembershipInput! non-null input​

Type​

UpdateAccountMembershipPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/update-account/index.html b/api-reference/mutations/update-account/index.html index ef46166d40b..9624f5da989 100644 --- a/api-reference/mutations/update-account/index.html +++ b/api-reference/mutations/update-account/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/update-card/index.html b/api-reference/mutations/update-card/index.html index 3ce8e8571f6..56fabb2bf59 100644 --- a/api-reference/mutations/update-card/index.html +++ b/api-reference/mutations/update-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/update-company-onboarding/index.html b/api-reference/mutations/update-company-onboarding/index.html index a680842cf7d..49873be38af 100644 --- a/api-reference/mutations/update-company-onboarding/index.html +++ b/api-reference/mutations/update-company-onboarding/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

updateCompanyOnboarding

Updates a company onboarding.

If you aim to update Ultimate Beneficiary Owners, you need to provide all of them as they are going to be overridden by your update payload.

This mutation is restricted to a Project access token (Learn More)

updateCompanyOnboarding(
  input: UpdateCompanyOnboardingInput
): UpdateCompanyOnboardingPayload!

Arguments​

updateCompanyOnboarding.input ● UpdateCompanyOnboardingInput input​

Type​

UpdateCompanyOnboardingPayload union​

Possible results for mutation updateCompanyOnboarding

- + \ No newline at end of file diff --git a/api-reference/mutations/update-individual-onboarding/index.html b/api-reference/mutations/update-individual-onboarding/index.html index 18508c5706e..9f93883b66a 100644 --- a/api-reference/mutations/update-individual-onboarding/index.html +++ b/api-reference/mutations/update-individual-onboarding/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/update-received-sepa-direct-debit-b2-b-mandate/index.html b/api-reference/mutations/update-received-sepa-direct-debit-b2-b-mandate/index.html index c9263cf75ec..142f435524b 100644 --- a/api-reference/mutations/update-received-sepa-direct-debit-b2-b-mandate/index.html +++ b/api-reference/mutations/update-received-sepa-direct-debit-b2-b-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

updateReceivedSepaDirectDebitB2bMandate

Allows to update a received sepa direct debit mandate B2b.

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request with the Swan app.

The user must be able to initiate payments for this account.

updateReceivedSepaDirectDebitB2bMandate(
  input: UpdateReceivedSepaDirectDebitB2bMandateInput!
): UpdateReceivedSepaDirectDebitB2bMandatePayload!

Arguments​

updateReceivedSepaDirectDebitB2bMandate.input ● UpdateReceivedSepaDirectDebitB2bMandateInput! non-null input​

Type​

UpdateReceivedSepaDirectDebitB2bMandatePayload union​

Union type returned by the updateReceivedSepaDirectDebitB2bMandate mutation

- + \ No newline at end of file diff --git a/api-reference/mutations/update-supporting-document/index.html b/api-reference/mutations/update-supporting-document/index.html index a1f23b21935..5f1fa1c289e 100644 --- a/api-reference/mutations/update-supporting-document/index.html +++ b/api-reference/mutations/update-supporting-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/update-user-consent-settings/index.html b/api-reference/mutations/update-user-consent-settings/index.html index a4713a2eeb3..08dcf84f016 100644 --- a/api-reference/mutations/update-user-consent-settings/index.html +++ b/api-reference/mutations/update-user-consent-settings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/view-card-numbers/index.html b/api-reference/mutations/view-card-numbers/index.html index 2750d43e7e3..48a49b27b10 100644 --- a/api-reference/mutations/view-card-numbers/index.html +++ b/api-reference/mutations/view-card-numbers/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/mutations/view-physical-card-numbers/index.html b/api-reference/mutations/view-physical-card-numbers/index.html index c637877c7d3..68612152853 100644 --- a/api-reference/mutations/view-physical-card-numbers/index.html +++ b/api-reference/mutations/view-physical-card-numbers/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

viewPhysicalCardNumbers

Reveal the physical card numbers in the consent page once consent has been given by the cardholder

This mutation is restricted to an User access token (Learn More) and ask the user to consent to this request.

The user must have the account membership for this card

viewPhysicalCardNumbers(
  input: ViewPhysicalCardNumbersInput!
): ViewPhysicalCardNumbersPayload!

Arguments​

viewPhysicalCardNumbers.input ● ViewPhysicalCardNumbersInput! non-null input​

Type​

ViewPhysicalCardNumbersPayload union​

- + \ No newline at end of file diff --git a/api-reference/mutations/view-physical-card-pin/index.html b/api-reference/mutations/view-physical-card-pin/index.html index b3b5f81e38f..de5eccc1fcf 100644 --- a/api-reference/mutations/view-physical-card-pin/index.html +++ b/api-reference/mutations/view-physical-card-pin/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-balances/index.html b/api-reference/objects/account-balances/index.html index be148909188..1e1cf37c89e 100644 --- a/api-reference/objects/account-balances/index.html +++ b/api-reference/objects/account-balances/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountBalances

A list of balances regarding an account.

type AccountBalances {
  available: Amount!
  pending: Amount!
  booked: Amount!
  reserved: Amount!
}

Fields​

AccountBalances.available ● Amount! non-null object​

Balance composed of booked, pending transactions and rolling reserve used known at the time of calculation.

AccountBalances.pending ● Amount! non-null object​

Balance just composed of pending transactions.

AccountBalances.booked ● Amount! non-null object​

Balance just composed of booked transactions.

AccountBalances.reserved ● Amount! non-null object​

Balance just composed of rolling reserve used in booked transactions.

Member of​

Account object ● Balance object

- + \ No newline at end of file diff --git a/api-reference/objects/account-closed-status/index.html b/api-reference/objects/account-closed-status/index.html index cb2640cb8f2..ace35ecbd94 100644 --- a/api-reference/objects/account-closed-status/index.html +++ b/api-reference/objects/account-closed-status/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountClosedStatus

Account Closed status information

type AccountClosedStatus implements AccountStatusInfo {
  status: AccountStatus!
  reason: String!
  reasonInfo: CloseAccountStatusReason!
}

Fields​

AccountClosedStatus.status ● AccountStatus! non-null enum​

Account status (always Closed for type AccountClosedStatus)

AccountClosedStatus.reason ● String! non-null scalar​

Reason why the account is suspended @Deprecated

AccountClosedStatus.reasonInfo ● CloseAccountStatusReason! non-null union​

Reason why the account is currently closed

Interfaces​

AccountStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/account-closing-status/index.html b/api-reference/objects/account-closing-status/index.html index e2bd0d3b310..6c5409be6dd 100644 --- a/api-reference/objects/account-closing-status/index.html +++ b/api-reference/objects/account-closing-status/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountClosingStatus

Account Closing status information

type AccountClosingStatus implements AccountStatusInfo {
  status: AccountStatus!
  reason: String!
  reasonInfo: CloseAccountStatusReason!
}

Fields​

AccountClosingStatus.status ● AccountStatus! non-null enum​

Account status (always Closing for type AccountClosingStatus)

AccountClosingStatus.reason ● String! non-null scalar​

Reason why the account is suspended @Deprecated

AccountClosingStatus.reasonInfo ● CloseAccountStatusReason! non-null union​

Reason why the account is currently in closing

Interfaces​

AccountStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/account-connection/index.html b/api-reference/objects/account-connection/index.html index 22f497a30a6..c2508039603 100644 --- a/api-reference/objects/account-connection/index.html +++ b/api-reference/objects/account-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type AccountConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [AccountEdge!]!
}

Fields​

AccountConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

AccountConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

AccountConnection.edges ● [AccountEdge!]! non-null object​

AccountEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

accounts query

Member of​

AccountHolder object

- + \ No newline at end of file diff --git a/api-reference/objects/account-edge/index.html b/api-reference/objects/account-edge/index.html index c867c935800..cd6645b292f 100644 --- a/api-reference/objects/account-edge/index.html +++ b/api-reference/objects/account-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountEdge

Implements the Relay Edge interface

type AccountEdge implements Edge {
  cursor: String!
  node: Account!
}

Fields​

AccountEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

AccountEdge.node ● Account! non-null object​

The account

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

AccountConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/account-holder-canceled-status-info/index.html b/api-reference/objects/account-holder-canceled-status-info/index.html index fbb5226cecf..30dca734cb8 100644 --- a/api-reference/objects/account-holder-canceled-status-info/index.html +++ b/api-reference/objects/account-holder-canceled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountHolderCanceledStatusInfo

Account Holder Canceled Status Information

type AccountHolderCanceledStatusInfo implements AccountHolderStatusInfo {
  status: AccountHolderStatus!
  reason: String!
}

Fields​

AccountHolderCanceledStatusInfo.status ● AccountHolderStatus! non-null enum​

Status of the account holder.

AccountHolderCanceledStatusInfo.reason ● String! non-null scalar​

Reason why the account holder is suspended.

Interfaces​

AccountHolderStatusInfo interface​

Account Holder Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/account-holder-company-info/index.html b/api-reference/objects/account-holder-company-info/index.html index 838297bf73a..8da934e1532 100644 --- a/api-reference/objects/account-holder-company-info/index.html +++ b/api-reference/objects/account-holder-company-info/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountHolderCompanyInfo

No description

type AccountHolderCompanyInfo implements AccountHolderInfo {
  type: AccountHolderType!
  name: String!
  registrationNumber: String
  companyRegistrationDate: Date
  companyType: CompanyType
  businessActivity: BusinessActivity!
  businessActivityDescription: String!
  monthlyPaymentVolume: MonthlyPaymentVolume!
  individualUltimateBeneficialOwners: [IndividualUltimateBeneficialOwner!]!
  vatNumber: String
  taxIdentificationNumber: String
  legalRepresentativePersonalAddress: AddressInformation
}

Fields​

AccountHolderCompanyInfo.type ● AccountHolderType! non-null enum​

Account holder type (always Company for type AccountHolderCompanyInfo)

AccountHolderCompanyInfo.name ● String! non-null scalar​

Name of the company.

AccountHolderCompanyInfo.registrationNumber ● String scalar​

Registration number of the company (SIRET, ...).

AccountHolderCompanyInfo.companyRegistrationDate ● Date scalar​

Registration date of the company.

AccountHolderCompanyInfo.companyType ● CompanyType enum​

Legal form of the company (SAS, SCI, SASU, ...).

AccountHolderCompanyInfo.businessActivity ● BusinessActivity! non-null enum​

Business activity.

AccountHolderCompanyInfo.businessActivityDescription ● String! non-null scalar​

Business activity description. This must be 1024 characters long maximum.

AccountHolderCompanyInfo.monthlyPaymentVolume ● MonthlyPaymentVolume! non-null enum​

Estimated monthly payment volume (euro).

AccountHolderCompanyInfo.individualUltimateBeneficialOwners ● [IndividualUltimateBeneficialOwner!]! non-null object​

The ultimate beneficiary is defined as the natural person (s) who own or control, directly or indirectly, the reporting company.

The ultimate beneficiary is :

  • either the natural person (s) who hold, directly or indirectly, more than 25% of the capital or the rights of vote of the reporting company;
  • either the natural person (s) who exercise, by other means, a power of control of the company;

AccountHolderCompanyInfo.vatNumber ● String scalar​

Unique number that identifies a taxable person (business) or non-taxable legal entity that is registered for VAT

AccountHolderCompanyInfo.taxIdentificationNumber ● String scalar​

Tax Identification Number

AccountHolderCompanyInfo.legalRepresentativePersonalAddress ● AddressInformation object​

Legal representative personal address

Interfaces​

AccountHolderInfo interface​

Account holder types.

- + \ No newline at end of file diff --git a/api-reference/objects/account-holder-connection/index.html b/api-reference/objects/account-holder-connection/index.html index 50d095c47bc..21101735809 100644 --- a/api-reference/objects/account-holder-connection/index.html +++ b/api-reference/objects/account-holder-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountHolderConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More).

type AccountHolderConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [AccountHolderEdge!]!
}

Fields​

AccountHolderConnection.totalCount ● Int! non-null scalar​

Total number of element in the list.

AccountHolderConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page.

AccountHolderConnection.edges ● [AccountHolderEdge!]! non-null object​

AccountHolderEdge list.

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

accountHolders query

- + \ No newline at end of file diff --git a/api-reference/objects/account-holder-edge/index.html b/api-reference/objects/account-holder-edge/index.html index a276c6513ef..098377990b3 100644 --- a/api-reference/objects/account-holder-edge/index.html +++ b/api-reference/objects/account-holder-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountHolderEdge

Implements the Relay Edge interface.

type AccountHolderEdge implements Edge {
  cursor: String!
  node: AccountHolder!
}

Fields​

AccountHolderEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism.

AccountHolderEdge.node ● AccountHolder! non-null object​

The account holder.

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

AccountHolderConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/account-holder-enabled-status-info/index.html b/api-reference/objects/account-holder-enabled-status-info/index.html index 3f5ddefebd0..12c2402bd5b 100644 --- a/api-reference/objects/account-holder-enabled-status-info/index.html +++ b/api-reference/objects/account-holder-enabled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-holder-individual-info/index.html b/api-reference/objects/account-holder-individual-info/index.html index fd0c69a3c8e..c5c9d9f9535 100644 --- a/api-reference/objects/account-holder-individual-info/index.html +++ b/api-reference/objects/account-holder-individual-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountHolderIndividualInfo

Individual account holder.

type AccountHolderIndividualInfo implements AccountHolderInfo {
  type: AccountHolderType!
  name: String!
  employmentStatus: EmploymentStatus!
  monthlyIncome: MonthlyIncome!
  user: User!
  taxIdentificationNumber: String
}

Fields​

AccountHolderIndividualInfo.type ● AccountHolderType! non-null enum​

Account holder type (always Individual for type AccountHolderIndividualInfo).

AccountHolderIndividualInfo.name ● String! non-null scalar​

Account Holder's first name and last name.

AccountHolderIndividualInfo.employmentStatus ● EmploymentStatus! non-null enum​

Employment status of the account holder (regulatory questions).

AccountHolderIndividualInfo.monthlyIncome ● MonthlyIncome! non-null enum​

Monthly income of the account holder (regulatory questions).

AccountHolderIndividualInfo.user ● User! non-null object​

User of the individual account holder.

AccountHolderIndividualInfo.taxIdentificationNumber ● String scalar​

Tax Identification Number

Interfaces​

AccountHolderInfo interface​

Account holder types.

- + \ No newline at end of file diff --git a/api-reference/objects/account-holder-not-found-rejection/index.html b/api-reference/objects/account-holder-not-found-rejection/index.html index 5b9309ee1d2..b9932be47ca 100644 --- a/api-reference/objects/account-holder-not-found-rejection/index.html +++ b/api-reference/objects/account-holder-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-holder-suspended-status-info/index.html b/api-reference/objects/account-holder-suspended-status-info/index.html index 97e759ee8cd..c1301d026f9 100644 --- a/api-reference/objects/account-holder-suspended-status-info/index.html +++ b/api-reference/objects/account-holder-suspended-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountHolderSuspendedStatusInfo

Account Holder Suspended Status Information

type AccountHolderSuspendedStatusInfo implements AccountHolderStatusInfo {
  status: AccountHolderStatus!
  reason: String!
}

Fields​

AccountHolderSuspendedStatusInfo.status ● AccountHolderStatus! non-null enum​

Status of the account holder.

AccountHolderSuspendedStatusInfo.reason ● String! non-null scalar​

Reason why the account holder is suspended.

Interfaces​

AccountHolderStatusInfo interface​

Account Holder Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/account-holder-type-individual-rejection/index.html b/api-reference/objects/account-holder-type-individual-rejection/index.html index 3be2cb0eefb..aecc079a91b 100644 --- a/api-reference/objects/account-holder-type-individual-rejection/index.html +++ b/api-reference/objects/account-holder-type-individual-rejection/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountHolderTypeIndividualRejection

Rejection returned if the account holder type is individual. An individual account holder can't create a b2b received direct debit mandate.

type AccountHolderTypeIndividualRejection implements Rejection {
  message: String!
}

Fields​

AccountHolderTypeIndividualRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddReceivedInternalDirectDebitB2bMandatePayload union ● AddReceivedSepaDirectDebitB2bMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/account-holder/index.html b/api-reference/objects/account-holder/index.html index 5dc139c1c2c..1b6d6eb8211 100644 --- a/api-reference/objects/account-holder/index.html +++ b/api-reference/objects/account-holder/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountHolder

The account holder is the person who owns the money stored in the account. The account holder can be one of your customers, whether it is a natural person or a legal person, or quite simply you.

type AccountHolder {
  id: ID!
  verificationStatus: VerificationStatus!
  info: AccountHolderInfo!
  statusInfo: AccountHolderStatusInfo
  residencyAddress: AddressInfo!
  createdDate: DateTime!
  updatedDate: DateTime!
  accounts(
  after: String
  before: String
  first: Int! = 50
  orderBy: AccountOrderByInput
): AccountConnection!
  supportingDocumentCollections(
  first: Int! = 50
  before: String
  after: String
): SupportingDocumentCollectionConnection!
  fundingLimitSettingsChangeRequests(
  first: Int! = 50
  before: String
  after: String
): FundingLimitSettingsChangeRequestConnection!
  onboarding: Onboarding
  externalAccounts(
  first: Int! = 50
  before: String
  after: String
): ExternalAccountConnection!
  paymentMandates(
  first: Int! = 50
  after: String
  orderBy: PaymentMandateOrderByInput
  filters: PaymentMandateFiltersInput
): PaymentMandateConnection
  fundingLimitSettings: FundingLimitSettings
}

Fields​

AccountHolder.id ● ID! non-null scalar​

Unique identifier of the account holder.

AccountHolder.verificationStatus ● VerificationStatus! non-null enum​

Verification status. Banking regulations require financial institutions such as Swan to know and verify their customers in order to comply with their anti-money laundering and terrorist financing obligations. In banking jargon, we talk about KYC (Know Your Customers) procedure

AccountHolder.info ● AccountHolderInfo! non-null interface​

Account holder type information.

AccountHolder.statusInfo ● AccountHolderStatusInfo interface​

Account holder status information.

AccountHolder.residencyAddress ● AddressInfo! non-null object​

Residency address.

AccountHolder.createdDate ● DateTime! non-null scalar​

Created date.

AccountHolder.updatedDate ● DateTime! non-null scalar​

Updated date.

AccountHolder.accounts ● AccountConnection! non-null object​

List of accounts owned by the account holder.

AccountHolder.accounts.after ● String scalar​
AccountHolder.accounts.before ● String scalar​
AccountHolder.accounts.first ● Int! non-null scalar​
AccountHolder.accounts.orderBy ● AccountOrderByInput input​

AccountHolder.supportingDocumentCollections ● SupportingDocumentCollectionConnection! non-null object​

List of supporting document collection for an account holder

AccountHolder.supportingDocumentCollections.first ● Int! non-null scalar​
AccountHolder.supportingDocumentCollections.before ● String scalar​
AccountHolder.supportingDocumentCollections.after ● String scalar​

AccountHolder.fundingLimitSettingsChangeRequests ● FundingLimitSettingsChangeRequestConnection! non-null object​

List of funding limit settings change request for an account holder

AccountHolder.fundingLimitSettingsChangeRequests.first ● Int! non-null scalar​
AccountHolder.fundingLimitSettingsChangeRequests.before ● String scalar​
AccountHolder.fundingLimitSettingsChangeRequests.after ● String scalar​

AccountHolder.onboarding ● Onboarding object​

Account holder onboarding

AccountHolder.externalAccounts ● ExternalAccountConnection! non-null object​

List of external account owned by the account holder

AccountHolder.externalAccounts.first ● Int! non-null scalar​
AccountHolder.externalAccounts.before ● String scalar​
AccountHolder.externalAccounts.after ● String scalar​

AccountHolder.paymentMandates ● PaymentMandateConnection object​

A list of Payment Mandates for an account holder.

AccountHolder.paymentMandates.first ● Int! non-null scalar​

number of elements in the list (default value 50)

AccountHolder.paymentMandates.after ● String scalar​

When the list of elements needs to start after a element

AccountHolder.paymentMandates.orderBy ● PaymentMandateOrderByInput input​

When the list of elements needs to be ordered, by default, the list will be ordered by the latest updated Payment Mandate

AccountHolder.paymentMandates.filters ● PaymentMandateFiltersInput input​

When the list of elements needs to be filtered

AccountHolder.fundingLimitSettings ● FundingLimitSettings object​

Funding limit settings

Returned by​

accountHolder query

Member of​

Account object ● AccountHolderEdge object ● ExternalAccount object ● InternalPaymentDirectDebitMandate object ● Onboarding object ● SEPAPaymentDirectDebitMandate object ● UpdateAccountHolderSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-binding-user-error-status-info/index.html b/api-reference/objects/account-membership-binding-user-error-status-info/index.html index 84b7ade84cc..66e8ada0f49 100644 --- a/api-reference/objects/account-membership-binding-user-error-status-info/index.html +++ b/api-reference/objects/account-membership-binding-user-error-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipBindingUserErrorStatusInfo

when a user is binded with the error to the account membership

type AccountMembershipBindingUserErrorStatusInfo implements AccountMembershipStatusInfo {
  status: AccountMembershipStatus!
  firstNameMatchError: Boolean!
  idVerifiedMatchError: Boolean!
  lastNameMatchError: Boolean!
  phoneNumberMatchError: Boolean!
  birthDateMatchError: Boolean!
  restrictedTo: RestrictedTo!
}

Fields​

AccountMembershipBindingUserErrorStatusInfo.status ● AccountMembershipStatus! non-null enum​

AccountMembership status (always BindingUserError for type AccountMembershipBindingUserErrorStatusInfo)

AccountMembershipBindingUserErrorStatusInfo.firstNameMatchError ● Boolean! non-null scalar​

true if the first name of the user binded doesn't match with the invitation

AccountMembershipBindingUserErrorStatusInfo.idVerifiedMatchError ● Boolean! non-null scalar​

true if Swan hasn't verified the user's identity

AccountMembershipBindingUserErrorStatusInfo.lastNameMatchError ● Boolean! non-null scalar​

true if the last name of the user binded doesn't match with the invitation

AccountMembershipBindingUserErrorStatusInfo.phoneNumberMatchError ● Boolean! non-null scalar​

true if the phone number of the user binded doesn't match with the invitation

AccountMembershipBindingUserErrorStatusInfo.birthDateMatchError ● Boolean! non-null scalar​

true if the birth date of the user binded doesn't match with the invitation

AccountMembershipBindingUserErrorStatusInfo.restrictedTo ● RestrictedTo! non-null object​

restricted to a user

Interfaces​

AccountMembershipStatusInfo interface​

here are the different account membership status:

- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-cannot-be-disabled-rejection/index.html b/api-reference/objects/account-membership-cannot-be-disabled-rejection/index.html index 9de59be8415..68e49c144cb 100644 --- a/api-reference/objects/account-membership-cannot-be-disabled-rejection/index.html +++ b/api-reference/objects/account-membership-cannot-be-disabled-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-cannot-be-updated-rejection/index.html b/api-reference/objects/account-membership-cannot-be-updated-rejection/index.html index a06e5ae6c81..1f0313be2f9 100644 --- a/api-reference/objects/account-membership-cannot-be-updated-rejection/index.html +++ b/api-reference/objects/account-membership-cannot-be-updated-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-connection/index.html b/api-reference/objects/account-membership-connection/index.html index d3fb7a3ff42..68c41d7d00e 100644 --- a/api-reference/objects/account-membership-connection/index.html +++ b/api-reference/objects/account-membership-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type AccountMembershipConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [AccountMembershipEdge!]!
}

Fields​

AccountMembershipConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

AccountMembershipConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

AccountMembershipConnection.edges ● [AccountMembershipEdge!]! non-null object​

AccountMembershipEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

accountMemberships query

Member of​

Account object ● User object

- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-consent-pending-status-info/index.html b/api-reference/objects/account-membership-consent-pending-status-info/index.html index 2780cc69ca4..da23460ae10 100644 --- a/api-reference/objects/account-membership-consent-pending-status-info/index.html +++ b/api-reference/objects/account-membership-consent-pending-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipConsentPendingStatusInfo

when the user has to consent to invite a new account membership

type AccountMembershipConsentPendingStatusInfo implements AccountMembershipStatusInfo {
  status: AccountMembershipStatus!
  consent: Consent!
  restrictedTo: RestrictedTo!
}

Fields​

AccountMembershipConsentPendingStatusInfo.status ● AccountMembershipStatus! non-null enum​

AccountMembership status (always ConsentPending for type AccountMembershipConsentPendingStatusInfo)

AccountMembershipConsentPendingStatusInfo.consent ● Consent! non-null object​

The consent required to invite this account membership

AccountMembershipConsentPendingStatusInfo.restrictedTo ● RestrictedTo! non-null object​

restricted to a user

Interfaces​

AccountMembershipStatusInfo interface​

here are the different account membership status:

- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-disabled-status-info/index.html b/api-reference/objects/account-membership-disabled-status-info/index.html index e0f141d235d..f4765cfa762 100644 --- a/api-reference/objects/account-membership-disabled-status-info/index.html +++ b/api-reference/objects/account-membership-disabled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipDisabledStatusInfo

when the account membership is disabled

type AccountMembershipDisabledStatusInfo implements AccountMembershipStatusInfo {
  status: AccountMembershipStatus!
  reason: String!
}

Fields​

AccountMembershipDisabledStatusInfo.status ● AccountMembershipStatus! non-null enum​

AccountMembership status (always Disabled for type AccountMembershipDisabledStatusInfo)

AccountMembershipDisabledStatusInfo.reason ● String! non-null scalar​

reason why the account membership is disabled

Interfaces​

AccountMembershipStatusInfo interface​

here are the different account membership status:

- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-edge/index.html b/api-reference/objects/account-membership-edge/index.html index b04af8e1a97..61793fc1f0b 100644 --- a/api-reference/objects/account-membership-edge/index.html +++ b/api-reference/objects/account-membership-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountMembershipEdge

Implements the Relay Edge interface

type AccountMembershipEdge implements Edge {
  cursor: String!
  node: AccountMembership!
}

Fields​

AccountMembershipEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

AccountMembershipEdge.node ● AccountMembership! non-null object​

The account membership

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

AccountMembershipConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-enabled-status-info/index.html b/api-reference/objects/account-membership-enabled-status-info/index.html index 2ce28d7045b..be63344c3ea 100644 --- a/api-reference/objects/account-membership-enabled-status-info/index.html +++ b/api-reference/objects/account-membership-enabled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-invitation-sent-status-info/index.html b/api-reference/objects/account-membership-invitation-sent-status-info/index.html index a2dd55f1736..4d8101a8f90 100644 --- a/api-reference/objects/account-membership-invitation-sent-status-info/index.html +++ b/api-reference/objects/account-membership-invitation-sent-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipInvitationSentStatusInfo

when a new account membership is invited and there is no user binded yet

type AccountMembershipInvitationSentStatusInfo implements AccountMembershipStatusInfo {
  status: AccountMembershipStatus!
  restrictedTo: RestrictedTo!
}

Fields​

AccountMembershipInvitationSentStatusInfo.status ● AccountMembershipStatus! non-null enum​

AccountMembership status (always InvitationSent for type AccountMembershipInvitationSentStatusInfo)

AccountMembershipInvitationSentStatusInfo.restrictedTo ● RestrictedTo! non-null object​

restricted to a user

Interfaces​

AccountMembershipStatusInfo interface​

here are the different account membership status:

- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-not-allowed-rejection/index.html b/api-reference/objects/account-membership-not-allowed-rejection/index.html index da53a879be1..9fcf9229c50 100644 --- a/api-reference/objects/account-membership-not-allowed-rejection/index.html +++ b/api-reference/objects/account-membership-not-allowed-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipNotAllowedRejection

Rejection returned when the Account Membership is not allowed to use an operation.

type AccountMembershipNotAllowedRejection implements Rejection {
  message: String!
}

Fields​

AccountMembershipNotAllowedRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddCardPayload union ● AddCardsPayload union ● AddCardsWithGroupDeliveryPayload union ● AddDigitalCardPayload union ● AddSingleUseVirtualCardPayload union ● AddSingleUseVirtualCardsPayload union ● CancelCardPayload union ● CancelDigitalCardPayload union ● CancelPhysicalCardPayload union ● PrintPhysicalCardPayload union ● SuspendPhysicalCardPayload union ● UpdateCardPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-not-found-rejection/index.html b/api-reference/objects/account-membership-not-found-rejection/index.html index 76927d788a0..32a5fa627d7 100644 --- a/api-reference/objects/account-membership-not-found-rejection/index.html +++ b/api-reference/objects/account-membership-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-not-ready-to-be-bound-rejection/index.html b/api-reference/objects/account-membership-not-ready-to-be-bound-rejection/index.html index fbf57293ea2..0dfa081a972 100644 --- a/api-reference/objects/account-membership-not-ready-to-be-bound-rejection/index.html +++ b/api-reference/objects/account-membership-not-ready-to-be-bound-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-membership-suspended-status-info/index.html b/api-reference/objects/account-membership-suspended-status-info/index.html index d4b7d29101f..a11f5dedb1f 100644 --- a/api-reference/objects/account-membership-suspended-status-info/index.html +++ b/api-reference/objects/account-membership-suspended-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembershipSuspendedStatusInfo

when the account membership is suspended

type AccountMembershipSuspendedStatusInfo implements AccountMembershipStatusInfo {
  status: AccountMembershipStatus!
  reason: String!
}

Fields​

AccountMembershipSuspendedStatusInfo.status ● AccountMembershipStatus! non-null enum​

AccountMembership status (always Suspended for type AccountMembershipSuspendedStatusInfo)

AccountMembershipSuspendedStatusInfo.reason ● String! non-null scalar​

reason why the account membership is suspended

Interfaces​

AccountMembershipStatusInfo interface​

here are the different account membership status:

- + \ No newline at end of file diff --git a/api-reference/objects/account-membership/index.html b/api-reference/objects/account-membership/index.html index 1886fe73572..46b1f23fae3 100644 --- a/api-reference/objects/account-membership/index.html +++ b/api-reference/objects/account-membership/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountMembership

An account membership represents the rights of a user for a given account.

Each account is administered by an account membership having the capacity of legal representative. He has the possibility of delegating rights on this account to other users.

type AccountMembership {
  id: ID!
  email: String!
  user: User
  legalRepresentative: Boolean!
  canViewAccount: Boolean!
  canManageBeneficiaries: Boolean!
  canInitiatePayments: Boolean!
  canManageAccountMembership: Boolean!
  canManageCards: Boolean!
  statusInfo: AccountMembershipStatusInfo!
  account: Account
  spendingLimits: [SpendingLimit!]
  createdAt: DateTime!
  updatedAt: DateTime!
  version: String!
  residencyAddress: AddressInfo
  taxIdentificationNumber: String
  acceptedIdentificationLevels: [IdentificationLevel]!
  recommendedIdentificationLevel: IdentificationLevel!
  hasRequiredIdentificationLevel: Boolean
  disabledAt: DateTime
  cards(
  first: Int! = 50
  before: String
  after: String
  orderBy: CardOrderByInput
  filters: CardFiltersInput
): CardConnection!
  spending: Spending
}

Fields​

AccountMembership.id ● ID! non-null scalar​

Unique identifier of an account membership

AccountMembership.email ● String! non-null scalar​

email

AccountMembership.user ● User object​

user of this account membership

AccountMembership.legalRepresentative ● Boolean! non-null scalar​

true if this account membership having the capacity of the legal representative of the account holder.

AccountMembership.canViewAccount ● Boolean! non-null scalar​

true if this account membership can view account balances and transactions history

AccountMembership.canManageBeneficiaries ● Boolean! non-null scalar​

true if this account membership can add or canceled beneficiaries

AccountMembership.canInitiatePayments ● Boolean! non-null scalar​

true if this account membership can initiate payments

AccountMembership.canManageAccountMembership ● Boolean! non-null scalar​

true if this account membership can invite, update, suspend or resume memberships

AccountMembership.canManageCards ● Boolean! non-null scalar​

true if this account membership can manage cards for himself or to the memberships he manages

AccountMembership.statusInfo ● AccountMembershipStatusInfo! non-null interface​

status of the account membership

AccountMembership.account ● Account object​

account of the account membership

AccountMembership.spendingLimits ● [SpendingLimit!] list object​

Periodic Spending limit list

AccountMembership.createdAt ● DateTime! non-null scalar​

Created date

AccountMembership.updatedAt ● DateTime! non-null scalar​

Updated date

AccountMembership.version ● String! non-null scalar​

version of the account membership started from '1' and incremented at every updates

AccountMembership.residencyAddress ● AddressInfo object​

Residency address of the member

AccountMembership.taxIdentificationNumber ● String scalar​

Tax Identification Number of the member

AccountMembership.acceptedIdentificationLevels ● [IdentificationLevel]! non-null enum​

List of accepted identification level

AccountMembership.recommendedIdentificationLevel ● IdentificationLevel! non-null enum​

Recommended identification level

AccountMembership.hasRequiredIdentificationLevel ● Boolean scalar​

Indicate if the identity bound to the account membership has required identification level

AccountMembership.disabledAt ● DateTime scalar​

Disabled date

AccountMembership.cards ● CardConnection! non-null object​

account membership's cards

AccountMembership.cards.first ● Int! non-null scalar​
AccountMembership.cards.before ● String scalar​
AccountMembership.cards.after ● String scalar​
AccountMembership.cards.orderBy ● CardOrderByInput input​

When the list of elements needs to be ordered

AccountMembership.cards.filters ● CardFiltersInput input​

When the list of elements needs to be filtered

AccountMembership.spending ● Spending object​

Periodic Spending

Returned by​

accountMembership query

Member of​

Account object ● AccountMembershipEdge object ● AddAccountMembershipsSuccessPayload object ● AddAccountMembershipSuccessPayload object ● BindAccountMembershipSuccessPayload object ● Card object ● DisableAccountMembershipSuccessPayload object ● PendingConsentAccountMembershipUpdate object ● SuspendAccountMembershipSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/account-not-eligible-rejection/index.html b/api-reference/objects/account-not-eligible-rejection/index.html index 8bf3de096cb..e6096e709c4 100644 --- a/api-reference/objects/account-not-eligible-rejection/index.html +++ b/api-reference/objects/account-not-eligible-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-not-found-rejection/index.html b/api-reference/objects/account-not-found-rejection/index.html index 864e91e5ee3..c1712d6c0de 100644 --- a/api-reference/objects/account-not-found-rejection/index.html +++ b/api-reference/objects/account-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountNotFoundRejection

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

type AccountNotFoundRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

AccountNotFoundRejection.id ● String! non-null scalar​

AccountNotFoundRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddMerchantProfilePayload union ● AddReceivedSepaDirectDebitB2bMandatePayload union ● AddVirtualIbanEntryPayload union ● AllowSddPayload union ● CancelVirtualIbanEntryPayload union ● CloseAccountPayload union ● DenySddPayload union ● InitiateCreditTransfersPayload union ● InitiateInternationalCreditTransferResponsePayload union ● RequestMerchantProfileUpdatePayload union ● UpdateAccountPayload union ● UpdateCardPayload union ● UpdateReceivedSepaDirectDebitB2bMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/account-opened-status/index.html b/api-reference/objects/account-opened-status/index.html index fbcf749a91b..98ef61daa84 100644 --- a/api-reference/objects/account-opened-status/index.html +++ b/api-reference/objects/account-opened-status/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account-suspended-status/index.html b/api-reference/objects/account-suspended-status/index.html index 6849056e0d7..377bf6dd1e8 100644 --- a/api-reference/objects/account-suspended-status/index.html +++ b/api-reference/objects/account-suspended-status/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AccountSuspendedStatus

Account Suspended status information

type AccountSuspendedStatus implements AccountStatusInfo {
  status: AccountStatus!
  reason: String!
  reasonInfo: SuspendAccountStatusReason!
}

Fields​

AccountSuspendedStatus.status ● AccountStatus! non-null enum​

Account status (always Suspended for type AccountSuspendedStatus)

AccountSuspendedStatus.reason ● String! non-null scalar​

Reason why the account is suspended @Deprecated

AccountSuspendedStatus.reasonInfo ● SuspendAccountStatusReason! non-null union​

Reason why the account is currently suspend

Interfaces​

AccountStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/account-verification-already-rejected-rejection/index.html b/api-reference/objects/account-verification-already-rejected-rejection/index.html index 442f5aac8e7..4f75818045b 100644 --- a/api-reference/objects/account-verification-already-rejected-rejection/index.html +++ b/api-reference/objects/account-verification-already-rejected-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountVerificationAlreadyRejectedRejection

Rejection returned when the external account has already been rejected.

In such a case, contact Swan directly to resolve the situation for this specific account holder.

type AccountVerificationAlreadyRejectedRejection implements Rejection {
  message: String!
}

Fields​

AccountVerificationAlreadyRejectedRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddDirectDebitFundingSourcePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/account-verification-wrong-status-rejection/index.html b/api-reference/objects/account-verification-wrong-status-rejection/index.html index c3a12fffc14..55d40cbc8ac 100644 --- a/api-reference/objects/account-verification-wrong-status-rejection/index.html +++ b/api-reference/objects/account-verification-wrong-status-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/account/index.html b/api-reference/objects/account/index.html index c8fac1a1d6c..6d4ec228ba7 100644 --- a/api-reference/objects/account/index.html +++ b/api-reference/objects/account/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ Only if the account membership has canViewAccount=true & this account has paymentLevel=Unlimited

Account.currency ● Currency! non-null scalar​

Currency

Account.blockSDD ● Boolean scalar​

true if the main IBAN refuses all Sepa Direct Debit received

Account.statusInfo ● AccountStatusInfo! non-null interface​

Status of the account

Account.partnershipStatusInfo ● PartnershipStatusInfo interface​

Partnership status

Account.createdAt ● DateTime! non-null scalar​

Created date

Account.updatedAt ● DateTime! non-null scalar​

Updated date

Account.virtualIbanEntries ● VirtualIBANEntryConnection! non-null object​

List of Virtual IBAN

Account.virtualIbanEntries.first ● Int! non-null scalar​
Account.virtualIbanEntries.before ● String scalar​
Account.virtualIbanEntries.after ● String scalar​

Account.memberships ● AccountMembershipConnection! non-null object​

List of account membership for this account

Account.memberships.first ● Int! non-null scalar​
Account.memberships.before ● String scalar​
Account.memberships.after ● String scalar​
Account.memberships.filters ● MembershipsFilterInput input​
Account.memberships.orderBy ● AccountMembershipOrderByInput input​

Account.requiredConsentToFetchNewTransactions ● Boolean! non-null scalar​

trueif a consent is required to fetch new transactions

Account.language ● AccountLanguage! non-null enum​

Language used for account statements

Account.legalRepresentativeMembership ● AccountMembership! non-null object​

Legal representative account membership

Account.paymentAccountType ● PaymentAccountType! non-null enum​

Type of the account : EMoney if account holder has not finished the KYC requirements, PaymentService otherwise

Account.upgradedAt ● DateTime scalar​

Date of the account going from eMoney to PaymentService

Account.bankDetails ● String scalar​

Link to the account's bank details

Account.legalDocuments ● LegalDocumentConnection object​

Legal Documents linked to the account

Account.legalDocuments.first ● Int! non-null scalar​
Account.legalDocuments.after ● String scalar​
Account.legalDocuments.filters ● LegalDocumentsFilterInput input​

Account.balances ● AccountBalances object​

A list of balances regarding an account.

Account.statements ● StatementConnection object​

A list of statements of an account. The list is ordered by lastUpdateAt

Account.statements.first ● Int! non-null scalar​

number of elements in the list (default value 50)

Account.statements.after ● String scalar​

When the list of elements needs to start after a element

Account.statements.filters ● StatementFiltersInput input​

When the list of elements needs to be filtered

Account.transactions ● TransactionConnection object​

A list of transactions of an account.

Account.transactions.first ● Int! non-null scalar​

number of elements in the list (default value 50)

Account.transactions.after ● String scalar​

When the list of elements needs to start after a element

Account.transactions.filters ● TransactionsFiltersInput input​

When the list of elements needs to be filtered

Account.transactions.orderBy ● TransactionsOrderByInput input​

When the list of elements needs to be sorted (default value UpdatedAt desc)

Account.invoices ● InvoiceConnection object​

A list of invoices of an account. The list is ordered by creation date (from newest to oldest)

Account.invoices.first ● Int! non-null scalar​

number of elements in the list (default value 10)

Account.invoices.after ● String scalar​

When the list of elements needs to start after an element

Account.receivedDirectDebitMandates ● ReceivedDirectDebitMandateConnection object​

A list of receive Direct Mandates of an account.

Account.receivedDirectDebitMandates.first ● Int! non-null scalar​

number of elements in the list (default value 50)

Account.receivedDirectDebitMandates.after ● String scalar​

When the list of elements needs to start after a element

Account.receivedDirectDebitMandates.orderBy ● AccountReceivedDirectDebitOrderByInput input​

When the list of elements needs to be ordered

Account.receivedDirectDebitMandates.filters ● AccountReceivedDirectDebitMandateFiltersInput input​

When the list of elements needs to be filtered

Account.standingOrders ● StandingOrderConnection! non-null object​

A list of standing orders regarding an account.

Account.standingOrders.first ● Int! non-null scalar​

number of elements in the list (default value 50)

Account.standingOrders.after ● String scalar​

When the list of elements needs to start after a element

Account.standingOrders.offset ● Int scalar​

When the list of elements needs to start at a specific offset

Account.standingOrders.orderBy ● AccountStandingOrderOrderByInput input​

When the list of elements needs to be ordered

Account.standingOrders.filters ● AccountStandingOrderFiltersInput input​

When the list of elements needs to be filtered

Account.fundingSources ● FundingSourceConnection object​

List of funding source created on the account

Account.fundingSources.first ● Int! non-null scalar​

number of elements in the list (default value 50)

Account.fundingSources.after ● String scalar​

When the list of elements needs to start after a element

Account.fundingSources.orderBy ● FundingSourceOrderByInput input​

When the list of elements needs to be ordered

Account.fundingSources.filters ● FundingSourceFiltersInput input​

When the list of elements needs to be filtered

Account.merchantProfiles ● MerchantProfileConnection object​

List of merchant profiles created on the account

Account.merchantProfiles.first ● Int! non-null scalar​

number of elements in the list (default value 50)

Account.merchantProfiles.after ● String scalar​

When the list of elements needs to start after a element

Account.merchantProfiles.orderBy ● MerchantProfileOrderByInput input​

When the list of elements needs to be ordered

Account.merchantProfiles.filters ● MerchantProfileFiltersInput input​

When the list of elements needs to be filtered

Returned by​

account query

Member of​

AccountEdge object ● AccountMembership object ● AllowSddSuccessPayload object ● Balance object ● CardTransaction object ● CheckTransaction object ● DenySddSuccessPayload object ● FeeTransaction object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● InternalReceivedDirectDebitMandate object ● InternationalCreditTransferTransaction object ● Onboarding object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object ● SEPAReceivedDirectDebitMandate object ● StandingOrder object ● Statement object ● Transaction interface ● UpdateAccountSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/activate-physical-card-success-payload/index.html b/api-reference/objects/activate-physical-card-success-payload/index.html index 442fd611804..9855399e5c3 100644 --- a/api-reference/objects/activate-physical-card-success-payload/index.html +++ b/api-reference/objects/activate-physical-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/active-merchant-payment-link-status-info/index.html b/api-reference/objects/active-merchant-payment-link-status-info/index.html index 9ee7c111ae1..fad1ca4ca34 100644 --- a/api-reference/objects/active-merchant-payment-link-status-info/index.html +++ b/api-reference/objects/active-merchant-payment-link-status-info/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

ActiveMerchantPaymentLinkStatusInfo

No description

type ActiveMerchantPaymentLinkStatusInfo implements MerchantPaymentLinkStatusInfo {
  status: MerchantPaymentLinkStatus!
  expiresAt: DateTime!
}

Fields​

ActiveMerchantPaymentLinkStatusInfo.status ● MerchantPaymentLinkStatus! non-null enum​

ActiveMerchantPaymentLinkStatusInfo.expiresAt ● DateTime! non-null scalar​

The date when the payment link expires. The payment link expires 24 hours after it was created.

Interfaces​

MerchantPaymentLinkStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/add-account-membership-success-payload/index.html b/api-reference/objects/add-account-membership-success-payload/index.html index a28235032d6..9098c28d20a 100644 --- a/api-reference/objects/add-account-membership-success-payload/index.html +++ b/api-reference/objects/add-account-membership-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-account-memberships-success-payload/index.html b/api-reference/objects/add-account-memberships-success-payload/index.html index fd6998280c0..6545cac84aa 100644 --- a/api-reference/objects/add-account-memberships-success-payload/index.html +++ b/api-reference/objects/add-account-memberships-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-card-success-payload/index.html b/api-reference/objects/add-card-success-payload/index.html index d3de1445e60..760f5395444 100644 --- a/api-reference/objects/add-card-success-payload/index.html +++ b/api-reference/objects/add-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-cards-success-payload/index.html b/api-reference/objects/add-cards-success-payload/index.html index 63e4ac09342..aeae8627474 100644 --- a/api-reference/objects/add-cards-success-payload/index.html +++ b/api-reference/objects/add-cards-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-cards-with-group-delivery-success-payload/index.html b/api-reference/objects/add-cards-with-group-delivery-success-payload/index.html index bf87d04c9f8..7a5df71bcdc 100644 --- a/api-reference/objects/add-cards-with-group-delivery-success-payload/index.html +++ b/api-reference/objects/add-cards-with-group-delivery-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-digital-card-success-payload/index.html b/api-reference/objects/add-digital-card-success-payload/index.html index b0a98ffa750..411406ac763 100644 --- a/api-reference/objects/add-digital-card-success-payload/index.html +++ b/api-reference/objects/add-digital-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-direct-debit-funding-source-success-payload/index.html b/api-reference/objects/add-direct-debit-funding-source-success-payload/index.html index b5087613ef7..79cdb39d6e3 100644 --- a/api-reference/objects/add-direct-debit-funding-source-success-payload/index.html +++ b/api-reference/objects/add-direct-debit-funding-source-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-external-account-balance-success-payload/index.html b/api-reference/objects/add-external-account-balance-success-payload/index.html index 9766c9bb292..399fbd2dc21 100644 --- a/api-reference/objects/add-external-account-balance-success-payload/index.html +++ b/api-reference/objects/add-external-account-balance-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-external-account-success-payload/index.html b/api-reference/objects/add-external-account-success-payload/index.html index 6568f78121d..6fd121d0209 100644 --- a/api-reference/objects/add-external-account-success-payload/index.html +++ b/api-reference/objects/add-external-account-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-funding-limit-settings-change-request-success-payload/index.html b/api-reference/objects/add-funding-limit-settings-change-request-success-payload/index.html index 0b620c33c49..063d31a3445 100644 --- a/api-reference/objects/add-funding-limit-settings-change-request-success-payload/index.html +++ b/api-reference/objects/add-funding-limit-settings-change-request-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddFundingLimitSettingsChangeRequestSuccessPayload

Add Funding Limit Settings Change Request Success Payload

type AddFundingLimitSettingsChangeRequestSuccessPayload {
  fundingLimitSettingsChangeRequest: FundingLimitSettingsChangeRequest!
}

Fields​

AddFundingLimitSettingsChangeRequestSuccessPayload.fundingLimitSettingsChangeRequest ● FundingLimitSettingsChangeRequest! non-null object​

The new request for funding limit settings change

Implemented by​

AddFundingLimitSettingsChangeRequestPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/add-internal-direct-debit-payment-mandate-success-payload/index.html b/api-reference/objects/add-internal-direct-debit-payment-mandate-success-payload/index.html index e270f2ba637..e3c21e56dc5 100644 --- a/api-reference/objects/add-internal-direct-debit-payment-mandate-success-payload/index.html +++ b/api-reference/objects/add-internal-direct-debit-payment-mandate-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-merchant-profile-success-payload/index.html b/api-reference/objects/add-merchant-profile-success-payload/index.html index 90922b7fe11..c0351fd9ffe 100644 --- a/api-reference/objects/add-merchant-profile-success-payload/index.html +++ b/api-reference/objects/add-merchant-profile-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-or-update-external-account-balance-success-payload/index.html b/api-reference/objects/add-or-update-external-account-balance-success-payload/index.html index c0060de7ec2..5d1880c675c 100644 --- a/api-reference/objects/add-or-update-external-account-balance-success-payload/index.html +++ b/api-reference/objects/add-or-update-external-account-balance-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-received-internal-direct-debit-b2-b-mandate-success-payload/index.html b/api-reference/objects/add-received-internal-direct-debit-b2-b-mandate-success-payload/index.html index 23f4f7984ce..a9b5a94fdb8 100644 --- a/api-reference/objects/add-received-internal-direct-debit-b2-b-mandate-success-payload/index.html +++ b/api-reference/objects/add-received-internal-direct-debit-b2-b-mandate-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddReceivedInternalDirectDebitB2bMandateSuccessPayload

Return type in case of a successful response of the addReceivedInternalDirectDebitB2bMandate mutation

type AddReceivedInternalDirectDebitB2bMandateSuccessPayload {
  receivedDirectDebitMandate: ReceivedDirectDebitMandate!
}

Fields​

AddReceivedInternalDirectDebitB2bMandateSuccessPayload.receivedDirectDebitMandate ● ReceivedDirectDebitMandate! non-null interface​

The received direct debit mandate is added

Implemented by​

AddReceivedInternalDirectDebitB2bMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/add-received-sepa-direct-debit-b2-b-mandate-success-payload/index.html b/api-reference/objects/add-received-sepa-direct-debit-b2-b-mandate-success-payload/index.html index fde10dab853..b5588043ff8 100644 --- a/api-reference/objects/add-received-sepa-direct-debit-b2-b-mandate-success-payload/index.html +++ b/api-reference/objects/add-received-sepa-direct-debit-b2-b-mandate-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddReceivedSepaDirectDebitB2bMandateSuccessPayload

Return type in case of a successful response of the addReceivedSepaDirectDebitB2bMandate mutation

type AddReceivedSepaDirectDebitB2bMandateSuccessPayload {
  receivedDirectDebitMandate: ReceivedDirectDebitMandate!
}

Fields​

AddReceivedSepaDirectDebitB2bMandateSuccessPayload.receivedDirectDebitMandate ● ReceivedDirectDebitMandate! non-null interface​

The received direct debit mandate is added

Implemented by​

AddReceivedSepaDirectDebitB2bMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/add-sepa-direct-debit-payment-mandate-success-payload/index.html b/api-reference/objects/add-sepa-direct-debit-payment-mandate-success-payload/index.html index cc79da3293c..b4ee3065127 100644 --- a/api-reference/objects/add-sepa-direct-debit-payment-mandate-success-payload/index.html +++ b/api-reference/objects/add-sepa-direct-debit-payment-mandate-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-single-use-virtual-card-success-for-project-owner-payload/index.html b/api-reference/objects/add-single-use-virtual-card-success-for-project-owner-payload/index.html index 989d4f63933..458d14edcab 100644 --- a/api-reference/objects/add-single-use-virtual-card-success-for-project-owner-payload/index.html +++ b/api-reference/objects/add-single-use-virtual-card-success-for-project-owner-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-single-use-virtual-card-success-for-user-payload/index.html b/api-reference/objects/add-single-use-virtual-card-success-for-user-payload/index.html index 94a9b85b24d..c9ae56a3384 100644 --- a/api-reference/objects/add-single-use-virtual-card-success-for-user-payload/index.html +++ b/api-reference/objects/add-single-use-virtual-card-success-for-user-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-single-use-virtual-cards-success-payload/index.html b/api-reference/objects/add-single-use-virtual-cards-success-payload/index.html index a7b68fed867..c1f1503a3ef 100644 --- a/api-reference/objects/add-single-use-virtual-cards-success-payload/index.html +++ b/api-reference/objects/add-single-use-virtual-cards-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/add-virtual-iban-entry-success-payload/index.html b/api-reference/objects/add-virtual-iban-entry-success-payload/index.html index 94b7c92a80a..ad4301ad6c5 100644 --- a/api-reference/objects/add-virtual-iban-entry-success-payload/index.html +++ b/api-reference/objects/add-virtual-iban-entry-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/adding-cards-to-different-accounts-rejection/index.html b/api-reference/objects/adding-cards-to-different-accounts-rejection/index.html index bfc69ebfa5b..541aef09ecf 100644 --- a/api-reference/objects/adding-cards-to-different-accounts-rejection/index.html +++ b/api-reference/objects/adding-cards-to-different-accounts-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/address-info/index.html b/api-reference/objects/address-info/index.html index c13e8629745..eebc0b77886 100644 --- a/api-reference/objects/address-info/index.html +++ b/api-reference/objects/address-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddressInfo

Address information.

type AddressInfo {
  addressLine1: String
  addressLine2: String
  city: String
  postalCode: String
  state: String
  country: CCA3
}

Fields​

AddressInfo.addressLine1 ● String scalar​

Address line 1.

AddressInfo.addressLine2 ● String scalar​

Address line 2.

AddressInfo.city ● String scalar​

City.

AddressInfo.postalCode ● String scalar​

Postal code.

AddressInfo.state ● String scalar​

State.

AddressInfo.country ● CCA3 scalar​

Country.

Member of​

AccountHolder object ● AccountMembership object ● OnboardingCompanyAccountHolderInfo object ● OnboardingIndividualAccountHolderInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/address-information/index.html b/api-reference/objects/address-information/index.html index 69701973011..020d939c6c3 100644 --- a/api-reference/objects/address-information/index.html +++ b/api-reference/objects/address-information/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddressInformation

Address

type AddressInformation {
  addressLine1: String!
  addressLine2: String
  city: String!
  country: CCA3!
  postalCode: String!
  state: String
}

Fields​

AddressInformation.addressLine1 ● String! non-null scalar​

Address

AddressInformation.addressLine2 ● String scalar​

Address

AddressInformation.city ● String! non-null scalar​

City

AddressInformation.country ● CCA3! non-null scalar​

Country

AddressInformation.postalCode ● String! non-null scalar​

Postal code

AddressInformation.state ● String scalar​

State

Member of​

AccountHolderCompanyInfo object ● CompanyInfo object ● IndividualUltimateBeneficialOwner object ● OnboardingCompanyAccountHolderInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/address/index.html b/api-reference/objects/address/index.html index 92fb91b8ee1..99a20fd4c07 100644 --- a/api-reference/objects/address/index.html +++ b/api-reference/objects/address/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Address

Address Information

type Address {
  addressLine1: String
  addressLine2: String
  city: String
  postalCode: String
  state: String
  country: CCA3
}

Fields​

Address.addressLine1 ● String scalar​

address line 1

Address.addressLine2 ● String scalar​

addressLine2

Address.city ● String scalar​

city

Address.postalCode ● String scalar​

postal code (max 10 characters)

Address.state ● String scalar​

state

Address.country ● CCA3 scalar​

country

Member of​

Bank object ● InternalPaymentMandateCreditor object ● InternalPaymentMandateDebtor object ● InternalReceivedDirectDebitMandateCreditor object ● MerchantPaymentLink object ● PaymentMandateCreditor interface ● PhysicalCardRenewedStatusInfo object ● PhysicalCardToActivateStatusInfo object ● SEPABeneficiary object ● SEPAPaymentMandateCreditor object ● SEPAPaymentMandateDebtor object ● SEPAReceivedDirectDebitMandateCreditor object

- + \ No newline at end of file diff --git a/api-reference/objects/allow-sdd-success-payload/index.html b/api-reference/objects/allow-sdd-success-payload/index.html index 8a72a6ec569..a7ab05f5836 100644 --- a/api-reference/objects/allow-sdd-success-payload/index.html +++ b/api-reference/objects/allow-sdd-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/allow-sdd-virtual-iban-entry-success-payload/index.html b/api-reference/objects/allow-sdd-virtual-iban-entry-success-payload/index.html index c715e0c0220..be2cd6bd7c5 100644 --- a/api-reference/objects/allow-sdd-virtual-iban-entry-success-payload/index.html +++ b/api-reference/objects/allow-sdd-virtual-iban-entry-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/allowed-value/index.html b/api-reference/objects/allowed-value/index.html index d38588f4d92..6d6dddaaf70 100644 --- a/api-reference/objects/allowed-value/index.html +++ b/api-reference/objects/allowed-value/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/already-valid-physical-card-rejection/index.html b/api-reference/objects/already-valid-physical-card-rejection/index.html index fb0c6d7e302..afd6e8d6e1a 100644 --- a/api-reference/objects/already-valid-physical-card-rejection/index.html +++ b/api-reference/objects/already-valid-physical-card-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/amount/index.html b/api-reference/objects/amount/index.html index 438c4446f04..a2e325c21bf 100644 --- a/api-reference/objects/amount/index.html +++ b/api-reference/objects/amount/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Amount

Amount with its currency

type Amount {
  currency: Currency!
  value: AmountValue!
}

Fields​

Amount.currency ● Currency! non-null scalar​

currency

Amount.value ● AmountValue! non-null scalar​

value of the amount

Member of​

AccountBalances object ● CapitalDepositCase object ● CardTransaction object ● CheckTransaction object ● ExternalAccountBalance object ● FeeTransaction object ● FundingLimit object ● FundingLimitAmount object ● InstantFundingLimit object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● InternationalCreditTransferCurrencyExchange object ● InternationalCreditTransferQuote object ● InternationalCreditTransferTransaction object ● Invoice object ● MerchantPaymentLink object ● MerchantProfile object ● PhysicalCard object ● RequestMerchantProfileUpdate object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object ● Shareholder object ● Spending object ● SpendingLimit object ● StandingOrder object ● Statement object ● Transaction interface

- + \ No newline at end of file diff --git a/api-reference/objects/apple-pay-not-allowed-for-project-rejection/index.html b/api-reference/objects/apple-pay-not-allowed-for-project-rejection/index.html index 46bd0d66a9a..eae835b2197 100644 --- a/api-reference/objects/apple-pay-not-allowed-for-project-rejection/index.html +++ b/api-reference/objects/apple-pay-not-allowed-for-project-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/approved-funding-limit/index.html b/api-reference/objects/approved-funding-limit/index.html index 08936674d87..f5d2a76b8f1 100644 --- a/api-reference/objects/approved-funding-limit/index.html +++ b/api-reference/objects/approved-funding-limit/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/authenticator/index.html b/api-reference/objects/authenticator/index.html index 6e56dbc275c..ab86ca672db 100644 --- a/api-reference/objects/authenticator/index.html +++ b/api-reference/objects/authenticator/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Authenticator

A method used to authenticate a user

type Authenticator {
  os: String
  brand: String
  model: String
  type: AuthenticatorType!
  userAgent: String
  acceptLanguage: String
}

Fields​

Authenticator.os ● String scalar​

Operating System (Apple, Android, ...)

Authenticator.brand ● String scalar​

Device Brand (Apple, Samsung, ...)

Authenticator.model ● String scalar​

Device Model (iPhone XS, Samsung S3, ...)

Authenticator.type ● AuthenticatorType! non-null enum​

Type of authenticator

Authenticator.userAgent ● String scalar​

User agent, if it's a web authenticator

Authenticator.acceptLanguage ● String scalar​

Accept-Language header used during registration, if it's a web authenticator

Member of​

User object

- + \ No newline at end of file diff --git a/api-reference/objects/bad-account-status-rejection/index.html b/api-reference/objects/bad-account-status-rejection/index.html index 8f0a43747a1..fbd8ac19e33 100644 --- a/api-reference/objects/bad-account-status-rejection/index.html +++ b/api-reference/objects/bad-account-status-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

BadAccountStatusRejection

Rejection returned if the status account is not valid

type BadAccountStatusRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

BadAccountStatusRejection.id ● String! non-null scalar​

BadAccountStatusRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

ActivatePhysicalCardPayload union ● AddAccountMembershipPayload union ● AddAccountMembershipsPayload union ● AddCardPayload union ● AddCardsPayload union ● AddCardsWithGroupDeliveryPayload union ● AddDigitalCardPayload union ● AddSingleUseVirtualCardPayload union ● AddSingleUseVirtualCardsPayload union ● AddVirtualIbanEntryPayload union ● AllowSddVirtualIbanEntryPayload union ● BindAccountMembershipPayload union ● CancelVirtualIbanEntryPayload union ● CloseAccountPayload union ● DenySddPayload union ● DenySddVirtualIbanEntryPayload union ● PrintPhysicalCardPayload union ● UpdateAccountPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/bad-request-rejection/index.html b/api-reference/objects/bad-request-rejection/index.html index 9f8ec9b8dd6..0d699c14ab9 100644 --- a/api-reference/objects/bad-request-rejection/index.html +++ b/api-reference/objects/bad-request-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/balance/index.html b/api-reference/objects/balance/index.html index b8ea09d0e32..6ae421e39b6 100644 --- a/api-reference/objects/balance/index.html +++ b/api-reference/objects/balance/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Balance

Balance Information

type Balance {
  account: Account!
  balances: AccountBalances
  lastSctOut: SEPACreditTransferTransaction
  lastSctIn: SEPACreditTransferTransaction
}

Fields​

Balance.account ● Account! non-null object​

Matching account for this balance

Balance.balances ● AccountBalances object​

A list of balances regarding an account.

Balance.lastSctOut ● SEPACreditTransferTransaction object​

Last SCT OUT transaction

Balance.lastSctIn ● SEPACreditTransferTransaction object​

Last SCT IN transaction

- + \ No newline at end of file diff --git a/api-reference/objects/bank/index.html b/api-reference/objects/bank/index.html index a62936d844e..337e01eb149 100644 --- a/api-reference/objects/bank/index.html +++ b/api-reference/objects/bank/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Bank

Information about the banking institution

type Bank {
  name: String!
  branch: String
  nationalId: String!
  bic: BIC!
  address: Address!
}

Fields​

Bank.name ● String! non-null scalar​

Bank name

Bank.branch ● String scalar​

Bank Branch Code

Bank.nationalId ● String! non-null scalar​

Bank local identifier (unique by country)

Bank.bic ● BIC! non-null scalar​

Bank BIC code

Bank.address ● Address! non-null object​

Bank address (We might only be able to fill in the country)

Member of​

ValidIban object

- + \ No newline at end of file diff --git a/api-reference/objects/bind-account-membership-success-payload/index.html b/api-reference/objects/bind-account-membership-success-payload/index.html index eeb725abce5..06ed143917f 100644 --- a/api-reference/objects/bind-account-membership-success-payload/index.html +++ b/api-reference/objects/bind-account-membership-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/booked-transaction-status-info/index.html b/api-reference/objects/booked-transaction-status-info/index.html index c96c7abc554..949686908cc 100644 --- a/api-reference/objects/booked-transaction-status-info/index.html +++ b/api-reference/objects/booked-transaction-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

BookedTransactionStatusInfo

Booked transaction status information

type BookedTransactionStatusInfo implements TransactionStatusInfo {
  status: TransactionStatus!
  bookingDate: DateTime!
  valueDate: DateTime!
}

Fields​

BookedTransactionStatusInfo.status ● TransactionStatus! non-null enum​

status of the transaction

BookedTransactionStatusInfo.bookingDate ● DateTime! non-null scalar​

The Date when the transaction is posted to an account on the Swan books.

BookedTransactionStatusInfo.valueDate ● DateTime! non-null scalar​

The Date when the transaction is considered effective in accounting

Interfaces​

TransactionStatusInfo interface​

Transaction Status information

- + \ No newline at end of file diff --git a/api-reference/objects/cancel-card-success-payload/index.html b/api-reference/objects/cancel-card-success-payload/index.html index 1483e6c8d0b..a0bac802a9e 100644 --- a/api-reference/objects/cancel-card-success-payload/index.html +++ b/api-reference/objects/cancel-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/cancel-consent-success-payload/index.html b/api-reference/objects/cancel-consent-success-payload/index.html index 88ff3efa6dd..2fee4f8a9c5 100644 --- a/api-reference/objects/cancel-consent-success-payload/index.html +++ b/api-reference/objects/cancel-consent-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/cancel-digital-card-success-payload/index.html b/api-reference/objects/cancel-digital-card-success-payload/index.html index 0794c11d88c..61adac0000f 100644 --- a/api-reference/objects/cancel-digital-card-success-payload/index.html +++ b/api-reference/objects/cancel-digital-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/cancel-funding-source-success-payload/index.html b/api-reference/objects/cancel-funding-source-success-payload/index.html index a23b8c6ad45..63e69a6f2d9 100644 --- a/api-reference/objects/cancel-funding-source-success-payload/index.html +++ b/api-reference/objects/cancel-funding-source-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/cancel-physical-card-success-payload/index.html b/api-reference/objects/cancel-physical-card-success-payload/index.html index f358ab161fa..19e624d7ad0 100644 --- a/api-reference/objects/cancel-physical-card-success-payload/index.html +++ b/api-reference/objects/cancel-physical-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/cancel-standing-order-success-payload/index.html b/api-reference/objects/cancel-standing-order-success-payload/index.html index 6d5c5934fcf..f02e2da1048 100644 --- a/api-reference/objects/cancel-standing-order-success-payload/index.html +++ b/api-reference/objects/cancel-standing-order-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/cancel-transaction-success-payload/index.html b/api-reference/objects/cancel-transaction-success-payload/index.html index 0c243786e5e..48ccee313a3 100644 --- a/api-reference/objects/cancel-transaction-success-payload/index.html +++ b/api-reference/objects/cancel-transaction-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/cancel-virtual-iban-entry-success-payload/index.html b/api-reference/objects/cancel-virtual-iban-entry-success-payload/index.html index 10cfc0742b3..b24163e5e30 100644 --- a/api-reference/objects/cancel-virtual-iban-entry-success-payload/index.html +++ b/api-reference/objects/cancel-virtual-iban-entry-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/canceled-funding-source-status-info/index.html b/api-reference/objects/canceled-funding-source-status-info/index.html index 16a6aaa6ae6..94cb2070fe4 100644 --- a/api-reference/objects/canceled-funding-source-status-info/index.html +++ b/api-reference/objects/canceled-funding-source-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CanceledFundingSourceStatusInfo

Funding Source Canceled status information

type CanceledFundingSourceStatusInfo implements FundingSourceStatusInfo {
  status: FundingSourceStatus!
  enabledAt: Date
  canceledAt: Date!
  reasonCode: CanceledFundingSourceReason!
}

Fields​

CanceledFundingSourceStatusInfo.status ● FundingSourceStatus! non-null enum​

Funding Source Canceled status

CanceledFundingSourceStatusInfo.enabledAt ● Date scalar​

Date at which the funding source was enabled

CanceledFundingSourceStatusInfo.canceledAt ● Date! non-null scalar​

Date at which the funding source was canceled

CanceledFundingSourceStatusInfo.reasonCode ● CanceledFundingSourceReason! non-null enum​

Reason code of the cancellation

Interfaces​

FundingSourceStatusInfo interface​

Funding Source status information

- + \ No newline at end of file diff --git a/api-reference/objects/canceled-identification-level-status-info/index.html b/api-reference/objects/canceled-identification-level-status-info/index.html index 89ff4dc9624..a0358e109c6 100644 --- a/api-reference/objects/canceled-identification-level-status-info/index.html +++ b/api-reference/objects/canceled-identification-level-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/canceled-merchant-payment-link-status-info/index.html b/api-reference/objects/canceled-merchant-payment-link-status-info/index.html index f856c30fa9f..883f555369d 100644 --- a/api-reference/objects/canceled-merchant-payment-link-status-info/index.html +++ b/api-reference/objects/canceled-merchant-payment-link-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CanceledMerchantPaymentLinkStatusInfo

No description

type CanceledMerchantPaymentLinkStatusInfo implements MerchantPaymentLinkStatusInfo {
  status: MerchantPaymentLinkStatus!
  canceledAt: DateTime!
}

Fields​

CanceledMerchantPaymentLinkStatusInfo.status ● MerchantPaymentLinkStatus! non-null enum​

CanceledMerchantPaymentLinkStatusInfo.canceledAt ● DateTime! non-null scalar​

The date at which the customer canceled the payment.

Interfaces​

MerchantPaymentLinkStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/canceled-merchant-payment-method-status-info/index.html b/api-reference/objects/canceled-merchant-payment-method-status-info/index.html index 8bb0d67fd1d..6309d24de3e 100644 --- a/api-reference/objects/canceled-merchant-payment-method-status-info/index.html +++ b/api-reference/objects/canceled-merchant-payment-method-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CanceledMerchantPaymentMethodStatusInfo

CanceledMerchantPaymentMethodStatusInfo

type CanceledMerchantPaymentMethodStatusInfo implements MerchantPaymentMethodStatusInfo {
  status: MerchantPaymentMethodStatus!
  canceledAt: Date!
}

Fields​

CanceledMerchantPaymentMethodStatusInfo.status ● MerchantPaymentMethodStatus! non-null enum​

CanceledMerchantPaymentMethodStatusInfo.canceledAt ● Date! non-null scalar​

Merchant Payment Method canceled date

Interfaces​

MerchantPaymentMethodStatusInfo interface​

The payment method status information

- + \ No newline at end of file diff --git a/api-reference/objects/canceled-merchant-profile-status-info/index.html b/api-reference/objects/canceled-merchant-profile-status-info/index.html index 27728de6450..3a1af61980a 100644 --- a/api-reference/objects/canceled-merchant-profile-status-info/index.html +++ b/api-reference/objects/canceled-merchant-profile-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CanceledMerchantProfileStatusInfo

CanceledMerchantProfileStatusInfo

type CanceledMerchantProfileStatusInfo implements MerchantProfileStatusInfo {
  status: MerchantProfileStatus!
  canceledAt: Date!
  enabledAt: Date
}

Fields​

CanceledMerchantProfileStatusInfo.status ● MerchantProfileStatus! non-null enum​

CanceledMerchantProfileStatusInfo.canceledAt ● Date! non-null scalar​

CanceledMerchantProfileStatusInfo.enabledAt ● Date scalar​

Interfaces​

MerchantProfileStatusInfo interface​

Merchant Profile Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/canceled-transaction-status-info/index.html b/api-reference/objects/canceled-transaction-status-info/index.html index 882f2afd590..1b47042a63a 100644 --- a/api-reference/objects/canceled-transaction-status-info/index.html +++ b/api-reference/objects/canceled-transaction-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CanceledTransactionStatusInfo

Canceled transaction status information

type CanceledTransactionStatusInfo implements TransactionStatusInfo {
  status: TransactionStatus!
  canceledDate: DateTime
}

Fields​

CanceledTransactionStatusInfo.status ● TransactionStatus! non-null enum​

status of the transaction

CanceledTransactionStatusInfo.canceledDate ● DateTime scalar​

The date when the transaction was canceled

Interfaces​

TransactionStatusInfo interface​

Transaction Status information

- + \ No newline at end of file diff --git a/api-reference/objects/cannot-activate-physical-card-rejection/index.html b/api-reference/objects/cannot-activate-physical-card-rejection/index.html index 279b7235820..f6b719dedf4 100644 --- a/api-reference/objects/cannot-activate-physical-card-rejection/index.html +++ b/api-reference/objects/cannot-activate-physical-card-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-case-connection/index.html b/api-reference/objects/capital-deposit-case-connection/index.html index 4978622378a..78d3f14fc78 100644 --- a/api-reference/objects/capital-deposit-case-connection/index.html +++ b/api-reference/objects/capital-deposit-case-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositCaseConnection

Implements the Relay Connection interface, used to paginate list of elements (Learn More)

type CapitalDepositCaseConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [CapitalDepositCaseEdge!]!
}

Fields​

CapitalDepositCaseConnection.totalCount ● Int! non-null scalar​

Total number of elements in the list

CapitalDepositCaseConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

CapitalDepositCaseConnection.edges ● [CapitalDepositCaseEdge!]! non-null object​

CapitalDepositCaseEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

capitalDepositCases query

- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-case-edge/index.html b/api-reference/objects/capital-deposit-case-edge/index.html index 121961928ca..e0a79fbb008 100644 --- a/api-reference/objects/capital-deposit-case-edge/index.html +++ b/api-reference/objects/capital-deposit-case-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

CapitalDepositCaseEdge

Implements the Relay Edge interface

type CapitalDepositCaseEdge implements Edge {
  cursor: String!
  node: CapitalDepositCase!
}

Fields​

CapitalDepositCaseEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this capital deposit case node in the pagination mechanism

CapitalDepositCaseEdge.node ● CapitalDepositCase! non-null object​

The CapitalDepositCase

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

CapitalDepositCaseConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-case/index.html b/api-reference/objects/capital-deposit-case/index.html index 977f6b54dfc..ba199c04e35 100644 --- a/api-reference/objects/capital-deposit-case/index.html +++ b/api-reference/objects/capital-deposit-case/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositCase

Capital deposit case for a company.

type CapitalDepositCase {
  id: String!
  shareholders: [Shareholder!]!
  totalCapitalDepositAmount: Amount!
  companyName: String!
  companyOnboarding: Onboarding
  companyAccountId: String
  status: CapitalDepositCaseStatus!
  documents: [CapitalDepositDocument!]!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

CapitalDepositCase.id ● String! non-null scalar​

Unique identifier of a capital deposit case.

CapitalDepositCase.shareholders ● [Shareholder!]! non-null object​

List of the company’s shareholders.

CapitalDepositCase.totalCapitalDepositAmount ● Amount! non-null object​

Amount of the capital deposit.

CapitalDepositCase.companyName ● String! non-null scalar​

Name of the company.

CapitalDepositCase.companyOnboarding ● Onboarding object​

Onboarding information of the company.

CapitalDepositCase.companyAccountId ● String scalar​

Unique identifier of the company account.

CapitalDepositCase.status ● CapitalDepositCaseStatus! non-null enum​

Status of the capital deposit case.

CapitalDepositCase.documents ● [CapitalDepositDocument!]! non-null object​

Documents to provide to fulfill the capital deposit case.

CapitalDepositCase.createdAt ● DateTime! non-null scalar​

Created date

CapitalDepositCase.updatedAt ● DateTime! non-null scalar​

Updated date

Returned by​

capitalDepositCase query

Member of​

CapitalDepositCaseEdge object ● CapitalDepositDocument object ● CreateCapitalDepositCaseSuccessPayload object ● Shareholder object

- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-document-can-not-be-uploaded-rejection/index.html b/api-reference/objects/capital-deposit-document-can-not-be-uploaded-rejection/index.html index 87237ce8a9b..c677f1574c3 100644 --- a/api-reference/objects/capital-deposit-document-can-not-be-uploaded-rejection/index.html +++ b/api-reference/objects/capital-deposit-document-can-not-be-uploaded-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositDocumentCanNotBeUploadedRejection

Rejection returned if the document from a capital deposit case cannot be uploaded in its context

type CapitalDepositDocumentCanNotBeUploadedRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

CapitalDepositDocumentCanNotBeUploadedRejection.id ● String! non-null scalar​

CapitalDepositDocumentCanNotBeUploadedRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

GenerateCapitalDepositDocumentUploadUrlPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-document-can-not-be-uploaded/index.html b/api-reference/objects/capital-deposit-document-can-not-be-uploaded/index.html index 795c03bc27c..8edc51526fa 100644 --- a/api-reference/objects/capital-deposit-document-can-not-be-uploaded/index.html +++ b/api-reference/objects/capital-deposit-document-can-not-be-uploaded/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

CapitalDepositDocumentCanNotBeUploaded

Rejection returned if the document from a capital deposit case cannot be uploaded in its context @deprecated(reason: "use CapitalDepositDocumentCanNotBeUploadedRejection instead")

type CapitalDepositDocumentCanNotBeUploaded implements Rejection {
  id: String!
  message: String!
}

Fields​

CapitalDepositDocumentCanNotBeUploaded.id ● String! non-null scalar​

CapitalDepositDocumentCanNotBeUploaded.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

GenerateCapitalDepositDocumentUploadUrlPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-document-pending-status-info/index.html b/api-reference/objects/capital-deposit-document-pending-status-info/index.html index edb457a6906..bf1855fadfa 100644 --- a/api-reference/objects/capital-deposit-document-pending-status-info/index.html +++ b/api-reference/objects/capital-deposit-document-pending-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-document-refused-status-info/index.html b/api-reference/objects/capital-deposit-document-refused-status-info/index.html index ee36cf8eb80..d214aac20c1 100644 --- a/api-reference/objects/capital-deposit-document-refused-status-info/index.html +++ b/api-reference/objects/capital-deposit-document-refused-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositDocumentRefusedStatusInfo

Capital Deposit Document with Refused status

type CapitalDepositDocumentRefusedStatusInfo implements CapitalDepositDocumentStatusInfo {
  status: CapitalDepositDocumentStatus!
  reasonCode: DocumentReasonCode!
}

Fields​

CapitalDepositDocumentRefusedStatusInfo.status ● CapitalDepositDocumentStatus! non-null enum​

Refused

CapitalDepositDocumentRefusedStatusInfo.reasonCode ● DocumentReasonCode! non-null enum​

Reason for the rejection.

Interfaces​

CapitalDepositDocumentStatusInfo interface​

Status info of the document.

- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-document-uploaded-status-info/index.html b/api-reference/objects/capital-deposit-document-uploaded-status-info/index.html index 6fe17ee912d..5a3d81a2fac 100644 --- a/api-reference/objects/capital-deposit-document-uploaded-status-info/index.html +++ b/api-reference/objects/capital-deposit-document-uploaded-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-document-validated-status-info/index.html b/api-reference/objects/capital-deposit-document-validated-status-info/index.html index c2173be626d..ce7eab103bb 100644 --- a/api-reference/objects/capital-deposit-document-validated-status-info/index.html +++ b/api-reference/objects/capital-deposit-document-validated-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/capital-deposit-document/index.html b/api-reference/objects/capital-deposit-document/index.html index 5843778f616..378c4b3082c 100644 --- a/api-reference/objects/capital-deposit-document/index.html +++ b/api-reference/objects/capital-deposit-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CapitalDepositDocument

Document provided for a capital deposit case.

type CapitalDepositDocument {
  id: String!
  type: CapitalDepositDocumentType!
  downloadUrl: String
  uploadedAt: Date
  status: CapitalDepositDocumentStatus!
  statusInfo: CapitalDepositDocumentStatusInfo!
  createdAt: DateTime!
  updatedAt: DateTime!
  relatedCapitalDepositCase: CapitalDepositCase
  relatedShareholder: Shareholder
}

Fields​

CapitalDepositDocument.id ● String! non-null scalar​

Unique identifier of a document.

CapitalDepositDocument.type ● CapitalDepositDocumentType! non-null enum​

Type of the document.

CapitalDepositDocument.downloadUrl ● String scalar​

Url to download the document, null if it has not already been uploaded.

CapitalDepositDocument.uploadedAt ● Date scalar​

Date when the last version of the document has been uploaded.

CapitalDepositDocument.status ● CapitalDepositDocumentStatus! non-null enum​

Status of the document.

CapitalDepositDocument.statusInfo ● CapitalDepositDocumentStatusInfo! non-null interface​

Status info of the document.

CapitalDepositDocument.createdAt ● DateTime! non-null scalar​

Created date

CapitalDepositDocument.updatedAt ● DateTime! non-null scalar​

Updated date

CapitalDepositDocument.relatedCapitalDepositCase ● CapitalDepositCase object​

Information about capital deposit case.

CapitalDepositDocument.relatedShareholder ● Shareholder object​

Information about shareholder.

Returned by​

capitalDepositDocument query

Member of​

CapitalDepositCase object ● Shareholder object

- + \ No newline at end of file diff --git a/api-reference/objects/card-can-not-be-digitalized-rejection/index.html b/api-reference/objects/card-can-not-be-digitalized-rejection/index.html index 8155e0bf658..6a6d5898f9b 100644 --- a/api-reference/objects/card-can-not-be-digitalized-rejection/index.html +++ b/api-reference/objects/card-can-not-be-digitalized-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-canceled-status-info/index.html b/api-reference/objects/card-canceled-status-info/index.html index 808d2ae9e6b..d46ea07850b 100644 --- a/api-reference/objects/card-canceled-status-info/index.html +++ b/api-reference/objects/card-canceled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-canceling-status-info/index.html b/api-reference/objects/card-canceling-status-info/index.html index b79e299ff29..2151e5b16e3 100644 --- a/api-reference/objects/card-canceling-status-info/index.html +++ b/api-reference/objects/card-canceling-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-confidential/index.html b/api-reference/objects/card-confidential/index.html index a84d69c6d7a..1f1c4dd2b75 100644 --- a/api-reference/objects/card-confidential/index.html +++ b/api-reference/objects/card-confidential/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-connection/index.html b/api-reference/objects/card-connection/index.html index 5ff36cc11cb..5e0d29b63c3 100644 --- a/api-reference/objects/card-connection/index.html +++ b/api-reference/objects/card-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type CardConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [CardEdge!]!
}

Fields​

CardConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

CardConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

CardConnection.edges ● [CardEdge!]! non-null object​

CardEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

cards query

Member of​

AccountMembership object

- + \ No newline at end of file diff --git a/api-reference/objects/card-consent-pending-status-info/index.html b/api-reference/objects/card-consent-pending-status-info/index.html index 0558ad9f662..2297cbc5d08 100644 --- a/api-reference/objects/card-consent-pending-status-info/index.html +++ b/api-reference/objects/card-consent-pending-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardConsentPendingStatusInfo

when the user has to consent to add this card

type CardConsentPendingStatusInfo implements CardStatusInfo {
  status: CardStatus!
  consent: Consent!
}

Fields​

CardConsentPendingStatusInfo.status ● CardStatus! non-null enum​

Card status (always ConsentPending for type CardConsentPendingStatusInfo)

CardConsentPendingStatusInfo.consent ● Consent! non-null object​

The consent required to add this card

Interfaces​

CardStatusInfo interface​

Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/card-design-background/index.html b/api-reference/objects/card-design-background/index.html index b3da7e987fa..04d44c95e7a 100644 --- a/api-reference/objects/card-design-background/index.html +++ b/api-reference/objects/card-design-background/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardDesignBackground

No description

type CardDesignBackground {
  id: ID!
  name: String!
  type: String!
  cardTextColor: String!
  cardBackgroundUrl: String!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

CardDesignBackground.id ● ID! non-null scalar​

Unique identifier of a project card design background

CardDesignBackground.name ● String! non-null scalar​

Card design background name

CardDesignBackground.type ● String! non-null scalar​

Card design background type

CardDesignBackground.cardTextColor ● String! non-null scalar​

Card design background text color

CardDesignBackground.cardBackgroundUrl ● String! non-null scalar​

Card design background url

CardDesignBackground.createdAt ● DateTime! non-null scalar​

Created date

CardDesignBackground.updatedAt ● DateTime! non-null scalar​

Updated date

Member of​

CardProductDesign object

- + \ No newline at end of file diff --git a/api-reference/objects/card-edge/index.html b/api-reference/objects/card-edge/index.html index adedf1d741d..a381ea6e3e5 100644 --- a/api-reference/objects/card-edge/index.html +++ b/api-reference/objects/card-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

CardEdge

Implements the Relay Edge interface

type CardEdge implements Edge {
  cursor: String!
  node: Card!
}

Fields​

CardEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

CardEdge.node ● Card! non-null object​

The Card entry

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

CardConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/card-enabled-status-info/index.html b/api-reference/objects/card-enabled-status-info/index.html index 28c381305c7..ae8eadf7934 100644 --- a/api-reference/objects/card-enabled-status-info/index.html +++ b/api-reference/objects/card-enabled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-not-found-rejection/index.html b/api-reference/objects/card-not-found-rejection/index.html index 8b161c48776..86d958eb098 100644 --- a/api-reference/objects/card-not-found-rejection/index.html +++ b/api-reference/objects/card-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardNotFoundRejection

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

type CardNotFoundRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

CardNotFoundRejection.id ● String! non-null scalar​

CardNotFoundRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

ActivatePhysicalCardPayload union ● AddDigitalCardPayload union ● CancelCardPayload union ● CancelDigitalCardPayload union ● CancelPhysicalCardPayload union ● PrintPhysicalCardPayload union ● ResumePhysicalCardPayload union ● SuspendPhysicalCardPayload union ● UpdateCardPayload union ● ViewCardNumbersPayload union ● ViewPhysicalCardNumbersPayload union ● ViewPhysicalCardPinPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/card-processing-status-info/index.html b/api-reference/objects/card-processing-status-info/index.html index a44ab1adfa2..ae558f0dca5 100644 --- a/api-reference/objects/card-processing-status-info/index.html +++ b/api-reference/objects/card-processing-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-product-design/index.html b/api-reference/objects/card-product-design/index.html index dcdd708e7c3..0e4c5e11efc 100644 --- a/api-reference/objects/card-product-design/index.html +++ b/api-reference/objects/card-product-design/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardProductDesign

Card design of a Card Product

type CardProductDesign {
  id: ID!
  version: Int!
  cardProjectLogoSvgUrl: String
  cardProjectLogo300dpiUrl: String
  cardProjectLogo600dpiUrl: String
  zoomRatioProjectLogo: Int
  cardDesignUrl: String
  accentColor: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  status: CardDesignStatus!
  cardBackground: CardDesignBackground!
}

Fields​

CardProductDesign.id ● ID! non-null scalar​

Unique identifier of a card design

CardProductDesign.version ● Int! non-null scalar​

Design version

CardProductDesign.cardProjectLogoSvgUrl ● String scalar​

Logo url svg

CardProductDesign.cardProjectLogo300dpiUrl ● String scalar​

Logo url 300 dpi

CardProductDesign.cardProjectLogo600dpiUrl ● String scalar​

Logo url 300 dpi

CardProductDesign.zoomRatioProjectLogo ● Int scalar​

Zoom level

CardProductDesign.cardDesignUrl ● String scalar​

Card Design URL

CardProductDesign.accentColor ● String! non-null scalar​

Accent color

CardProductDesign.createdAt ● DateTime! non-null scalar​

Created date

CardProductDesign.updatedAt ● DateTime! non-null scalar​

Updated date

CardProductDesign.status ● CardDesignStatus! non-null enum​

Status of the card design

CardProductDesign.cardBackground ● CardDesignBackground! non-null object​

Card Background of the Card design

Member of​

CardProduct object ● ProjectCardDesigns object

- + \ No newline at end of file diff --git a/api-reference/objects/card-product-disabled-rejection/index.html b/api-reference/objects/card-product-disabled-rejection/index.html index 187b71969ca..1a19e522042 100644 --- a/api-reference/objects/card-product-disabled-rejection/index.html +++ b/api-reference/objects/card-product-disabled-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardProductDisabledRejection

Rejection returned if the card product is disabled.

type CardProductDisabledRejection implements Rejection {
  message: String!
}

Fields​

CardProductDisabledRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddCardPayload union ● AddCardsPayload union ● AddCardsWithGroupDeliveryPayload union ● AddDigitalCardPayload union ● AddSingleUseVirtualCardPayload union ● AddSingleUseVirtualCardsPayload union ● PrintPhysicalCardPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/card-product-not-applicable-to-physical-cards-rejection/index.html b/api-reference/objects/card-product-not-applicable-to-physical-cards-rejection/index.html index ce00b09698a..5d4c0e8a6ef 100644 --- a/api-reference/objects/card-product-not-applicable-to-physical-cards-rejection/index.html +++ b/api-reference/objects/card-product-not-applicable-to-physical-cards-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-product-not-found-rejection/index.html b/api-reference/objects/card-product-not-found-rejection/index.html index 785ae47ce02..960e8673b9a 100644 --- a/api-reference/objects/card-product-not-found-rejection/index.html +++ b/api-reference/objects/card-product-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-product-suspended-rejection/index.html b/api-reference/objects/card-product-suspended-rejection/index.html index 167611d0f99..16e84295761 100644 --- a/api-reference/objects/card-product-suspended-rejection/index.html +++ b/api-reference/objects/card-product-suspended-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-product-used-rejection/index.html b/api-reference/objects/card-product-used-rejection/index.html index 0a0a6ed76e3..f4f378ad913 100644 --- a/api-reference/objects/card-product-used-rejection/index.html +++ b/api-reference/objects/card-product-used-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/card-product/index.html b/api-reference/objects/card-product/index.html index e964664f04e..090c89de769 100644 --- a/api-reference/objects/card-product/index.html +++ b/api-reference/objects/card-product/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardProduct

Card Product

type CardProduct {
  id: ID!
  name: String
  projectId: ID!
  status: CardProductStatus!
  createdAt: DateTime!
  updatedAt: DateTime!
  applicableToPhysicalCards: Boolean!
  cardDesigns: [CardProductDesign!]!
  defaultCardProduct: Boolean!
  individualSpendingLimit: SpendingLimit!
  companySpendingLimit: SpendingLimit!
}

Fields​

CardProduct.id ● ID! non-null scalar​

CardProduct.name ● String scalar​

CardProduct.projectId ● ID! non-null scalar​

CardProduct.status ● CardProductStatus! non-null enum​

CardProduct.createdAt ● DateTime! non-null scalar​

CardProduct.updatedAt ● DateTime! non-null scalar​

CardProduct.applicableToPhysicalCards ● Boolean! non-null scalar​

CardProduct.cardDesigns ● [CardProductDesign!]! non-null object​

CardProduct.defaultCardProduct ● Boolean! non-null scalar​

CardProduct.individualSpendingLimit ● SpendingLimit! non-null object​

CardProduct.companySpendingLimit ● SpendingLimit! non-null object​

Member of​

Card object ● ProjectInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/card-settings-background/index.html b/api-reference/objects/card-settings-background/index.html index 1ded0a0a6c5..b357b00708b 100644 --- a/api-reference/objects/card-settings-background/index.html +++ b/api-reference/objects/card-settings-background/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardSettingsBackground

No description

type CardSettingsBackground {
  id: ID!
  name: String!
  type: String!
  cardTextColor: String!
  cardBackgroundUrl: String!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

CardSettingsBackground.id ● ID! non-null scalar​

Unique identifier of a project card settings

CardSettingsBackground.name ● String! non-null scalar​

Card settings background name

CardSettingsBackground.type ● String! non-null scalar​

Card settings background type

CardSettingsBackground.cardTextColor ● String! non-null scalar​

Card settings background text color

CardSettingsBackground.cardBackgroundUrl ● String! non-null scalar​

Card settings background url

CardSettingsBackground.createdAt ● DateTime! non-null scalar​

Created date

CardSettingsBackground.updatedAt ● DateTime! non-null scalar​

Updated date

Member of​

CardSettings object

- + \ No newline at end of file diff --git a/api-reference/objects/card-settings/index.html b/api-reference/objects/card-settings/index.html index 4e21b793f70..8d4a6cf205c 100644 --- a/api-reference/objects/card-settings/index.html +++ b/api-reference/objects/card-settings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardSettings

Card settings for a Project

type CardSettings {
  id: ID!
  allowsApplePay: Boolean!
  version: Int!
  cardProjectLogoSvgUrl: String
  cardProjectLogo300dpiUrl: String
  cardProjectLogo600dpiUrl: String
  zoomRatioProjectLogo: Int
  cardDesignUrl: String
  accentColor: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  status: ProjectCardStatus!
  cardBackground: CardSettingsBackground!
}

Fields​

CardSettings.id ● ID! non-null scalar​

Unique identifier of a project card settings

CardSettings.allowsApplePay ● Boolean! non-null scalar​

Flag used to indicate if ApplePay is activated for the project

CardSettings.version ● Int! non-null scalar​

Settings version

CardSettings.cardProjectLogoSvgUrl ● String scalar​

Logo url svg

CardSettings.cardProjectLogo300dpiUrl ● String scalar​

Logo url 300 dpi

CardSettings.cardProjectLogo600dpiUrl ● String scalar​

Logo url 300 dpi

CardSettings.zoomRatioProjectLogo ● Int scalar​

Zoom level

CardSettings.cardDesignUrl ● String scalar​

Card Design URL

CardSettings.accentColor ● String! non-null scalar​

Accent color

CardSettings.createdAt ● DateTime! non-null scalar​

Created date

CardSettings.updatedAt ● DateTime! non-null scalar​

Updated date

CardSettings.status ● ProjectCardStatus! non-null enum​

Status of the card settings

CardSettings.cardBackground ● CardSettingsBackground! non-null object​

Card Background of the Card Settings

Member of​

ProjectCardSettings object ● ProjectInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/card-transaction/index.html b/api-reference/objects/card-transaction/index.html index b26f3b4e821..4b7a9442c44 100644 --- a/api-reference/objects/card-transaction/index.html +++ b/api-reference/objects/card-transaction/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

CardTransaction

Card transaction

type CardTransaction implements Transaction {
  id: ID!
  reference: String!
  paymentMethodIdentifier: String!
  side: TransactionSide!
  type: TransactionTypeEnum!
  amount: Amount!
  label: String!
  statusInfo: TransactionStatusInfo!
  paymentId: String
  payment: Payment
  createdAt: DateTime!
  updatedAt: DateTime!
  counterparty: String!
  bookedBalanceAfter: Amount
  paymentProduct: PaymentProduct!
  maskedPan: String!
  cardId: String!
  card: Card!
  terminalId: String!
  originalAmount: Amount!
  currencyExchange: [ReportExchangeRate!]!
  merchantId: String!
  merchantName: String!
  merchantCity: String!
  merchantCountry: CCA3
  merchantPostalCode: String
  merchantCategoryCode: String!
  merchantCategoryDescription: MerchantCategoryDescription!
  category: Category!
  authorizationType: AuthorizationType
  account: Account
  externalReference: String
  executionDate: DateTime!
  requestedExecutionAt: DateTime
  originTransactionId: String
  originTransaction: Transaction
}

Fields​

CardTransaction.id ● ID! non-null scalar​

unique identifier of the transaction

CardTransaction.reference ● String! non-null scalar​

external identifier of the transaction

CardTransaction.paymentMethodIdentifier ● String! non-null scalar​

payment method identifier used for this transaction. e.g masked PAN or IBAN or accountNumber

CardTransaction.side ● TransactionSide! non-null enum​

side (Credit or Debit)

CardTransaction.type ● TransactionTypeEnum! non-null enum​

type

CardTransaction.amount ● Amount! non-null object​

amount

CardTransaction.label ● String! non-null scalar​

label

CardTransaction.statusInfo ● TransactionStatusInfo! non-null interface​

status information

CardTransaction.paymentId ● String scalar​

ID of the payment associated to this transaction

CardTransaction.payment ● Payment object​

payment associated to this transaction

CardTransaction.createdAt ● DateTime! non-null scalar​

created date

CardTransaction.updatedAt ● DateTime! non-null scalar​

updated date

CardTransaction.counterparty ● String! non-null scalar​

name of the counterparty. e.g Merchant name, Creditor name, Beneficiary Name ...

CardTransaction.bookedBalanceAfter ● Amount object​

booked balance after this transaction

CardTransaction.paymentProduct ● PaymentProduct! non-null enum​

payment product used for this transaction

CardTransaction.maskedPan ● String! non-null scalar​

card numbers masked (Primary Account Number)

CardTransaction.cardId ● String! non-null scalar​

unique identifier of the card

CardTransaction.card ● Card! non-null object​

card used for this transaction

CardTransaction.terminalId ● String! non-null scalar​

unique identifier of the terminal

CardTransaction.originalAmount ● Amount! non-null object​

original amount and currency of the transaction

CardTransaction.currencyExchange ● [ReportExchangeRate!]! non-null object​

currency exchange if any

CardTransaction.merchantId ● String! non-null scalar​

unique identifier of the merchant

CardTransaction.merchantName ● String! non-null scalar​

merchant name

CardTransaction.merchantCity ● String! non-null scalar​

merchant city

CardTransaction.merchantCountry ● CCA3 scalar​

merchant country

CardTransaction.merchantPostalCode ● String scalar​

merchant postal code

CardTransaction.merchantCategoryCode ● String! non-null scalar​

merchant category code (MCC)

CardTransaction.merchantCategoryDescription ● MerchantCategoryDescription! non-null enum​

merchant category description Enum that explains what the MCC corresponds to in a more readable way

CardTransaction.category ● Category! non-null enum​

category of the payment flow

CardTransaction.authorizationType ● AuthorizationType enum​

type of the authorization. Only available for:

  • authorization transaction
  • debit transaction linked to a previous authorization transaction

CardTransaction.account ● Account object​

matching account for the transaction

CardTransaction.externalReference ● String scalar​

an arbitrary identifier that was defined by you when you created this transaction.

For example, you can define it in the CreditTransferInput mutation.

CardTransaction.executionDate ● DateTime! non-null scalar​

a date that reflects the execution date of a transaction from a user viewpoint. Can be used for sorting transactions.

CardTransaction.requestedExecutionAt ● DateTime scalar​

a date that reflects the time at which the user asked the transaction to be executed

CardTransaction.originTransactionId ● String scalar​

ID of the origin transaction associated to this transaction

CardTransaction.originTransaction ● Transaction interface​

origin transaction associated to this transaction

Interfaces​

Transaction interface​

Transaction

- + \ No newline at end of file diff --git a/api-reference/objects/card-wrong-status-rejection/index.html b/api-reference/objects/card-wrong-status-rejection/index.html index 241abb00368..fab93e56ccb 100644 --- a/api-reference/objects/card-wrong-status-rejection/index.html +++ b/api-reference/objects/card-wrong-status-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CardWrongStatusRejection

Rejection returned when the Card is not the expected status

type CardWrongStatusRejection implements Rejection {
  message: String!
  identifier: String!
  currentStatus: CardStatus!
  expectedStatus: CardStatus!
}

Fields​

CardWrongStatusRejection.message ● String! non-null scalar​

CardWrongStatusRejection.identifier ● String! non-null scalar​

CardWrongStatusRejection.currentStatus ● CardStatus! non-null enum​

CardWrongStatusRejection.expectedStatus ● CardStatus! non-null enum​

Interfaces​

Rejection interface​

- + \ No newline at end of file diff --git a/api-reference/objects/card/index.html b/api-reference/objects/card/index.html index 2acf5bd8720..f1539e83d44 100644 --- a/api-reference/objects/card/index.html +++ b/api-reference/objects/card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Card

Card

type Card {
  id: ID!
  type: CardType!
  createdAt: DateTime!
  updatedAt: DateTime!
  accountMembership: AccountMembership!
  mainCurrency: Currency!
  cardContractExpiryDate: DateTime
  cardDesignUrl: String!
  cardUrl: String!
  statusInfo: CardStatusInfo!
  withdrawal: Boolean!
  international: Boolean!
  nonMainCurrencyTransactions: Boolean!
  eCommerce: Boolean!
  spendingLimits: [SpendingLimit!]
  physicalCard: PhysicalCard
  cardMaskedNumber: String!
  expiryDate: String
  name: String
  cardProduct: CardProduct!
  issuingCountry: CCA3!
  digitalCards(
  first: Int! = 50
  after: String
  orderBy: DigitalCardOrderByInput
  filters: DigitalCardFiltersInput
): DigitalCardConnection!
  transactions(
  first: Int! = 50
  after: String
  filters: TransactionsFiltersInput
): TransactionConnection
  spending: Spending
}

Fields​

Card.id ● ID! non-null scalar​

Unique identifier of a card

Card.type ● CardType! non-null enum​

Type of a card

Card.createdAt ● DateTime! non-null scalar​

Created date

Card.updatedAt ● DateTime! non-null scalar​

Updated date

Card.accountMembership ● AccountMembership! non-null object​

Account membership to define the card holder and the account linked to the card.

Card.mainCurrency ● Currency! non-null scalar​

Main Currency

Card.cardContractExpiryDate ● DateTime scalar​

Card expiration date if null it does not have an expiration date

Card.cardDesignUrl ● String! non-null scalar​

URL of the card design

Card.cardUrl ● String! non-null scalar​

URL of the card with masked card information (like its number) and with full card information if connected user consented beforehand

Card.statusInfo ● CardStatusInfo! non-null interface​

Card status information

Card.withdrawal ● Boolean! non-null scalar​

true if this card allows cash withdrawals

Card.international ● Boolean! non-null scalar​

true if this card allows payments outside of the country

Card.nonMainCurrencyTransactions ● Boolean! non-null scalar​

true if this card allows transactions outside of the card's main currency

Card.eCommerce ● Boolean! non-null scalar​

true if this card allows transactions at eCommerce sites

Card.spendingLimits ● [SpendingLimit!] list object​

Periodic Spending limit list

Card.physicalCard ● PhysicalCard object​

Physical card if the card holder has ordered one

Card.cardMaskedNumber ● String! non-null scalar​

Masked Card Number

Card.expiryDate ● String scalar​

Card expiry date with MM/YY format

Card.name ● String scalar​

Card name

Card.cardProduct ● CardProduct! non-null object​

Card product

Card.issuingCountry ● CCA3! non-null scalar​

Issuing Country

Card.digitalCards ● DigitalCardConnection! non-null object​

Digital Cards linked to this card

Card.digitalCards.first ● Int! non-null scalar​
Card.digitalCards.after ● String scalar​
Card.digitalCards.orderBy ● DigitalCardOrderByInput input​

When the list of elements needs to be ordered

Card.digitalCards.filters ● DigitalCardFiltersInput input​

When the list of elements needs to be filtered

Card.transactions ● TransactionConnection object​

List of transactions of a card.

Card.transactions.first ● Int! non-null scalar​

number of elements in the list (default value 50)

Card.transactions.after ● String scalar​

When the list of elements needs to start after a element

Card.transactions.filters ● TransactionsFiltersInput input​

When the list of elements needs to be filtered

Card.spending ● Spending object​

Periodic Spending

Returned by​

card query

Member of​

AddCardsSuccessPayload object ● AddCardSuccessPayload object ● AddCardsWithGroupDeliverySuccessPayload object ● AddSingleUseVirtualCardsSuccessPayload object ● AddSingleUseVirtualCardSuccessForProjectOwnerPayload object ● AddSingleUseVirtualCardSuccessForUserPayload object ● CancelCardSuccessPayload object ● CardEdge object ● CardTransaction object

- + \ No newline at end of file diff --git a/api-reference/objects/check-merchant-payment-method/index.html b/api-reference/objects/check-merchant-payment-method/index.html index d8be6f900cc..a0c8203d113 100644 --- a/api-reference/objects/check-merchant-payment-method/index.html +++ b/api-reference/objects/check-merchant-payment-method/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CheckMerchantPaymentMethod

CheckMerchantPaymentMethod

type CheckMerchantPaymentMethod implements MerchantPaymentMethod {
  id: ID!
  type: MerchantPaymentMethodType!
  methodId: ID!
  statusInfo: MerchantPaymentMethodStatusInfo!
  version: Int!
  updatedAt: Date!
  rollingReserve: RollingReserve
}

Fields​

CheckMerchantPaymentMethod.id ● ID! non-null scalar​

Unique identifier tied to every version of a given Merchant Payment Method

CheckMerchantPaymentMethod.type ● MerchantPaymentMethodType! non-null enum​

The Merchant Payment Method Type

CheckMerchantPaymentMethod.methodId ● ID! non-null scalar​

Unique identifier for a given merchant Payment Method, identical for every version of a given Merchant Payment Method Type

CheckMerchantPaymentMethod.statusInfo ● MerchantPaymentMethodStatusInfo! non-null interface​

Status of the Merchant Payment Method

CheckMerchantPaymentMethod.version ● Int! non-null scalar​

Version of the Merchant Payment Method

CheckMerchantPaymentMethod.updatedAt ● Date! non-null scalar​

Date at which the Merchant Payment Method was last updated

CheckMerchantPaymentMethod.rollingReserve ● RollingReserve object​

Rolling Reserve applied to the Merchant Payment Method

Interfaces​

MerchantPaymentMethod interface​

Base object for the different Payment Methods available

- + \ No newline at end of file diff --git a/api-reference/objects/check-transaction/index.html b/api-reference/objects/check-transaction/index.html index 598b75b8402..08d717b86f6 100644 --- a/api-reference/objects/check-transaction/index.html +++ b/api-reference/objects/check-transaction/index.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@ CMC7 is composed of 3 sections (check number (7 char.), check issuing bank code (12 char.), check holder account number (12 char.)). Combined with RLMC key, it allows the check traceability.

CheckTransaction.rlmcKey ● String! non-null scalar​

2-digit key used to check the integrity of the CMC7 line, located at the bottom right of the check. Combined with CMC7 line, it allows the check traceability.

CheckTransaction.side ● TransactionSide! non-null enum​

side (Credit or Debit)

CheckTransaction.type ● TransactionTypeEnum! non-null enum​

type

CheckTransaction.amount ● Amount! non-null object​

amount

CheckTransaction.label ● String! non-null scalar​

label

CheckTransaction.statusInfo ● TransactionStatusInfo! non-null interface​

status information

CheckTransaction.paymentId ● String scalar​

ID of the payment associated to this transaction

CheckTransaction.payment ● Payment object​

payment associated to this transaction

CheckTransaction.createdAt ● DateTime! non-null scalar​

created date

CheckTransaction.updatedAt ● DateTime! non-null scalar​

updated date

CheckTransaction.counterparty ● String! non-null scalar​

name of the counterparty. e.g Merchant name, Creditor name, Beneficiary Name ...

CheckTransaction.bookedBalanceAfter ● Amount object​

booked balance after this transaction

CheckTransaction.paymentProduct ● PaymentProduct! non-null enum​

payment product used for this transaction

CheckTransaction.account ● Account object​

matching account for the transaction

CheckTransaction.externalReference ● String scalar​

an arbitrary identifier that was defined by you when you created this transaction.

For example, you can define it in the CreditTransferInput mutation.

CheckTransaction.executionDate ● DateTime! non-null scalar​

a date that reflects the execution date of a transaction from a user viewpoint. Can be used for sorting transactions.

CheckTransaction.requestedExecutionAt ● DateTime scalar​

a date that reflects the time at which the user asked the transaction to be executed

CheckTransaction.originTransactionId ● String scalar​

ID of the origin transaction associated to this transaction

CheckTransaction.originTransaction ● Transaction interface​

origin transaction associated to this transaction

CheckTransaction.reservedAmount ● Amount object​

reserved amount of the transaction computed with the rolling reserve.

CheckTransaction.reservedAmountReleasedAt ● DateTime scalar​

date on which reserved funds become available

CheckTransaction.returnReason ● TransactionReasonCode enum​

return reason

Interfaces​

Transaction interface​

Transaction

- + \ No newline at end of file diff --git a/api-reference/objects/close-account-reason/index.html b/api-reference/objects/close-account-reason/index.html index 0252c896540..f6a61da7dab 100644 --- a/api-reference/objects/close-account-reason/index.html +++ b/api-reference/objects/close-account-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/close-account-success-payload/index.html b/api-reference/objects/close-account-success-payload/index.html index 368383a1d3e..97643bd49de 100644 --- a/api-reference/objects/close-account-success-payload/index.html +++ b/api-reference/objects/close-account-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/company-info/index.html b/api-reference/objects/company-info/index.html index 526a445d813..10ff717761b 100644 --- a/api-reference/objects/company-info/index.html +++ b/api-reference/objects/company-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CompanyInfo

Data provided following the search for company information by siren number

type CompanyInfo {
  siren: String!
  companyName: String!
  headquarters: Headquarters!
  vatNumber: String
  taxIdentificationNumber: String
  legalRepresentativePersonalAddress: AddressInformation
}

Fields​

CompanyInfo.siren ● String! non-null scalar​

CompanyInfo.companyName ● String! non-null scalar​

CompanyInfo.headquarters ● Headquarters! non-null object​

CompanyInfo.vatNumber ● String scalar​

CompanyInfo.taxIdentificationNumber ● String scalar​

CompanyInfo.legalRepresentativePersonalAddress ● AddressInformation object​

- + \ No newline at end of file diff --git a/api-reference/objects/company-shareholder/index.html b/api-reference/objects/company-shareholder/index.html index ef605eaa62b..e71f486e2ae 100644 --- a/api-reference/objects/company-shareholder/index.html +++ b/api-reference/objects/company-shareholder/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/complete-digital-card/index.html b/api-reference/objects/complete-digital-card/index.html index 6d6904ce5db..3038b15adca 100644 --- a/api-reference/objects/complete-digital-card/index.html +++ b/api-reference/objects/complete-digital-card/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

CompleteDigitalCard

Complete Digital Card used for ApplePay or GooglePay

Once the pending phase is over, more data will be available in the response

type CompleteDigitalCard implements DigitalCard {
  id: ID!
  type: DigitalizationType!
  createdAt: DateTime!
  updatedAt: DateTime!
  walletProvider: WalletProvider!
  device: Device!
  walletId: String
  cardMaskedNumber: String!
  statusInfo: CompleteDigitalCardStatusInfo!
}

Fields​

CompleteDigitalCard.id ● ID! non-null scalar​

Unique identifier of a digital card

CompleteDigitalCard.type ● DigitalizationType! non-null enum​

The type of digitalization that created this digital card.

CompleteDigitalCard.createdAt ● DateTime! non-null scalar​

Created date

CompleteDigitalCard.updatedAt ● DateTime! non-null scalar​

Updated date

CompleteDigitalCard.walletProvider ● WalletProvider! non-null object​

Wallet Provider (ApplePay, GooglePay ...)

CompleteDigitalCard.device ● Device! non-null object​

Device In case of a wallet application, some information about the device will be provided

CompleteDigitalCard.walletId ● String scalar​

Id of the wallet application. Will not be present for Merchant

CompleteDigitalCard.cardMaskedNumber ● String! non-null scalar​

Masked DPAN with the last four digits visible

This value is present in the user wallet application

CompleteDigitalCard.statusInfo ● CompleteDigitalCardStatusInfo! non-null interface​

Digital Card status information

In this type the status will be either ConsentPending or Pending

Interfaces​

DigitalCard interface​

Digital Card used for ApplePay or GooglePay

- + \ No newline at end of file diff --git a/api-reference/objects/completed-merchant-payment-link-status-info/index.html b/api-reference/objects/completed-merchant-payment-link-status-info/index.html index e7dab9693b2..8ada3a51570 100644 --- a/api-reference/objects/completed-merchant-payment-link-status-info/index.html +++ b/api-reference/objects/completed-merchant-payment-link-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CompletedMerchantPaymentLinkStatusInfo

No description

type CompletedMerchantPaymentLinkStatusInfo implements MerchantPaymentLinkStatusInfo {
  status: MerchantPaymentLinkStatus!
  completedAt: DateTime!
}

Fields​

CompletedMerchantPaymentLinkStatusInfo.status ● MerchantPaymentLinkStatus! non-null enum​

CompletedMerchantPaymentLinkStatusInfo.completedAt ● DateTime! non-null scalar​

The time when the customer completed the payment.

Interfaces​

MerchantPaymentLinkStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/consent-connection/index.html b/api-reference/objects/consent-connection/index.html index bba5719fff3..55d667002bd 100644 --- a/api-reference/objects/consent-connection/index.html +++ b/api-reference/objects/consent-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ConsentConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type ConsentConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [ConsentEdge!]!
}

Fields​

ConsentConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

ConsentConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

ConsentConnection.edges ● [ConsentEdge!]! non-null object​

ConsentEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

consents query

- + \ No newline at end of file diff --git a/api-reference/objects/consent-edge/index.html b/api-reference/objects/consent-edge/index.html index 30fb0217569..8e496e513be 100644 --- a/api-reference/objects/consent-edge/index.html +++ b/api-reference/objects/consent-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

ConsentEdge

Implements the Relay Edge interface

type ConsentEdge implements Edge {
  cursor: String!
  node: Consent!
}

Fields​

ConsentEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this consent node in the pagination mechanism

ConsentEdge.node ● Consent! non-null object​

The consent

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

ConsentConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/consent-not-found-rejection/index.html b/api-reference/objects/consent-not-found-rejection/index.html index f90a24cf1d5..096002774c8 100644 --- a/api-reference/objects/consent-not-found-rejection/index.html +++ b/api-reference/objects/consent-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/consent-type-not-supported-by-server-consent-rejection/index.html b/api-reference/objects/consent-type-not-supported-by-server-consent-rejection/index.html index f141f198371..765f8d72d49 100644 --- a/api-reference/objects/consent-type-not-supported-by-server-consent-rejection/index.html +++ b/api-reference/objects/consent-type-not-supported-by-server-consent-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/consent/index.html b/api-reference/objects/consent/index.html index 65948335ef8..6ba5637c881 100644 --- a/api-reference/objects/consent/index.html +++ b/api-reference/objects/consent/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Consent

Some sensitive operation at Swan, such as initiating a payment, require consent

type Consent {
  id: ID!
  requireSCA: Boolean!
  status: ConsentStatus!
  createdAt: DateTime!
  updatedAt: DateTime
  startedAt: DateTime
  expiredAt: DateTime
  purpose: ConsentPurpose!
  consentUrl: String!
  redirectUrl: String!
  userId: String!
  user: User
  challenge: String
}

Fields​

Consent.id ● ID! non-null scalar​

unique identifier of the consent

Consent.requireSCA ● Boolean! non-null scalar​

true if the consent requires a Strong Customer Authentication

Consent.status ● ConsentStatus! non-null enum​

status of the consent

Consent.createdAt ● DateTime! non-null scalar​

created date

Consent.updatedAt ● DateTime scalar​

updated date

Consent.startedAt ● DateTime scalar​

date when the consentUrl was request the first time

Consent.expiredAt ● DateTime scalar​

date when the consent expire

Consent.purpose ● ConsentPurpose! non-null enum​

purpose of the consent

Consent.consentUrl ● String! non-null scalar​

Redirect the user to this URL to start the consent flow

Consent.redirectUrl ● String! non-null scalar​

When the consent flow is finished the user is redirected to this URL

Consent.userId ● String! non-null scalar​

userId who initiated the consent

Consent.user ● User object​

user who initiated the consent

Consent.challenge ● String scalar​

unique hash of the consent

Returned by​

consent query

Member of​

AccountMembershipConsentPendingStatusInfo object ● ActivatePhysicalCardSuccessPayload object ● CancelConsentSuccessPayload object ● CardConsentPendingStatusInfo object ● CloseAccountSuccessPayload object ● ConsentEdge object ● CreateMultiConsentSuccessPayload object ● DigitalCardConsentPendingStatusInfo object ● GrantConsentWithServerSignatureSuccessPayload object ● PaymentConsentPending object ● PaymentMandateConsentPendingStatusInfo object ● PendingConsentAccountMembershipUpdate object ● PhysicalCardConsentPendingStatusInfo object ● ReceivedDirectDebitMandateStatusInfoConsentPending object ● RefundSuccessPayload object ● ResumeAccountMembershipSuccessPayload object ● ResumePhysicalCardSuccessPayload object ● StandingOrderConsentPendingStatusInfo object ● UpdateAccountMembershipSuccessPayload object ● UpdateCardSuccessPayload object ● ViewCardNumbersSuccessPayload object ● ViewPhysicalCardNumbersSuccessPayload object ● ViewPhysicalCardPinSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/consents-already-linked-to-multi-consent-rejection/index.html b/api-reference/objects/consents-already-linked-to-multi-consent-rejection/index.html index 759a1aa8957..187b34d4aaa 100644 --- a/api-reference/objects/consents-already-linked-to-multi-consent-rejection/index.html +++ b/api-reference/objects/consents-already-linked-to-multi-consent-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ConsentsAlreadyLinkedToMultiConsentRejection

Rejection returned when a the consent is already linked to another multi consent

type ConsentsAlreadyLinkedToMultiConsentRejection implements Rejection {
  message: String!
  consentIds: [String!]!
}

Fields​

ConsentsAlreadyLinkedToMultiConsentRejection.message ● String! non-null scalar​

ConsentsAlreadyLinkedToMultiConsentRejection.consentIds ● [String!]! non-null scalar​

IDs of the consents that are already linked to another multi consent

Interfaces​

Rejection interface​

Implemented by​

CreateMultiConsentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/consents-not-all-in-created-status-rejection/index.html b/api-reference/objects/consents-not-all-in-created-status-rejection/index.html index 2b2839dc96e..c7b525b55c1 100644 --- a/api-reference/objects/consents-not-all-in-created-status-rejection/index.html +++ b/api-reference/objects/consents-not-all-in-created-status-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ConsentsNotAllInCreatedStatusRejection

Rejection returned when all provided consents are not in created status

type ConsentsNotAllInCreatedStatusRejection implements Rejection {
  message: String!
  consentIds: [String!]!
}

Fields​

ConsentsNotAllInCreatedStatusRejection.message ● String! non-null scalar​

ConsentsNotAllInCreatedStatusRejection.consentIds ● [String!]! non-null scalar​

IDs of the consents that are not in created status

Interfaces​

Rejection interface​

Implemented by​

CreateMultiConsentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/consents-not-found-rejection/index.html b/api-reference/objects/consents-not-found-rejection/index.html index ab4f917cc30..6415eebdfa0 100644 --- a/api-reference/objects/consents-not-found-rejection/index.html +++ b/api-reference/objects/consents-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/create-capital-deposit-case-success-payload/index.html b/api-reference/objects/create-capital-deposit-case-success-payload/index.html index cc413d732aa..cd336067c83 100644 --- a/api-reference/objects/create-capital-deposit-case-success-payload/index.html +++ b/api-reference/objects/create-capital-deposit-case-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/create-merchant-payment-link-success-payload/index.html b/api-reference/objects/create-merchant-payment-link-success-payload/index.html index ff261e2c1b9..d12acd5c23e 100644 --- a/api-reference/objects/create-merchant-payment-link-success-payload/index.html +++ b/api-reference/objects/create-merchant-payment-link-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/create-multi-consent-success-payload/index.html b/api-reference/objects/create-multi-consent-success-payload/index.html index d287ae5518a..9cffe760134 100644 --- a/api-reference/objects/create-multi-consent-success-payload/index.html +++ b/api-reference/objects/create-multi-consent-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/csv-statement/index.html b/api-reference/objects/csv-statement/index.html index 7cd2c56612d..233683b2163 100644 --- a/api-reference/objects/csv-statement/index.html +++ b/api-reference/objects/csv-statement/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CsvStatement

Custom information for a CSV statement

type CsvStatement implements StatementInfo {
  type: StatementType
  url: String
  expiresAt: DateTime
}

Fields​

CsvStatement.type ● StatementType enum​

statement type

CsvStatement.url ● String scalar​

temporary public url on which the file can be accessed

CsvStatement.expiresAt ● DateTime scalar​

date at which the link will not be useable anymore

Interfaces​

StatementInfo interface​

Custom information for a certain type of statement

- + \ No newline at end of file diff --git a/api-reference/objects/customer/index.html b/api-reference/objects/customer/index.html index 62c066abfc8..b08303e9eec 100644 --- a/api-reference/objects/customer/index.html +++ b/api-reference/objects/customer/index.html @@ -7,14 +7,14 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/date-field/index.html b/api-reference/objects/date-field/index.html index 53306a7482d..b1d6be2f358 100644 --- a/api-reference/objects/date-field/index.html +++ b/api-reference/objects/date-field/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/debtor-account-closed-rejection/index.html b/api-reference/objects/debtor-account-closed-rejection/index.html index 0792da198a8..6349e89c895 100644 --- a/api-reference/objects/debtor-account-closed-rejection/index.html +++ b/api-reference/objects/debtor-account-closed-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/debtor-account-not-allowed-rejection/index.html b/api-reference/objects/debtor-account-not-allowed-rejection/index.html index 2fc675161b5..f1395e7430f 100644 --- a/api-reference/objects/debtor-account-not-allowed-rejection/index.html +++ b/api-reference/objects/debtor-account-not-allowed-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/delete-supporting-document-success-payload/index.html b/api-reference/objects/delete-supporting-document-success-payload/index.html index c9e09cae1c7..15042d8366b 100644 --- a/api-reference/objects/delete-supporting-document-success-payload/index.html +++ b/api-reference/objects/delete-supporting-document-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/deny-sdd-success-payload/index.html b/api-reference/objects/deny-sdd-success-payload/index.html index 94860669e30..52b27f13bc4 100644 --- a/api-reference/objects/deny-sdd-success-payload/index.html +++ b/api-reference/objects/deny-sdd-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/deny-sdd-virtual-iban-entry-success-payload/index.html b/api-reference/objects/deny-sdd-virtual-iban-entry-success-payload/index.html index 4bbeb51d314..fcaa8e488d6 100644 --- a/api-reference/objects/deny-sdd-virtual-iban-entry-success-payload/index.html +++ b/api-reference/objects/deny-sdd-virtual-iban-entry-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/device/index.html b/api-reference/objects/device/index.html index a9a4ee338cb..d96811d6cff 100644 --- a/api-reference/objects/device/index.html +++ b/api-reference/objects/device/index.html @@ -7,14 +7,14 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/digital-card-canceled-status-info/index.html b/api-reference/objects/digital-card-canceled-status-info/index.html index f163b145f47..6687b2075ef 100644 --- a/api-reference/objects/digital-card-canceled-status-info/index.html +++ b/api-reference/objects/digital-card-canceled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DigitalCardCanceledStatusInfo

Digital Card Canceled Status Information

type DigitalCardCanceledStatusInfo implements CompleteDigitalCardStatusInfo {
  status: CompleteDigitalCardStatus!
  enabledAt: DateTime!
  canceledAt: DateTime!
}

Fields​

DigitalCardCanceledStatusInfo.status ● CompleteDigitalCardStatus! non-null enum​

Card status (always Canceled for type DigitalCardCanceledStatusInfo).

DigitalCardCanceledStatusInfo.enabledAt ● DateTime! non-null scalar​

Enable Date

DigitalCardCanceledStatusInfo.canceledAt ● DateTime! non-null scalar​

Cancel Date

Interfaces​

CompleteDigitalCardStatusInfo interface​

Complete Digital Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/digital-card-connection/index.html b/api-reference/objects/digital-card-connection/index.html index 9ec0e30f9ab..80745ade286 100644 --- a/api-reference/objects/digital-card-connection/index.html +++ b/api-reference/objects/digital-card-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DigitalCardConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type DigitalCardConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [DigitalCardEdge!]!
}

Fields​

DigitalCardConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

DigitalCardConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

DigitalCardConnection.edges ● [DigitalCardEdge!]! non-null object​

CardEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

Card object

- + \ No newline at end of file diff --git a/api-reference/objects/digital-card-consent-pending-status-info/index.html b/api-reference/objects/digital-card-consent-pending-status-info/index.html index a97aed57c57..f71317f85cd 100644 --- a/api-reference/objects/digital-card-consent-pending-status-info/index.html +++ b/api-reference/objects/digital-card-consent-pending-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DigitalCardConsentPendingStatusInfo

Digital Card ConsentPending Status Information

type DigitalCardConsentPendingStatusInfo implements PendingDigitalCardStatusInfo {
  status: PendingDigitalCardStatus!
  consent: Consent!
}

Fields​

DigitalCardConsentPendingStatusInfo.status ● PendingDigitalCardStatus! non-null enum​

Digital Card status (always ConsentPending for type DigitalCardConsentPendingStatusInfo).

DigitalCardConsentPendingStatusInfo.consent ● Consent! non-null object​

A reference to the consent to validate

Interfaces​

PendingDigitalCardStatusInfo interface​

Pending Digital Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/digital-card-declined-status-info/index.html b/api-reference/objects/digital-card-declined-status-info/index.html index b71e97bf588..cc51d854a18 100644 --- a/api-reference/objects/digital-card-declined-status-info/index.html +++ b/api-reference/objects/digital-card-declined-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/digital-card-edge/index.html b/api-reference/objects/digital-card-edge/index.html index 329520af747..d91a241b9f0 100644 --- a/api-reference/objects/digital-card-edge/index.html +++ b/api-reference/objects/digital-card-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

DigitalCardEdge

Implements the Relay Edge interface

type DigitalCardEdge implements Edge {
  cursor: String!
  node: DigitalCard!
}

Fields​

DigitalCardEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

DigitalCardEdge.node ● DigitalCard! non-null interface​

The Card entry

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

DigitalCardConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/digital-card-enabled-status-info/index.html b/api-reference/objects/digital-card-enabled-status-info/index.html index 59297f51892..dc0ec0ba84e 100644 --- a/api-reference/objects/digital-card-enabled-status-info/index.html +++ b/api-reference/objects/digital-card-enabled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DigitalCardEnabledStatusInfo

Digital Card Enabled Status Information

type DigitalCardEnabledStatusInfo implements CompleteDigitalCardStatusInfo {
  status: CompleteDigitalCardStatus!
  enabledAt: DateTime!
}

Fields​

DigitalCardEnabledStatusInfo.status ● CompleteDigitalCardStatus! non-null enum​

Digital Card status (always Enabled for type DigitalCardEnabledStatusInfo).

DigitalCardEnabledStatusInfo.enabledAt ● DateTime! non-null scalar​

Enable Date

Interfaces​

CompleteDigitalCardStatusInfo interface​

Complete Digital Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/digital-card-not-found-rejection/index.html b/api-reference/objects/digital-card-not-found-rejection/index.html index 5c537fa8a8a..285217ce26f 100644 --- a/api-reference/objects/digital-card-not-found-rejection/index.html +++ b/api-reference/objects/digital-card-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/digital-card-pending-status-info/index.html b/api-reference/objects/digital-card-pending-status-info/index.html index c3a3b0be873..47e78975ba4 100644 --- a/api-reference/objects/digital-card-pending-status-info/index.html +++ b/api-reference/objects/digital-card-pending-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/digital-card-suspended-status-info/index.html b/api-reference/objects/digital-card-suspended-status-info/index.html index 5db3b75aa1d..a69539a3724 100644 --- a/api-reference/objects/digital-card-suspended-status-info/index.html +++ b/api-reference/objects/digital-card-suspended-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DigitalCardSuspendedStatusInfo

Digital Card Suspended Status Information

type DigitalCardSuspendedStatusInfo implements CompleteDigitalCardStatusInfo {
  status: CompleteDigitalCardStatus!
  enabledAt: DateTime!
  suspendedAt: DateTime!
}

Fields​

DigitalCardSuspendedStatusInfo.status ● CompleteDigitalCardStatus! non-null enum​

Digital Card status (always Suspended for type DigitalCardSuspendedStatusInfo).

DigitalCardSuspendedStatusInfo.enabledAt ● DateTime! non-null scalar​

Enable Date

DigitalCardSuspendedStatusInfo.suspendedAt ● DateTime! non-null scalar​

Suspend Date

Interfaces​

CompleteDigitalCardStatusInfo interface​

Complete Digital Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/direct-debit-account-verification/index.html b/api-reference/objects/direct-debit-account-verification/index.html index 8397d0fe862..4affaf53b3a 100644 --- a/api-reference/objects/direct-debit-account-verification/index.html +++ b/api-reference/objects/direct-debit-account-verification/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DirectDebitAccountVerification

Direct Debit Account Verification

type DirectDebitAccountVerification implements AccountVerification {
  createdAt: DateTime!
  iban: IBAN!
  id: ID!
  statusInfo: AccountVerificationStatusInfo!
  updatedAt: DateTime!
}

Fields​

DirectDebitAccountVerification.createdAt ● DateTime! non-null scalar​

Creation date of the account verification

DirectDebitAccountVerification.iban ● IBAN! non-null scalar​

IBAN of the account to cross check with account holder information

DirectDebitAccountVerification.id ● ID! non-null scalar​

Unique identifier of the Account Verification

DirectDebitAccountVerification.statusInfo ● AccountVerificationStatusInfo! non-null interface​

Account Verification Status Information

DirectDebitAccountVerification.updatedAt ● DateTime! non-null scalar​

Last update date of the account verification

Interfaces​

AccountVerification interface​

Account Verification

Member of​

DirectDebitFundingSource object

- + \ No newline at end of file diff --git a/api-reference/objects/direct-debit-funding-source/index.html b/api-reference/objects/direct-debit-funding-source/index.html index 56f22b6e05a..5ce6907f222 100644 --- a/api-reference/objects/direct-debit-funding-source/index.html +++ b/api-reference/objects/direct-debit-funding-source/index.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@ Money will be debited from this IBAN when an initiateFundingRequest is done using this funding source

DirectDebitFundingSource.createdAt ● DateTime! non-null scalar​

Created date

DirectDebitFundingSource.updatedAt ● DateTime! non-null scalar​

Last updated date

DirectDebitFundingSource.accountVerification ● DirectDebitAccountVerification! non-null object​

Can be queried to check the status of the account verification for this funding source. If the account verification is PendingVerification, you should ask your account holder to wire some money from his external account to any swan account

DirectDebitFundingSource.paymentMandate ● PaymentDirectDebitMandate! non-null interface​

Can be queried to check the status of payment payment Mandate. If the payment mandate is ConsentPending, you should confirm it to enable this funding source

Interfaces​

FundingSource interface​

Funding Source

- + \ No newline at end of file diff --git a/api-reference/objects/disable-account-membership-success-payload/index.html b/api-reference/objects/disable-account-membership-success-payload/index.html index 36f59b1f892..3efc1a01598 100644 --- a/api-reference/objects/disable-account-membership-success-payload/index.html +++ b/api-reference/objects/disable-account-membership-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/disabled-funding-limit-settings-status-info/index.html b/api-reference/objects/disabled-funding-limit-settings-status-info/index.html index 5ba9228525b..ab71989f16a 100644 --- a/api-reference/objects/disabled-funding-limit-settings-status-info/index.html +++ b/api-reference/objects/disabled-funding-limit-settings-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DisabledFundingLimitSettingsStatusInfo

StatusInfo when funding limit settings has been disabled

type DisabledFundingLimitSettingsStatusInfo implements FundingLimitSettingsStatusInfo {
  status: FundingLimitSettingsStatus!
  reason: String!
}

Fields​

DisabledFundingLimitSettingsStatusInfo.status ● FundingLimitSettingsStatus! non-null enum​

DisabledFundingLimitSettingsStatusInfo.reason ● String! non-null scalar​

Interfaces​

FundingLimitSettingsStatusInfo interface​

Object containing details about funding limit settings status

- + \ No newline at end of file diff --git a/api-reference/objects/disabled-merchant-payment-method-status-info/index.html b/api-reference/objects/disabled-merchant-payment-method-status-info/index.html index 0362551cb19..377f445098f 100644 --- a/api-reference/objects/disabled-merchant-payment-method-status-info/index.html +++ b/api-reference/objects/disabled-merchant-payment-method-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DisabledMerchantPaymentMethodStatusInfo

EnabledMerchantPaymentMethodStatusInfo

type DisabledMerchantPaymentMethodStatusInfo implements MerchantPaymentMethodStatusInfo {
  status: MerchantPaymentMethodStatus!
  disabledAt: Date!
}

Fields​

DisabledMerchantPaymentMethodStatusInfo.status ● MerchantPaymentMethodStatus! non-null enum​

DisabledMerchantPaymentMethodStatusInfo.disabledAt ● Date! non-null scalar​

Merchant Payment Method disabled date

Interfaces​

MerchantPaymentMethodStatusInfo interface​

The payment method status information

- + \ No newline at end of file diff --git a/api-reference/objects/drivers-license-document-file/index.html b/api-reference/objects/drivers-license-document-file/index.html index c4811ee7326..372d4703605 100644 --- a/api-reference/objects/drivers-license-document-file/index.html +++ b/api-reference/objects/drivers-license-document-file/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DriversLicenseDocumentFile

The file associated to the driver's license document

type DriversLicenseDocumentFile implements DocumentFile {
  downloadUrl: String!
  side: DocumentFileSide!
}

Fields​

DriversLicenseDocumentFile.downloadUrl ● String! non-null scalar​

The file's temporary download url

DriversLicenseDocumentFile.side ● DocumentFileSide! non-null enum​

From which side the deiver's license's picture was taken

Interfaces​

DocumentFile interface​

Retrieved document extracted from the identity verification

Member of​

DriversLicenseDocument object

- + \ No newline at end of file diff --git a/api-reference/objects/drivers-license-document/index.html b/api-reference/objects/drivers-license-document/index.html index 4f7349ea804..23378f96f31 100644 --- a/api-reference/objects/drivers-license-document/index.html +++ b/api-reference/objects/drivers-license-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DriversLicenseDocument

The document corresponding to a driver's license

type DriversLicenseDocument {
  id: String!
  type: DocumentType!
  files: [DriversLicenseDocumentFile!]!
}

Fields​

DriversLicenseDocument.id ● String! non-null scalar​

Unique identifier of the driver's license document

DriversLicenseDocument.type ● DocumentType! non-null enum​

The type of the document

DriversLicenseDocument.files ● [DriversLicenseDocumentFile!]! non-null object​

List of the associated files

Implemented by​

IdentificationDocument union

- + \ No newline at end of file diff --git a/api-reference/objects/enable-received-direct-debit-mandate-success-payload/index.html b/api-reference/objects/enable-received-direct-debit-mandate-success-payload/index.html index 77a0d263e45..5dba548204e 100644 --- a/api-reference/objects/enable-received-direct-debit-mandate-success-payload/index.html +++ b/api-reference/objects/enable-received-direct-debit-mandate-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

EnableReceivedDirectDebitMandateSuccessPayload

Return type in case of a successful response of the enableReceivedDirectDebitMandate mutation

type EnableReceivedDirectDebitMandateSuccessPayload {
  receivedDirectDebitMandate: ReceivedDirectDebitMandate!
}

Fields​

EnableReceivedDirectDebitMandateSuccessPayload.receivedDirectDebitMandate ● ReceivedDirectDebitMandate! non-null interface​

The received direct debit mandate is enable, i.e that it is moved back to from the suspended to the enabled status

Implemented by​

EnableReceivedDirectDebitMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/enabled-card-design-not-found-rejection/index.html b/api-reference/objects/enabled-card-design-not-found-rejection/index.html index 866e96f9b66..f589fb4f95b 100644 --- a/api-reference/objects/enabled-card-design-not-found-rejection/index.html +++ b/api-reference/objects/enabled-card-design-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

EnabledCardDesignNotFoundRejection

Rejection returned if the card product don't have a card design enabled

type EnabledCardDesignNotFoundRejection implements Rejection {
  message: String!
}

Fields​

EnabledCardDesignNotFoundRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddCardPayload union ● AddCardsPayload union ● AddCardsWithGroupDeliveryPayload union ● AddDigitalCardPayload union ● AddSingleUseVirtualCardPayload union ● AddSingleUseVirtualCardsPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/enabled-funding-limit-settings-status-info/index.html b/api-reference/objects/enabled-funding-limit-settings-status-info/index.html index c4eb12cf2a2..bcfe8b9a883 100644 --- a/api-reference/objects/enabled-funding-limit-settings-status-info/index.html +++ b/api-reference/objects/enabled-funding-limit-settings-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/enabled-funding-source-status-info/index.html b/api-reference/objects/enabled-funding-source-status-info/index.html index 52775f86dc9..a40a5f9a1aa 100644 --- a/api-reference/objects/enabled-funding-source-status-info/index.html +++ b/api-reference/objects/enabled-funding-source-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

EnabledFundingSourceStatusInfo

Funding Source Enabled status information

type EnabledFundingSourceStatusInfo implements FundingSourceStatusInfo {
  status: FundingSourceStatus!
  enabledAt: Date!
}

Fields​

EnabledFundingSourceStatusInfo.status ● FundingSourceStatus! non-null enum​

Funding Source Enabled status

EnabledFundingSourceStatusInfo.enabledAt ● Date! non-null scalar​

Date at which the funding source was enabled

Interfaces​

FundingSourceStatusInfo interface​

Funding Source status information

- + \ No newline at end of file diff --git a/api-reference/objects/enabled-merchant-payment-method-status-info/index.html b/api-reference/objects/enabled-merchant-payment-method-status-info/index.html index 1e807e5ba1c..38e2398c5c2 100644 --- a/api-reference/objects/enabled-merchant-payment-method-status-info/index.html +++ b/api-reference/objects/enabled-merchant-payment-method-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

EnabledMerchantPaymentMethodStatusInfo

EnabledMerchantPaymentMethodStatusInfo

type EnabledMerchantPaymentMethodStatusInfo implements MerchantPaymentMethodStatusInfo {
  status: MerchantPaymentMethodStatus!
  enabledAt: Date!
}

Fields​

EnabledMerchantPaymentMethodStatusInfo.status ● MerchantPaymentMethodStatus! non-null enum​

EnabledMerchantPaymentMethodStatusInfo.enabledAt ● Date! non-null scalar​

Merchant Payment Method enabled date

Interfaces​

MerchantPaymentMethodStatusInfo interface​

The payment method status information

- + \ No newline at end of file diff --git a/api-reference/objects/enabled-merchant-profile-status-info/index.html b/api-reference/objects/enabled-merchant-profile-status-info/index.html index 64bc2a52e43..15353c21499 100644 --- a/api-reference/objects/enabled-merchant-profile-status-info/index.html +++ b/api-reference/objects/enabled-merchant-profile-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/expired-identification-level-status-info/index.html b/api-reference/objects/expired-identification-level-status-info/index.html index 740df4c20cb..0ae9fc39f5a 100644 --- a/api-reference/objects/expired-identification-level-status-info/index.html +++ b/api-reference/objects/expired-identification-level-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ExpiredIdentificationLevelStatusInfo

Describes an identification level for the process associated to this identification that has expired and is no longer considered valid

type ExpiredIdentificationLevelStatusInfo {
  status: SwanIdentificationStatus!
  expiredAt: Date!
}

Fields​

ExpiredIdentificationLevelStatusInfo.status ● SwanIdentificationStatus! non-null enum​

Always set to Expired

ExpiredIdentificationLevelStatusInfo.expiredAt ● Date! non-null scalar​

When this identification level expired

Implemented by​

IdentificationLevelStatusInfo union

- + \ No newline at end of file diff --git a/api-reference/objects/expired-merchant-payment-link-status-info/index.html b/api-reference/objects/expired-merchant-payment-link-status-info/index.html index d914f372885..f5aaa7345de 100644 --- a/api-reference/objects/expired-merchant-payment-link-status-info/index.html +++ b/api-reference/objects/expired-merchant-payment-link-status-info/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

ExpiredMerchantPaymentLinkStatusInfo

No description

type ExpiredMerchantPaymentLinkStatusInfo implements MerchantPaymentLinkStatusInfo {
  status: MerchantPaymentLinkStatus!
  expiredAt: DateTime!
}

Fields​

ExpiredMerchantPaymentLinkStatusInfo.status ● MerchantPaymentLinkStatus! non-null enum​

ExpiredMerchantPaymentLinkStatusInfo.expiredAt ● DateTime! non-null scalar​

The date when the payment link expired. The payment link expires 24 hours after it was created.

Interfaces​

MerchantPaymentLinkStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/external-account-already-exists-rejection/index.html b/api-reference/objects/external-account-already-exists-rejection/index.html index 93ce07ff9b0..535762cccf4 100644 --- a/api-reference/objects/external-account-already-exists-rejection/index.html +++ b/api-reference/objects/external-account-already-exists-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ExternalAccountAlreadyExistsRejection

No description

type ExternalAccountAlreadyExistsRejection implements Rejection {
  iban: String!
  accountHolderId: String!
  message: String!
}

Fields​

ExternalAccountAlreadyExistsRejection.iban ● String! non-null scalar​

ExternalAccountAlreadyExistsRejection.accountHolderId ● String! non-null scalar​

ExternalAccountAlreadyExistsRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddExternalAccountPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/external-account-balance-already-exists-rejection/index.html b/api-reference/objects/external-account-balance-already-exists-rejection/index.html index d58e88db95e..7f25bafc1da 100644 --- a/api-reference/objects/external-account-balance-already-exists-rejection/index.html +++ b/api-reference/objects/external-account-balance-already-exists-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ExternalAccountBalanceAlreadyExistsRejection

No description

type ExternalAccountBalanceAlreadyExistsRejection implements Rejection {
  type: ExternalAccountBalanceType!
  lastChangedAt: DateTime!
  message: String!
}

Fields​

ExternalAccountBalanceAlreadyExistsRejection.type ● ExternalAccountBalanceType! non-null enum​

ExternalAccountBalanceAlreadyExistsRejection.lastChangedAt ● DateTime! non-null scalar​

ExternalAccountBalanceAlreadyExistsRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddExternalAccountBalancePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/external-account-balance/index.html b/api-reference/objects/external-account-balance/index.html index 6339fe2172f..f9e1845a25a 100644 --- a/api-reference/objects/external-account-balance/index.html +++ b/api-reference/objects/external-account-balance/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ExternalAccountBalance

No description

type ExternalAccountBalance {
  id: ID!
  amount: Amount
  type: ExternalAccountBalanceType!
  lastChangedAt: DateTime!
}

Fields​

ExternalAccountBalance.id ● ID! non-null scalar​

Unique identifier of an external balance

ExternalAccountBalance.amount ● Amount object​

Amount with currency

ExternalAccountBalance.type ● ExternalAccountBalanceType! non-null enum​

Type of Balance

ExternalAccountBalance.lastChangedAt ● DateTime! non-null scalar​

Last changed Date

Member of​

AddExternalAccountBalanceSuccessPayload object ● AddOrUpdateExternalAccountBalanceSuccessPayload object ● ExternalBalanceEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/external-account-connection/index.html b/api-reference/objects/external-account-connection/index.html index d940409eee7..468913209a9 100644 --- a/api-reference/objects/external-account-connection/index.html +++ b/api-reference/objects/external-account-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ExternalAccountConnection

Implements the Relay Connection interface, used to paginate the list of element (Learn More)

type ExternalAccountConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [ExternalAccountEdge!]!
}

Fields​

ExternalAccountConnection.totalCount ● Int! non-null scalar​

Total number of elements in the list

ExternalAccountConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

ExternalAccountConnection.edges ● [ExternalAccountEdge!]! non-null object​

ExternalAccountEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

AccountHolder object

- + \ No newline at end of file diff --git a/api-reference/objects/external-account-data-source/index.html b/api-reference/objects/external-account-data-source/index.html index 446ff068b14..ba21a2429b4 100644 --- a/api-reference/objects/external-account-data-source/index.html +++ b/api-reference/objects/external-account-data-source/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/external-account-edge/index.html b/api-reference/objects/external-account-edge/index.html index cf7e71923ee..df53fe40627 100644 --- a/api-reference/objects/external-account-edge/index.html +++ b/api-reference/objects/external-account-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

ExternalAccountEdge

Implements the Relay Edge interface

type ExternalAccountEdge implements Edge {
  cursor: String!
  node: ExternalAccount!
}

Fields​

ExternalAccountEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

ExternalAccountEdge.node ● ExternalAccount! non-null object​

The external account

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

ExternalAccountConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/external-account/index.html b/api-reference/objects/external-account/index.html index cfe27375673..78aeb786214 100644 --- a/api-reference/objects/external-account/index.html +++ b/api-reference/objects/external-account/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ExternalAccount

No description

type ExternalAccount {
  id: ID!
  externalId: String!
  name: String
  cashAccountType: CashAccountType!
  BIC: BIC!
  IBAN: IBAN!
  currency: Currency!
  holderName: String!
  country: CCA3!
  originalCreatedAt: DateTime!
  createdAt: DateTime!
  updatedAt: DateTime!
  balances(
  first: Int! = 90
  before: String
  after: String
): ExternalBalanceConnection!
  source: ExternalAccountDataSource!
  institution: FinancialInstitution
  usage: ExternalAccountUsage!
  accountHolder: AccountHolder
}

Fields​

ExternalAccount.id ● ID! non-null scalar​

Unique identifier of an external account

ExternalAccount.externalId ● String! non-null scalar​

External account identifier following ISO-20022 standard

ExternalAccount.name ● String scalar​

Name of the account

ExternalAccount.cashAccountType ● CashAccountType! non-null enum​

Type of the account

ExternalAccount.BIC ● BIC! non-null scalar​

Bank Identifier Code

ExternalAccount.IBAN ● IBAN! non-null scalar​

International Bank Account Number

ExternalAccount.currency ● Currency! non-null scalar​

Currency

ExternalAccount.holderName ● String! non-null scalar​

Account Holder name

ExternalAccount.country ● CCA3! non-null scalar​

Country

ExternalAccount.originalCreatedAt ● DateTime! non-null scalar​

Original Created date

ExternalAccount.createdAt ● DateTime! non-null scalar​

Created date

ExternalAccount.updatedAt ● DateTime! non-null scalar​

Updated date

ExternalAccount.balances ● ExternalBalanceConnection! non-null object​

A list of balances regarding an external account.

ExternalAccount.balances.first ● Int! non-null scalar​
ExternalAccount.balances.before ● String scalar​
ExternalAccount.balances.after ● String scalar​

ExternalAccount.source ● ExternalAccountDataSource! non-null object​

Source used for this account

ExternalAccount.institution ● FinancialInstitution object​

Financial institution

ExternalAccount.usage ● ExternalAccountUsage! non-null enum​

Usage information of the account

ExternalAccount.accountHolder ● AccountHolder object​

Account holder for the external account

Member of​

AddExternalAccountSuccessPayload object ● ExternalAccountEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/external-balance-connection/index.html b/api-reference/objects/external-balance-connection/index.html index 92df9b62cd3..d520c0c48cb 100644 --- a/api-reference/objects/external-balance-connection/index.html +++ b/api-reference/objects/external-balance-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ExternalBalanceConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type ExternalBalanceConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [ExternalBalanceEdge!]!
}

Fields​

ExternalBalanceConnection.totalCount ● Int! non-null scalar​

Total number of elements in the list

ExternalBalanceConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

ExternalBalanceConnection.edges ● [ExternalBalanceEdge!]! non-null object​

ExternalBalanceEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

ExternalAccount object

- + \ No newline at end of file diff --git a/api-reference/objects/external-balance-edge/index.html b/api-reference/objects/external-balance-edge/index.html index 9bafcbb0d13..e61c79f5267 100644 --- a/api-reference/objects/external-balance-edge/index.html +++ b/api-reference/objects/external-balance-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

ExternalBalanceEdge

Implements the Relay Edge interface

type ExternalBalanceEdge implements Edge {
  cursor: String!
  node: ExternalAccountBalance!
}

Fields​

ExternalBalanceEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

ExternalBalanceEdge.node ● ExternalAccountBalance! non-null object​

The external balance

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

ExternalBalanceConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/face-photo-document/index.html b/api-reference/objects/face-photo-document/index.html index ae253722469..23e01561a4d 100644 --- a/api-reference/objects/face-photo-document/index.html +++ b/api-reference/objects/face-photo-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/fee-in-creditor/index.html b/api-reference/objects/fee-in-creditor/index.html index 08862b69975..642e1e9d386 100644 --- a/api-reference/objects/fee-in-creditor/index.html +++ b/api-reference/objects/fee-in-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/fee-in-debtor/index.html b/api-reference/objects/fee-in-debtor/index.html index 8211a9f4617..49e920bfc15 100644 --- a/api-reference/objects/fee-in-debtor/index.html +++ b/api-reference/objects/fee-in-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/fee-out-creditor/index.html b/api-reference/objects/fee-out-creditor/index.html index 786c7256dca..11d68ab40e1 100644 --- a/api-reference/objects/fee-out-creditor/index.html +++ b/api-reference/objects/fee-out-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/fee-out-debtor/index.html b/api-reference/objects/fee-out-debtor/index.html index e7a9764b1c7..16ce2fb7a61 100644 --- a/api-reference/objects/fee-out-debtor/index.html +++ b/api-reference/objects/fee-out-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/fee-settings-not-found-rejection/index.html b/api-reference/objects/fee-settings-not-found-rejection/index.html index 0bf9c4b6b2b..1d922b88d0d 100644 --- a/api-reference/objects/fee-settings-not-found-rejection/index.html +++ b/api-reference/objects/fee-settings-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/fee-transaction/index.html b/api-reference/objects/fee-transaction/index.html index ab6282b6d91..99dcd8c3c8b 100644 --- a/api-reference/objects/fee-transaction/index.html +++ b/api-reference/objects/fee-transaction/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FeeTransaction

Fee Transaction

type FeeTransaction implements Transaction {
  id: ID!
  reference: String!
  paymentMethodIdentifier: String!
  side: TransactionSide!
  type: TransactionTypeEnum!
  amount: Amount!
  label: String!
  feesType: FeesTypeEnum!
  statusInfo: TransactionStatusInfo!
  paymentId: String
  payment: Payment
  createdAt: DateTime!
  updatedAt: DateTime!
  counterparty: String!
  bookedBalanceAfter: Amount
  paymentProduct: PaymentProduct!
  creditor: FeeCreditor!
  debtor: FeeDebtor!
  account: Account
  externalReference: String
  executionDate: DateTime!
  requestedExecutionAt: DateTime
  originTransactionId: String
  originTransaction: Transaction
}

Fields​

FeeTransaction.id ● ID! non-null scalar​

unique identifier of the transaction

FeeTransaction.reference ● String! non-null scalar​

reference assigned by the initiating party, to unambiguously identify the transaction. This reference is passed on, unchanged, throughout the entire reference chain.

FeeTransaction.paymentMethodIdentifier ● String! non-null scalar​

payment method identifier used for this transaction. e.g masked PAN or IBAN or accountNumber

FeeTransaction.side ● TransactionSide! non-null enum​

side (Credit or Debit)

FeeTransaction.type ● TransactionTypeEnum! non-null enum​

type

FeeTransaction.amount ● Amount! non-null object​

amount

FeeTransaction.label ● String! non-null scalar​

label

FeeTransaction.feesType ● FeesTypeEnum! non-null enum​

feesType

FeeTransaction.statusInfo ● TransactionStatusInfo! non-null interface​

status information

FeeTransaction.paymentId ● String scalar​

ID of the payment associated to this transaction

FeeTransaction.payment ● Payment object​

payment associated to this transaction

FeeTransaction.createdAt ● DateTime! non-null scalar​

created date

FeeTransaction.updatedAt ● DateTime! non-null scalar​

updated date

FeeTransaction.counterparty ● String! non-null scalar​

name of the counterparty. e.g Merchant name, Creditor name, Beneficiary Name ...

FeeTransaction.bookedBalanceAfter ● Amount object​

booked balance after this transaction

FeeTransaction.paymentProduct ● PaymentProduct! non-null enum​

payment product used for this transaction

FeeTransaction.creditor ● FeeCreditor! non-null interface​

creditor information

FeeTransaction.debtor ● FeeDebtor! non-null interface​

debtor information

FeeTransaction.account ● Account object​

matching account for the transaction

FeeTransaction.externalReference ● String scalar​

an arbitrary identifier that was defined by you when you created this transaction.

For example, you can define it in the CreditTransferInput mutation.

FeeTransaction.executionDate ● DateTime! non-null scalar​

a date that reflects the execution date of a transaction from a user viewpoint. Can be used for sorting transactions.

FeeTransaction.requestedExecutionAt ● DateTime scalar​

a date that reflects the time at which the user asked the transaction to be executed

FeeTransaction.originTransactionId ● String scalar​

ID of the origin transaction associated to this transaction

FeeTransaction.originTransaction ● Transaction interface​

origin transaction associated to this transaction

Interfaces​

Transaction interface​

Transaction

- + \ No newline at end of file diff --git a/api-reference/objects/finalize-onboarding-success-payload/index.html b/api-reference/objects/finalize-onboarding-success-payload/index.html index 9b1849e0aef..980df0e92b3 100644 --- a/api-reference/objects/finalize-onboarding-success-payload/index.html +++ b/api-reference/objects/finalize-onboarding-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/financial-institution/index.html b/api-reference/objects/financial-institution/index.html index 9c42edc7c84..ed5cd8c6938 100644 --- a/api-reference/objects/financial-institution/index.html +++ b/api-reference/objects/financial-institution/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/forbidden-rejection/index.html b/api-reference/objects/forbidden-rejection/index.html index 9b8cef164c6..88bdeaef177 100644 --- a/api-reference/objects/forbidden-rejection/index.html +++ b/api-reference/objects/forbidden-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ForbiddenRejection

No description

type ForbiddenRejection implements Rejection {
  message: String!
}

Fields​

ForbiddenRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

ActivatePhysicalCardPayload union ● AddAccountMembershipPayload union ● AddAccountMembershipsPayload union ● AddCardPayload union ● AddDirectDebitFundingSourcePayload union ● AddExternalAccountBalancePayload union ● AddExternalAccountPayload union ● AddFundingLimitSettingsChangeRequestPayload union ● AddInternalDirectDebitPaymentMandatePayload union ● AddMerchantProfilePayload union ● AddOrUpdateExternalAccountBalancePayload union ● AddReceivedInternalDirectDebitB2bMandatePayload union ● AddReceivedSepaDirectDebitB2bMandatePayload union ● AddSepaDirectDebitPaymentMandatePayload union ● AddVirtualIbanEntryPayload union ● CancelCardPayload union ● CancelDigitalCardPayload union ● CancelFundingSourcePayload union ● CancelPhysicalCardPayload union ● CancelStandingOrderPayload union ● CancelTransactionPayload union ● CloseAccountPayload union ● CreateCapitalDepositCasePayload union ● CreateMerchantPaymentLinkPayload union ● DeleteSupportingDocumentPayload union ● DisableAccountMembershipPayload union ● EnableReceivedDirectDebitMandatePayload union ● FinalizeOnboardingPayload union ● GenerateCapitalDepositDocumentUploadUrlPayload union ● GenerateSupportingDocumentUploadUrlPayload union ● GrantConsentWithServerSignaturePayload union ● InitiateCreditTransfersPayload union ● InitiateFundingRequestPayload union ● InitiateInternationalCreditTransferResponsePayload union ● InitiateMerchantPaymentCollectionPayload union ● OnboardCompanyAccountHolderPayload union ● OnboardIndividualAccountHolderPayload union ● RequestMerchantPaymentMethodsPayload union ● RequestMerchantProfileUpdatePayload union ● RequestSupportingDocumentCollectionReviewPayload union ● ResumeAccountMembershipPayload union ● ResumePhysicalCardPayload union ● ScheduleStandingOrderPayload union ● SuspendPhysicalCardPayload union ● SuspendReceivedDirectDebitMandatePayload union ● UpdateAccountMembershipPayload union ● UpdateAccountPayload union ● UpdateCompanyOnboardingPayload union ● UpdateIndividualOnboardingPayload union ● UpdateReceivedSepaDirectDebitB2bMandatePayload union ● UpdateSupportingDocumentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-amount/index.html b/api-reference/objects/funding-limit-amount/index.html index 572764a0d5f..4372b44d628 100644 --- a/api-reference/objects/funding-limit-amount/index.html +++ b/api-reference/objects/funding-limit-amount/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-exceeded-rejection/index.html b/api-reference/objects/funding-limit-exceeded-rejection/index.html index 59c6f9ca5bc..5f36acf7f44 100644 --- a/api-reference/objects/funding-limit-exceeded-rejection/index.html +++ b/api-reference/objects/funding-limit-exceeded-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-settings-change-request-approved-status-info/index.html b/api-reference/objects/funding-limit-settings-change-request-approved-status-info/index.html index e765c691133..20e50d5d1a3 100644 --- a/api-reference/objects/funding-limit-settings-change-request-approved-status-info/index.html +++ b/api-reference/objects/funding-limit-settings-change-request-approved-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestApprovedStatusInfo

StatusInfo when funding limit settings change request has been approved

type FundingLimitSettingsChangeRequestApprovedStatusInfo implements FundingLimitSettingsChangeRequestStatusInfo {
  status: FundingLimitSettingsChangeRequestStatus!
  reason: String!
}

Fields​

FundingLimitSettingsChangeRequestApprovedStatusInfo.status ● FundingLimitSettingsChangeRequestStatus! non-null enum​

FundingLimitSettingsChangeRequestApprovedStatusInfo.reason ● String! non-null scalar​

Interfaces​

FundingLimitSettingsChangeRequestStatusInfo interface​

Object containing details about funding limit settings change request status

- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-settings-change-request-bad-amount-rejection/index.html b/api-reference/objects/funding-limit-settings-change-request-bad-amount-rejection/index.html index ce223478bd9..e22e57f9e5f 100644 --- a/api-reference/objects/funding-limit-settings-change-request-bad-amount-rejection/index.html +++ b/api-reference/objects/funding-limit-settings-change-request-bad-amount-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-settings-change-request-connection/index.html b/api-reference/objects/funding-limit-settings-change-request-connection/index.html index 70b250fd8a3..29908492070 100644 --- a/api-reference/objects/funding-limit-settings-change-request-connection/index.html +++ b/api-reference/objects/funding-limit-settings-change-request-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type FundingLimitSettingsChangeRequestConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [FundingLimitSettingsChangeRequestEdge!]!
}

Fields​

FundingLimitSettingsChangeRequestConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

FundingLimitSettingsChangeRequestConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

FundingLimitSettingsChangeRequestConnection.edges ● [FundingLimitSettingsChangeRequestEdge!]! non-null object​

FundingLimitSettingsChangeRequestEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

AccountHolder object

- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-settings-change-request-edge/index.html b/api-reference/objects/funding-limit-settings-change-request-edge/index.html index fa1143a49d0..f7495f9ce05 100644 --- a/api-reference/objects/funding-limit-settings-change-request-edge/index.html +++ b/api-reference/objects/funding-limit-settings-change-request-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestEdge

Implements the Relay Edge interface

type FundingLimitSettingsChangeRequestEdge implements Edge {
  cursor: String!
  node: FundingLimitSettingsChangeRequest!
}

Fields​

FundingLimitSettingsChangeRequestEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this onboarding node in the pagination mechanism

FundingLimitSettingsChangeRequestEdge.node ● FundingLimitSettingsChangeRequest! non-null object​

The FundingLimitSettingsChangeRequest

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

FundingLimitSettingsChangeRequestConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-settings-change-request-pending-status-info/index.html b/api-reference/objects/funding-limit-settings-change-request-pending-status-info/index.html index 224d57dab90..674ebae3785 100644 --- a/api-reference/objects/funding-limit-settings-change-request-pending-status-info/index.html +++ b/api-reference/objects/funding-limit-settings-change-request-pending-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestPendingStatusInfo

StatusInfo when funding limit settings change request is pending

type FundingLimitSettingsChangeRequestPendingStatusInfo implements FundingLimitSettingsChangeRequestStatusInfo {
  status: FundingLimitSettingsChangeRequestStatus!
}

Fields​

FundingLimitSettingsChangeRequestPendingStatusInfo.status ● FundingLimitSettingsChangeRequestStatus! non-null enum​

Interfaces​

FundingLimitSettingsChangeRequestStatusInfo interface​

Object containing details about funding limit settings change request status

- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-settings-change-request-refused-status-info/index.html b/api-reference/objects/funding-limit-settings-change-request-refused-status-info/index.html index 4fb5991d3b0..342d2087f28 100644 --- a/api-reference/objects/funding-limit-settings-change-request-refused-status-info/index.html +++ b/api-reference/objects/funding-limit-settings-change-request-refused-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestRefusedStatusInfo

StatusInfo when funding limit settings change request has been rejected

type FundingLimitSettingsChangeRequestRefusedStatusInfo implements FundingLimitSettingsChangeRequestStatusInfo {
  status: FundingLimitSettingsChangeRequestStatus!
  reason: String!
}

Fields​

FundingLimitSettingsChangeRequestRefusedStatusInfo.status ● FundingLimitSettingsChangeRequestStatus! non-null enum​

FundingLimitSettingsChangeRequestRefusedStatusInfo.reason ● String! non-null scalar​

Interfaces​

FundingLimitSettingsChangeRequestStatusInfo interface​

Object containing details about funding limit settings change request status

- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-settings-change-request-waiting-for-information-status-info/index.html b/api-reference/objects/funding-limit-settings-change-request-waiting-for-information-status-info/index.html index e5c467cfac1..26c1f822597 100644 --- a/api-reference/objects/funding-limit-settings-change-request-waiting-for-information-status-info/index.html +++ b/api-reference/objects/funding-limit-settings-change-request-waiting-for-information-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequestWaitingForInformationStatusInfo

StatusInfo when funding limit settings change request is waiting for more information

type FundingLimitSettingsChangeRequestWaitingForInformationStatusInfo implements FundingLimitSettingsChangeRequestStatusInfo {
  status: FundingLimitSettingsChangeRequestStatus!
}

Fields​

FundingLimitSettingsChangeRequestWaitingForInformationStatusInfo.status ● FundingLimitSettingsChangeRequestStatus! non-null enum​

Interfaces​

FundingLimitSettingsChangeRequestStatusInfo interface​

Object containing details about funding limit settings change request status

- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-settings-change-request/index.html b/api-reference/objects/funding-limit-settings-change-request/index.html index cab94a285bd..be2cbb7db6e 100644 --- a/api-reference/objects/funding-limit-settings-change-request/index.html +++ b/api-reference/objects/funding-limit-settings-change-request/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettingsChangeRequest

Funding Limit Settings Change Request

type FundingLimitSettingsChangeRequest {
  id: ID!
  instantFundingLimit: FundingLimitAmount!
  fundingLimit: FundingLimitAmount!
  approved: ApprovedFundingLimit
  statusInfo: FundingLimitSettingsChangeRequestStatusInfo!
  createdAt: Date
  updatedAt: Date
}

Fields​

FundingLimitSettingsChangeRequest.id ● ID! non-null scalar​

Unique identifier of a funding limit settings change request

FundingLimitSettingsChangeRequest.instantFundingLimit ● FundingLimitAmount! non-null object​

Requested amount settings for the instant funding limit

FundingLimitSettingsChangeRequest.fundingLimit ● FundingLimitAmount! non-null object​

Requested amount settings for the funding limit

FundingLimitSettingsChangeRequest.approved ● ApprovedFundingLimit object​

Approved amount settings for the the instant funding limit and the funding limit

FundingLimitSettingsChangeRequest.statusInfo ● FundingLimitSettingsChangeRequestStatusInfo! non-null interface​

Status of the request

FundingLimitSettingsChangeRequest.createdAt ● Date scalar​

Date of creation

FundingLimitSettingsChangeRequest.updatedAt ● Date scalar​

Date of last update

Returned by​

fundingLimitSettingsChangeRequest query

Member of​

AddFundingLimitSettingsChangeRequestSuccessPayload object ● FundingLimitSettings object ● FundingLimitSettingsChangeRequestEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit-settings/index.html b/api-reference/objects/funding-limit-settings/index.html index fd90873f80b..d6b0f1f14e3 100644 --- a/api-reference/objects/funding-limit-settings/index.html +++ b/api-reference/objects/funding-limit-settings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingLimitSettings

No description

type FundingLimitSettings {
  instantFundingLimit: InstantFundingLimit
  fundingLimit: FundingLimit
  fundingLimitSettingsChangeRequest: FundingLimitSettingsChangeRequest
  statusInfo: FundingLimitSettingsStatusInfo!
}

Fields​

FundingLimitSettings.instantFundingLimit ● InstantFundingLimit object​

Instant funding limit

FundingLimitSettings.fundingLimit ● FundingLimit object​

Periodic funding limit

FundingLimitSettings.fundingLimitSettingsChangeRequest ● FundingLimitSettingsChangeRequest object​

Related change request

FundingLimitSettings.statusInfo ● FundingLimitSettingsStatusInfo! non-null interface​

Status of the resource

Member of​

AccountHolder object

- + \ No newline at end of file diff --git a/api-reference/objects/funding-limit/index.html b/api-reference/objects/funding-limit/index.html index 8100223cd41..f7d061c77de 100644 --- a/api-reference/objects/funding-limit/index.html +++ b/api-reference/objects/funding-limit/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/funding-source-connection/index.html b/api-reference/objects/funding-source-connection/index.html index 3af35bd5862..7b919b868a9 100644 --- a/api-reference/objects/funding-source-connection/index.html +++ b/api-reference/objects/funding-source-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingSourceConnection

Please see the Connection interface

type FundingSourceConnection implements Connection {
  pageInfo: PageInfo!
  edges: [FundingSourceEdge!]!
  totalCount: Int!
}

Fields​

FundingSourceConnection.pageInfo ● PageInfo! non-null object​

FundingSourceConnection.edges ● [FundingSourceEdge!]! non-null object​

FundingSourceConnection.totalCount ● Int! non-null scalar​

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

Account object

- + \ No newline at end of file diff --git a/api-reference/objects/funding-source-edge/index.html b/api-reference/objects/funding-source-edge/index.html index 0f29633e94a..15d041d1255 100644 --- a/api-reference/objects/funding-source-edge/index.html +++ b/api-reference/objects/funding-source-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

FundingSourceEdge

Please see the Connection interface

type FundingSourceEdge implements Edge {
  node: FundingSource!
  cursor: String!
}

Fields​

FundingSourceEdge.node ● FundingSource! non-null interface​

FundingSourceEdge.cursor ● String! non-null scalar​

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

FundingSourceConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/funding-source-not-found-rejection/index.html b/api-reference/objects/funding-source-not-found-rejection/index.html index 8c2745bb1d9..7b99a27186a 100644 --- a/api-reference/objects/funding-source-not-found-rejection/index.html +++ b/api-reference/objects/funding-source-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/funding-source-wrong-status-rejection/index.html b/api-reference/objects/funding-source-wrong-status-rejection/index.html index 77726c1db9a..701072c452e 100644 --- a/api-reference/objects/funding-source-wrong-status-rejection/index.html +++ b/api-reference/objects/funding-source-wrong-status-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FundingSourceWrongStatusRejection

Rejection returned when the Funding Source is not in the expected status

type FundingSourceWrongStatusRejection implements Rejection {
  message: String!
  currentStatus: FundingSourceStatus!
  expectedStatus: FundingSourceStatus!
}

Fields​

FundingSourceWrongStatusRejection.message ● String! non-null scalar​

FundingSourceWrongStatusRejection.currentStatus ● FundingSourceStatus! non-null enum​

FundingSourceWrongStatusRejection.expectedStatus ● FundingSourceStatus! non-null enum​

Interfaces​

Rejection interface​

Implemented by​

InitiateFundingRequestPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/generate-capital-deposit-document-upload-url-success-payload/index.html b/api-reference/objects/generate-capital-deposit-document-upload-url-success-payload/index.html index d5f36067376..88a193c3b3e 100644 --- a/api-reference/objects/generate-capital-deposit-document-upload-url-success-payload/index.html +++ b/api-reference/objects/generate-capital-deposit-document-upload-url-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/generate-supporting-document-upload-url-success-payload/index.html b/api-reference/objects/generate-supporting-document-upload-url-success-payload/index.html index 1433cb3b664..e8fbf6457c3 100644 --- a/api-reference/objects/generate-supporting-document-upload-url-success-payload/index.html +++ b/api-reference/objects/generate-supporting-document-upload-url-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

GenerateSupportingDocumentUploadUrlSuccessPayload

No description

type GenerateSupportingDocumentUploadUrlSuccessPayload {
  supportingDocumentId: String!
  upload: SupportingDocumentUploadInfo!
}

Fields​

GenerateSupportingDocumentUploadUrlSuccessPayload.supportingDocumentId ● String! non-null scalar​

Id of the supporting document created for this uploadUrl

GenerateSupportingDocumentUploadUrlSuccessPayload.upload ● SupportingDocumentUploadInfo! non-null object​

Info to upload the document : url and fields to add along file in form (POST)

Implemented by​

GenerateSupportingDocumentUploadUrlPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/global-funding-limit-exceeded-rejection/index.html b/api-reference/objects/global-funding-limit-exceeded-rejection/index.html index f4ce2db6a7c..6af413190bf 100644 --- a/api-reference/objects/global-funding-limit-exceeded-rejection/index.html +++ b/api-reference/objects/global-funding-limit-exceeded-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/global-instant-funding-limit-exceeded-rejection/index.html b/api-reference/objects/global-instant-funding-limit-exceeded-rejection/index.html index 461b254de86..28ccd8c91c0 100644 --- a/api-reference/objects/global-instant-funding-limit-exceeded-rejection/index.html +++ b/api-reference/objects/global-instant-funding-limit-exceeded-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/grant-consent-with-server-signature-success-payload/index.html b/api-reference/objects/grant-consent-with-server-signature-success-payload/index.html index bd752dbc1ae..2998c82b0b6 100644 --- a/api-reference/objects/grant-consent-with-server-signature-success-payload/index.html +++ b/api-reference/objects/grant-consent-with-server-signature-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/headquarters/index.html b/api-reference/objects/headquarters/index.html index b102881e1e8..ed13cb8823e 100644 --- a/api-reference/objects/headquarters/index.html +++ b/api-reference/objects/headquarters/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/iban-validation-rejection/index.html b/api-reference/objects/iban-validation-rejection/index.html index 5e9c5d7c888..23111084cda 100644 --- a/api-reference/objects/iban-validation-rejection/index.html +++ b/api-reference/objects/iban-validation-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/ibannot-reachable-rejection/index.html b/api-reference/objects/ibannot-reachable-rejection/index.html index 992abd59897..0a7b6cbb472 100644 --- a/api-reference/objects/ibannot-reachable-rejection/index.html +++ b/api-reference/objects/ibannot-reachable-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/ibannot-valid-rejection/index.html b/api-reference/objects/ibannot-valid-rejection/index.html index b4f976f434f..e4a9d468f5d 100644 --- a/api-reference/objects/ibannot-valid-rejection/index.html +++ b/api-reference/objects/ibannot-valid-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/id-card-document-file/index.html b/api-reference/objects/id-card-document-file/index.html index 46b2641adac..49945d220d5 100644 --- a/api-reference/objects/id-card-document-file/index.html +++ b/api-reference/objects/id-card-document-file/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IdCardDocumentFile

The file associated to the ID card document

type IdCardDocumentFile implements DocumentFile {
  downloadUrl: String!
  side: DocumentFileSide!
}

Fields​

IdCardDocumentFile.downloadUrl ● String! non-null scalar​

The file's temporary download url

IdCardDocumentFile.side ● DocumentFileSide! non-null enum​

From which side the ID card's picture was taken

Interfaces​

DocumentFile interface​

Retrieved document extracted from the identity verification

Member of​

IdCardDocument object

- + \ No newline at end of file diff --git a/api-reference/objects/id-card-document/index.html b/api-reference/objects/id-card-document/index.html index 484e0cafd7d..f87b6edc432 100644 --- a/api-reference/objects/id-card-document/index.html +++ b/api-reference/objects/id-card-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IdCardDocument

The document corresponding to an ID card

type IdCardDocument {
  id: String!
  type: DocumentType!
  issueDate: Date
  expiryDate: Date
  mrz: String
  number: String
  files: [IdCardDocumentFile!]!
}

Fields​

IdCardDocument.id ● String! non-null scalar​

Unique identifier of the ID card document

IdCardDocument.type ● DocumentType! non-null enum​

The type of the document

IdCardDocument.issueDate ● Date scalar​

The date at which the ID card was issued

IdCardDocument.expiryDate ● Date scalar​

The date at which the ID card expires

IdCardDocument.mrz ● String scalar​

Machine-readable zone code of the ID card

IdCardDocument.number ● String scalar​

Number of the ID card

IdCardDocument.files ● [IdCardDocumentFile!]! non-null object​

List of the associated files

Implemented by​

IdentificationDocument union

- + \ No newline at end of file diff --git a/api-reference/objects/identification-connection/index.html b/api-reference/objects/identification-connection/index.html index 34f61c32888..8bce7b7fc2c 100644 --- a/api-reference/objects/identification-connection/index.html +++ b/api-reference/objects/identification-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IdentificationConnection

Fields we can use when ordering that can be applied when listing identifications

type IdentificationConnection {
  totalCount: Int!
  pageInfo: PageInfo
  edges: [IdentificationEdge!]!
}

Fields​

IdentificationConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

IdentificationConnection.pageInfo ● PageInfo object​

Information about the current, the previous and the next page

IdentificationConnection.edges ● [IdentificationEdge!]! non-null object​

IdentificationEdge list

Member of​

User object

- + \ No newline at end of file diff --git a/api-reference/objects/identification-edge/index.html b/api-reference/objects/identification-edge/index.html index 73831e42822..5f5a1a50328 100644 --- a/api-reference/objects/identification-edge/index.html +++ b/api-reference/objects/identification-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

IdentificationEdge

Implements the Relay Edge interface

type IdentificationEdge implements Edge {
  node: Identification!
  cursor: String!
}

Fields​

IdentificationEdge.node ● Identification! non-null object​

The identification entry

IdentificationEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

IdentificationConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/identification-level-statuses-info/index.html b/api-reference/objects/identification-level-statuses-info/index.html index b8fe9883b02..a3a613f6a7d 100644 --- a/api-reference/objects/identification-level-statuses-info/index.html +++ b/api-reference/objects/identification-level-statuses-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IdentificationLevelStatusesInfo

The status and results associated to the available identification processes

type IdentificationLevelStatusesInfo {
  expert: IdentificationLevelStatusInfo!
  qes: IdentificationLevelStatusInfo!
  pvid: IdentificationLevelStatusInfo!
}

Fields​

IdentificationLevelStatusesInfo.expert ● IdentificationLevelStatusInfo! non-null union​

The status and results associated to the expert level

IdentificationLevelStatusesInfo.qes ● IdentificationLevelStatusInfo! non-null union​

The status and results associated to the Qualified Electronic Signature level

IdentificationLevelStatusesInfo.pvid ● IdentificationLevelStatusInfo! non-null union​

The status and results associated to the Remote Identity Verification Service level

Member of​

Identification object

- + \ No newline at end of file diff --git a/api-reference/objects/identification-levels/index.html b/api-reference/objects/identification-levels/index.html index 4cb35bc6259..43baa9d65fe 100644 --- a/api-reference/objects/identification-levels/index.html +++ b/api-reference/objects/identification-levels/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/identification/index.html b/api-reference/objects/identification/index.html index 9bd49b8c45b..eb2a14d9bc5 100644 --- a/api-reference/objects/identification/index.html +++ b/api-reference/objects/identification/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Identification

The identification represents an ongoing identification process or its result

type Identification {
  id: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  status: SwanIdentificationStatus!
  process: IdentificationProcess!
  levels: IdentificationLevelStatusesInfo!
  documents: [IdentificationDocument!]
  identityDocumentType: IdentityDocumentType
}

Fields​

Identification.id ● String! non-null scalar​

Unique identifier of the identification

Identification.createdAt ● DateTime! non-null scalar​

Creation date of the identification

Identification.updatedAt ● DateTime! non-null scalar​

Last update date of the identification

Identification.status ● SwanIdentificationStatus! non-null enum​

The global status of the identification

Identification.process ● IdentificationProcess! non-null enum​

The process that was used for this identification

Identification.levels ● IdentificationLevelStatusesInfo! non-null object​

The status and results associated to the available identification processes

Identification.documents ● [IdentificationDocument!] list union​

The available documents related to the identification (id doc, selfie, report...)

Identification.identityDocumentType ● IdentityDocumentType enum​

The identity document type used for the current identification (passport, id card ...)

Member of​

IdentificationEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/identity-already-bind-to-account-membership-rejection/index.html b/api-reference/objects/identity-already-bind-to-account-membership-rejection/index.html index 99f7bab3b97..6fbe4b53772 100644 --- a/api-reference/objects/identity-already-bind-to-account-membership-rejection/index.html +++ b/api-reference/objects/identity-already-bind-to-account-membership-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IdentityAlreadyBindToAccountMembershipRejection

Rejection returned if identity and the account memberships are already bind

type IdentityAlreadyBindToAccountMembershipRejection implements Rejection {
  accountId: String!
  identityId: String!
  message: String!
}

Fields​

IdentityAlreadyBindToAccountMembershipRejection.accountId ● String! non-null scalar​

IdentityAlreadyBindToAccountMembershipRejection.identityId ● String! non-null scalar​

IdentityAlreadyBindToAccountMembershipRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

BindAccountMembershipPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/in-app-provisioning-data/index.html b/api-reference/objects/in-app-provisioning-data/index.html index 82cfdb9e7a9..1f1dd82f319 100644 --- a/api-reference/objects/in-app-provisioning-data/index.html +++ b/api-reference/objects/in-app-provisioning-data/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InAppProvisioningData

Data used for in app provisioning

type InAppProvisioningData {
  activationData: String!
  ephemeralPublicKey: String!
  encryptedData: String!
  iv: String
  publicKeyFingerprint: String
  oaepHashingAlgorithm: String
}

Fields​

InAppProvisioningData.activationData ● String! non-null scalar​

Cryptographic OTP used to pre-validate digitalization

InAppProvisioningData.ephemeralPublicKey ● String! non-null scalar​

Base64 public key used with the wallet provider public key to encrypt the card data

InAppProvisioningData.encryptedData ● String! non-null scalar​

Encrypted card data

InAppProvisioningData.iv ● String scalar​

IV used to encrypt the card Data (Useful for Google Pay)

InAppProvisioningData.publicKeyFingerprint ● String scalar​

public key fingerprint of the key used to encrypt card data (Useful for Google Pay)

InAppProvisioningData.oaepHashingAlgorithm ● String scalar​

hash algorithm used during encryption of the card data (Useful for Google Pay)

Member of​

PendingDigitalCard object

- + \ No newline at end of file diff --git a/api-reference/objects/individual-shareholder/index.html b/api-reference/objects/individual-shareholder/index.html index dd94491a52e..6022192e0ed 100644 --- a/api-reference/objects/individual-shareholder/index.html +++ b/api-reference/objects/individual-shareholder/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IndividualShareholder

Individual shareholder info.

type IndividualShareholder {
  type: ShareholderType!
  firstName: String!
  lastName: String!
  birthDate: String!
  nationality: CCA3!
}

Fields​

IndividualShareholder.type ● ShareholderType! non-null enum​

Whether the shareholder is an individual or a company.

IndividualShareholder.firstName ● String! non-null scalar​

First name of the shareholder.

IndividualShareholder.lastName ● String! non-null scalar​

Last name of the shareholder.

IndividualShareholder.birthDate ● String! non-null scalar​

Birth date of the shareholder.

IndividualShareholder.nationality ● CCA3! non-null scalar​

CCA3 code for the country of nationality of the shareholder.

Implemented by​

ShareholderInfo union

- + \ No newline at end of file diff --git a/api-reference/objects/individual-ultimate-beneficial-owner-type-has-capital/index.html b/api-reference/objects/individual-ultimate-beneficial-owner-type-has-capital/index.html index 58ccf69514c..639d2fa5098 100644 --- a/api-reference/objects/individual-ultimate-beneficial-owner-type-has-capital/index.html +++ b/api-reference/objects/individual-ultimate-beneficial-owner-type-has-capital/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IndividualUltimateBeneficialOwnerTypeHasCapital

Individual Ultimate Beneficial Owner Type Has Capital

type IndividualUltimateBeneficialOwnerTypeHasCapital implements IndividualUltimateBeneficialOwnerInfo {
  type: IndividualUltimateBeneficialOwnerTypeEnum!
  indirect: Boolean
  direct: Boolean
  totalCapitalPercentage: Float
}

Fields​

IndividualUltimateBeneficialOwnerTypeHasCapital.type ● IndividualUltimateBeneficialOwnerTypeEnum! non-null enum​

Individual type

IndividualUltimateBeneficialOwnerTypeHasCapital.indirect ● Boolean scalar​

Define UBO is an Indirect Owner

IndividualUltimateBeneficialOwnerTypeHasCapital.direct ● Boolean scalar​

Define UBO is an Direct Owner

IndividualUltimateBeneficialOwnerTypeHasCapital.totalCapitalPercentage ● Float scalar​

Total of capital (in percentage, ex: 50 = 50%)

Interfaces​

IndividualUltimateBeneficialOwnerInfo interface​

Define the type of the UBO

- + \ No newline at end of file diff --git a/api-reference/objects/individual-ultimate-beneficial-owner-type-legal-representative/index.html b/api-reference/objects/individual-ultimate-beneficial-owner-type-legal-representative/index.html index 3e28fb2ba16..e049ef47257 100644 --- a/api-reference/objects/individual-ultimate-beneficial-owner-type-legal-representative/index.html +++ b/api-reference/objects/individual-ultimate-beneficial-owner-type-legal-representative/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IndividualUltimateBeneficialOwnerTypeLegalRepresentative

Individual Ultimate Beneficial Owner Type Legal Representative

type IndividualUltimateBeneficialOwnerTypeLegalRepresentative implements IndividualUltimateBeneficialOwnerInfo {
  type: IndividualUltimateBeneficialOwnerTypeEnum!
}

Fields​

IndividualUltimateBeneficialOwnerTypeLegalRepresentative.type ● IndividualUltimateBeneficialOwnerTypeEnum! non-null enum​

Individual type

Interfaces​

IndividualUltimateBeneficialOwnerInfo interface​

Define the type of the UBO

- + \ No newline at end of file diff --git a/api-reference/objects/individual-ultimate-beneficial-owner-type-other/index.html b/api-reference/objects/individual-ultimate-beneficial-owner-type-other/index.html index 0425f31a587..728b95084c2 100644 --- a/api-reference/objects/individual-ultimate-beneficial-owner-type-other/index.html +++ b/api-reference/objects/individual-ultimate-beneficial-owner-type-other/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/individual-ultimate-beneficial-owner/index.html b/api-reference/objects/individual-ultimate-beneficial-owner/index.html index f9a425f7720..2e32a091db1 100644 --- a/api-reference/objects/individual-ultimate-beneficial-owner/index.html +++ b/api-reference/objects/individual-ultimate-beneficial-owner/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

IndividualUltimateBeneficialOwner

Individual Ultimate Beneficial Owner You need to describe the natural person (s) who hold, directly or indirectly, more than 25% of the capital or the rights of vote of the reporting company. Please describe the company (s) that owns the company that wishes to open an account, when an individual holds in fine more than 25%

type IndividualUltimateBeneficialOwner {
  firstName: String
  lastName: String
  birthDate: DateTime
  birthCity: String
  birthCityPostalCode: String
  birthCountryCode: CCA3
  info: IndividualUltimateBeneficialOwnerInfo!
  taxIdentificationNumber: String
  residencyAddress: AddressInformation
  title: TitleEnum
}

Fields​

IndividualUltimateBeneficialOwner.firstName ● String scalar​

individual first name

IndividualUltimateBeneficialOwner.lastName ● String scalar​

individual last name

IndividualUltimateBeneficialOwner.birthDate ● DateTime scalar​

individual birth date

IndividualUltimateBeneficialOwner.birthCity ● String scalar​

individual birth city

IndividualUltimateBeneficialOwner.birthCityPostalCode ● String scalar​

individual birth city postal code

IndividualUltimateBeneficialOwner.birthCountryCode ● CCA3 scalar​

individual birth country code

IndividualUltimateBeneficialOwner.info ● IndividualUltimateBeneficialOwnerInfo! non-null interface​

Information relating to the type of the UBO

IndividualUltimateBeneficialOwner.taxIdentificationNumber ● String scalar​

Individual beneficial owner Tax or Identification Number

IndividualUltimateBeneficialOwner.residencyAddress ● AddressInformation object​

Individual beneficial owner residency Address

IndividualUltimateBeneficialOwner.title ● TitleEnum enum​

Individual beneficial owner title (Mr/Ms)

Member of​

AccountHolderCompanyInfo object ● OnboardingCompanyAccountHolderInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/initiate-credit-transfers-success-payload/index.html b/api-reference/objects/initiate-credit-transfers-success-payload/index.html index 07de80a28ac..6a14949d5ba 100644 --- a/api-reference/objects/initiate-credit-transfers-success-payload/index.html +++ b/api-reference/objects/initiate-credit-transfers-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/initiate-funding-request-success-payload/index.html b/api-reference/objects/initiate-funding-request-success-payload/index.html index 5a205d09e3c..bc7a8c6aa54 100644 --- a/api-reference/objects/initiate-funding-request-success-payload/index.html +++ b/api-reference/objects/initiate-funding-request-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/initiate-international-credit-transfer-response-success-payload/index.html b/api-reference/objects/initiate-international-credit-transfer-response-success-payload/index.html index c9a6a5627b4..d83623df097 100644 --- a/api-reference/objects/initiate-international-credit-transfer-response-success-payload/index.html +++ b/api-reference/objects/initiate-international-credit-transfer-response-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InitiateInternationalCreditTransferResponseSuccessPayload

Initiate International Credit Transfer Response Success Payload

type InitiateInternationalCreditTransferResponseSuccessPayload {
  payment: Payment!
  quote: InternationalCreditTransferQuote!
}

Fields​

InitiateInternationalCreditTransferResponseSuccessPayload.payment ● Payment! non-null object​

Details of the international credit transfer created

InitiateInternationalCreditTransferResponseSuccessPayload.quote ● InternationalCreditTransferQuote! non-null object​

Details for the quote of international credit transfer

Implemented by​

InitiateInternationalCreditTransferResponsePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/initiate-merchant-payment-collection-success-payload/index.html b/api-reference/objects/initiate-merchant-payment-collection-success-payload/index.html index 5fafa1b81cb..b5e009137f8 100644 --- a/api-reference/objects/initiate-merchant-payment-collection-success-payload/index.html +++ b/api-reference/objects/initiate-merchant-payment-collection-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/instant-funding-limit-exceeded-rejection/index.html b/api-reference/objects/instant-funding-limit-exceeded-rejection/index.html index 2e80aca7e47..3c0a7629aeb 100644 --- a/api-reference/objects/instant-funding-limit-exceeded-rejection/index.html +++ b/api-reference/objects/instant-funding-limit-exceeded-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/instant-funding-limit/index.html b/api-reference/objects/instant-funding-limit/index.html index f1b55362570..7f758a995b9 100644 --- a/api-reference/objects/instant-funding-limit/index.html +++ b/api-reference/objects/instant-funding-limit/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/insufficient-funds-rejection/index.html b/api-reference/objects/insufficient-funds-rejection/index.html index 1ae20cb3e8d..ef66e68325b 100644 --- a/api-reference/objects/insufficient-funds-rejection/index.html +++ b/api-reference/objects/insufficient-funds-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/internal-beneficiary/index.html b/api-reference/objects/internal-beneficiary/index.html index 4d685436377..b4ffd06f86a 100644 --- a/api-reference/objects/internal-beneficiary/index.html +++ b/api-reference/objects/internal-beneficiary/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

InternalBeneficiary

SOON TO BE DEPRECATED Internal Beneficiary

type InternalBeneficiary implements Beneficiary {
  id: ID
  name: String!
  isMyOwnIban: Boolean!
  accountNumber: AccountNumber!
}

Fields​

InternalBeneficiary.id ● ID scalar​

unique identifier of a beneficiary

InternalBeneficiary.name ● String! non-null scalar​

full name of the beneficiary

InternalBeneficiary.isMyOwnIban ● Boolean! non-null scalar​

true if this new beneficiary is the account holder himself in an other financial institution.

InternalBeneficiary.accountNumber ● AccountNumber! non-null scalar​

account number if the beneficiary is a swan account

Interfaces​

Beneficiary interface​

SOON TO BE DEPRECATED Beneficiary

Member of​

SEPACreditTransferInternalOutCreditor object

- + \ No newline at end of file diff --git a/api-reference/objects/internal-credit-transfer-in-creditor/index.html b/api-reference/objects/internal-credit-transfer-in-creditor/index.html index 236d59d0924..b7c8e15d936 100644 --- a/api-reference/objects/internal-credit-transfer-in-creditor/index.html +++ b/api-reference/objects/internal-credit-transfer-in-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalCreditTransferInCreditor

Internal Credit Transfer creditor for Incoming transaction

type InternalCreditTransferInCreditor implements InternalCreditTransferCreditor {
  name: String!
  accountNumber: AccountNumber!
}

Fields​

InternalCreditTransferInCreditor.name ● String! non-null scalar​

full name of the creditor

InternalCreditTransferInCreditor.accountNumber ● AccountNumber! non-null scalar​

account number

Interfaces​

InternalCreditTransferCreditor interface​

Internal Credit Transfer creditor

- + \ No newline at end of file diff --git a/api-reference/objects/internal-credit-transfer-in-debtor/index.html b/api-reference/objects/internal-credit-transfer-in-debtor/index.html index 43fa82704b8..4733841906b 100644 --- a/api-reference/objects/internal-credit-transfer-in-debtor/index.html +++ b/api-reference/objects/internal-credit-transfer-in-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalCreditTransferInDebtor

Internal Credit Transfer debtor for Incoming transaction

type InternalCreditTransferInDebtor implements InternalCreditTransferDebtor {
  name: String!
  accountNumber: AccountNumber!
}

Fields​

InternalCreditTransferInDebtor.name ● String! non-null scalar​

full name of the creditor

InternalCreditTransferInDebtor.accountNumber ● AccountNumber! non-null scalar​

account number

Interfaces​

InternalCreditTransferDebtor interface​

Internal Credit Transfer debtor

- + \ No newline at end of file diff --git a/api-reference/objects/internal-credit-transfer-out-creditor/index.html b/api-reference/objects/internal-credit-transfer-out-creditor/index.html index 7299e32b7ec..f2bacd8e86c 100644 --- a/api-reference/objects/internal-credit-transfer-out-creditor/index.html +++ b/api-reference/objects/internal-credit-transfer-out-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalCreditTransferOutCreditor

Internal Credit Transfer creditor for Outgoing transaction

type InternalCreditTransferOutCreditor implements InternalCreditTransferCreditor {
  name: String!
  accountNumber: AccountNumber!
}

Fields​

InternalCreditTransferOutCreditor.name ● String! non-null scalar​

full name of the creditor

InternalCreditTransferOutCreditor.accountNumber ● AccountNumber! non-null scalar​

account number

Interfaces​

InternalCreditTransferCreditor interface​

Internal Credit Transfer creditor

- + \ No newline at end of file diff --git a/api-reference/objects/internal-credit-transfer-out-debtor/index.html b/api-reference/objects/internal-credit-transfer-out-debtor/index.html index 8fb4e5c73c2..60b17609622 100644 --- a/api-reference/objects/internal-credit-transfer-out-debtor/index.html +++ b/api-reference/objects/internal-credit-transfer-out-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalCreditTransferOutDebtor

Internal Credit Transfer debtor for Outgoing transaction

type InternalCreditTransferOutDebtor implements InternalCreditTransferDebtor {
  name: String!
  accountNumber: AccountNumber!
}

Fields​

InternalCreditTransferOutDebtor.name ● String! non-null scalar​

full name of the creditor

InternalCreditTransferOutDebtor.accountNumber ● AccountNumber! non-null scalar​

account number

Interfaces​

InternalCreditTransferDebtor interface​

Internal Credit Transfer debtor

- + \ No newline at end of file diff --git a/api-reference/objects/internal-credit-transfer/index.html b/api-reference/objects/internal-credit-transfer/index.html index 4a95220a6ac..84662015563 100644 --- a/api-reference/objects/internal-credit-transfer/index.html +++ b/api-reference/objects/internal-credit-transfer/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalCreditTransfer

Internal Credit Transfer transaction

type InternalCreditTransfer implements Transaction {
  id: ID!
  reference: String!
  paymentMethodIdentifier: String!
  side: TransactionSide!
  type: TransactionTypeEnum!
  amount: Amount!
  label: String!
  statusInfo: TransactionStatusInfo!
  paymentId: String
  payment: Payment
  createdAt: DateTime!
  updatedAt: DateTime!
  counterparty: String!
  bookedBalanceAfter: Amount
  paymentProduct: PaymentProduct!
  creditor: InternalCreditTransferCreditor!
  debtor: InternalCreditTransferDebtor!
  account: Account
  externalReference: String
  executionDate: DateTime!
  requestedExecutionAt: DateTime
  originTransactionId: String
  originTransaction: Transaction
  returnReason: TransactionReasonCode
}

Fields​

InternalCreditTransfer.id ● ID! non-null scalar​

unique identifier of the transaction

InternalCreditTransfer.reference ● String! non-null scalar​

reference assigned by the initiating party, to unambiguously identify the transaction. This reference is passed on, unchanged, throughout the entire reference chain.

InternalCreditTransfer.paymentMethodIdentifier ● String! non-null scalar​

payment method identifier used for this transaction. e.g masked PAN or IBAN or accountNumber

InternalCreditTransfer.side ● TransactionSide! non-null enum​

side (Credit or Debit)

InternalCreditTransfer.type ● TransactionTypeEnum! non-null enum​

type

InternalCreditTransfer.amount ● Amount! non-null object​

amount

InternalCreditTransfer.label ● String! non-null scalar​

label

InternalCreditTransfer.statusInfo ● TransactionStatusInfo! non-null interface​

status information

InternalCreditTransfer.paymentId ● String scalar​

ID of the payment associated to this transaction

InternalCreditTransfer.payment ● Payment object​

payment associated to this transaction

InternalCreditTransfer.createdAt ● DateTime! non-null scalar​

created date

InternalCreditTransfer.updatedAt ● DateTime! non-null scalar​

updated date

InternalCreditTransfer.counterparty ● String! non-null scalar​

name of the counterparty. e.g Merchant name, Creditor name, Beneficiary Name ...

InternalCreditTransfer.bookedBalanceAfter ● Amount object​

booked balance after this transaction

InternalCreditTransfer.paymentProduct ● PaymentProduct! non-null enum​

payment product used for this transaction

InternalCreditTransfer.creditor ● InternalCreditTransferCreditor! non-null interface​

creditor information

InternalCreditTransfer.debtor ● InternalCreditTransferDebtor! non-null interface​

debtor information

InternalCreditTransfer.account ● Account object​

matching account for the transaction

InternalCreditTransfer.externalReference ● String scalar​

an arbitrary identifier that was defined by you when you created this transaction.

For example, you can define it in the CreditTransferInput mutation.

InternalCreditTransfer.executionDate ● DateTime! non-null scalar​

a date that reflects the execution date of a transaction from a user viewpoint. Can be used for sorting transactions.

InternalCreditTransfer.requestedExecutionAt ● DateTime scalar​

a date that reflects the time at which the user asked the transaction to be executed

InternalCreditTransfer.originTransactionId ● String scalar​

ID of the origin transaction associated to this transaction

InternalCreditTransfer.originTransaction ● Transaction interface​

origin transaction associated to this transaction

InternalCreditTransfer.returnReason ● TransactionReasonCode enum​

r-transaction reason

Interfaces​

Transaction interface​

Transaction

- + \ No newline at end of file diff --git a/api-reference/objects/internal-direct-debit-b2-bmerchant-payment-method/index.html b/api-reference/objects/internal-direct-debit-b2-bmerchant-payment-method/index.html index 5a82f5cd78d..09c6f7f464d 100644 --- a/api-reference/objects/internal-direct-debit-b2-bmerchant-payment-method/index.html +++ b/api-reference/objects/internal-direct-debit-b2-bmerchant-payment-method/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalDirectDebitB2BMerchantPaymentMethod

InternalDirectDebitB2BMerchantPaymentMethod

type InternalDirectDebitB2BMerchantPaymentMethod implements MerchantPaymentMethod {
  id: ID!
  type: MerchantPaymentMethodType!
  methodId: ID!
  statusInfo: MerchantPaymentMethodStatusInfo!
  version: Int!
  updatedAt: Date!
  rollingReserve: RollingReserve
}

Fields​

InternalDirectDebitB2BMerchantPaymentMethod.id ● ID! non-null scalar​

Unique identifier tied to every version of a given Merchant Payment Method

InternalDirectDebitB2BMerchantPaymentMethod.type ● MerchantPaymentMethodType! non-null enum​

The Merchant Payment Method Type

InternalDirectDebitB2BMerchantPaymentMethod.methodId ● ID! non-null scalar​

Unique identifier for a given merchant Payment Method, identical for every version of a given Merchant Payment Method Type

InternalDirectDebitB2BMerchantPaymentMethod.statusInfo ● MerchantPaymentMethodStatusInfo! non-null interface​

Status of the Merchant Payment Method

InternalDirectDebitB2BMerchantPaymentMethod.version ● Int! non-null scalar​

Version of the Merchant Payment Method

InternalDirectDebitB2BMerchantPaymentMethod.updatedAt ● Date! non-null scalar​

Date at which the Merchant Payment Method was last updated

InternalDirectDebitB2BMerchantPaymentMethod.rollingReserve ● RollingReserve object​

Rolling Reserve applied to the Merchant Payment Method

Interfaces​

MerchantPaymentMethod interface​

Base object for the different Payment Methods available

- + \ No newline at end of file diff --git a/api-reference/objects/internal-direct-debit-creditor/index.html b/api-reference/objects/internal-direct-debit-creditor/index.html index 88ebecce269..0bc94ee41e2 100644 --- a/api-reference/objects/internal-direct-debit-creditor/index.html +++ b/api-reference/objects/internal-direct-debit-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/internal-direct-debit-debtor/index.html b/api-reference/objects/internal-direct-debit-debtor/index.html index c783b0165d1..e5f292c392a 100644 --- a/api-reference/objects/internal-direct-debit-debtor/index.html +++ b/api-reference/objects/internal-direct-debit-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/internal-direct-debit-standard-merchant-payment-method/index.html b/api-reference/objects/internal-direct-debit-standard-merchant-payment-method/index.html index b8bbd5c4c65..3ce79652a01 100644 --- a/api-reference/objects/internal-direct-debit-standard-merchant-payment-method/index.html +++ b/api-reference/objects/internal-direct-debit-standard-merchant-payment-method/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalDirectDebitStandardMerchantPaymentMethod

InternalDirectDebitStandardMerchantPaymentMethod

type InternalDirectDebitStandardMerchantPaymentMethod implements MerchantPaymentMethod {
  id: ID!
  type: MerchantPaymentMethodType!
  methodId: ID!
  statusInfo: MerchantPaymentMethodStatusInfo!
  version: Int!
  updatedAt: Date!
  rollingReserve: RollingReserve
}

Fields​

InternalDirectDebitStandardMerchantPaymentMethod.id ● ID! non-null scalar​

Unique identifier tied to every version of a given Merchant Payment Method

InternalDirectDebitStandardMerchantPaymentMethod.type ● MerchantPaymentMethodType! non-null enum​

The Merchant Payment Method Type

InternalDirectDebitStandardMerchantPaymentMethod.methodId ● ID! non-null scalar​

Unique identifier for a given merchant Payment Method, identical for every version of a given Merchant Payment Method Type

InternalDirectDebitStandardMerchantPaymentMethod.statusInfo ● MerchantPaymentMethodStatusInfo! non-null interface​

Status of the Merchant Payment Method

InternalDirectDebitStandardMerchantPaymentMethod.version ● Int! non-null scalar​

Version of the Merchant Payment Method

InternalDirectDebitStandardMerchantPaymentMethod.updatedAt ● Date! non-null scalar​

Date at which the Merchant Payment Method was last updated

InternalDirectDebitStandardMerchantPaymentMethod.rollingReserve ● RollingReserve object​

Rolling Reserve applied to the Merchant Payment Method

Interfaces​

MerchantPaymentMethod interface​

Base object for the different Payment Methods available

- + \ No newline at end of file diff --git a/api-reference/objects/internal-direct-debit-transaction/index.html b/api-reference/objects/internal-direct-debit-transaction/index.html index a9da94feb4a..e402f2eb860 100644 --- a/api-reference/objects/internal-direct-debit-transaction/index.html +++ b/api-reference/objects/internal-direct-debit-transaction/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalDirectDebitTransaction

Internal Direct Debit transaction

type InternalDirectDebitTransaction implements Transaction {
  id: ID!
  reference: String!
  paymentMethodIdentifier: String!
  side: TransactionSide!
  type: TransactionTypeEnum!
  amount: Amount!
  label: String!
  statusInfo: TransactionStatusInfo!
  paymentId: String
  payment: Payment
  createdAt: DateTime!
  updatedAt: DateTime!
  counterparty: String!
  bookedBalanceAfter: Amount
  paymentProduct: PaymentProduct!
  creditor: InternalDirectDebitCreditor!
  debtor: InternalDirectDebitDebtor!
  account: Account
  mandate: InternalDirectDebitMandate
  externalReference: String
  executionDate: DateTime!
  requestedExecutionAt: DateTime
  originTransactionId: String
  originTransaction: Transaction
  reservedAmount: Amount
  reservedAmountReleasedAt: DateTime
  returnReason: TransactionReasonCode
}

Fields​

InternalDirectDebitTransaction.id ● ID! non-null scalar​

unique identifier of the transaction

InternalDirectDebitTransaction.reference ● String! non-null scalar​

reference assigned by the initiating party, to unambiguously identify the transaction. This reference is passed on, unchanged, throughout the entire end-to-end chain.

InternalDirectDebitTransaction.paymentMethodIdentifier ● String! non-null scalar​

payment method identifier used for this transaction: accountNumber

InternalDirectDebitTransaction.side ● TransactionSide! non-null enum​

side (Credit or Debit)

InternalDirectDebitTransaction.type ● TransactionTypeEnum! non-null enum​

type

InternalDirectDebitTransaction.amount ● Amount! non-null object​

amount

InternalDirectDebitTransaction.label ● String! non-null scalar​

label

InternalDirectDebitTransaction.statusInfo ● TransactionStatusInfo! non-null interface​

status information

InternalDirectDebitTransaction.paymentId ● String scalar​

ID of the payment associated to this transaction

InternalDirectDebitTransaction.payment ● Payment object​

payment associated to this transaction

InternalDirectDebitTransaction.createdAt ● DateTime! non-null scalar​

created date

InternalDirectDebitTransaction.updatedAt ● DateTime! non-null scalar​

updated date

InternalDirectDebitTransaction.counterparty ● String! non-null scalar​

name of the counterparty. e.g Merchant name, Creditor name, Beneficiary Name ...

InternalDirectDebitTransaction.bookedBalanceAfter ● Amount object​

booked balance after this transaction

InternalDirectDebitTransaction.paymentProduct ● PaymentProduct! non-null enum​

payment product used for this transaction

InternalDirectDebitTransaction.creditor ● InternalDirectDebitCreditor! non-null object​

creditor information

InternalDirectDebitTransaction.debtor ● InternalDirectDebitDebtor! non-null object​

debtor information

InternalDirectDebitTransaction.account ● Account object​

matching account for the transaction

InternalDirectDebitTransaction.mandate ● InternalDirectDebitMandate interface​

matching Internal mandate for the transaction

InternalDirectDebitTransaction.externalReference ● String scalar​

an arbitrary identifier that was defined by you when you created this transaction.

For example, you can define it in the CreditTransferInput mutation.

InternalDirectDebitTransaction.executionDate ● DateTime! non-null scalar​

a date that reflects the execution date of a transaction from a user viewpoint. Can be used for sorting transactions.

InternalDirectDebitTransaction.requestedExecutionAt ● DateTime scalar​

a date that reflects the time at which the user asked the transaction to be executed

InternalDirectDebitTransaction.originTransactionId ● String scalar​

ID of the origin transaction associated to this transaction

InternalDirectDebitTransaction.originTransaction ● Transaction interface​

origin transaction associated to this transaction

InternalDirectDebitTransaction.reservedAmount ● Amount object​

reserved amount of the transaction computed with the rolling reserve.

InternalDirectDebitTransaction.reservedAmountReleasedAt ● DateTime scalar​

date on which reserved funds become available.

InternalDirectDebitTransaction.returnReason ● TransactionReasonCode enum​

r-transaction reason

Interfaces​

Transaction interface​

Transaction

- + \ No newline at end of file diff --git a/api-reference/objects/internal-error-rejection/index.html b/api-reference/objects/internal-error-rejection/index.html index 3531ff5a1a6..81da2045c46 100644 --- a/api-reference/objects/internal-error-rejection/index.html +++ b/api-reference/objects/internal-error-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalErrorRejection

Rejection returned on unexpected server error

type InternalErrorRejection implements Rejection {
  message: String!
}

Fields​

InternalErrorRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddInternalDirectDebitPaymentMandatePayload union ● AddMerchantProfilePayload union ● AddSepaDirectDebitPaymentMandatePayload union ● CancelStandingOrderPayload union ● CancelVirtualIbanEntryPayload union ● CloseAccountPayload union ● CreateCapitalDepositCasePayload union ● CreateMerchantPaymentLinkPayload union ● DeleteSupportingDocumentPayload union ● DisableAccountMembershipPayload union ● FinalizeOnboardingPayload union ● GenerateCapitalDepositDocumentUploadUrlPayload union ● GenerateSupportingDocumentUploadUrlPayload union ● InitiateInternationalCreditTransferResponsePayload union ● InitiateMerchantPaymentCollectionPayload union ● RequestMerchantPaymentMethodsPayload union ● RequestMerchantProfileUpdatePayload union ● ScheduleStandingOrderPayload union ● SuspendAccountMembershipPayload union ● UpdateAccountPayload union ● UpdateCompanyOnboardingPayload union ● UpdateIndividualOnboardingPayload union ● UpdateSupportingDocumentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/internal-payment-direct-debit-mandate/index.html b/api-reference/objects/internal-payment-direct-debit-mandate/index.html index 5cf6e72774f..a07f30f0f15 100644 --- a/api-reference/objects/internal-payment-direct-debit-mandate/index.html +++ b/api-reference/objects/internal-payment-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalPaymentDirectDebitMandate

Payment direct debit mandate for Internal

type InternalPaymentDirectDebitMandate implements InternalDirectDebitMandate, PaymentDirectDebitMandate, PaymentMandate {
  id: ID!
  transactions(
  first: Int! = 50
  after: String
  filters: TransactionsFiltersInput
): TransactionConnection
  reference: String!
  scheme: InternalPaymentMandateScheme!
  statusInfo: PaymentMandateStatusInfo!
  sequence: InternalPaymentMandateSequence!
  mandateDocumentUrl: String!
  debtor: InternalPaymentMandateDebtor!
  ultimateCreditorName: String
  creditor: InternalPaymentMandateCreditor!
  signatureDate: Date
  createdAt: DateTime!
  updatedAt: DateTime!
  executedAt: DateTime
  expiredAt: Date
  accountHolder: AccountHolder!
  language: String!
  name: String
}

Fields​

InternalPaymentDirectDebitMandate.id ● ID! non-null scalar​

Unique identifier of the Internal Direct Debit Payment Mandate

InternalPaymentDirectDebitMandate.transactions ● TransactionConnection object​

List of transactions associated with the Internal Payment Direct Debit Mandate.

InternalPaymentDirectDebitMandate.transactions.first ● Int! non-null scalar​

number of elements in the list (default value 50)

InternalPaymentDirectDebitMandate.transactions.after ● String scalar​

When the list of elements needs to start after a element

InternalPaymentDirectDebitMandate.transactions.filters ● TransactionsFiltersInput input​

When the list of elements needs to be filtered

InternalPaymentDirectDebitMandate.reference ● String! non-null scalar​

Unique reference of the Internal Direct Debit Payment Mandate

InternalPaymentDirectDebitMandate.scheme ● InternalPaymentMandateScheme! non-null enum​

Internal Direct Debit Payment Mandate scheme

InternalPaymentDirectDebitMandate.statusInfo ● PaymentMandateStatusInfo! non-null interface​

Internal Direct Debit Payment Mandate status information

InternalPaymentDirectDebitMandate.sequence ● InternalPaymentMandateSequence! non-null enum​

Internal Direct Debit Payment Mandate sequence

InternalPaymentDirectDebitMandate.mandateDocumentUrl ● String! non-null scalar​

Internal Direct Debit Payment Mandate PDF document URL

InternalPaymentDirectDebitMandate.debtor ● InternalPaymentMandateDebtor! non-null object​

Internal Direct Debit Payment Mandate debtor information

InternalPaymentDirectDebitMandate.ultimateCreditorName ● String scalar​

Internal direct debit ultimate creditor name

InternalPaymentDirectDebitMandate.creditor ● InternalPaymentMandateCreditor! non-null object​

Internal Direct Debit Payment Mandate creditor information

InternalPaymentDirectDebitMandate.signatureDate ● Date scalar​

Signature date of the Internal Direct Debit Payment Mandate

InternalPaymentDirectDebitMandate.createdAt ● DateTime! non-null scalar​

Creation date of the Internal Direct Debit Payment Mandate

InternalPaymentDirectDebitMandate.updatedAt ● DateTime! non-null scalar​

Last Update date of the Internal Direct Debit Payment Mandate

InternalPaymentDirectDebitMandate.executedAt ● DateTime scalar​

Date of the the last transaction executed for the concerned Internal Direct Debit Payment Mandate

InternalPaymentDirectDebitMandate.expiredAt ● Date scalar​

Expiry date of the Internal Direct Debit Payment Mandate

InternalPaymentDirectDebitMandate.accountHolder ● AccountHolder! non-null object​

Account Holder information

InternalPaymentDirectDebitMandate.language ● String! non-null scalar​

Language that will be used to produce the mandate PDF document

InternalPaymentDirectDebitMandate.name ● String scalar​

Custom name of the mandate

Interfaces​

InternalDirectDebitMandate interface​

PaymentDirectDebitMandate interface​

PaymentMandate interface​

Member of​

AddInternalDirectDebitPaymentMandateSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/internal-payment-mandate-creditor/index.html b/api-reference/objects/internal-payment-mandate-creditor/index.html index 6577fb98d3c..8c5e85a4abe 100644 --- a/api-reference/objects/internal-payment-mandate-creditor/index.html +++ b/api-reference/objects/internal-payment-mandate-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalPaymentMandateCreditor

No description

type InternalPaymentMandateCreditor implements PaymentMandateCreditor {
  id: ID!
  identifier: ID!
  name: String!
  address: Address!
}

Fields​

InternalPaymentMandateCreditor.id ● ID! non-null scalar​

Internal Direct Debit Payment Mandate creditor UUID

InternalPaymentMandateCreditor.identifier ● ID! non-null scalar​

Internal Direct Debit Payment Mandate Creditor Idenfier

InternalPaymentMandateCreditor.name ● String! non-null scalar​

Internal Direct Debit Payment Mandate creditor name

InternalPaymentMandateCreditor.address ● Address! non-null object​

Internal Direct Debit Payment Mandate creditor address

Interfaces​

PaymentMandateCreditor interface​

Member of​

InternalPaymentDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/objects/internal-payment-mandate-debtor/index.html b/api-reference/objects/internal-payment-mandate-debtor/index.html index 20a7cd29291..e4a0f4da36d 100644 --- a/api-reference/objects/internal-payment-mandate-debtor/index.html +++ b/api-reference/objects/internal-payment-mandate-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalPaymentMandateDebtor

No description

type InternalPaymentMandateDebtor implements PaymentMandateDebtor {
  name: String!
  email: String!
  country: CCA3!
  address: Address
  accountId: ID
}

Fields​

InternalPaymentMandateDebtor.name ● String! non-null scalar​

Internal Direct Debit Payment Mandate debtor name

InternalPaymentMandateDebtor.email ● String! non-null scalar​

Internal Direct Debit Payment Mandate debtor e-mail

InternalPaymentMandateDebtor.country ● CCA3! non-null scalar​

Internal Direct Debit Payment Mandate debtor country

InternalPaymentMandateDebtor.address ● Address object​

Internal Direct Debit Payment Mandate debtor address. Mandatory for non EEA Countries

InternalPaymentMandateDebtor.accountId ● ID scalar​

Internal Direct Debit Payment Mandate debtor address. Mandatory for non EEA Countries

Interfaces​

PaymentMandateDebtor interface​

Member of​

InternalPaymentDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/objects/internal-received-direct-debit-mandate-creditor/index.html b/api-reference/objects/internal-received-direct-debit-mandate-creditor/index.html index bd76fd0695e..51752f756d7 100644 --- a/api-reference/objects/internal-received-direct-debit-mandate-creditor/index.html +++ b/api-reference/objects/internal-received-direct-debit-mandate-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalReceivedDirectDebitMandateCreditor

Internal received direct debit mandate creditor

type InternalReceivedDirectDebitMandateCreditor {
  identifier: String!
  name: String!
  address: Address!
}

Fields​

InternalReceivedDirectDebitMandateCreditor.identifier ● String! non-null scalar​

Creditor identifier

InternalReceivedDirectDebitMandateCreditor.name ● String! non-null scalar​

Name of the creditor

InternalReceivedDirectDebitMandateCreditor.address ● Address! non-null object​

Address of the creditor

Member of​

InternalReceivedDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/objects/internal-received-direct-debit-mandate/index.html b/api-reference/objects/internal-received-direct-debit-mandate/index.html index c2a09df990c..3a8e051cd17 100644 --- a/api-reference/objects/internal-received-direct-debit-mandate/index.html +++ b/api-reference/objects/internal-received-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternalReceivedDirectDebitMandate

Received direct debit mandate for SEPA

type InternalReceivedDirectDebitMandate implements InternalDirectDebitMandate, ReceivedDirectDebitMandate {
  id: ID!
  transactions(
  first: Int! = 50
  after: String
  filters: TransactionsFiltersInput
): TransactionConnection
  version: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  reference: String!
  scheme: InternalReceivedDirectDebitMandateScheme!
  sequence: InternalReceivedDirectDebitMandateSequence!
  creditor: InternalReceivedDirectDebitMandateCreditor!
  ultimateCreditorName: String
  executedAt: DateTime
  signatureDate: Date
  expiredAt: Date
  statusInfo: ReceivedDirectDebitMandateStatusInfo!
  account: Account
  iban: IBAN!
  name: String
}

Fields​

InternalReceivedDirectDebitMandate.id ● ID! non-null scalar​

Unique identifier of the received internal direct debit mandate, generated by Swan

InternalReceivedDirectDebitMandate.transactions ● TransactionConnection object​

List of transactions associated with the Internal Receive Direct Debit Mandate.

InternalReceivedDirectDebitMandate.transactions.first ● Int! non-null scalar​

number of elements in the list (default value 50)

InternalReceivedDirectDebitMandate.transactions.after ● String scalar​

When the list of elements needs to start after a element

InternalReceivedDirectDebitMandate.transactions.filters ● TransactionsFiltersInput input​

When the list of elements needs to be filtered

InternalReceivedDirectDebitMandate.version ● String! non-null scalar​

Version of the received internal direct debit mandate

InternalReceivedDirectDebitMandate.createdAt ● DateTime! non-null scalar​

Creation date of the received internal direct debit mandate

InternalReceivedDirectDebitMandate.updatedAt ● DateTime! non-null scalar​

Last Update date of the received internal direct debit mandate

InternalReceivedDirectDebitMandate.reference ● String! non-null scalar​

Received internal direct debit Unique Mandate Reference (UMR)

InternalReceivedDirectDebitMandate.scheme ● InternalReceivedDirectDebitMandateScheme! non-null enum​

Received internal direct debit mandate scheme

InternalReceivedDirectDebitMandate.sequence ● InternalReceivedDirectDebitMandateSequence! non-null enum​

Received internal direct debit mandate sequence

InternalReceivedDirectDebitMandate.creditor ● InternalReceivedDirectDebitMandateCreditor! non-null object​

Received internal direct debit creditor

InternalReceivedDirectDebitMandate.ultimateCreditorName ● String scalar​

Received internal direct debit ultimate creditor name

InternalReceivedDirectDebitMandate.executedAt ● DateTime scalar​

Date of the last internal direct debit transaction executed for the concerned received internal direct debit mandate

InternalReceivedDirectDebitMandate.signatureDate ● Date scalar​

Date of signature of the received internal direct debit mandate

InternalReceivedDirectDebitMandate.expiredAt ● Date scalar​

Expiry date of the received internal direct debit mandate, computed automatically (36 months from the executedAt date)

InternalReceivedDirectDebitMandate.statusInfo ● ReceivedDirectDebitMandateStatusInfo! non-null interface​

Mandate status information of the received internal direct debit mandate

InternalReceivedDirectDebitMandate.account ● Account object​

Account of the received internal direct debit mandate debtor

InternalReceivedDirectDebitMandate.iban ● IBAN! non-null scalar​

Iban of the received internal direct debit mandate debtor

InternalReceivedDirectDebitMandate.name ● String scalar​

Mandate name

Interfaces​

InternalDirectDebitMandate interface​

ReceivedDirectDebitMandate interface​

Interface for Received Direct Debit Mandate

- + \ No newline at end of file diff --git a/api-reference/objects/international-beneficiary-dynamic-forms/index.html b/api-reference/objects/international-beneficiary-dynamic-forms/index.html index 123bced30ab..08190f15728 100644 --- a/api-reference/objects/international-beneficiary-dynamic-forms/index.html +++ b/api-reference/objects/international-beneficiary-dynamic-forms/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/international-credit-transfer-currency-exchange/index.html b/api-reference/objects/international-credit-transfer-currency-exchange/index.html index 72e9fbac235..c7141a6bf74 100644 --- a/api-reference/objects/international-credit-transfer-currency-exchange/index.html +++ b/api-reference/objects/international-credit-transfer-currency-exchange/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternationalCreditTransferCurrencyExchange

International Currency Exchange / Quote

type InternationalCreditTransferCurrencyExchange {
  exchangeRate: String!
  feesAmount: Amount!
  sourceAmount: Amount!
  targetAmount: Amount!
}

Fields​

InternationalCreditTransferCurrencyExchange.exchangeRate ● String! non-null scalar​

Rate of the quote

InternationalCreditTransferCurrencyExchange.feesAmount ● Amount! non-null object​

Fees

InternationalCreditTransferCurrencyExchange.sourceAmount ● Amount! non-null object​

Source amount of the quote

InternationalCreditTransferCurrencyExchange.targetAmount ● Amount! non-null object​

target amount of the quote

Member of​

InternationalCreditTransferTransaction object

- + \ No newline at end of file diff --git a/api-reference/objects/international-credit-transfer-details/index.html b/api-reference/objects/international-credit-transfer-details/index.html index fa3853c62b9..0bc26cf774b 100644 --- a/api-reference/objects/international-credit-transfer-details/index.html +++ b/api-reference/objects/international-credit-transfer-details/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/international-credit-transfer-dynamic-form/index.html b/api-reference/objects/international-credit-transfer-dynamic-form/index.html index fad9eb4096e..87b3c5004b3 100644 --- a/api-reference/objects/international-credit-transfer-dynamic-form/index.html +++ b/api-reference/objects/international-credit-transfer-dynamic-form/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

InternationalCreditTransferDynamicForm

COMING SOON International Credit Transfer Dynamic Form

type InternationalCreditTransferDynamicForm {
  fields: [Field!]!
  remainingFieldsToRefreshCount: Int!
}

Fields​

InternationalCreditTransferDynamicForm.fields ● [Field!]! non-null interface​

List of international transaction fields

InternationalCreditTransferDynamicForm.remainingFieldsToRefreshCount ● Int! non-null scalar​

COMING SOON Number of fields that need to be updated to fill the form completely. Please re run the query internationalCreditTransferTransactionDetailsDynamicForm with updated refreshableFields if the value of this field is not 0

Returned by​

internationalCreditTransferTransactionDetailsDynamicForm query

- + \ No newline at end of file diff --git a/api-reference/objects/international-credit-transfer-out-creditor/index.html b/api-reference/objects/international-credit-transfer-out-creditor/index.html index 1523c066c15..74360b56800 100644 --- a/api-reference/objects/international-credit-transfer-out-creditor/index.html +++ b/api-reference/objects/international-credit-transfer-out-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternationalCreditTransferOutCreditor

International Credit Transfer Out - Creditor info

type InternationalCreditTransferOutCreditor {
  currency: Currency!
  details: [InternationalCreditTransferDetails!]!
  name: String!
  route: InternationalCreditTransferRoute!
}

Fields​

InternationalCreditTransferOutCreditor.currency ● Currency! non-null scalar​

Currency of the international beneficiary account

InternationalCreditTransferOutCreditor.details ● [InternationalCreditTransferDetails!]! non-null object​

Currency-specific details of the beneficiary

InternationalCreditTransferOutCreditor.name ● String! non-null scalar​

Account holder name

InternationalCreditTransferOutCreditor.route ● InternationalCreditTransferRoute! non-null enum​

Route that Wise will use to transfer the funds

Member of​

InternationalCreditTransferTransaction object

- + \ No newline at end of file diff --git a/api-reference/objects/international-credit-transfer-out-debtor/index.html b/api-reference/objects/international-credit-transfer-out-debtor/index.html index d6b07741446..e11d707e11c 100644 --- a/api-reference/objects/international-credit-transfer-out-debtor/index.html +++ b/api-reference/objects/international-credit-transfer-out-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/international-credit-transfer-quote/index.html b/api-reference/objects/international-credit-transfer-quote/index.html index 2016560dab3..fd6ecc00ff7 100644 --- a/api-reference/objects/international-credit-transfer-quote/index.html +++ b/api-reference/objects/international-credit-transfer-quote/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

InternationalCreditTransferQuote

COMING SOON International Quote

type InternationalCreditTransferQuote {
  exchangeRate: String!
  sourceAmount: Amount!
  targetAmount: Amount!
  feesAmount: Amount!
}

Fields​

InternationalCreditTransferQuote.exchangeRate ● String! non-null scalar​

Rate of the quote

InternationalCreditTransferQuote.sourceAmount ● Amount! non-null object​

Source amount of the quote

InternationalCreditTransferQuote.targetAmount ● Amount! non-null object​

target amount of the quote

InternationalCreditTransferQuote.feesAmount ● Amount! non-null object​

Fees

Returned by​

internationalCreditTransferQuote query

Member of​

InitiateInternationalCreditTransferResponseSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/international-credit-transfer-transaction/index.html b/api-reference/objects/international-credit-transfer-transaction/index.html index 46a5b3fed19..a175674072a 100644 --- a/api-reference/objects/international-credit-transfer-transaction/index.html +++ b/api-reference/objects/international-credit-transfer-transaction/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InternationalCreditTransferTransaction

No description

type InternationalCreditTransferTransaction implements Transaction {
  account: Account
  amount: Amount!
  bookedBalanceAfter: Amount
  counterparty: String!
  createdAt: DateTime!
  creditor: InternationalCreditTransferOutCreditor!
  debtor: InternationalCreditTransferOutDebtor!
  executionDate: DateTime!
  externalReference: String
  fees: Amount
  id: ID!
  label: String!
  originTransaction: Transaction
  originTransactionId: String
  payment: Payment
  paymentId: String
  paymentMethodIdentifier: String!
  paymentProduct: PaymentProduct!
  currencyExchange: InternationalCreditTransferCurrencyExchange!
  reference: String!
  requestedExecutionAt: DateTime
  side: TransactionSide!
  statusInfo: TransactionStatusInfo!
  type: TransactionTypeEnum!
  updatedAt: DateTime!
}

Fields​

InternationalCreditTransferTransaction.account ● Account object​

matching account for this transaction

InternationalCreditTransferTransaction.amount ● Amount! non-null object​

amount

InternationalCreditTransferTransaction.bookedBalanceAfter ● Amount object​

booked balance after this transaction

InternationalCreditTransferTransaction.counterparty ● String! non-null scalar​

name of the counterparty. e.g Merchant name, Creditor name, Beneficiary Name ...

InternationalCreditTransferTransaction.createdAt ● DateTime! non-null scalar​

created date

InternationalCreditTransferTransaction.creditor ● InternationalCreditTransferOutCreditor! non-null object​

creditor information

InternationalCreditTransferTransaction.debtor ● InternationalCreditTransferOutDebtor! non-null object​

debtor information

InternationalCreditTransferTransaction.executionDate ● DateTime! non-null scalar​

a date that reflects the execution date of a transaction from a user viewpoint. Can be used for sorting transactions.

InternationalCreditTransferTransaction.externalReference ● String scalar​

an arbitrary identifier that was defined by you when you created this transaction.

For example, you can define it in the CreditTransferInput mutation.

InternationalCreditTransferTransaction.fees ● Amount object​

@deprecated(reason: "use quote.feesAmount instead")

InternationalCreditTransferTransaction.id ● ID! non-null scalar​

unique identifier of the transaction

InternationalCreditTransferTransaction.label ● String! non-null scalar​

label

InternationalCreditTransferTransaction.originTransaction ● Transaction interface​

origin transaction associated to this transaction

InternationalCreditTransferTransaction.originTransactionId ● String scalar​

ID of the origin transaction associated to this transaction

InternationalCreditTransferTransaction.payment ● Payment object​

payment associated to this transaction

InternationalCreditTransferTransaction.paymentId ● String scalar​

ID of the payment associated to this transaction

InternationalCreditTransferTransaction.paymentMethodIdentifier ● String! non-null scalar​

payment method identifier used for this transaction. e.g masked PAN or IBAN or accountNumber

InternationalCreditTransferTransaction.paymentProduct ● PaymentProduct! non-null enum​

payment product used for this transaction

InternationalCreditTransferTransaction.currencyExchange ● InternationalCreditTransferCurrencyExchange! non-null object​

quote given by our international provider

InternationalCreditTransferTransaction.reference ● String! non-null scalar​

external identifier of the transaction

InternationalCreditTransferTransaction.requestedExecutionAt ● DateTime scalar​

a date that reflects the time at which the user asked the transaction to be executed

InternationalCreditTransferTransaction.side ● TransactionSide! non-null enum​

side (Credit or Debit)

InternationalCreditTransferTransaction.statusInfo ● TransactionStatusInfo! non-null interface​

status information

InternationalCreditTransferTransaction.type ● TransactionTypeEnum! non-null enum​

type

InternationalCreditTransferTransaction.updatedAt ● DateTime! non-null scalar​

updated date

Interfaces​

Transaction interface​

Transaction

- + \ No newline at end of file diff --git a/api-reference/objects/invalid-argument-rejection-field/index.html b/api-reference/objects/invalid-argument-rejection-field/index.html index ab834ead0f7..2415caf59e2 100644 --- a/api-reference/objects/invalid-argument-rejection-field/index.html +++ b/api-reference/objects/invalid-argument-rejection-field/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/invalid-argument-rejection/index.html b/api-reference/objects/invalid-argument-rejection/index.html index 213e6159317..57366ef51d3 100644 --- a/api-reference/objects/invalid-argument-rejection/index.html +++ b/api-reference/objects/invalid-argument-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InvalidArgumentRejection

Rejection returned on invalid argument error

type InvalidArgumentRejection implements Rejection {
  message: String!
  code: InvalidArgumentRejectionCode!
  fields: [InvalidArgumentRejectionField!]!
}

Fields​

InvalidArgumentRejection.message ● String! non-null scalar​

InvalidArgumentRejection.code ● InvalidArgumentRejectionCode! non-null enum​

InvalidArgumentRejection.fields ● [InvalidArgumentRejectionField!]! non-null object​

Interfaces​

Rejection interface​

Implemented by​

DenySddPayload union ● ScheduleStandingOrderPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/invalid-iban/index.html b/api-reference/objects/invalid-iban/index.html index d66e75d6b0a..bc56a622377 100644 --- a/api-reference/objects/invalid-iban/index.html +++ b/api-reference/objects/invalid-iban/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/invalid-identification-level-status-info/index.html b/api-reference/objects/invalid-identification-level-status-info/index.html index 3c53b676376..3904f4bdbac 100644 --- a/api-reference/objects/invalid-identification-level-status-info/index.html +++ b/api-reference/objects/invalid-identification-level-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InvalidIdentificationLevelStatusInfo

Describes an invalid identification level for the process associated to this identification, and the invalid reason can be accessed

type InvalidIdentificationLevelStatusInfo {
  status: SwanIdentificationStatus!
  reasons: [IdentificationInvalidReason!]
}

Fields​

InvalidIdentificationLevelStatusInfo.status ● SwanIdentificationStatus! non-null enum​

Always set to Invalid

InvalidIdentificationLevelStatusInfo.reasons ● [IdentificationInvalidReason!] list enum​

The reasons why this identification level is invalid

Implemented by​

IdentificationLevelStatusInfo union

- + \ No newline at end of file diff --git a/api-reference/objects/invalid-phone-number-rejection/index.html b/api-reference/objects/invalid-phone-number-rejection/index.html index ab0a4591170..c7845c784fc 100644 --- a/api-reference/objects/invalid-phone-number-rejection/index.html +++ b/api-reference/objects/invalid-phone-number-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/invalid-siren-number-rejection/index.html b/api-reference/objects/invalid-siren-number-rejection/index.html index 5d0e2e6706b..ce70956c46d 100644 --- a/api-reference/objects/invalid-siren-number-rejection/index.html +++ b/api-reference/objects/invalid-siren-number-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/invoice-connection/index.html b/api-reference/objects/invoice-connection/index.html index e45d4aaccda..df33bc75620 100644 --- a/api-reference/objects/invoice-connection/index.html +++ b/api-reference/objects/invoice-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InvoiceConnection

Please see the Connection interface

type InvoiceConnection implements Connection {
  pageInfo: PageInfo!
  totalCount: Int!
  edges: [InvoiceEdge!]!
}

Fields​

InvoiceConnection.pageInfo ● PageInfo! non-null object​

InvoiceConnection.totalCount ● Int! non-null scalar​

InvoiceConnection.edges ● [InvoiceEdge!]! non-null object​

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

Account object

- + \ No newline at end of file diff --git a/api-reference/objects/invoice-edge/index.html b/api-reference/objects/invoice-edge/index.html index 4064ad6e8ca..c5b387aeb26 100644 --- a/api-reference/objects/invoice-edge/index.html +++ b/api-reference/objects/invoice-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

InvoiceEdge

Please see the Edge interface

type InvoiceEdge implements Edge {
  node: Invoice!
  cursor: String!
}

Fields​

InvoiceEdge.node ● Invoice! non-null object​

InvoiceEdge.cursor ● String! non-null scalar​

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

InvoiceConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/invoice/index.html b/api-reference/objects/invoice/index.html index 80769950ba4..35205fc1f6b 100644 --- a/api-reference/objects/invoice/index.html +++ b/api-reference/objects/invoice/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Invoice

Invoice

type Invoice {
  id: ID!
  accountId: ID!
  name: String!
  type: InvoiceType!
  status: InvoiceStatus!
  amount: Amount!
  url: String
  expiresAt: DateTime
  openingDate: DateTime!
  closingDate: DateTime!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

Invoice.id ● ID! non-null scalar​

unique id

Invoice.accountId ● ID! non-null scalar​

account id

Invoice.name ● String! non-null scalar​

name of the invoice

Invoice.type ● InvoiceType! non-null enum​

type of the invoice

Invoice.status ● InvoiceStatus! non-null enum​

status of the invoice

Invoice.amount ● Amount! non-null object​

due amount

Invoice.url ● String scalar​

temporary public url on which the file can be accessible

Invoice.expiresAt ● DateTime scalar​

date at which the link will not be useable anymore

Invoice.openingDate ● DateTime! non-null scalar​

starting date of the billing window

Invoice.closingDate ● DateTime! non-null scalar​

ending date of the billing window

Invoice.createdAt ● DateTime! non-null scalar​

creation date

Invoice.updatedAt ● DateTime! non-null scalar​

last update date

Returned by​

accountInvoice query

Member of​

InvoiceEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/legal-document-active-status-info/index.html b/api-reference/objects/legal-document-active-status-info/index.html index 58a88bc2dd7..b36a48fbc5c 100644 --- a/api-reference/objects/legal-document-active-status-info/index.html +++ b/api-reference/objects/legal-document-active-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

LegalDocumentActiveStatusInfo

No description

type LegalDocumentActiveStatusInfo implements LegalDocumentStatusInfo {
  status: LegalDocumentStatus!
  createdAt: DateTime!
  activatedAt: DateTime
}

Fields​

LegalDocumentActiveStatusInfo.status ● LegalDocumentStatus! non-null enum​

LegalDocument status (always Active for type LegalDocumentActiveStatusInfo)

LegalDocumentActiveStatusInfo.createdAt ● DateTime! non-null scalar​

Creation date

LegalDocumentActiveStatusInfo.activatedAt ● DateTime scalar​

Activation date

Interfaces​

LegalDocumentStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/legal-document-connection/index.html b/api-reference/objects/legal-document-connection/index.html index 7a7f0494f16..487dd2bdfbd 100644 --- a/api-reference/objects/legal-document-connection/index.html +++ b/api-reference/objects/legal-document-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

LegalDocumentConnection

No description

type LegalDocumentConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [LegalDocumentEdge!]!
}

Fields​

LegalDocumentConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

LegalDocumentConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

LegalDocumentConnection.edges ● [LegalDocumentEdge!]! non-null object​

LegalDocumentEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

Account object

- + \ No newline at end of file diff --git a/api-reference/objects/legal-document-edge/index.html b/api-reference/objects/legal-document-edge/index.html index 38820a1c784..e44305a3826 100644 --- a/api-reference/objects/legal-document-edge/index.html +++ b/api-reference/objects/legal-document-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

LegalDocumentEdge

No description

type LegalDocumentEdge implements Edge {
  cursor: String!
  node: LegalDocument!
}

Fields​

LegalDocumentEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

LegalDocumentEdge.node ● LegalDocument! non-null object​

The account membership

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

LegalDocumentConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/legal-document-inactive-status-info/index.html b/api-reference/objects/legal-document-inactive-status-info/index.html index 1afa757ddba..a6667e2f162 100644 --- a/api-reference/objects/legal-document-inactive-status-info/index.html +++ b/api-reference/objects/legal-document-inactive-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

LegalDocumentInactiveStatusInfo

No description

type LegalDocumentInactiveStatusInfo implements LegalDocumentStatusInfo {
  status: LegalDocumentStatus!
  createdAt: DateTime!
  activatedAt: DateTime
  deactivatedAt: DateTime
}

Fields​

LegalDocumentInactiveStatusInfo.status ● LegalDocumentStatus! non-null enum​

LegalDocument status (always Inactive for type LegalDocumentInactiveStatusInfo)

LegalDocumentInactiveStatusInfo.createdAt ● DateTime! non-null scalar​

Creation date

LegalDocumentInactiveStatusInfo.activatedAt ● DateTime scalar​

Activation date

LegalDocumentInactiveStatusInfo.deactivatedAt ● DateTime scalar​

Deactivation date

Interfaces​

LegalDocumentStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/legal-document-upcoming-status-info/index.html b/api-reference/objects/legal-document-upcoming-status-info/index.html index 15ee1113959..4b38e560858 100644 --- a/api-reference/objects/legal-document-upcoming-status-info/index.html +++ b/api-reference/objects/legal-document-upcoming-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

LegalDocumentUpcomingStatusInfo

No description

type LegalDocumentUpcomingStatusInfo implements LegalDocumentStatusInfo {
  status: LegalDocumentStatus!
  createdAt: DateTime!
  effectiveDate: DateTime
}

Fields​

LegalDocumentUpcomingStatusInfo.status ● LegalDocumentStatus! non-null enum​

LegalDocument status (always Upcoming for type LegalDocumentUpcomingStatusInfo)

LegalDocumentUpcomingStatusInfo.createdAt ● DateTime! non-null scalar​

Creation date

LegalDocumentUpcomingStatusInfo.effectiveDate ● DateTime scalar​

Date when the LegalDocument will be activated

Interfaces​

LegalDocumentStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/legal-document/index.html b/api-reference/objects/legal-document/index.html index f6269adb419..87454f0468e 100644 --- a/api-reference/objects/legal-document/index.html +++ b/api-reference/objects/legal-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

LegalDocument

No description

type LegalDocument {
  id: ID!
  type: LegalDocumentType!
  statusInfo: LegalDocumentStatusInfo!
  language: AccountLanguage!
  url: String!
}

Fields​

LegalDocument.id ● ID! non-null scalar​

ID of the legal document

LegalDocument.type ● LegalDocumentType! non-null enum​

Type of the legal document

LegalDocument.statusInfo ● LegalDocumentStatusInfo! non-null interface​

Status of the Legal Document

LegalDocument.language ● AccountLanguage! non-null enum​

Language of the Legal Document

LegalDocument.url ● String! non-null scalar​

Url to download the Document

Member of​

LegalDocumentEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/legal-representative-account-membership-cannot-be-disabled-rejection/index.html b/api-reference/objects/legal-representative-account-membership-cannot-be-disabled-rejection/index.html index 0c9a0805b9d..1aa22114eec 100644 --- a/api-reference/objects/legal-representative-account-membership-cannot-be-disabled-rejection/index.html +++ b/api-reference/objects/legal-representative-account-membership-cannot-be-disabled-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

LegalRepresentativeAccountMembershipCannotBeDisabledRejection

No description

type LegalRepresentativeAccountMembershipCannotBeDisabledRejection implements Rejection {
  accountMembershipId: String!
  message: String!
}

Fields​

LegalRepresentativeAccountMembershipCannotBeDisabledRejection.accountMembershipId ● String! non-null scalar​

LegalRepresentativeAccountMembershipCannotBeDisabledRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

DisableAccountMembershipPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/legal-representative-account-membership-cannot-be-suspended-rejection/index.html b/api-reference/objects/legal-representative-account-membership-cannot-be-suspended-rejection/index.html index 3dc3dce8516..13c4ceb61d5 100644 --- a/api-reference/objects/legal-representative-account-membership-cannot-be-suspended-rejection/index.html +++ b/api-reference/objects/legal-representative-account-membership-cannot-be-suspended-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

LegalRepresentativeAccountMembershipCannotBeSuspendedRejection

No description

type LegalRepresentativeAccountMembershipCannotBeSuspendedRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

LegalRepresentativeAccountMembershipCannotBeSuspendedRejection.id ● String! non-null scalar​

LegalRepresentativeAccountMembershipCannotBeSuspendedRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

SuspendAccountMembershipPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/merchant-payment-link/index.html b/api-reference/objects/merchant-payment-link/index.html index 294ddebc12c..0616067efbe 100644 --- a/api-reference/objects/merchant-payment-link/index.html +++ b/api-reference/objects/merchant-payment-link/index.html @@ -7,7 +7,7 @@ - + @@ -22,7 +22,7 @@ depending on the payment method the end user chooses. Keep in mind that your end customer will be able to edit these fields.

MerchantPaymentLink.paymentMethods ● [MerchantPaymentMethod!]! non-null interface​

List of payment methods IDs enabled for this payment link. If the array is empty Swan will allow all the payment methods that are enabled for the merchant profile (except for Check and Internal Direct Debit)

Member of​

CreateMerchantPaymentLinkSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/merchant-payment-method-not-active-rejection/index.html b/api-reference/objects/merchant-payment-method-not-active-rejection/index.html index 965d703c718..a55617ea3d1 100644 --- a/api-reference/objects/merchant-payment-method-not-active-rejection/index.html +++ b/api-reference/objects/merchant-payment-method-not-active-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantPaymentMethodNotActiveRejection

Rejection returned when the Merchant Payment Method is not active

type MerchantPaymentMethodNotActiveRejection implements Rejection {
  paymentMethodIds: [String!]
  message: String!
}

Fields​

MerchantPaymentMethodNotActiveRejection.paymentMethodIds ● [String!] list scalar​

MerchantPaymentMethodNotActiveRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

CreateMerchantPaymentLinkPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/merchant-profile-connection/index.html b/api-reference/objects/merchant-profile-connection/index.html index 22496ab5cf4..600578bd74e 100644 --- a/api-reference/objects/merchant-profile-connection/index.html +++ b/api-reference/objects/merchant-profile-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantProfileConnection

No description

type MerchantProfileConnection implements Connection {
  pageInfo: PageInfo!
  edges: [MerchantProfileEdge!]!
  totalCount: Int!
}

Fields​

MerchantProfileConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

MerchantProfileConnection.edges ● [MerchantProfileEdge!]! non-null object​

Edge list

MerchantProfileConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

Account object

- + \ No newline at end of file diff --git a/api-reference/objects/merchant-profile-edge/index.html b/api-reference/objects/merchant-profile-edge/index.html index 05458aee927..c6f1d674c97 100644 --- a/api-reference/objects/merchant-profile-edge/index.html +++ b/api-reference/objects/merchant-profile-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

MerchantProfileEdge

No description

type MerchantProfileEdge implements Edge {
  node: MerchantProfile!
  cursor: String!
}

Fields​

MerchantProfileEdge.node ● MerchantProfile! non-null object​

MerchantProfileEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

MerchantProfileConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/merchant-profile-wrong-status-rejection/index.html b/api-reference/objects/merchant-profile-wrong-status-rejection/index.html index 29ca895a337..9372a785e17 100644 --- a/api-reference/objects/merchant-profile-wrong-status-rejection/index.html +++ b/api-reference/objects/merchant-profile-wrong-status-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantProfileWrongStatusRejection

Rejection returned when the Merchant Profile is not in the expected status

type MerchantProfileWrongStatusRejection implements Rejection {
  message: String!
  currentStatus: MerchantProfileStatus!
  expectedStatus: MerchantProfileStatus!
}

Fields​

MerchantProfileWrongStatusRejection.message ● String! non-null scalar​

MerchantProfileWrongStatusRejection.currentStatus ● MerchantProfileStatus! non-null enum​

MerchantProfileWrongStatusRejection.expectedStatus ● MerchantProfileStatus! non-null enum​

Interfaces​

Rejection interface​

Implemented by​

CreateMerchantPaymentLinkPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/merchant-profile/index.html b/api-reference/objects/merchant-profile/index.html index 49a2be23424..3e143bec33d 100644 --- a/api-reference/objects/merchant-profile/index.html +++ b/api-reference/objects/merchant-profile/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MerchantProfile

Merchant Profile

type MerchantProfile {
  id: ID!
  accountId: ID!
  merchantName: String!
  merchantWebsite: String
  merchantLogoUrl: String
  statusInfo: MerchantProfileStatusInfo!
  productType: ProductType!
  expectedMonthlyPaymentVolume: Amount!
  merchantPaymentMethods: [MerchantPaymentMethod!]
  requestedMerchantProfileUpdates: [RequestMerchantProfileUpdate!]
  expectedAverageBasket: Amount!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

MerchantProfile.id ● ID! non-null scalar​

The Merchant Profile ID

MerchantProfile.accountId ● ID! non-null scalar​

The Account ID this Merchant Profile is linked to

MerchantProfile.merchantName ● String! non-null scalar​

Business name of the merchant, i.e. name that will be displayed on debtors' bank statements

MerchantProfile.merchantWebsite ● String scalar​

Url of the merchant's website

MerchantProfile.merchantLogoUrl ● String scalar​

Url of the merchant's logo

MerchantProfile.statusInfo ● MerchantProfileStatusInfo! non-null interface​

The status of the merchant profile

MerchantProfile.productType ● ProductType! non-null enum​

Type of product sold. List of value: Goods, Services, VirtualGoods, GiftsAndDonations. Gifts and donations can be club subscription or collection of donations (for associations), tips collection, contributions for local authorities

MerchantProfile.expectedMonthlyPaymentVolume ● Amount! non-null object​

Expected annual activity volumes for all payment method

MerchantProfile.merchantPaymentMethods ● [MerchantPaymentMethod!] list interface​

Payment Methods associated

MerchantProfile.requestedMerchantProfileUpdates ● [RequestMerchantProfileUpdate!] list object​

Updates Requested associated

MerchantProfile.expectedAverageBasket ● Amount! non-null object​

expected average basket value.

MerchantProfile.createdAt ● DateTime! non-null scalar​

created date

MerchantProfile.updatedAt ● DateTime! non-null scalar​

updated date

Returned by​

merchantProfile query

Member of​

AddMerchantProfileSuccessPayload object ● MerchantProfileEdge object ● RequestMerchantPaymentMethodsSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/missing-mandatory-field-rejection/index.html b/api-reference/objects/missing-mandatory-field-rejection/index.html index b74c807c68a..2273fa92b58 100644 --- a/api-reference/objects/missing-mandatory-field-rejection/index.html +++ b/api-reference/objects/missing-mandatory-field-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

MissingMandatoryFieldRejection

Rejection returned when mandatory fields are missing from the call.

type MissingMandatoryFieldRejection implements Rejection {
  message: String!
}

Fields​

MissingMandatoryFieldRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddCardPayload union ● AddCardsPayload union ● AddCardsWithGroupDeliveryPayload union ● AddDigitalCardPayload union ● AddSingleUseVirtualCardPayload union ● AddSingleUseVirtualCardsPayload union ● PrintPhysicalCardPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/not-found-rejection/index.html b/api-reference/objects/not-found-rejection/index.html index 569a3057842..dd1dd27ca6d 100644 --- a/api-reference/objects/not-found-rejection/index.html +++ b/api-reference/objects/not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

NotFoundRejection

Rejection returned if the entity was not found or if the user does not have the rights to know that the account exists

type NotFoundRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

NotFoundRejection.id ● String! non-null scalar​

NotFoundRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

AddDirectDebitFundingSourcePayload union ● AddInternalDirectDebitPaymentMandatePayload union ● AddSepaDirectDebitPaymentMandatePayload union ● CancelFundingSourcePayload union ● InitiateMerchantPaymentCollectionPayload union ● RequestMerchantPaymentMethodsPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/not-reachable-consent-status-rejection/index.html b/api-reference/objects/not-reachable-consent-status-rejection/index.html index 09acc84a557..a5b87f0fc41 100644 --- a/api-reference/objects/not-reachable-consent-status-rejection/index.html +++ b/api-reference/objects/not-reachable-consent-status-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

NotReachableConsentStatusRejection

Rejection returned when consent status couldn't change

type NotReachableConsentStatusRejection implements Rejection {
  message: String!
  currentStatus: ConsentStatus
  unreachableStatus: ConsentStatus
}

Fields​

NotReachableConsentStatusRejection.message ● String! non-null scalar​

NotReachableConsentStatusRejection.currentStatus ● ConsentStatus enum​

NotReachableConsentStatusRejection.unreachableStatus ● ConsentStatus enum​

Interfaces​

Rejection interface​

Implemented by​

CancelConsentPayload union ● GrantConsentWithServerSignaturePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/not-started-identification-level-status-info/index.html b/api-reference/objects/not-started-identification-level-status-info/index.html index 8ee3b6163d3..67dce28a972 100644 --- a/api-reference/objects/not-started-identification-level-status-info/index.html +++ b/api-reference/objects/not-started-identification-level-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/not-supported-country-rejection/index.html b/api-reference/objects/not-supported-country-rejection/index.html index 2e83407112e..29e0672c738 100644 --- a/api-reference/objects/not-supported-country-rejection/index.html +++ b/api-reference/objects/not-supported-country-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/not-supported-identification-level-status-info/index.html b/api-reference/objects/not-supported-identification-level-status-info/index.html index 7fb6909e1d3..1db63bcc53f 100644 --- a/api-reference/objects/not-supported-identification-level-status-info/index.html +++ b/api-reference/objects/not-supported-identification-level-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/oauth-redirect-parameters/index.html b/api-reference/objects/oauth-redirect-parameters/index.html index 31d46b2532e..3027729f3dc 100644 --- a/api-reference/objects/oauth-redirect-parameters/index.html +++ b/api-reference/objects/oauth-redirect-parameters/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OAuthRedirectParameters

Extra parameters provided by partner

type OAuthRedirectParameters {
  state: String
  redirectUrl: String
}

Fields​

OAuthRedirectParameters.state ● String scalar​

Custom state provided by partner to prevent XSRF attack, will be filled by onBoardingId in case of nullity.

OAuthRedirectParameters.redirectUrl ● String scalar​

URL used to redirect the user at the end of the onboarding process. If null the user is redirected to the white label web banking.

Member of​

Onboarding object ● OnboardingInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/onboard-company-account-holder-success-payload/index.html b/api-reference/objects/onboard-company-account-holder-success-payload/index.html index de38b03929c..3e736d248c7 100644 --- a/api-reference/objects/onboard-company-account-holder-success-payload/index.html +++ b/api-reference/objects/onboard-company-account-holder-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/onboard-individual-account-holder-success-payload/index.html b/api-reference/objects/onboard-individual-account-holder-success-payload/index.html index c7624b0dc2d..259080516b6 100644 --- a/api-reference/objects/onboard-individual-account-holder-success-payload/index.html +++ b/api-reference/objects/onboard-individual-account-holder-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/onboarding-company-account-holder-info/index.html b/api-reference/objects/onboarding-company-account-holder-info/index.html index fb39b21b8cd..b968bc0d4ab 100644 --- a/api-reference/objects/onboarding-company-account-holder-info/index.html +++ b/api-reference/objects/onboarding-company-account-holder-info/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

OnboardingCompanyAccountHolderInfo

Company Account Holder Information

type OnboardingCompanyAccountHolderInfo implements OnboardingAccountHolderInfo {
  type: AccountHolderType!
  name: String
  registrationNumber: String
  companyType: CompanyType
  businessActivity: BusinessActivity
  businessActivityDescription: String
  monthlyPaymentVolume: MonthlyPaymentVolume
  individualUltimateBeneficialOwners: [IndividualUltimateBeneficialOwner!]
  residencyAddress: AddressInfo
  isRegistered: Boolean
  vatNumber: String
  taxIdentificationNumber: String
  legalRepresentativePersonalAddress: AddressInformation
  typeOfRepresentation: TypeOfRepresentation
}

Fields​

OnboardingCompanyAccountHolderInfo.type ● AccountHolderType! non-null enum​

Account holder type (always Company for type OnboardingCompanyAccountHolderInfo)

OnboardingCompanyAccountHolderInfo.name ● String scalar​

name of the company

OnboardingCompanyAccountHolderInfo.registrationNumber ● String scalar​

registration number of the company (SIRET, ...)

OnboardingCompanyAccountHolderInfo.companyType ● CompanyType enum​

legal form of the company (SAS, SCI, SASU, ...)

OnboardingCompanyAccountHolderInfo.businessActivity ● BusinessActivity enum​

business activity

OnboardingCompanyAccountHolderInfo.businessActivityDescription ● String scalar​

business activity description This must be 1024 characters long maximum.

OnboardingCompanyAccountHolderInfo.monthlyPaymentVolume ● MonthlyPaymentVolume enum​

estimated monthly payment volume (euro)

OnboardingCompanyAccountHolderInfo.individualUltimateBeneficialOwners ● [IndividualUltimateBeneficialOwner!] list object​

The ultimate beneficiary is defined as the natural person (s) who own or control, directly or indirectly, the reporting company.

The ultimate beneficiary is :

  • either the natural person (s) who hold, directly or indirectly, more than 25% of the capital or the rights of vote of the reporting company;
  • either the natural person (s) who exercise, by other means, a power of control of the company;

OnboardingCompanyAccountHolderInfo.residencyAddress ● AddressInfo object​

residency address of the head office (Must be in a European country)

OnboardingCompanyAccountHolderInfo.isRegistered ● Boolean scalar​

Is company registered at RCS in its country

OnboardingCompanyAccountHolderInfo.vatNumber ● String scalar​

Unique number that identifies a taxable person (business) or non-taxable legal entity that is registered for VAT

OnboardingCompanyAccountHolderInfo.taxIdentificationNumber ● String scalar​

Tax Identification Number

OnboardingCompanyAccountHolderInfo.legalRepresentativePersonalAddress ● AddressInformation object​

Legal representative personal address

OnboardingCompanyAccountHolderInfo.typeOfRepresentation ● TypeOfRepresentation enum​

Type of representation (legal representative or power of attorney)

Interfaces​

OnboardingAccountHolderInfo interface​

The onboarding could be for an Individual or a company

- + \ No newline at end of file diff --git a/api-reference/objects/onboarding-connection/index.html b/api-reference/objects/onboarding-connection/index.html index 4b6ab350eb5..824120fd6db 100644 --- a/api-reference/objects/onboarding-connection/index.html +++ b/api-reference/objects/onboarding-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardingConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type OnboardingConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [OnboardingEdge!]!
}

Fields​

OnboardingConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

OnboardingConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

OnboardingConnection.edges ● [OnboardingEdge!]! non-null object​

OnboardingEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

onboardings query

- + \ No newline at end of file diff --git a/api-reference/objects/onboarding-edge/index.html b/api-reference/objects/onboarding-edge/index.html index cde21870335..e23d7844300 100644 --- a/api-reference/objects/onboarding-edge/index.html +++ b/api-reference/objects/onboarding-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

OnboardingEdge

Implements the Relay Edge interface

type OnboardingEdge implements Edge {
  cursor: String!
  node: Onboarding!
}

Fields​

OnboardingEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this onboarding node in the pagination mechanism

OnboardingEdge.node ● Onboarding! non-null object​

The Onboarding

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

OnboardingConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/onboarding-finalized-status-info/index.html b/api-reference/objects/onboarding-finalized-status-info/index.html index 72db72e4ccb..1d2577763b2 100644 --- a/api-reference/objects/onboarding-finalized-status-info/index.html +++ b/api-reference/objects/onboarding-finalized-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/onboarding-individual-account-holder-info/index.html b/api-reference/objects/onboarding-individual-account-holder-info/index.html index 58a4f07e04f..9824c2aec58 100644 --- a/api-reference/objects/onboarding-individual-account-holder-info/index.html +++ b/api-reference/objects/onboarding-individual-account-holder-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardingIndividualAccountHolderInfo

Individual Account Holder Information

type OnboardingIndividualAccountHolderInfo implements OnboardingAccountHolderInfo {
  type: AccountHolderType!
  employmentStatus: EmploymentStatus
  monthlyIncome: MonthlyIncome
  residencyAddress: AddressInfo
  taxIdentificationNumber: String
}

Fields​

OnboardingIndividualAccountHolderInfo.type ● AccountHolderType! non-null enum​

Account holder type (always Individual for type OnboardingIndividualAccountHolderInfo)

OnboardingIndividualAccountHolderInfo.employmentStatus ● EmploymentStatus enum​

employment status of the individual account holder

OnboardingIndividualAccountHolderInfo.monthlyIncome ● MonthlyIncome enum​

monthly income of the individual account holder

OnboardingIndividualAccountHolderInfo.residencyAddress ● AddressInfo object​

residency address of the individual account holder (must be in a European country)

OnboardingIndividualAccountHolderInfo.taxIdentificationNumber ● String scalar​

Tax Identification Number

Interfaces​

OnboardingAccountHolderInfo interface​

The onboarding could be for an Individual or a company

- + \ No newline at end of file diff --git a/api-reference/objects/onboarding-info/index.html b/api-reference/objects/onboarding-info/index.html index 04c9d61b088..14bbadd59fe 100644 --- a/api-reference/objects/onboarding-info/index.html +++ b/api-reference/objects/onboarding-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardingInfo

No description

type OnboardingInfo {
  id: String!
  accountName: String
  accountCountry: AccountCountry
  email: String
  language: String
  info: OnboardingAccountHolderInfo!
  onboardingUrl: String!
  onboardingState: OnboardingState
  redirectUrl: String!
  projectInfo: ProjectInfo
  verificationFlow: VerificationFlow!
  oAuthRedirectParameters: OAuthRedirectParameters
  statusInfo: OnboardingStatusInfo!
  supportingDocumentCollection: SupportingDocumentCollection!
  legalRepresentativeAcceptedIdentificationLevels: [IdentificationLevel]!
  legalRepresentativeRecommendedIdentificationLevel: IdentificationLevel!
  tcuUrl: String!
}

Fields​

OnboardingInfo.id ● String! non-null scalar​

Unique identifier of an onboarding

OnboardingInfo.accountName ● String scalar​

Account name

OnboardingInfo.accountCountry ● AccountCountry enum​

Country of the account that will be created at the end of the onboarding process

OnboardingInfo.email ● String scalar​

email

OnboardingInfo.language ● String scalar​

language of the onboarding process. This consists of a 2-3 letter base language tag representing the language, optionally followed by additional subtags separated by '-'. The most common extra information is the country or region variant (like 'en-US' or 'fr-CA') or the type of alphabet to use (like 'sr-Latn'). Other variants like the type of orthography ('de-DE-1996') are usually not used in the context of this header. Learn More

OnboardingInfo.info ● OnboardingAccountHolderInfo! non-null interface​

Information regarding the Individual or the company to onboard

OnboardingInfo.onboardingUrl ● String! non-null scalar​

Redirect the legal representative of a new account holder to this URL to start the onboarding process

OnboardingInfo.onboardingState ● OnboardingState enum​

Current computed state of onboarding

OnboardingInfo.redirectUrl ● String! non-null scalar​

URL used to redirect the user at the end of the onboarding process. If null the user is redirected to the white label web banking.

OnboardingInfo.projectInfo ● ProjectInfo object​

Project infos you set in the dashboard

OnboardingInfo.verificationFlow ● VerificationFlow! non-null enum​

Verification Flow

OnboardingInfo.oAuthRedirectParameters ● OAuthRedirectParameters object​

Extra parameters provided by partner

OnboardingInfo.statusInfo ● OnboardingStatusInfo! non-null interface​

Status (valid/invalid/finalized) and details of errors on fields

OnboardingInfo.supportingDocumentCollection ● SupportingDocumentCollection! non-null object​

Supporting document collection related to onboarding.

OnboardingInfo.legalRepresentativeAcceptedIdentificationLevels ● [IdentificationLevel]! non-null enum​

List of accepted identification level for the legal representative

OnboardingInfo.legalRepresentativeRecommendedIdentificationLevel ● IdentificationLevel! non-null enum​

Recommended identification level for the legal representative

OnboardingInfo.tcuUrl ● String! non-null scalar​

Swan TCU URL

Member of​

UpdateCompanyOnboardingSuccessPayload object ● UpdateIndividualOnboardingSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/onboarding-invalid-status-info/index.html b/api-reference/objects/onboarding-invalid-status-info/index.html index 494850b0f32..86e0950e9ac 100644 --- a/api-reference/objects/onboarding-invalid-status-info/index.html +++ b/api-reference/objects/onboarding-invalid-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardingInvalidStatusInfo

StatusInfo when onboarding has still at least one incorrect field

type OnboardingInvalidStatusInfo implements OnboardingStatusInfo {
  status: OnboardingStatus!
  errors: [ValidationError!]!
}

Fields​

OnboardingInvalidStatusInfo.status ● OnboardingStatus! non-null enum​

OnboardingInvalidStatusInfo.errors ● [ValidationError!]! non-null object​

Interfaces​

OnboardingStatusInfo interface​

Object containing details about onboarding status (valid/invalid and why it is invalid/already finalized)

- + \ No newline at end of file diff --git a/api-reference/objects/onboarding-not-completed-rejection/index.html b/api-reference/objects/onboarding-not-completed-rejection/index.html index cef6655b378..60dd6876790 100644 --- a/api-reference/objects/onboarding-not-completed-rejection/index.html +++ b/api-reference/objects/onboarding-not-completed-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

OnboardingNotCompletedRejection

Rejection returned if an onboarding is not completed

type OnboardingNotCompletedRejection implements Rejection {
  message: String!
  onboardingId: String!
  onboarding: Onboarding!
}

Fields​

OnboardingNotCompletedRejection.message ● String! non-null scalar​

OnboardingNotCompletedRejection.onboardingId ● String! non-null scalar​

@deprecated(reason: "use onboarding.id instead")

OnboardingNotCompletedRejection.onboarding ● Onboarding! non-null object​

Interfaces​

Rejection interface​

Implemented by​

FinalizeOnboardingPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/onboarding-valid-status-info/index.html b/api-reference/objects/onboarding-valid-status-info/index.html index fb3c0983a4d..a75b5413d00 100644 --- a/api-reference/objects/onboarding-valid-status-info/index.html +++ b/api-reference/objects/onboarding-valid-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/onboarding/index.html b/api-reference/objects/onboarding/index.html index 8cb18f9bcaf..cecfcf147f4 100644 --- a/api-reference/objects/onboarding/index.html +++ b/api-reference/objects/onboarding/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Onboarding

Information provided during the onboarding process of an individual or a company

type Onboarding {
  id: String!
  accountName: String
  accountCountry: AccountCountry!
  createdAt: DateTime!
  email: String
  finalizedAt: DateTime
  language: String
  info: OnboardingAccountHolderInfo!
  accountHolder: AccountHolder
  onboardingUrl: String!
  onboardingState: OnboardingState!
  redirectUrl: String!
  oAuthRedirectParameters: OAuthRedirectParameters
  statusInfo: OnboardingStatusInfo!
  tcuUrl: String!
  supportingDocumentCollection: SupportingDocumentCollection!
  updatedAt: DateTime!
  account: Account
  legalRepresentativeAcceptedIdentificationLevels: [IdentificationLevel]!
  legalRepresentativeRecommendedIdentificationLevel: IdentificationLevel!
}

Fields​

Onboarding.id ● String! non-null scalar​

Unique identifier of an onboarding

Onboarding.accountName ● String scalar​

Account name

Onboarding.accountCountry ● AccountCountry! non-null enum​

Account Country

Onboarding.createdAt ● DateTime! non-null scalar​

Creation date

Onboarding.email ● String scalar​

Email

Onboarding.finalizedAt ● DateTime scalar​

Finalization date

Onboarding.language ● String scalar​

Language of the onboarding process. This consists of a 2-3 letter base language tag representing the language, optionally followed by additional subtags separated by '-'. The most common extra information is the country or region variant (like 'en-US' or 'fr-CA') or the type of alphabet to use (like 'sr-Latn'). Other variants like the type of orthography ('de-DE-1996') are usually not used in the context of this header. Learn More

Onboarding.info ● OnboardingAccountHolderInfo! non-null interface​

Information regarding the Individual or the company to onboard

Onboarding.accountHolder ● AccountHolder object​

Account holder created at the end of the onboarding process

Onboarding.onboardingUrl ● String! non-null scalar​

Redirect the legal representative of a new account holder to this URL to start the onboarding process

Onboarding.onboardingState ● OnboardingState! non-null enum​

Current computed state of onboarding

Onboarding.redirectUrl ● String! non-null scalar​

URL used to redirect the user at the end of the onboarding process. If null the user is redirected to the white label web banking.

Onboarding.oAuthRedirectParameters ● OAuthRedirectParameters object​

Extra parameters provided by partner

Onboarding.statusInfo ● OnboardingStatusInfo! non-null interface​

Status (valid/invalid/finalized) and details of errors on fields

Onboarding.tcuUrl ● String! non-null scalar​

Swan TCU URL

Onboarding.supportingDocumentCollection ● SupportingDocumentCollection! non-null object​

List of supporting document collection owned by the account holder.

Onboarding.updatedAt ● DateTime! non-null scalar​

Creation date

Onboarding.account ● Account object​

Account opened after the onboarding finalization

Onboarding.legalRepresentativeAcceptedIdentificationLevels ● [IdentificationLevel]! non-null enum​

List of accepted identification level for the legal representative

Onboarding.legalRepresentativeRecommendedIdentificationLevel ● IdentificationLevel! non-null enum​

Recommended identification level for the legal representative

Returned by​

onboarding query

Member of​

AccountHolder object ● CapitalDepositCase object ● FinalizeOnboardingSuccessPayload object ● OnboardCompanyAccountHolderSuccessPayload object ● OnboardIndividualAccountHolderSuccessPayload object ● OnboardingEdge object ● OnboardingNotCompletedRejection object ● Shareholder object

- + \ No newline at end of file diff --git a/api-reference/objects/page-info/index.html b/api-reference/objects/page-info/index.html index 7208ebfc580..f6b4aba0345 100644 --- a/api-reference/objects/page-info/index.html +++ b/api-reference/objects/page-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PageInfo

Implements PageInfo from the Relay Connections Specification - information about a page in the pagination mechanism

type PageInfo {
  hasNextPage: Boolean
  hasPreviousPage: Boolean
  startCursor: String
  endCursor: String
}

Fields​

PageInfo.hasNextPage ● Boolean scalar​

Indicates whether more edges exist following this page

PageInfo.hasPreviousPage ● Boolean scalar​

Indicates whether more edges exist preceding this page

PageInfo.startCursor ● String scalar​

Opaque identifier pointing to the first node of the page

PageInfo.endCursor ● String scalar​

Opaque identifier pointing to the last node of the page

Member of​

AccountConnection object ● AccountHolderConnection object ● AccountMembershipConnection object ● CapitalDepositCaseConnection object ● CardConnection object ● Connection interface ● ConsentConnection object ● DigitalCardConnection object ● ExternalAccountConnection object ● ExternalBalanceConnection object ● FundingLimitSettingsChangeRequestConnection object ● FundingSourceConnection object ● IdentificationConnection object ● InvoiceConnection object ● LegalDocumentConnection object ● MerchantProfileConnection object ● OnboardingConnection object ● PaymentConnection object ● PaymentMandateConnection object ● ReceivedDirectDebitMandateConnection object ● StandingOrderConnection object ● StatementConnection object ● SupportingDocumentCollectionConnection object ● TransactionConnection object ● UserConnection object ● VirtualIBANEntryConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/partnership-accepted-status-info/index.html b/api-reference/objects/partnership-accepted-status-info/index.html index 7f4bf14906b..651e635ee74 100644 --- a/api-reference/objects/partnership-accepted-status-info/index.html +++ b/api-reference/objects/partnership-accepted-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PartnershipAcceptedStatusInfo

Partnership Status Accepted

type PartnershipAcceptedStatusInfo implements PartnershipStatusInfo {
  status: PartnershipStatus!
  acceptedDate: DateTime!
}

Fields​

PartnershipAcceptedStatusInfo.status ● PartnershipStatus! non-null enum​

Partnership status (always Accepted for type PartnershipAcceptedStatusInfo)

PartnershipAcceptedStatusInfo.acceptedDate ● DateTime! non-null scalar​

Accepted date of the partnership for this account

Interfaces​

PartnershipStatusInfo interface​

Partnership Status information

- + \ No newline at end of file diff --git a/api-reference/objects/partnership-canceled-status-info/index.html b/api-reference/objects/partnership-canceled-status-info/index.html index 10788e5e0ae..b4173863116 100644 --- a/api-reference/objects/partnership-canceled-status-info/index.html +++ b/api-reference/objects/partnership-canceled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PartnershipCanceledStatusInfo

Partnership Status canceled

type PartnershipCanceledStatusInfo implements PartnershipStatusInfo {
  status: PartnershipStatus!
  acceptedDate: DateTime!
  canceledDate: DateTime!
  reason: String!
}

Fields​

PartnershipCanceledStatusInfo.status ● PartnershipStatus! non-null enum​

Partnership status (always Canceled for type PartnershipCanceledStatusInfo)

PartnershipCanceledStatusInfo.acceptedDate ● DateTime! non-null scalar​

Accepted date of the partnership for this account

PartnershipCanceledStatusInfo.canceledDate ● DateTime! non-null scalar​

Canceled date of the partnership for this account

PartnershipCanceledStatusInfo.reason ● String! non-null scalar​

Reason of the cancelation

Interfaces​

PartnershipStatusInfo interface​

Partnership Status information

- + \ No newline at end of file diff --git a/api-reference/objects/partnership-canceling-status-info/index.html b/api-reference/objects/partnership-canceling-status-info/index.html index 654ec26aa10..04b99440189 100644 --- a/api-reference/objects/partnership-canceling-status-info/index.html +++ b/api-reference/objects/partnership-canceling-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PartnershipCancelingStatusInfo

Partnership Status currently cancelling

type PartnershipCancelingStatusInfo implements PartnershipStatusInfo {
  status: PartnershipStatus!
  acceptedDate: DateTime!
  canceledAfter: DateTime!
}

Fields​

PartnershipCancelingStatusInfo.status ● PartnershipStatus! non-null enum​

Partnership status (always Canceling for type PartnershipCancelingStatusInfo)

PartnershipCancelingStatusInfo.acceptedDate ● DateTime! non-null scalar​

Accepted date of the partnership for this account

PartnershipCancelingStatusInfo.canceledAfter ● DateTime! non-null scalar​

Canceled date of the partnership for this account

Interfaces​

PartnershipStatusInfo interface​

Partnership Status information

- + \ No newline at end of file diff --git a/api-reference/objects/passport-document-file/index.html b/api-reference/objects/passport-document-file/index.html index dbee48896f6..e30911696d4 100644 --- a/api-reference/objects/passport-document-file/index.html +++ b/api-reference/objects/passport-document-file/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PassportDocumentFile

The file associated to the passport document

type PassportDocumentFile implements DocumentFile {
  downloadUrl: String!
  side: DocumentFileSide!
}

Fields​

PassportDocumentFile.downloadUrl ● String! non-null scalar​

The file's temporary download url

PassportDocumentFile.side ● DocumentFileSide! non-null enum​

From which side the passport's picture was taken

Interfaces​

DocumentFile interface​

Retrieved document extracted from the identity verification

Member of​

PassportDocument object

- + \ No newline at end of file diff --git a/api-reference/objects/passport-document/index.html b/api-reference/objects/passport-document/index.html index 92a1926f43c..5231d71e38a 100644 --- a/api-reference/objects/passport-document/index.html +++ b/api-reference/objects/passport-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PassportDocument

The document corresponding to a passport

type PassportDocument {
  id: String!
  type: DocumentType!
  issueDate: Date
  expiryDate: Date
  mrz: String
  number: String
  files: [PassportDocumentFile!]!
}

Fields​

PassportDocument.id ● String! non-null scalar​

Unique identifier of the passport document

PassportDocument.type ● DocumentType! non-null enum​

The type of the document

PassportDocument.issueDate ● Date scalar​

The date at which the passport was issued

PassportDocument.expiryDate ● Date scalar​

The date at which the passport expires

PassportDocument.mrz ● String scalar​

Machine-readable zone code of the passport

PassportDocument.number ● String scalar​

Number of the passport

PassportDocument.files ● [PassportDocumentFile!]! non-null object​

List of the associated files

Implemented by​

IdentificationDocument union

- + \ No newline at end of file diff --git a/api-reference/objects/payment-connection/index.html b/api-reference/objects/payment-connection/index.html index 450aaecdd43..81e087254fc 100644 --- a/api-reference/objects/payment-connection/index.html +++ b/api-reference/objects/payment-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PaymentConnection

Please see the Connection interface

type PaymentConnection implements Connection {
  pageInfo: PageInfo!
  edges: [PaymentEdge!]!
  totalCount: Int!
}

Fields​

PaymentConnection.pageInfo ● PageInfo! non-null object​

PaymentConnection.edges ● [PaymentEdge!]! non-null object​

PaymentConnection.totalCount ● Int! non-null scalar​

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

payments query

Member of​

StandingOrder object

- + \ No newline at end of file diff --git a/api-reference/objects/payment-consent-pending/index.html b/api-reference/objects/payment-consent-pending/index.html index 30ecd7a20bd..acc01fca97c 100644 --- a/api-reference/objects/payment-consent-pending/index.html +++ b/api-reference/objects/payment-consent-pending/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/payment-edge/index.html b/api-reference/objects/payment-edge/index.html index 192fc908449..5b8f2bba7a8 100644 --- a/api-reference/objects/payment-edge/index.html +++ b/api-reference/objects/payment-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

PaymentEdge

Please see the Connection interface

type PaymentEdge implements Edge {
  node: Payment!
  cursor: String!
}

Fields​

PaymentEdge.node ● Payment! non-null object​

PaymentEdge.cursor ● String! non-null scalar​

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

PaymentConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/payment-initiated/index.html b/api-reference/objects/payment-initiated/index.html index 0a694217e59..9aff97e3d61 100644 --- a/api-reference/objects/payment-initiated/index.html +++ b/api-reference/objects/payment-initiated/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/payment-mandate-canceled-status-info/index.html b/api-reference/objects/payment-mandate-canceled-status-info/index.html index 0302d74be84..b5ea98e3126 100644 --- a/api-reference/objects/payment-mandate-canceled-status-info/index.html +++ b/api-reference/objects/payment-mandate-canceled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PaymentMandateCanceledStatusInfo

Payment Mandate Canceled status information

type PaymentMandateCanceledStatusInfo implements PaymentMandateStatusInfo {
  status: PaymentMandateStatus!
  reason: PaymentMandateCanceledReason!
}

Fields​

PaymentMandateCanceledStatusInfo.status ● PaymentMandateStatus! non-null enum​

Payment Mandate status (always Canceled for type PaymentMandateCanceledStatusInfo).

PaymentMandateCanceledStatusInfo.reason ● PaymentMandateCanceledReason! non-null enum​

Reason behind the Payment Mandate Canceled status

Interfaces​

PaymentMandateStatusInfo interface​

Payment Mandate status information

- + \ No newline at end of file diff --git a/api-reference/objects/payment-mandate-connection/index.html b/api-reference/objects/payment-mandate-connection/index.html index 9cc87717ead..0a542709b57 100644 --- a/api-reference/objects/payment-mandate-connection/index.html +++ b/api-reference/objects/payment-mandate-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PaymentMandateConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type PaymentMandateConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [PaymentMandateEdge!]!
}

Fields​

PaymentMandateConnection.totalCount ● Int! non-null scalar​

Total number of elements in the list

PaymentMandateConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

PaymentMandateConnection.edges ● [PaymentMandateEdge!]! non-null object​

PaymentMandateEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

AccountHolder object

- + \ No newline at end of file diff --git a/api-reference/objects/payment-mandate-consent-pending-status-info/index.html b/api-reference/objects/payment-mandate-consent-pending-status-info/index.html index a0842407b0b..acf939cdc73 100644 --- a/api-reference/objects/payment-mandate-consent-pending-status-info/index.html +++ b/api-reference/objects/payment-mandate-consent-pending-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PaymentMandateConsentPendingStatusInfo

Payment Mandate Consent Pending status information

type PaymentMandateConsentPendingStatusInfo implements PaymentMandateStatusInfo {
  status: PaymentMandateStatus!
  consent: Consent!
}

Fields​

PaymentMandateConsentPendingStatusInfo.status ● PaymentMandateStatus! non-null enum​

Payment Mandate status (always Enabled for type PaymentMandateEnableedStatusInfo).

PaymentMandateConsentPendingStatusInfo.consent ● Consent! non-null object​

Consent information required to enable the concerned Payment Mandate

Interfaces​

PaymentMandateStatusInfo interface​

Payment Mandate status information

- + \ No newline at end of file diff --git a/api-reference/objects/payment-mandate-edge/index.html b/api-reference/objects/payment-mandate-edge/index.html index da0163acc22..a8a28ed6f3b 100644 --- a/api-reference/objects/payment-mandate-edge/index.html +++ b/api-reference/objects/payment-mandate-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

PaymentMandateEdge

Implements the Relay Edge interface

type PaymentMandateEdge implements Edge {
  cursor: String!
  node: PaymentMandate!
}

Fields​

PaymentMandateEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this onboarding node in the pagination mechanism

PaymentMandateEdge.node ● PaymentMandate! non-null interface​

The payment mandate

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

PaymentMandateConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/payment-mandate-enabled-status-info/index.html b/api-reference/objects/payment-mandate-enabled-status-info/index.html index bd1436afb2a..9d38e4160a2 100644 --- a/api-reference/objects/payment-mandate-enabled-status-info/index.html +++ b/api-reference/objects/payment-mandate-enabled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/payment-mandate-mandate-not-found-rejection/index.html b/api-reference/objects/payment-mandate-mandate-not-found-rejection/index.html index 43583a3cd89..8354d1b9bf8 100644 --- a/api-reference/objects/payment-mandate-mandate-not-found-rejection/index.html +++ b/api-reference/objects/payment-mandate-mandate-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/payment-mandate-reference-already-used-rejection/index.html b/api-reference/objects/payment-mandate-reference-already-used-rejection/index.html index 619b046e0f4..8a768899a32 100644 --- a/api-reference/objects/payment-mandate-reference-already-used-rejection/index.html +++ b/api-reference/objects/payment-mandate-reference-already-used-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/payment-mandate-rejected-status-info/index.html b/api-reference/objects/payment-mandate-rejected-status-info/index.html index 51001698597..9b6e3839d32 100644 --- a/api-reference/objects/payment-mandate-rejected-status-info/index.html +++ b/api-reference/objects/payment-mandate-rejected-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/payment-method-not-compatible-rejection/index.html b/api-reference/objects/payment-method-not-compatible-rejection/index.html index 7a6e55c6f70..141b3695bd6 100644 --- a/api-reference/objects/payment-method-not-compatible-rejection/index.html +++ b/api-reference/objects/payment-method-not-compatible-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/payment-rejected/index.html b/api-reference/objects/payment-rejected/index.html index bbafffa6d28..5ba929e09b8 100644 --- a/api-reference/objects/payment-rejected/index.html +++ b/api-reference/objects/payment-rejected/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/payment/index.html b/api-reference/objects/payment/index.html index 5f92ccdaf26..405b32011f8 100644 --- a/api-reference/objects/payment/index.html +++ b/api-reference/objects/payment/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Payment

A Payment represents a set of transactions linked to the same payment act.

This payment act can be initiated:

  • either from a user
  • either from a merchant
  • either from you
  • either from Swan
type Payment {
  id: ID!
  createdAt: DateTime!
  updatedAt: DateTime!
  statusInfo: PaymentStatusInfo!
  transactions(
  first: Int! = 50
  after: String
  filters: TransactionsFiltersInput
): TransactionConnection
  standingOrder: StandingOrder
}

Fields​

Payment.id ● ID! non-null scalar​

unique identifier of a payment

Payment.createdAt ● DateTime! non-null scalar​

created date

Payment.updatedAt ● DateTime! non-null scalar​

updated date

Payment.statusInfo ● PaymentStatusInfo! non-null interface​

status information

Payment.transactions ● TransactionConnection object​

list of transactions associated to this payment

Payment.transactions.first ● Int! non-null scalar​

number of elements in the list (default value 50)

Payment.transactions.after ● String scalar​

When the list of elements needs to start after a element

Payment.transactions.filters ● TransactionsFiltersInput input​

When the list of elements needs to be filtered

Payment.standingOrder ● StandingOrder object​

standing order that has initiated this payment

Returned by​

payment query

Member of​

CardTransaction object ● CheckTransaction object ● FeeTransaction object ● InitiateCreditTransfersSuccessPayload object ● InitiateFundingRequestSuccessPayload object ● InitiateInternationalCreditTransferResponseSuccessPayload object ● InitiateMerchantPaymentCollectionSuccessPayload object ● InternalCreditTransfer object ● InternalDirectDebitTransaction object ● InternationalCreditTransferTransaction object ● PaymentEdge object ● SEPACreditTransferTransaction object ● SEPADirectDebitTransaction object ● Transaction interface

- + \ No newline at end of file diff --git a/api-reference/objects/pdf-statement/index.html b/api-reference/objects/pdf-statement/index.html index c446d8c07ee..3da21a65cf3 100644 --- a/api-reference/objects/pdf-statement/index.html +++ b/api-reference/objects/pdf-statement/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PdfStatement

Custom information for a PDF statement

type PdfStatement implements StatementInfo {
  type: StatementType
  url: String
  expiresAt: DateTime
}

Fields​

PdfStatement.type ● StatementType enum​

statement type

PdfStatement.url ● String scalar​

temporary public url on which the file can be accessed

PdfStatement.expiresAt ● DateTime scalar​

date at which the link will not be useable anymore

Interfaces​

StatementInfo interface​

Custom information for a certain type of statement

- + \ No newline at end of file diff --git a/api-reference/objects/pending-consent-account-membership-update/index.html b/api-reference/objects/pending-consent-account-membership-update/index.html index d143bd54256..3635da1f26e 100644 --- a/api-reference/objects/pending-consent-account-membership-update/index.html +++ b/api-reference/objects/pending-consent-account-membership-update/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PendingConsentAccountMembershipUpdate

Pending Consent when the account membership will be updated

type PendingConsentAccountMembershipUpdate {
  accountMembershipId: AccountMembership!
  consent: Consent!
}

Fields​

PendingConsentAccountMembershipUpdate.accountMembershipId ● AccountMembership! non-null object​

New account membership version waiting for consent

PendingConsentAccountMembershipUpdate.consent ● Consent! non-null object​

The consent required to update the account membership

- + \ No newline at end of file diff --git a/api-reference/objects/pending-digital-card/index.html b/api-reference/objects/pending-digital-card/index.html index 5671b613993..e4936fdf15b 100644 --- a/api-reference/objects/pending-digital-card/index.html +++ b/api-reference/objects/pending-digital-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PendingDigitalCard

Pending Digital Card used for ApplePay or GooglePay

type PendingDigitalCard implements DigitalCard {
  id: ID!
  type: DigitalizationType!
  createdAt: DateTime!
  updatedAt: DateTime!
  walletProvider: WalletProvider!
  statusInfo: PendingDigitalCardStatusInfo!
  inAppProvisioningData(
  signatureData: SignatureData
): InAppProvisioningData
}

Fields​

PendingDigitalCard.id ● ID! non-null scalar​

Unique identifier of a digital card

PendingDigitalCard.type ● DigitalizationType! non-null enum​

The type of digitalization that created this digital card.

PendingDigitalCard.createdAt ● DateTime! non-null scalar​

Created date

PendingDigitalCard.updatedAt ● DateTime! non-null scalar​

Updated date

PendingDigitalCard.walletProvider ● WalletProvider! non-null object​

Wallet Provider (ApplePay, GooglePay ...)

PendingDigitalCard.statusInfo ● PendingDigitalCardStatusInfo! non-null interface​

Digital Card status information

In this type the status will be either ConsentPending or Pending

PendingDigitalCard.inAppProvisioningData ● InAppProvisioningData object​

Data to provide to the wallet during InApp Provisioning

Signature Data is mandatory for ApplePay

This data is only available for a digital card in

Interfaces​

DigitalCard interface​

Digital Card used for ApplePay or GooglePay

Member of​

AddDigitalCardSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/pending-funding-source-status-info/index.html b/api-reference/objects/pending-funding-source-status-info/index.html index a29b076834b..6c278b8dfba 100644 --- a/api-reference/objects/pending-funding-source-status-info/index.html +++ b/api-reference/objects/pending-funding-source-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/pending-identification-level-status-info/index.html b/api-reference/objects/pending-identification-level-status-info/index.html index 510853b5e3d..d8f991b9a6b 100644 --- a/api-reference/objects/pending-identification-level-status-info/index.html +++ b/api-reference/objects/pending-identification-level-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/pending-merchant-payment-method-status-info/index.html b/api-reference/objects/pending-merchant-payment-method-status-info/index.html index 58c50749966..0ecc2f58921 100644 --- a/api-reference/objects/pending-merchant-payment-method-status-info/index.html +++ b/api-reference/objects/pending-merchant-payment-method-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/pending-review-merchant-profile-status-info/index.html b/api-reference/objects/pending-review-merchant-profile-status-info/index.html index f0f4ab43778..006f8e058b2 100644 --- a/api-reference/objects/pending-review-merchant-profile-status-info/index.html +++ b/api-reference/objects/pending-review-merchant-profile-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/pending-review-status-info/index.html b/api-reference/objects/pending-review-status-info/index.html index a22b916c794..0051ffdd6c3 100644 --- a/api-reference/objects/pending-review-status-info/index.html +++ b/api-reference/objects/pending-review-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/pending-transaction-status-info/index.html b/api-reference/objects/pending-transaction-status-info/index.html index 40b6e67d767..a3ef528be59 100644 --- a/api-reference/objects/pending-transaction-status-info/index.html +++ b/api-reference/objects/pending-transaction-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PendingTransactionStatusInfo

Pending transaction status information

type PendingTransactionStatusInfo implements TransactionStatusInfo {
  status: TransactionStatus!
  pendingEndDate: DateTime
}

Fields​

PendingTransactionStatusInfo.status ● TransactionStatus! non-null enum​

status of the transaction

PendingTransactionStatusInfo.pendingEndDate ● DateTime scalar​

The date when the pending amount of this transaction is released on the available balance of this account if not booked

Interfaces​

TransactionStatusInfo interface​

Transaction Status information

- + \ No newline at end of file diff --git a/api-reference/objects/pending-verification-status-info/index.html b/api-reference/objects/pending-verification-status-info/index.html index 5479a18c8ff..73f977afc35 100644 --- a/api-reference/objects/pending-verification-status-info/index.html +++ b/api-reference/objects/pending-verification-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/permission-cannot-be-granted-rejection/index.html b/api-reference/objects/permission-cannot-be-granted-rejection/index.html index 7bfafbfc2a9..7c8f0108e33 100644 --- a/api-reference/objects/permission-cannot-be-granted-rejection/index.html +++ b/api-reference/objects/permission-cannot-be-granted-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-activated-status-info/index.html b/api-reference/objects/physical-card-activated-status-info/index.html index 3889df32f46..67cd698f05c 100644 --- a/api-reference/objects/physical-card-activated-status-info/index.html +++ b/api-reference/objects/physical-card-activated-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-canceled-status-info/index.html b/api-reference/objects/physical-card-canceled-status-info/index.html index 26ca4ba48f6..7561f9d7ba2 100644 --- a/api-reference/objects/physical-card-canceled-status-info/index.html +++ b/api-reference/objects/physical-card-canceled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardCanceledStatusInfo

Physical Card Canceled Status Information

type PhysicalCardCanceledStatusInfo implements PhysicalCardStatusInfo {
  status: PhysicalCardStatus!
  reason: String!
}

Fields​

PhysicalCardCanceledStatusInfo.status ● PhysicalCardStatus! non-null enum​

Physical Card status (always Canceled for type PhysicalCardCanceledStatusInfo).

PhysicalCardCanceledStatusInfo.reason ● String! non-null scalar​

Reason why the card is canceled.

Interfaces​

PhysicalCardStatusInfo interface​

Physical Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-canceling-status-info/index.html b/api-reference/objects/physical-card-canceling-status-info/index.html index 024fed73ce2..b879c3fa158 100644 --- a/api-reference/objects/physical-card-canceling-status-info/index.html +++ b/api-reference/objects/physical-card-canceling-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardCancelingStatusInfo

Physical Card Canceling Status Information

type PhysicalCardCancelingStatusInfo implements PhysicalCardStatusInfo {
  status: PhysicalCardStatus!
  reason: String!
}

Fields​

PhysicalCardCancelingStatusInfo.status ● PhysicalCardStatus! non-null enum​

Physical Card status (always Canceling for type PhysicalCardCancelingStatusInfo).

PhysicalCardCancelingStatusInfo.reason ● String! non-null scalar​

Reason why the card is canceled.

Interfaces​

PhysicalCardStatusInfo interface​

Physical Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-consent-pending-status-info/index.html b/api-reference/objects/physical-card-consent-pending-status-info/index.html index 7f259f01cbb..769eae6adf5 100644 --- a/api-reference/objects/physical-card-consent-pending-status-info/index.html +++ b/api-reference/objects/physical-card-consent-pending-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardConsentPendingStatusInfo

when the user has to authorize production of the physical card

type PhysicalCardConsentPendingStatusInfo implements PhysicalCardStatusInfo {
  status: PhysicalCardStatus!
  consent: Consent!
}

Fields​

PhysicalCardConsentPendingStatusInfo.status ● PhysicalCardStatus! non-null enum​

Physical Card status (always ConsentPending for type PhysicalCardConsentPendingStatusInfo)

PhysicalCardConsentPendingStatusInfo.consent ● Consent! non-null object​

The consent required to authorize production of the physical card

Interfaces​

PhysicalCardStatusInfo interface​

Physical Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-custom-options/index.html b/api-reference/objects/physical-card-custom-options/index.html index b25d4243403..68cd56da71b 100644 --- a/api-reference/objects/physical-card-custom-options/index.html +++ b/api-reference/objects/physical-card-custom-options/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-not-found-rejection/index.html b/api-reference/objects/physical-card-not-found-rejection/index.html index 21939dc44ee..c86146539fa 100644 --- a/api-reference/objects/physical-card-not-found-rejection/index.html +++ b/api-reference/objects/physical-card-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardNotFoundRejection

Rejection returned when the Physical Card does not exist

type PhysicalCardNotFoundRejection implements Rejection {
  message: String!
  identifier: String!
}

Fields​

PhysicalCardNotFoundRejection.message ● String! non-null scalar​

PhysicalCardNotFoundRejection.identifier ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

ActivatePhysicalCardPayload union ● CancelPhysicalCardPayload union ● ResumePhysicalCardPayload union ● SuspendPhysicalCardPayload union ● ViewPhysicalCardPinPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-processing-status-info/index.html b/api-reference/objects/physical-card-processing-status-info/index.html index a815823dbe7..280d3eb1e25 100644 --- a/api-reference/objects/physical-card-processing-status-info/index.html +++ b/api-reference/objects/physical-card-processing-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-renewed-status-info/index.html b/api-reference/objects/physical-card-renewed-status-info/index.html index 1cdfc9f7ba3..6b60a9b26bb 100644 --- a/api-reference/objects/physical-card-renewed-status-info/index.html +++ b/api-reference/objects/physical-card-renewed-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardRenewedStatusInfo

Physical Card Renewed Status Information

type PhysicalCardRenewedStatusInfo implements PhysicalCardStatusInfo {
  status: PhysicalCardStatus!
  address: Address!
  estimatedDeliveryDate: DateTime
  trackingNumber: String
  shippingProvider: String
  isPINReady: Boolean!
}

Fields​

PhysicalCardRenewedStatusInfo.status ● PhysicalCardStatus! non-null enum​

Physical Card status (always Renewed for type PhysicalCardRenewedStatusInfo).

PhysicalCardRenewedStatusInfo.address ● Address! non-null object​

address to deliver the physical card

PhysicalCardRenewedStatusInfo.estimatedDeliveryDate ● DateTime scalar​

Estimated delivery date

PhysicalCardRenewedStatusInfo.trackingNumber ● String scalar​

Shipping tracking number

PhysicalCardRenewedStatusInfo.shippingProvider ● String scalar​

Name of the shipping provider (Ex: LaPoste, DHL ...)

PhysicalCardRenewedStatusInfo.isPINReady ● Boolean! non-null scalar​

true if PIN Code is available.

Interfaces​

PhysicalCardStatusInfo interface​

Physical Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-suspended-status-info/index.html b/api-reference/objects/physical-card-suspended-status-info/index.html index bbf9c3778fc..9b5a48fafc8 100644 --- a/api-reference/objects/physical-card-suspended-status-info/index.html +++ b/api-reference/objects/physical-card-suspended-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardSuspendedStatusInfo

Physical Card Suspended Status Information

type PhysicalCardSuspendedStatusInfo implements PhysicalCardStatusInfo {
  status: PhysicalCardStatus!
  reason: String!
}

Fields​

PhysicalCardSuspendedStatusInfo.status ● PhysicalCardStatus! non-null enum​

Physical Card status (always Suspended for type PhysicalCardSuspendedStatusInfo).

PhysicalCardSuspendedStatusInfo.reason ● String! non-null scalar​

Reason why the card is suspended.

Interfaces​

PhysicalCardStatusInfo interface​

Physical Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-to-activate-status-info/index.html b/api-reference/objects/physical-card-to-activate-status-info/index.html index 08b95aa0c54..8c53861202f 100644 --- a/api-reference/objects/physical-card-to-activate-status-info/index.html +++ b/api-reference/objects/physical-card-to-activate-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardToActivateStatusInfo

Physical Card To Activate Status Information

type PhysicalCardToActivateStatusInfo implements PhysicalCardStatusInfo {
  status: PhysicalCardStatus!
  address: Address!
  estimatedDeliveryDate: DateTime
  trackingNumber: String
  shippingProvider: String
  isPINReady: Boolean!
}

Fields​

PhysicalCardToActivateStatusInfo.status ● PhysicalCardStatus! non-null enum​

Physical Card status (always ToActivate for type PhysicalCardToActivateStatusInfo).

PhysicalCardToActivateStatusInfo.address ● Address! non-null object​

address to deliver the physical card

PhysicalCardToActivateStatusInfo.estimatedDeliveryDate ● DateTime scalar​

Estimated delivery date

PhysicalCardToActivateStatusInfo.trackingNumber ● String scalar​

Shipping tracking number

PhysicalCardToActivateStatusInfo.shippingProvider ● String scalar​

Name of the shipping provider (Ex: LaPoste, DHL ...)

PhysicalCardToActivateStatusInfo.isPINReady ● Boolean! non-null scalar​

true if PIN Code is available.

Interfaces​

PhysicalCardStatusInfo interface​

Physical Card Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/physical-card-wrong-status-rejection/index.html b/api-reference/objects/physical-card-wrong-status-rejection/index.html index 9883f9a47fb..a45becfbb0d 100644 --- a/api-reference/objects/physical-card-wrong-status-rejection/index.html +++ b/api-reference/objects/physical-card-wrong-status-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCardWrongStatusRejection

Rejection returned when the Physical Card is not the expected status

type PhysicalCardWrongStatusRejection implements Rejection {
  message: String!
  identifier: String!
  currentStatus: PhysicalCardStatus!
  expectedStatus: PhysicalCardStatus!
}

Fields​

PhysicalCardWrongStatusRejection.message ● String! non-null scalar​

PhysicalCardWrongStatusRejection.identifier ● String! non-null scalar​

PhysicalCardWrongStatusRejection.currentStatus ● PhysicalCardStatus! non-null enum​

PhysicalCardWrongStatusRejection.expectedStatus ● PhysicalCardStatus! non-null enum​

Interfaces​

Rejection interface​

Implemented by​

ActivatePhysicalCardPayload union ● ResumePhysicalCardPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/physical-card/index.html b/api-reference/objects/physical-card/index.html index f317d672ff8..efd963598e9 100644 --- a/api-reference/objects/physical-card/index.html +++ b/api-reference/objects/physical-card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PhysicalCard

Physical Card

type PhysicalCard {
  statusInfo: PhysicalCardStatusInfo!
  expiryDate: String
  identifier: String
  offlineSpendingLimit: Amount!
  cardMaskedNumber: String!
  customOptions: PhysicalCardCustomOptions!
}

Fields​

PhysicalCard.statusInfo ● PhysicalCardStatusInfo! non-null interface​

Physical Card status information

PhysicalCard.expiryDate ● String scalar​

Physical Card expiration date with MM/YY string format

PhysicalCard.identifier ● String scalar​

Unique identifier present on physical card, such identifier is null if the status is ToActivate or Canceled. This identifier is updated when a renewed card is activated

PhysicalCard.offlineSpendingLimit ● Amount! non-null object​

Offline Spending limit defined by Swan

PhysicalCard.cardMaskedNumber ● String! non-null scalar​

Masked Card Number

PhysicalCard.customOptions ● PhysicalCardCustomOptions! non-null object​

Custom Options

Member of​

ActivatePhysicalCardSuccessPayload object ● CancelPhysicalCardSuccessPayload object ● Card object ● PrintPhysicalCardSuccessPayload object ● ResumePhysicalCardSuccessPayload object ● SuspendPhysicalCardSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/pinnot-ready-rejection/index.html b/api-reference/objects/pinnot-ready-rejection/index.html index 6e127e0221c..9528a12f32d 100644 --- a/api-reference/objects/pinnot-ready-rejection/index.html +++ b/api-reference/objects/pinnot-ready-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/pre-provisioning-suvcard-settings/index.html b/api-reference/objects/pre-provisioning-suvcard-settings/index.html index 8227dd3e4ec..639e9a71071 100644 --- a/api-reference/objects/pre-provisioning-suvcard-settings/index.html +++ b/api-reference/objects/pre-provisioning-suvcard-settings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PreProvisioningSUVCardSettings

No description

type PreProvisioningSUVCardSettings {
  preProvisioningSUVCards: Boolean!
  preProvisioningSUVNumberOfCards: Int!
  ownerProvisioningSUVCards: ID
  preProvisioningSUVCardsAvailablePercentage: Float!
}

Fields​

PreProvisioningSUVCardSettings.preProvisioningSUVCards ● Boolean! non-null scalar​

PreProvisioningSUVCardSettings.preProvisioningSUVNumberOfCards ● Int! non-null scalar​

PreProvisioningSUVCardSettings.ownerProvisioningSUVCards ● ID scalar​

PreProvisioningSUVCardSettings.preProvisioningSUVCardsAvailablePercentage ● Float! non-null scalar​

Member of​

ProjectCardDesigns object ● ProjectCardSettings object

- + \ No newline at end of file diff --git a/api-reference/objects/print-physical-card-success-payload/index.html b/api-reference/objects/print-physical-card-success-payload/index.html index ccbf017f9a5..5762c3fd33a 100644 --- a/api-reference/objects/print-physical-card-success-payload/index.html +++ b/api-reference/objects/print-physical-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/project-card-designs/index.html b/api-reference/objects/project-card-designs/index.html index ffcc3c5f6df..34d3bce1338 100644 --- a/api-reference/objects/project-card-designs/index.html +++ b/api-reference/objects/project-card-designs/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ProjectCardDesigns

No description

type ProjectCardDesigns {
  id: ID!
  issuingProcessorVisualId: String
  specificCardProductCodeForCompanies: String
  name: String
  cardDesigns: [CardProductDesign!]!
  preProvisioningSUVCardSettings: PreProvisioningSUVCardSettings
}

Fields​

ProjectCardDesigns.id ● ID! non-null scalar​

Unique identifier of a project

ProjectCardDesigns.issuingProcessorVisualId ● String scalar​

Visual Id from the issuing card processor (Monext)

ProjectCardDesigns.specificCardProductCodeForCompanies ● String scalar​

Specific card product for companies

ProjectCardDesigns.name ● String scalar​

Project name

ProjectCardDesigns.cardDesigns ● [CardProductDesign!]! non-null object​

Project card product designs

ProjectCardDesigns.preProvisioningSUVCardSettings ● PreProvisioningSUVCardSettings object​

Project's pre provisioning suv card settings

- + \ No newline at end of file diff --git a/api-reference/objects/project-card-settings/index.html b/api-reference/objects/project-card-settings/index.html index 02b0da5440d..65b4810fa24 100644 --- a/api-reference/objects/project-card-settings/index.html +++ b/api-reference/objects/project-card-settings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ProjectCardSettings

No description

type ProjectCardSettings {
  id: ID!
  issuingProcessorVisualId: String
  specificCardProductCodeForCompanies: String
  name: String
  cardSettings: [CardSettings!]!
  preProvisioningSUVCardSettings: PreProvisioningSUVCardSettings
}

Fields​

ProjectCardSettings.id ● ID! non-null scalar​

Unique identifier of a project

ProjectCardSettings.issuingProcessorVisualId ● String scalar​

Visual Id from the issuing card processor (Monext)

ProjectCardSettings.specificCardProductCodeForCompanies ● String scalar​

Specific card product for companies

ProjectCardSettings.name ● String scalar​

Project name

ProjectCardSettings.cardSettings ● [CardSettings!]! non-null object​

Project's card settings

ProjectCardSettings.preProvisioningSUVCardSettings ● PreProvisioningSUVCardSettings object​

Project's pre provisioning suv card settings

- + \ No newline at end of file diff --git a/api-reference/objects/project-forbidden-rejection/index.html b/api-reference/objects/project-forbidden-rejection/index.html index c4cf0a6aca9..7d6bbaf437c 100644 --- a/api-reference/objects/project-forbidden-rejection/index.html +++ b/api-reference/objects/project-forbidden-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/project-funding-limit-exceeded-rejection/index.html b/api-reference/objects/project-funding-limit-exceeded-rejection/index.html index 1c3163dce1b..4a9d6416d6e 100644 --- a/api-reference/objects/project-funding-limit-exceeded-rejection/index.html +++ b/api-reference/objects/project-funding-limit-exceeded-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/project-info/index.html b/api-reference/objects/project-info/index.html index 85e9f325a77..80bc3ad07aa 100644 --- a/api-reference/objects/project-info/index.html +++ b/api-reference/objects/project-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ProjectInfo

Public information of a Project

type ProjectInfo {
  cardProducts: [CardProduct!]
  activeCardSettings: CardSettings
  id: ID!
  B2BMembershipIDVerification: Boolean
  supportingDocumentSettings: SupportingDocumentSettings
  name: String!
  type: ProjectType!
  logoUri: String
  accentColor: String
  customConsentSubdomain: String
  oAuthClientId: String
  tcuDocumentUri(
  language: String!
): String!
  tcuDocumentId: String!
  webBankingSettings: WebBankingSettings
  status: ProjectStatus!
  allowsDesktopAuthentication: Boolean!
}

Fields​

ProjectInfo.cardProducts ● [CardProduct!] list object​

The card products associated with this project.

ProjectInfo.activeCardSettings ● CardSettings object​

the currently active card settings

ProjectInfo.id ● ID! non-null scalar​

Unique identifier of the project

ProjectInfo.B2BMembershipIDVerification ● Boolean scalar​

ProjectInfo.supportingDocumentSettings ● SupportingDocumentSettings object​

ProjectInfo.name ● String! non-null scalar​

Your project name displayed in white label interfaces and in the terms and conditions

ProjectInfo.type ● ProjectType! non-null enum​

The type of your project

ProjectInfo.logoUri ● String scalar​

URL of your logo

ProjectInfo.accentColor ● String scalar​

Your accent color, used in white label interfaces. Most of the time for call to actions

ProjectInfo.customConsentSubdomain ● String scalar​

Your custom subdomain used in consents

ProjectInfo.oAuthClientId ● String scalar​

Your OAuth client id

ProjectInfo.tcuDocumentUri ● String! non-null scalar​

URL to your Terms and Conditions of Use document depending on the provided language

ProjectInfo.tcuDocumentUri.language ● String! non-null scalar​

this consists of a 2-3 letter base language tag representing the language, optionally followed by additional subtags separated by '-'. The most common extra information is the country or region variant (like 'en-US' or 'fr-CA') or the type of alphabet to use (like 'sr-Latn'). Other variants like the type of orthography ('de-DE-1996') are usually not used in the context of this header. Learn More

ProjectInfo.tcuDocumentId ● String! non-null scalar​

Unique id of your current Terms and Conditions of Use

ProjectInfo.webBankingSettings ● WebBankingSettings object​

Web banking settings

ProjectInfo.status ● ProjectStatus! non-null enum​

Project status

ProjectInfo.allowsDesktopAuthentication ● Boolean! non-null scalar​

Flag that determines if desktop authentication is enabled for this project

Returned by​

projectInfo query

Member of​

OnboardingInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/project-instant-funding-limit-exceeded-rejection/index.html b/api-reference/objects/project-instant-funding-limit-exceeded-rejection/index.html index 744233f4f95..e71e8336dd8 100644 --- a/api-reference/objects/project-instant-funding-limit-exceeded-rejection/index.html +++ b/api-reference/objects/project-instant-funding-limit-exceeded-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/project-invalid-status-rejection/index.html b/api-reference/objects/project-invalid-status-rejection/index.html index 90df1a98e02..1291e07c26a 100644 --- a/api-reference/objects/project-invalid-status-rejection/index.html +++ b/api-reference/objects/project-invalid-status-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/project-not-found-rejection/index.html b/api-reference/objects/project-not-found-rejection/index.html index 6d3c6f72a93..7b48c7586ef 100644 --- a/api-reference/objects/project-not-found-rejection/index.html +++ b/api-reference/objects/project-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/project-not-found/index.html b/api-reference/objects/project-not-found/index.html index f0fd4a00d2c..c9a6d7f2e5f 100644 --- a/api-reference/objects/project-not-found/index.html +++ b/api-reference/objects/project-not-found/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/project-settings-forbidden-error/index.html b/api-reference/objects/project-settings-forbidden-error/index.html index f519cf8f586..09d46208916 100644 --- a/api-reference/objects/project-settings-forbidden-error/index.html +++ b/api-reference/objects/project-settings-forbidden-error/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/project-settings-not-found/index.html b/api-reference/objects/project-settings-not-found/index.html index 9bbecb3522c..a76a8aa2c3f 100644 --- a/api-reference/objects/project-settings-not-found/index.html +++ b/api-reference/objects/project-settings-not-found/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/project-settings-status-not-reachable/index.html b/api-reference/objects/project-settings-status-not-reachable/index.html index 77a9971c5e2..f4ebfd571d9 100644 --- a/api-reference/objects/project-settings-status-not-reachable/index.html +++ b/api-reference/objects/project-settings-status-not-reachable/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/public-onboarding-disabled-rejection/index.html b/api-reference/objects/public-onboarding-disabled-rejection/index.html index f70e91d747e..cc8fc537949 100644 --- a/api-reference/objects/public-onboarding-disabled-rejection/index.html +++ b/api-reference/objects/public-onboarding-disabled-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/radio-field/index.html b/api-reference/objects/radio-field/index.html index d7c9ce7d194..cea970f9144 100644 --- a/api-reference/objects/radio-field/index.html +++ b/api-reference/objects/radio-field/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RadioField

No description

type RadioField implements Field {
  key: String!
  name: String!
  refreshDynamicFieldsOnChange: Boolean!
  required: Boolean!
  allowedValues: [AllowedValue!]!
}

Fields​

RadioField.key ● String! non-null scalar​

RadioField.name ● String! non-null scalar​

RadioField.refreshDynamicFieldsOnChange ● Boolean! non-null scalar​

RadioField.required ● Boolean! non-null scalar​

RadioField.allowedValues ● [AllowedValue!]! non-null object​

Interfaces​

Field interface​

- + \ No newline at end of file diff --git a/api-reference/objects/reachability/index.html b/api-reference/objects/reachability/index.html index 7f6773dad51..fd0bd4e3221 100644 --- a/api-reference/objects/reachability/index.html +++ b/api-reference/objects/reachability/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Reachability

Information that can be used to determine where the iban can be used

type Reachability {
  sepaCreditTransferInst: Boolean!
  sepaDirectDebitCore: Boolean!
  sepaDirectDebitB2b: Boolean!
  sepaCreditTransfer: Boolean!
}

Fields​

Reachability.sepaCreditTransferInst ● Boolean! non-null scalar​

Can be used for instant transfer over SEPA

Reachability.sepaDirectDebitCore ● Boolean! non-null scalar​

Can be used for direct debit over SEPA

Reachability.sepaDirectDebitB2b ● Boolean! non-null scalar​

Can be used for B2B direct debit over SEPA

Reachability.sepaCreditTransfer ● Boolean! non-null scalar​

Can be used for transfer over SEPA (can be used in initiateCreditTransfer mutation)

Member of​

ValidIban object

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-already-exist-rejection/index.html b/api-reference/objects/received-direct-debit-mandate-already-exist-rejection/index.html index 7942fd7875f..26e79ad5f10 100644 --- a/api-reference/objects/received-direct-debit-mandate-already-exist-rejection/index.html +++ b/api-reference/objects/received-direct-debit-mandate-already-exist-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateAlreadyExistRejection

Rejection returned if the received direct debit mandate already exist

type ReceivedDirectDebitMandateAlreadyExistRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

ReceivedDirectDebitMandateAlreadyExistRejection.id ● String! non-null scalar​

ReceivedDirectDebitMandateAlreadyExistRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

UpdateReceivedSepaDirectDebitB2bMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-canceled-rejection/index.html b/api-reference/objects/received-direct-debit-mandate-canceled-rejection/index.html index 77088fccf90..49c99ed354b 100644 --- a/api-reference/objects/received-direct-debit-mandate-canceled-rejection/index.html +++ b/api-reference/objects/received-direct-debit-mandate-canceled-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateCanceledRejection

Received direct debit mandate is canceled and therefore can't be enabled/suspended or updated

type ReceivedDirectDebitMandateCanceledRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

ReceivedDirectDebitMandateCanceledRejection.id ● String! non-null scalar​

ReceivedDirectDebitMandateCanceledRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

EnableReceivedDirectDebitMandatePayload union ● SuspendReceivedDirectDebitMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-connection/index.html b/api-reference/objects/received-direct-debit-mandate-connection/index.html index 7f69175e5ec..f8a2992bb97 100644 --- a/api-reference/objects/received-direct-debit-mandate-connection/index.html +++ b/api-reference/objects/received-direct-debit-mandate-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type ReceivedDirectDebitMandateConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [ReceivedDirectDebitMandateEdge!]!
}

Fields​

ReceivedDirectDebitMandateConnection.totalCount ● Int! non-null scalar​

Total number of elements in the list

ReceivedDirectDebitMandateConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

ReceivedDirectDebitMandateConnection.edges ● [ReceivedDirectDebitMandateEdge!]! non-null object​

ReceivedDirectDebitMandateEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

Account object

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-edge/index.html b/api-reference/objects/received-direct-debit-mandate-edge/index.html index 8df2863c91f..ee6f65910f1 100644 --- a/api-reference/objects/received-direct-debit-mandate-edge/index.html +++ b/api-reference/objects/received-direct-debit-mandate-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

ReceivedDirectDebitMandateEdge

Implements the Relay Edge interface

type ReceivedDirectDebitMandateEdge implements Edge {
  cursor: String!
  node: ReceivedDirectDebitMandate!
}

Fields​

ReceivedDirectDebitMandateEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this onboarding node in the pagination mechanism

ReceivedDirectDebitMandateEdge.node ● ReceivedDirectDebitMandate! non-null interface​

The received direct debit mandate

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

ReceivedDirectDebitMandateConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-not-b2-b-rejection/index.html b/api-reference/objects/received-direct-debit-mandate-not-b2-b-rejection/index.html index 18ab0c0c5c5..05fec454c01 100644 --- a/api-reference/objects/received-direct-debit-mandate-not-b2-b-rejection/index.html +++ b/api-reference/objects/received-direct-debit-mandate-not-b2-b-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateNotB2bRejection

Rejection returned if the received direct debit mandate is not a B2b mandate

type ReceivedDirectDebitMandateNotB2bRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

ReceivedDirectDebitMandateNotB2bRejection.id ● String! non-null scalar​

ReceivedDirectDebitMandateNotB2bRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

UpdateReceivedSepaDirectDebitB2bMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-not-found-rejection/index.html b/api-reference/objects/received-direct-debit-mandate-not-found-rejection/index.html index 41d6e98cc99..c102ee37282 100644 --- a/api-reference/objects/received-direct-debit-mandate-not-found-rejection/index.html +++ b/api-reference/objects/received-direct-debit-mandate-not-found-rejection/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

ReceivedDirectDebitMandateNotFoundRejection

Error returned if the received direct debit mandate was not found or if the user does not have the rights to receive information abo ut the existence of the received direct debit mandate

type ReceivedDirectDebitMandateNotFoundRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

ReceivedDirectDebitMandateNotFoundRejection.id ● String! non-null scalar​

ReceivedDirectDebitMandateNotFoundRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

EnableReceivedDirectDebitMandatePayload union ● SuspendReceivedDirectDebitMandatePayload union ● UpdateReceivedSepaDirectDebitB2bMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-status-info-canceled/index.html b/api-reference/objects/received-direct-debit-mandate-status-info-canceled/index.html index 61a2ed79aba..85f07b41059 100644 --- a/api-reference/objects/received-direct-debit-mandate-status-info-canceled/index.html +++ b/api-reference/objects/received-direct-debit-mandate-status-info-canceled/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateStatusInfoCanceled

Received Direct Debit Mandate Canceled status information

type ReceivedDirectDebitMandateStatusInfoCanceled implements ReceivedDirectDebitMandateStatusInfo {
  status: ReceivedDirectDebitMandateStatus!
  canceledAt: DateTime!
}

Fields​

ReceivedDirectDebitMandateStatusInfoCanceled.status ● ReceivedDirectDebitMandateStatus! non-null enum​

Received Direct Debit Mandate status (always Canceled for type ReceivedDirectDebitMandateStatusInfoCanceled)

ReceivedDirectDebitMandateStatusInfoCanceled.canceledAt ● DateTime! non-null scalar​

Date of cancellation

Interfaces​

ReceivedDirectDebitMandateStatusInfo interface​

Received Direct Debit Mandate status information

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-status-info-consent-initiation-pending/index.html b/api-reference/objects/received-direct-debit-mandate-status-info-consent-initiation-pending/index.html index 905f3f38550..1868fd827fb 100644 --- a/api-reference/objects/received-direct-debit-mandate-status-info-consent-initiation-pending/index.html +++ b/api-reference/objects/received-direct-debit-mandate-status-info-consent-initiation-pending/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateStatusInfoConsentInitiationPending

Received Direct Debit Mandate ConsentInitiationPending status information

type ReceivedDirectDebitMandateStatusInfoConsentInitiationPending implements ReceivedDirectDebitMandateStatusInfo {
  status: ReceivedDirectDebitMandateStatus!
}

Fields​

ReceivedDirectDebitMandateStatusInfoConsentInitiationPending.status ● ReceivedDirectDebitMandateStatus! non-null enum​

Received Direct Debit Mandate status (always ConsentInitiationPending for type ReceivedDirectDebitMandateStatusInfoConsentInitiationPending)

Interfaces​

ReceivedDirectDebitMandateStatusInfo interface​

Received Direct Debit Mandate status information

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-status-info-consent-pending/index.html b/api-reference/objects/received-direct-debit-mandate-status-info-consent-pending/index.html index e6a48d7705a..7e112609782 100644 --- a/api-reference/objects/received-direct-debit-mandate-status-info-consent-pending/index.html +++ b/api-reference/objects/received-direct-debit-mandate-status-info-consent-pending/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateStatusInfoConsentPending

Received Direct Debit Mandate ConsentPending status information

type ReceivedDirectDebitMandateStatusInfoConsentPending implements ReceivedDirectDebitMandateStatusInfo {
  status: ReceivedDirectDebitMandateStatus!
  consent: Consent!
}

Fields​

ReceivedDirectDebitMandateStatusInfoConsentPending.status ● ReceivedDirectDebitMandateStatus! non-null enum​

Received Direct Debit Mandate status (always ConsentInitiationPending for type ReceivedDirectDebitMandateStatusInfoConsentPending)

ReceivedDirectDebitMandateStatusInfoConsentPending.consent ● Consent! non-null object​

The consent required to consent to a received direct debit mandate

Interfaces​

ReceivedDirectDebitMandateStatusInfo interface​

Received Direct Debit Mandate status information

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-status-info-enabled/index.html b/api-reference/objects/received-direct-debit-mandate-status-info-enabled/index.html index 0996fcd4465..971f004ed90 100644 --- a/api-reference/objects/received-direct-debit-mandate-status-info-enabled/index.html +++ b/api-reference/objects/received-direct-debit-mandate-status-info-enabled/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateStatusInfoEnabled

Received Direct Debit Mandate Enabled status information

type ReceivedDirectDebitMandateStatusInfoEnabled implements ReceivedDirectDebitMandateStatusInfo {
  status: ReceivedDirectDebitMandateStatus!
  enabledAt: DateTime!
}

Fields​

ReceivedDirectDebitMandateStatusInfoEnabled.status ● ReceivedDirectDebitMandateStatus! non-null enum​

Received Direct Debit Mandate status (always Enabled for type ReceivedDirectDebitMandateStatusInfoEnabled)

ReceivedDirectDebitMandateStatusInfoEnabled.enabledAt ● DateTime! non-null scalar​

Date at which the received direct debit mandate has been moved to the enabled status

Interfaces​

ReceivedDirectDebitMandateStatusInfo interface​

Received Direct Debit Mandate status information

- + \ No newline at end of file diff --git a/api-reference/objects/received-direct-debit-mandate-status-info-suspended/index.html b/api-reference/objects/received-direct-debit-mandate-status-info-suspended/index.html index f6091f4a497..1ff2a019329 100644 --- a/api-reference/objects/received-direct-debit-mandate-status-info-suspended/index.html +++ b/api-reference/objects/received-direct-debit-mandate-status-info-suspended/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReceivedDirectDebitMandateStatusInfoSuspended

Received Direct Debit Mandate Suspended status information

type ReceivedDirectDebitMandateStatusInfoSuspended implements ReceivedDirectDebitMandateStatusInfo {
  status: ReceivedDirectDebitMandateStatus!
  suspendedAt: DateTime!
}

Fields​

ReceivedDirectDebitMandateStatusInfoSuspended.status ● ReceivedDirectDebitMandateStatus! non-null enum​

Received Direct Debit Mandate status (always Suspended for type ReceivedDirectDebitMandateStatusInfoSuspended)

ReceivedDirectDebitMandateStatusInfoSuspended.suspendedAt ● DateTime! non-null scalar​

Date of the last time the received direct debit mandate has been moved to the suspended status

Interfaces​

ReceivedDirectDebitMandateStatusInfo interface​

Received Direct Debit Mandate status information

- + \ No newline at end of file diff --git a/api-reference/objects/refund-rejection/index.html b/api-reference/objects/refund-rejection/index.html index 949a6901319..25ea1c2aeaf 100644 --- a/api-reference/objects/refund-rejection/index.html +++ b/api-reference/objects/refund-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/refund-success-payload/index.html b/api-reference/objects/refund-success-payload/index.html index 8f2bff9f7f0..7d8673ee2da 100644 --- a/api-reference/objects/refund-success-payload/index.html +++ b/api-reference/objects/refund-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/rejected-funding-source-status-info/index.html b/api-reference/objects/rejected-funding-source-status-info/index.html index e87990b3863..33076d0ac5d 100644 --- a/api-reference/objects/rejected-funding-source-status-info/index.html +++ b/api-reference/objects/rejected-funding-source-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RejectedFundingSourceStatusInfo

Funding Source Rejected status information

type RejectedFundingSourceStatusInfo implements FundingSourceStatusInfo {
  status: FundingSourceStatus!
  rejectedAt: Date!
  reasonCode: RejectedFundingSourceReason!
}

Fields​

RejectedFundingSourceStatusInfo.status ● FundingSourceStatus! non-null enum​

Funding Source Rejected status

RejectedFundingSourceStatusInfo.rejectedAt ● Date! non-null scalar​

Date at which the funding source was rejected

RejectedFundingSourceStatusInfo.reasonCode ● RejectedFundingSourceReason! non-null enum​

Reason code of the rejection

Interfaces​

FundingSourceStatusInfo interface​

Funding Source status information

- + \ No newline at end of file diff --git a/api-reference/objects/rejected-merchant-payment-method-status-info/index.html b/api-reference/objects/rejected-merchant-payment-method-status-info/index.html index c5bb15c579f..6333f6bb869 100644 --- a/api-reference/objects/rejected-merchant-payment-method-status-info/index.html +++ b/api-reference/objects/rejected-merchant-payment-method-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RejectedMerchantPaymentMethodStatusInfo

RejectedMerchantPaymentMethodStatusInfo

type RejectedMerchantPaymentMethodStatusInfo implements MerchantPaymentMethodStatusInfo {
  status: MerchantPaymentMethodStatus!
  rejectedAt: Date!
}

Fields​

RejectedMerchantPaymentMethodStatusInfo.status ● MerchantPaymentMethodStatus! non-null enum​

RejectedMerchantPaymentMethodStatusInfo.rejectedAt ● Date! non-null scalar​

Merchant Payment Method rejected date

Interfaces​

MerchantPaymentMethodStatusInfo interface​

The payment method status information

- + \ No newline at end of file diff --git a/api-reference/objects/rejected-merchant-profile-status-info/index.html b/api-reference/objects/rejected-merchant-profile-status-info/index.html index ac559e55177..5157ad7b1e0 100644 --- a/api-reference/objects/rejected-merchant-profile-status-info/index.html +++ b/api-reference/objects/rejected-merchant-profile-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/rejected-transaction-status-info/index.html b/api-reference/objects/rejected-transaction-status-info/index.html index 772bbd7004b..05bc91da325 100644 --- a/api-reference/objects/rejected-transaction-status-info/index.html +++ b/api-reference/objects/rejected-transaction-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RejectedTransactionStatusInfo

Rejected transaction status information

type RejectedTransactionStatusInfo implements TransactionStatusInfo {
  status: TransactionStatus!
  reason: RejectedReasonCode!
  hasFallback: Boolean!
}

Fields​

RejectedTransactionStatusInfo.status ● TransactionStatus! non-null enum​

status of the transaction

RejectedTransactionStatusInfo.reason ● RejectedReasonCode! non-null enum​

reason code

RejectedTransactionStatusInfo.hasFallback ● Boolean! non-null scalar​

true if the transaction had a fallback

Interfaces​

TransactionStatusInfo interface​

Transaction Status information

- + \ No newline at end of file diff --git a/api-reference/objects/rejected-verification-status-info/index.html b/api-reference/objects/rejected-verification-status-info/index.html index 6cbdfa55023..c4c55c3ace8 100644 --- a/api-reference/objects/rejected-verification-status-info/index.html +++ b/api-reference/objects/rejected-verification-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RejectedVerificationStatusInfo

Rejected Information

type RejectedVerificationStatusInfo implements AccountVerificationStatusInfo {
  reason: RejectedVerificationReason!
  rejectedAt: DateTime!
  status: AccountVerificationStatus!
}

Fields​

RejectedVerificationStatusInfo.reason ● RejectedVerificationReason! non-null enum​

Rejected Reason

RejectedVerificationStatusInfo.rejectedAt ● DateTime! non-null scalar​

Date at which the verification was rejected

RejectedVerificationStatusInfo.status ● AccountVerificationStatus! non-null enum​

Account verification status (Rejected)

Interfaces​

AccountVerificationStatusInfo interface​

Account Verification Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/released-transaction-status-info/index.html b/api-reference/objects/released-transaction-status-info/index.html index 92def9aaf9c..1b76ed35e1f 100644 --- a/api-reference/objects/released-transaction-status-info/index.html +++ b/api-reference/objects/released-transaction-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReleasedTransactionStatusInfo

Released card transaction status information

type ReleasedTransactionStatusInfo implements TransactionStatusInfo {
  status: TransactionStatus!
  releaseDate: DateTime!
  reason: ReleasedReason!
}

Fields​

ReleasedTransactionStatusInfo.status ● TransactionStatus! non-null enum​

status of the transaction

ReleasedTransactionStatusInfo.releaseDate ● DateTime! non-null scalar​

The date when the transaction was released

ReleasedTransactionStatusInfo.reason ● ReleasedReason! non-null enum​

reason of the released transaction

Interfaces​

TransactionStatusInfo interface​

Transaction Status information

- + \ No newline at end of file diff --git a/api-reference/objects/report-document-file/index.html b/api-reference/objects/report-document-file/index.html index cc538494af7..1cac61edcc6 100644 --- a/api-reference/objects/report-document-file/index.html +++ b/api-reference/objects/report-document-file/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/report-document/index.html b/api-reference/objects/report-document/index.html index d42157a56f1..2341ed1e26c 100644 --- a/api-reference/objects/report-document/index.html +++ b/api-reference/objects/report-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/report-exchange-rate/index.html b/api-reference/objects/report-exchange-rate/index.html index 0a4e35f20d0..80724d3bf2c 100644 --- a/api-reference/objects/report-exchange-rate/index.html +++ b/api-reference/objects/report-exchange-rate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ReportExchangeRate

here is the exchange rate detail

type ReportExchangeRate {
  sourceCurrency: Currency!
  exchangeRate: Float!
  unitCurrency: Currency!
  targetCurrency: Currency!
  quotationDate: Date!
  contractIdentification: String
}

Fields​

ReportExchangeRate.sourceCurrency ● Currency! non-null scalar​

ReportExchangeRate.exchangeRate ● Float! non-null scalar​

ReportExchangeRate.unitCurrency ● Currency! non-null scalar​

ReportExchangeRate.targetCurrency ● Currency! non-null scalar​

ReportExchangeRate.quotationDate ● Date! non-null scalar​

ReportExchangeRate.contractIdentification ● String scalar​

Member of​

CardTransaction object

- + \ No newline at end of file diff --git a/api-reference/objects/request-merchant-payment-methods-success-payload/index.html b/api-reference/objects/request-merchant-payment-methods-success-payload/index.html index 4e1637d1c79..8d1c6c4a745 100644 --- a/api-reference/objects/request-merchant-payment-methods-success-payload/index.html +++ b/api-reference/objects/request-merchant-payment-methods-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/request-merchant-profile-update-success-payload/index.html b/api-reference/objects/request-merchant-profile-update-success-payload/index.html index 3363d066a28..2822e701587 100644 --- a/api-reference/objects/request-merchant-profile-update-success-payload/index.html +++ b/api-reference/objects/request-merchant-profile-update-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/request-merchant-profile-update/index.html b/api-reference/objects/request-merchant-profile-update/index.html index 09614bfb675..a6d5620a97e 100644 --- a/api-reference/objects/request-merchant-profile-update/index.html +++ b/api-reference/objects/request-merchant-profile-update/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RequestMerchantProfileUpdate

Request Update Merchant Profile

type RequestMerchantProfileUpdate {
  id: ID!
  merchantProfileId: ID!
  merchantName: String!
  merchantWebsite: String
  merchantLogoUrl: String
  status: RequestMerchantProfileUpdateStatus!
  productType: ProductType!
  expectedMonthlyPaymentVolume: Amount!
  expectedAverageBasket: Amount!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

RequestMerchantProfileUpdate.id ● ID! non-null scalar​

The Request ID

RequestMerchantProfileUpdate.merchantProfileId ● ID! non-null scalar​

The Merchant Profile ID to update

RequestMerchantProfileUpdate.merchantName ● String! non-null scalar​

Business name of the merchant, i.e. name that will be displayed on debtors' bank statements

RequestMerchantProfileUpdate.merchantWebsite ● String scalar​

Url of the merchant's website

RequestMerchantProfileUpdate.merchantLogoUrl ● String scalar​

Url of the merchant's logo

RequestMerchantProfileUpdate.status ● RequestMerchantProfileUpdateStatus! non-null enum​

The status of the request

RequestMerchantProfileUpdate.productType ● ProductType! non-null enum​

Type of product sold. List of value: Goods, Services, VirtualGoods, GiftsAndDonations. Gifts and donations can be club subscription or collection of donations (for associations), tips collection, contributions for local authorities

RequestMerchantProfileUpdate.expectedMonthlyPaymentVolume ● Amount! non-null object​

Expected annual activity volumes for all payment method

RequestMerchantProfileUpdate.expectedAverageBasket ● Amount! non-null object​

expected average basket value.

RequestMerchantProfileUpdate.createdAt ● DateTime! non-null scalar​

created date

RequestMerchantProfileUpdate.updatedAt ● DateTime! non-null scalar​

updated date

Member of​

MerchantProfile object ● RequestMerchantProfileUpdateSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/request-supporting-document-collection-review-success-payload/index.html b/api-reference/objects/request-supporting-document-collection-review-success-payload/index.html index f32fb12540f..efe6e9b956a 100644 --- a/api-reference/objects/request-supporting-document-collection-review-success-payload/index.html +++ b/api-reference/objects/request-supporting-document-collection-review-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/residence-permit-document-file/index.html b/api-reference/objects/residence-permit-document-file/index.html index be83da4e75a..0083e0f9954 100644 --- a/api-reference/objects/residence-permit-document-file/index.html +++ b/api-reference/objects/residence-permit-document-file/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ResidencePermitDocumentFile

The file associated to the resident permit document

type ResidencePermitDocumentFile implements DocumentFile {
  downloadUrl: String!
  side: DocumentFileSide!
}

Fields​

ResidencePermitDocumentFile.downloadUrl ● String! non-null scalar​

The file's temporary download url

ResidencePermitDocumentFile.side ● DocumentFileSide! non-null enum​

From which side the residence permit's picture was taken

Interfaces​

DocumentFile interface​

Retrieved document extracted from the identity verification

Member of​

ResidencePermitDocument object

- + \ No newline at end of file diff --git a/api-reference/objects/residence-permit-document/index.html b/api-reference/objects/residence-permit-document/index.html index fcb8064432d..6bcd0f1afac 100644 --- a/api-reference/objects/residence-permit-document/index.html +++ b/api-reference/objects/residence-permit-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ResidencePermitDocument

The document corresponding to a residence permit

type ResidencePermitDocument {
  id: String!
  type: DocumentType!
  issueDate: Date
  expiryDate: Date
  mrz: String
  number: String
  files: [ResidencePermitDocumentFile!]!
}

Fields​

ResidencePermitDocument.id ● String! non-null scalar​

Unique identifier of the residence permit document

ResidencePermitDocument.type ● DocumentType! non-null enum​

The type of the document

ResidencePermitDocument.issueDate ● Date scalar​

The date at which the residence permit was issued

ResidencePermitDocument.expiryDate ● Date scalar​

The date at which the residence permit expires

ResidencePermitDocument.mrz ● String scalar​

Machine-readable zone code of the residence permit

ResidencePermitDocument.number ● String scalar​

Number of the residence permit

ResidencePermitDocument.files ● [ResidencePermitDocumentFile!]! non-null object​

List of the associated files

Implemented by​

IdentificationDocument union

- + \ No newline at end of file diff --git a/api-reference/objects/restricted-to-user-rejection/index.html b/api-reference/objects/restricted-to-user-rejection/index.html index 3f3b8241eb9..c734e9bc6ea 100644 --- a/api-reference/objects/restricted-to-user-rejection/index.html +++ b/api-reference/objects/restricted-to-user-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/restricted-to/index.html b/api-reference/objects/restricted-to/index.html index c514b8c5242..10d2bfdb9d2 100644 --- a/api-reference/objects/restricted-to/index.html +++ b/api-reference/objects/restricted-to/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RestrictedTo

Account membership restricted to

type RestrictedTo {
  firstName: String!
  lastName: String!
  birthDate: Date
  phoneNumber: String!
}

Fields​

RestrictedTo.firstName ● String! non-null scalar​

first name

RestrictedTo.lastName ● String! non-null scalar​

last name

RestrictedTo.birthDate ● Date scalar​

birth date

RestrictedTo.phoneNumber ● String! non-null scalar​

phone number

Member of​

AccountMembershipBindingUserErrorStatusInfo object ● AccountMembershipConsentPendingStatusInfo object ● AccountMembershipInvitationSentStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/resume-account-membership-success-payload/index.html b/api-reference/objects/resume-account-membership-success-payload/index.html index 59e5c0a9f5b..8a39d9d0c19 100644 --- a/api-reference/objects/resume-account-membership-success-payload/index.html +++ b/api-reference/objects/resume-account-membership-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/resume-physical-card-success-payload/index.html b/api-reference/objects/resume-physical-card-success-payload/index.html index 9d685e85099..fd862319d02 100644 --- a/api-reference/objects/resume-physical-card-success-payload/index.html +++ b/api-reference/objects/resume-physical-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/rolling-reserve/index.html b/api-reference/objects/rolling-reserve/index.html index 7f3115b0fc1..2e0fb369d70 100644 --- a/api-reference/objects/rolling-reserve/index.html +++ b/api-reference/objects/rolling-reserve/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

RollingReserve

Percentage over a number of business days, that is applied to all funds collected to compute a Reserved amount This amount cannot be used over the corresponding business days

type RollingReserve {
  percentage: Int!
  rollingDays: Int!
}

Fields​

RollingReserve.percentage ● Int! non-null scalar​

Percentage of the funding amount to be reserved

RollingReserve.rollingDays ● Int! non-null scalar​

Number of business days the computed amount is reserved

Member of​

CheckMerchantPaymentMethod object ● InternalDirectDebitB2BMerchantPaymentMethod object ● InternalDirectDebitStandardMerchantPaymentMethod object ● MerchantPaymentMethod interface ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitCoreMerchantPaymentMethod object

- + \ No newline at end of file diff --git a/api-reference/objects/schedule-standing-order-success-payload/index.html b/api-reference/objects/schedule-standing-order-success-payload/index.html index ea0b29a6c07..0fe45b9728b 100644 --- a/api-reference/objects/schedule-standing-order-success-payload/index.html +++ b/api-reference/objects/schedule-standing-order-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/scheme-wrong-rejection/index.html b/api-reference/objects/scheme-wrong-rejection/index.html index 46f38c4686e..7e0a9cddf2d 100644 --- a/api-reference/objects/scheme-wrong-rejection/index.html +++ b/api-reference/objects/scheme-wrong-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/scheme/index.html b/api-reference/objects/scheme/index.html index 37d6a80d142..dac8663fa7d 100644 --- a/api-reference/objects/scheme/index.html +++ b/api-reference/objects/scheme/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/select-field/index.html b/api-reference/objects/select-field/index.html index 1cfa581a224..76ee283f6db 100644 --- a/api-reference/objects/select-field/index.html +++ b/api-reference/objects/select-field/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SelectField

No description

type SelectField implements Field {
  key: String!
  name: String!
  refreshDynamicFieldsOnChange: Boolean!
  required: Boolean!
  allowedValues: [AllowedValue!]!
}

Fields​

SelectField.key ● String! non-null scalar​

SelectField.name ● String! non-null scalar​

SelectField.refreshDynamicFieldsOnChange ● Boolean! non-null scalar​

SelectField.required ● Boolean! non-null scalar​

SelectField.allowedValues ● [AllowedValue!]! non-null object​

Interfaces​

Field interface​

- + \ No newline at end of file diff --git a/api-reference/objects/sepa-direct-debit-b2-bmerchant-payment-method/index.html b/api-reference/objects/sepa-direct-debit-b2-bmerchant-payment-method/index.html index 1a7705e9b51..3fe17b2de93 100644 --- a/api-reference/objects/sepa-direct-debit-b2-bmerchant-payment-method/index.html +++ b/api-reference/objects/sepa-direct-debit-b2-bmerchant-payment-method/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SepaDirectDebitB2BMerchantPaymentMethod

SepaDirectDebitB2BMerchantPaymentMethod

type SepaDirectDebitB2BMerchantPaymentMethod implements MerchantPaymentMethod {
  id: ID!
  type: MerchantPaymentMethodType!
  methodId: ID!
  statusInfo: MerchantPaymentMethodStatusInfo!
  version: Int!
  updatedAt: Date!
  rollingReserve: RollingReserve
  useSwanSepaCreditorIdentifier: Boolean!
  sepaCreditorIdentifier: String
}

Fields​

SepaDirectDebitB2BMerchantPaymentMethod.id ● ID! non-null scalar​

Unique identifier tied to every version of a given Merchant Payment Method

SepaDirectDebitB2BMerchantPaymentMethod.type ● MerchantPaymentMethodType! non-null enum​

The Merchant Payment Method Type

SepaDirectDebitB2BMerchantPaymentMethod.methodId ● ID! non-null scalar​

Unique identifier for a given merchant Payment Method, identical for every version of a given Merchant Payment Method Type

SepaDirectDebitB2BMerchantPaymentMethod.statusInfo ● MerchantPaymentMethodStatusInfo! non-null interface​

Status of the Merchant Payment Method

SepaDirectDebitB2BMerchantPaymentMethod.version ● Int! non-null scalar​

Version of the Merchant Payment Method

SepaDirectDebitB2BMerchantPaymentMethod.updatedAt ● Date! non-null scalar​

Date at which the Merchant Payment Method was last updated

SepaDirectDebitB2BMerchantPaymentMethod.rollingReserve ● RollingReserve object​

Rolling Reserve applied to the Merchant Payment Method

SepaDirectDebitB2BMerchantPaymentMethod.useSwanSepaCreditorIdentifier ● Boolean! non-null scalar​

Whether this payment method uses the Swan Sepa Creditor Identifier

SepaDirectDebitB2BMerchantPaymentMethod.sepaCreditorIdentifier ● String scalar​

When the above is false, the value of the Sepa Creditor Identifier used

Interfaces​

MerchantPaymentMethod interface​

Base object for the different Payment Methods available

- + \ No newline at end of file diff --git a/api-reference/objects/sepa-direct-debit-core-merchant-payment-method/index.html b/api-reference/objects/sepa-direct-debit-core-merchant-payment-method/index.html index 55fb18ac0c2..2284301450d 100644 --- a/api-reference/objects/sepa-direct-debit-core-merchant-payment-method/index.html +++ b/api-reference/objects/sepa-direct-debit-core-merchant-payment-method/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SepaDirectDebitCoreMerchantPaymentMethod

SepaDirectDebitCoreMerchantPaymentMethod

type SepaDirectDebitCoreMerchantPaymentMethod implements MerchantPaymentMethod {
  id: ID!
  type: MerchantPaymentMethodType!
  methodId: ID!
  statusInfo: MerchantPaymentMethodStatusInfo!
  version: Int!
  updatedAt: Date!
  rollingReserve: RollingReserve
  useSwanSepaCreditorIdentifier: Boolean!
  sepaCreditorIdentifier: String
}

Fields​

SepaDirectDebitCoreMerchantPaymentMethod.id ● ID! non-null scalar​

Unique identifier tied to every version of a given Merchant Payment Method

SepaDirectDebitCoreMerchantPaymentMethod.type ● MerchantPaymentMethodType! non-null enum​

The Merchant Payment Method Type

SepaDirectDebitCoreMerchantPaymentMethod.methodId ● ID! non-null scalar​

Unique identifier for a given merchant Payment Method, identical for every version of a given Merchant Payment Method Type

SepaDirectDebitCoreMerchantPaymentMethod.statusInfo ● MerchantPaymentMethodStatusInfo! non-null interface​

Status of the Merchant Payment Method

SepaDirectDebitCoreMerchantPaymentMethod.version ● Int! non-null scalar​

Version of the Merchant Payment Method

SepaDirectDebitCoreMerchantPaymentMethod.updatedAt ● Date! non-null scalar​

Date at which the Merchant Payment Method was last updated

SepaDirectDebitCoreMerchantPaymentMethod.rollingReserve ● RollingReserve object​

Rolling Reserve applied to the Merchant Payment Method

SepaDirectDebitCoreMerchantPaymentMethod.useSwanSepaCreditorIdentifier ● Boolean! non-null scalar​

Whether this payment method uses the Swan Sepa Creditor Identifier

SepaDirectDebitCoreMerchantPaymentMethod.sepaCreditorIdentifier ● String scalar​

When the above is false, the value of the Sepa Creditor Identifier used

Interfaces​

MerchantPaymentMethod interface​

Base object for the different Payment Methods available

- + \ No newline at end of file diff --git a/api-reference/objects/sepabeneficiary/index.html b/api-reference/objects/sepabeneficiary/index.html index e232b4425d5..ed16b9692fd 100644 --- a/api-reference/objects/sepabeneficiary/index.html +++ b/api-reference/objects/sepabeneficiary/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content

SEPABeneficiary

SOON TO BE DEPRECATED External Beneficiary type SEPA

type SEPABeneficiary implements Beneficiary {
  id: ID
  name: String!
  isMyOwnIban: Boolean!
  address: Address
  maskedIBAN: String
}

Fields​

SEPABeneficiary.id ● ID scalar​

unique identifier of a beneficiary

SEPABeneficiary.name ● String! non-null scalar​

full name of the beneficiary

SEPABeneficiary.isMyOwnIban ● Boolean! non-null scalar​

true if this new beneficiary is the account holder himself in an other financial institution.

SEPABeneficiary.address ● Address object​

beneficiary address

SEPABeneficiary.maskedIBAN ● String scalar​

maskedIBAN if the beneficiary is a an account in an other financial institution

Interfaces​

Beneficiary interface​

SOON TO BE DEPRECATED Beneficiary

Member of​

SEPACreditTransferOutCreditor object ● SEPADirectDebitInDebtor object ● SEPADirectDebitOutCreditor object ● StandingOrder object

- + \ No newline at end of file diff --git a/api-reference/objects/sepacredit-transfer-in-creditor/index.html b/api-reference/objects/sepacredit-transfer-in-creditor/index.html index 1a6b7c0934b..222d542ab0e 100644 --- a/api-reference/objects/sepacredit-transfer-in-creditor/index.html +++ b/api-reference/objects/sepacredit-transfer-in-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPACreditTransferInCreditor

Sepa Credit Transfer Creditor for Incoming transaction

type SEPACreditTransferInCreditor implements SEPACreditTransferCreditor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  virtualIBANEntryId: ID
  accountNumber: AccountNumber!
}

Fields​

SEPACreditTransferInCreditor.name ● String! non-null scalar​

full name of the creditor

SEPACreditTransferInCreditor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPACreditTransferInCreditor.IBAN ● String scalar​

IBAN

SEPACreditTransferInCreditor.BIC ● String scalar​

BIC

SEPACreditTransferInCreditor.virtualIBANEntryId ● ID scalar​

identifier of a Virtual IBAN

SEPACreditTransferInCreditor.accountNumber ● AccountNumber! non-null scalar​

account number

Interfaces​

SEPACreditTransferCreditor interface​

Sepa Credit Transfer Creditor

- + \ No newline at end of file diff --git a/api-reference/objects/sepacredit-transfer-in-debtor/index.html b/api-reference/objects/sepacredit-transfer-in-debtor/index.html index a0251084d96..693911e8930 100644 --- a/api-reference/objects/sepacredit-transfer-in-debtor/index.html +++ b/api-reference/objects/sepacredit-transfer-in-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPACreditTransferInDebtor

Sepa Credit Transfer Debtor for Incoming transaction

type SEPACreditTransferInDebtor implements SEPACreditTransferDebtor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  virtualIBANEntryId: ID
}

Fields​

SEPACreditTransferInDebtor.name ● String! non-null scalar​

full name of the debtor (max 70 characters)

SEPACreditTransferInDebtor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPACreditTransferInDebtor.IBAN ● String scalar​

IBAN

SEPACreditTransferInDebtor.BIC ● String scalar​

BIC

SEPACreditTransferInDebtor.virtualIBANEntryId ● ID scalar​

identifier of a Virtual IBAN

Interfaces​

SEPACreditTransferDebtor interface​

Sepa Credit Transfer Debtor

- + \ No newline at end of file diff --git a/api-reference/objects/sepacredit-transfer-internal-in-debtor/index.html b/api-reference/objects/sepacredit-transfer-internal-in-debtor/index.html index 55c9dd97d3d..e648e2ab9c3 100644 --- a/api-reference/objects/sepacredit-transfer-internal-in-debtor/index.html +++ b/api-reference/objects/sepacredit-transfer-internal-in-debtor/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

SEPACreditTransferInternalInDebtor

SOON TO BE DEPRECATED Sepa Credit Transfer Debtor for Incoming transaction

type SEPACreditTransferInternalInDebtor implements SEPACreditTransferDebtor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  virtualIBANEntryId: ID
  accountNumber: AccountNumber!
}

Fields​

SEPACreditTransferInternalInDebtor.name ● String! non-null scalar​

full name of the debtor

SEPACreditTransferInternalInDebtor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPACreditTransferInternalInDebtor.IBAN ● String scalar​

IBAN

SEPACreditTransferInternalInDebtor.BIC ● String scalar​

BIC

SEPACreditTransferInternalInDebtor.virtualIBANEntryId ● ID scalar​

identifier of a Virtual IBAN

SEPACreditTransferInternalInDebtor.accountNumber ● AccountNumber! non-null scalar​

account number

Interfaces​

SEPACreditTransferDebtor interface​

Sepa Credit Transfer Debtor

- + \ No newline at end of file diff --git a/api-reference/objects/sepacredit-transfer-internal-out-creditor/index.html b/api-reference/objects/sepacredit-transfer-internal-out-creditor/index.html index d6e56ad8776..33966c0ee47 100644 --- a/api-reference/objects/sepacredit-transfer-internal-out-creditor/index.html +++ b/api-reference/objects/sepacredit-transfer-internal-out-creditor/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

SEPACreditTransferInternalOutCreditor

SOON TO BE DEPRECATED Sepa Credit Transfer Creditor for internal transaction

type SEPACreditTransferInternalOutCreditor implements SEPACreditTransferCreditor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  virtualIBANEntryId: ID
  accountNumber: AccountNumber!
  beneficiary: InternalBeneficiary
}

Fields​

SEPACreditTransferInternalOutCreditor.name ● String! non-null scalar​

full name of the creditor

SEPACreditTransferInternalOutCreditor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPACreditTransferInternalOutCreditor.IBAN ● String scalar​

IBAN

SEPACreditTransferInternalOutCreditor.BIC ● String scalar​

BIC

SEPACreditTransferInternalOutCreditor.virtualIBANEntryId ● ID scalar​

identifier of a Virtual IBAN

SEPACreditTransferInternalOutCreditor.accountNumber ● AccountNumber! non-null scalar​

account number

SEPACreditTransferInternalOutCreditor.beneficiary ● InternalBeneficiary object​

beneficiary if the beneficiary is already saved

Interfaces​

SEPACreditTransferCreditor interface​

Sepa Credit Transfer Creditor

- + \ No newline at end of file diff --git a/api-reference/objects/sepacredit-transfer-out-creditor/index.html b/api-reference/objects/sepacredit-transfer-out-creditor/index.html index db5f1e8fb35..7e026e63ec9 100644 --- a/api-reference/objects/sepacredit-transfer-out-creditor/index.html +++ b/api-reference/objects/sepacredit-transfer-out-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPACreditTransferOutCreditor

Sepa Credit Transfer Creditor for Outgoing transaction

type SEPACreditTransferOutCreditor implements SEPACreditTransferCreditor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  beneficiary: SEPABeneficiary
}

Fields​

SEPACreditTransferOutCreditor.name ● String! non-null scalar​

full name of the creditor

SEPACreditTransferOutCreditor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPACreditTransferOutCreditor.IBAN ● String scalar​

IBAN

SEPACreditTransferOutCreditor.BIC ● String scalar​

BIC

SEPACreditTransferOutCreditor.beneficiary ● SEPABeneficiary object​

beneficiary if the beneficiary is already saved

Interfaces​

SEPACreditTransferCreditor interface​

Sepa Credit Transfer Creditor

- + \ No newline at end of file diff --git a/api-reference/objects/sepacredit-transfer-out-debtor/index.html b/api-reference/objects/sepacredit-transfer-out-debtor/index.html index ef07eb99df8..c28e115b7be 100644 --- a/api-reference/objects/sepacredit-transfer-out-debtor/index.html +++ b/api-reference/objects/sepacredit-transfer-out-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPACreditTransferOutDebtor

Sepa Credit Transfer Debtor for internal transaction

type SEPACreditTransferOutDebtor implements SEPACreditTransferDebtor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  virtualIBANEntryId: ID
  accountNumber: AccountNumber!
}

Fields​

SEPACreditTransferOutDebtor.name ● String! non-null scalar​

full name of the debtor

SEPACreditTransferOutDebtor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPACreditTransferOutDebtor.IBAN ● String scalar​

IBAN

SEPACreditTransferOutDebtor.BIC ● String scalar​

BIC

SEPACreditTransferOutDebtor.virtualIBANEntryId ● ID scalar​

identifier of a Virtual IBAN

SEPACreditTransferOutDebtor.accountNumber ● AccountNumber! non-null scalar​

account number

Interfaces​

SEPACreditTransferDebtor interface​

Sepa Credit Transfer Debtor

- + \ No newline at end of file diff --git a/api-reference/objects/sepacredit-transfer-transaction/index.html b/api-reference/objects/sepacredit-transfer-transaction/index.html index 0bc14fd31e0..97a0626673f 100644 --- a/api-reference/objects/sepacredit-transfer-transaction/index.html +++ b/api-reference/objects/sepacredit-transfer-transaction/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPACreditTransferTransaction

Sepa Credit Transfer transaction

type SEPACreditTransferTransaction implements Transaction {
  id: ID!
  reference: String!
  paymentMethodIdentifier: String!
  side: TransactionSide!
  type: TransactionTypeEnum!
  amount: Amount!
  label: String!
  statusInfo: TransactionStatusInfo!
  paymentId: String
  payment: Payment
  createdAt: DateTime!
  updatedAt: DateTime!
  counterparty: String!
  bookedBalanceAfter: Amount
  paymentProduct: PaymentProduct!
  creditor: SEPACreditTransferCreditor!
  debtor: SEPACreditTransferDebtor!
  account: Account
  externalReference: String
  executionDate: DateTime!
  requestedExecutionAt: DateTime
  originTransactionId: String
  originTransaction: Transaction
  returnReason: TransactionReasonCode
}

Fields​

SEPACreditTransferTransaction.id ● ID! non-null scalar​

unique identifier of the transaction

SEPACreditTransferTransaction.reference ● String! non-null scalar​

reference assigned by the initiating party, to unambiguously identify the transaction. This reference is passed on, unchanged, throughout the entire end-to-end chain.

SEPACreditTransferTransaction.paymentMethodIdentifier ● String! non-null scalar​

payment method identifier used for this transaction. e.g masked PAN or IBAN or accountNumber

SEPACreditTransferTransaction.side ● TransactionSide! non-null enum​

side (Credit or Debit)

SEPACreditTransferTransaction.type ● TransactionTypeEnum! non-null enum​

type

SEPACreditTransferTransaction.amount ● Amount! non-null object​

amount

SEPACreditTransferTransaction.label ● String! non-null scalar​

label

SEPACreditTransferTransaction.statusInfo ● TransactionStatusInfo! non-null interface​

status information

SEPACreditTransferTransaction.paymentId ● String scalar​

ID of the payment associated to this transaction

SEPACreditTransferTransaction.payment ● Payment object​

payment associated to this transaction

SEPACreditTransferTransaction.createdAt ● DateTime! non-null scalar​

created date

SEPACreditTransferTransaction.updatedAt ● DateTime! non-null scalar​

updated date

SEPACreditTransferTransaction.counterparty ● String! non-null scalar​

name of the counterparty. e.g Merchant name, Creditor name, Beneficiary Name ...

SEPACreditTransferTransaction.bookedBalanceAfter ● Amount object​

booked balance after this transaction

SEPACreditTransferTransaction.paymentProduct ● PaymentProduct! non-null enum​

payment product used for this transaction

SEPACreditTransferTransaction.creditor ● SEPACreditTransferCreditor! non-null interface​

creditor information

SEPACreditTransferTransaction.debtor ● SEPACreditTransferDebtor! non-null interface​

debtor information

SEPACreditTransferTransaction.account ● Account object​

matching account for the transaction

SEPACreditTransferTransaction.externalReference ● String scalar​

an arbitrary identifier that was defined by you when you created this transaction.

For example, you can define it in the CreditTransferInput mutation.

SEPACreditTransferTransaction.executionDate ● DateTime! non-null scalar​

a date that reflects the execution date of a transaction from a user viewpoint. Can be used for sorting transactions.

SEPACreditTransferTransaction.requestedExecutionAt ● DateTime scalar​

a date that reflects the time at which the user asked the transaction to be executed

SEPACreditTransferTransaction.originTransactionId ● String scalar​

ID of the origin transaction associated to this transaction

SEPACreditTransferTransaction.originTransaction ● Transaction interface​

origin transaction associated to this transaction

SEPACreditTransferTransaction.returnReason ● TransactionReasonCode enum​

r-transaction reason

Interfaces​

Transaction interface​

Transaction

Member of​

Balance object

- + \ No newline at end of file diff --git a/api-reference/objects/sepadirect-debit-in-creditor/index.html b/api-reference/objects/sepadirect-debit-in-creditor/index.html index 54520b3c285..50685f1fc7c 100644 --- a/api-reference/objects/sepadirect-debit-in-creditor/index.html +++ b/api-reference/objects/sepadirect-debit-in-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPADirectDebitInCreditor

Sepa Direct Debit Creditor for Input transaction

type SEPADirectDebitInCreditor implements SEPADirectDebitCreditor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  virtualIBANEntryId: ID
  accountNumber: AccountNumber!
}

Fields​

SEPADirectDebitInCreditor.name ● String! non-null scalar​

full name of the creditor

SEPADirectDebitInCreditor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPADirectDebitInCreditor.IBAN ● String scalar​

IBAN

SEPADirectDebitInCreditor.BIC ● String scalar​

BIC

SEPADirectDebitInCreditor.virtualIBANEntryId ● ID scalar​

identifier of a Virtual IBAN

SEPADirectDebitInCreditor.accountNumber ● AccountNumber! non-null scalar​

account number

Interfaces​

SEPADirectDebitCreditor interface​

Sepa Direct Debit Creditor

- + \ No newline at end of file diff --git a/api-reference/objects/sepadirect-debit-in-debtor/index.html b/api-reference/objects/sepadirect-debit-in-debtor/index.html index 8c70cebdfc5..ba5589f4a3d 100644 --- a/api-reference/objects/sepadirect-debit-in-debtor/index.html +++ b/api-reference/objects/sepadirect-debit-in-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPADirectDebitInDebtor

Sepa Direct Debtor for Input transaction

type SEPADirectDebitInDebtor implements SEPADirectDebitDebtor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  virtualIBANEntryId: ID
  beneficiary: SEPABeneficiary
}

Fields​

SEPADirectDebitInDebtor.name ● String! non-null scalar​

full name of the debtor

SEPADirectDebitInDebtor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPADirectDebitInDebtor.IBAN ● String scalar​

IBAN

SEPADirectDebitInDebtor.BIC ● String scalar​

BIC

SEPADirectDebitInDebtor.virtualIBANEntryId ● ID scalar​

identifier of a Virtual IBAN

SEPADirectDebitInDebtor.beneficiary ● SEPABeneficiary object​

beneficiary if the beneficiary is already saved

Interfaces​

SEPADirectDebitDebtor interface​

Sepa Direct Debit Debtor

- + \ No newline at end of file diff --git a/api-reference/objects/sepadirect-debit-out-creditor/index.html b/api-reference/objects/sepadirect-debit-out-creditor/index.html index 1aa072d2acb..64ca85081f6 100644 --- a/api-reference/objects/sepadirect-debit-out-creditor/index.html +++ b/api-reference/objects/sepadirect-debit-out-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPADirectDebitOutCreditor

Sepa Direct Debit Creditor for Outgoing transaction

type SEPADirectDebitOutCreditor implements SEPADirectDebitCreditor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  beneficiary: SEPABeneficiary
  virtualIBANEntryId: ID
}

Fields​

SEPADirectDebitOutCreditor.name ● String! non-null scalar​

full name of the creditor (max 70 characters)

SEPADirectDebitOutCreditor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPADirectDebitOutCreditor.IBAN ● String scalar​

IBAN

SEPADirectDebitOutCreditor.BIC ● String scalar​

BIC

SEPADirectDebitOutCreditor.beneficiary ● SEPABeneficiary object​

beneficiary if the beneficiary is already saved

SEPADirectDebitOutCreditor.virtualIBANEntryId ● ID scalar​

identifier of a Virtual IBAN

Interfaces​

SEPADirectDebitCreditor interface​

Sepa Direct Debit Creditor

- + \ No newline at end of file diff --git a/api-reference/objects/sepadirect-debit-out-debtor/index.html b/api-reference/objects/sepadirect-debit-out-debtor/index.html index 3cd4de389a0..c9c6957f434 100644 --- a/api-reference/objects/sepadirect-debit-out-debtor/index.html +++ b/api-reference/objects/sepadirect-debit-out-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPADirectDebitOutDebtor

Sepa Direct Debtor for Outgoing transaction

type SEPADirectDebitOutDebtor implements SEPADirectDebitDebtor {
  name: String!
  maskedIBAN: String!
  IBAN: String
  BIC: String
  virtualIBANEntryId: ID
  accountNumber: AccountNumber!
}

Fields​

SEPADirectDebitOutDebtor.name ● String! non-null scalar​

full name of the debtor

SEPADirectDebitOutDebtor.maskedIBAN ● String! non-null scalar​

maskedIBAN

SEPADirectDebitOutDebtor.IBAN ● String scalar​

IBAN

SEPADirectDebitOutDebtor.BIC ● String scalar​

BIC

SEPADirectDebitOutDebtor.virtualIBANEntryId ● ID scalar​

identifier of a Virtual IBAN

SEPADirectDebitOutDebtor.accountNumber ● AccountNumber! non-null scalar​

account number

Interfaces​

SEPADirectDebitDebtor interface​

Sepa Direct Debit Debtor

- + \ No newline at end of file diff --git a/api-reference/objects/sepadirect-debit-transaction/index.html b/api-reference/objects/sepadirect-debit-transaction/index.html index e214379261f..1c3fcbe291f 100644 --- a/api-reference/objects/sepadirect-debit-transaction/index.html +++ b/api-reference/objects/sepadirect-debit-transaction/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPADirectDebitTransaction

Sepa Direct Debit transaction

type SEPADirectDebitTransaction implements Transaction {
  id: ID!
  reference: String!
  paymentMethodIdentifier: String!
  side: TransactionSide!
  type: TransactionTypeEnum!
  amount: Amount!
  label: String!
  statusInfo: TransactionStatusInfo!
  paymentId: String
  payment: Payment
  createdAt: DateTime!
  updatedAt: DateTime!
  counterparty: String!
  bookedBalanceAfter: Amount
  paymentProduct: PaymentProduct!
  creditor: SEPADirectDebitCreditor!
  debtor: SEPADirectDebitDebtor!
  account: Account
  mandate: SEPADirectDebitMandate
  externalReference: String
  executionDate: DateTime!
  requestedExecutionAt: DateTime
  originTransactionId: String
  originTransaction: Transaction
  reservedAmount: Amount
  reservedAmountReleasedAt: DateTime
  returnReason: TransactionReasonCode
}

Fields​

SEPADirectDebitTransaction.id ● ID! non-null scalar​

unique identifier of the transaction

SEPADirectDebitTransaction.reference ● String! non-null scalar​

reference assigned by the initiating party, to unambiguously identify the transaction. This reference is passed on, unchanged, throughout the entire end-to-end chain.

SEPADirectDebitTransaction.paymentMethodIdentifier ● String! non-null scalar​

payment method identifier used for this transaction. e.g masked PAN or IBAN or accountNumber

SEPADirectDebitTransaction.side ● TransactionSide! non-null enum​

side (Credit or Debit)

SEPADirectDebitTransaction.type ● TransactionTypeEnum! non-null enum​

type

SEPADirectDebitTransaction.amount ● Amount! non-null object​

amount

SEPADirectDebitTransaction.label ● String! non-null scalar​

label

SEPADirectDebitTransaction.statusInfo ● TransactionStatusInfo! non-null interface​

status information

SEPADirectDebitTransaction.paymentId ● String scalar​

ID of the payment associated to this transaction

SEPADirectDebitTransaction.payment ● Payment object​

payment associated to this transaction

SEPADirectDebitTransaction.createdAt ● DateTime! non-null scalar​

created date

SEPADirectDebitTransaction.updatedAt ● DateTime! non-null scalar​

updated date

SEPADirectDebitTransaction.counterparty ● String! non-null scalar​

name of the counterparty. e.g Merchant name, Creditor name, Beneficiary Name ...

SEPADirectDebitTransaction.bookedBalanceAfter ● Amount object​

booked balance after this transaction

SEPADirectDebitTransaction.paymentProduct ● PaymentProduct! non-null enum​

payment product used for this transaction

SEPADirectDebitTransaction.creditor ● SEPADirectDebitCreditor! non-null interface​

creditor information

SEPADirectDebitTransaction.debtor ● SEPADirectDebitDebtor! non-null interface​

debtor information

SEPADirectDebitTransaction.account ● Account object​

matching account for the transaction

SEPADirectDebitTransaction.mandate ● SEPADirectDebitMandate interface​

matching SEPA mandate for the transaction

SEPADirectDebitTransaction.externalReference ● String scalar​

an arbitrary identifier that was defined by you when you created this transaction.

For example, you can define it in the CreditTransferInput mutation.

SEPADirectDebitTransaction.executionDate ● DateTime! non-null scalar​

a date that reflects the execution date of a transaction from a user viewpoint. Can be used for sorting transactions.

SEPADirectDebitTransaction.requestedExecutionAt ● DateTime scalar​

a date that reflects the time at which the user asked the transaction to be executed

SEPADirectDebitTransaction.originTransactionId ● String scalar​

ID of the origin transaction associated to this transaction

SEPADirectDebitTransaction.originTransaction ● Transaction interface​

origin transaction associated to this transaction

SEPADirectDebitTransaction.reservedAmount ● Amount object​

reserved amount of the transaction computed with the rolling reserve.

SEPADirectDebitTransaction.reservedAmountReleasedAt ● DateTime scalar​

date on which reserved funds become available.

SEPADirectDebitTransaction.returnReason ● TransactionReasonCode enum​

r-transaction reason

Interfaces​

Transaction interface​

Transaction

- + \ No newline at end of file diff --git a/api-reference/objects/sepapayment-direct-debit-mandate/index.html b/api-reference/objects/sepapayment-direct-debit-mandate/index.html index 657eac0ee02..295d8d25a4b 100644 --- a/api-reference/objects/sepapayment-direct-debit-mandate/index.html +++ b/api-reference/objects/sepapayment-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPAPaymentDirectDebitMandate

Payment direct debit mandate for SEPA

type SEPAPaymentDirectDebitMandate implements SEPADirectDebitMandate, PaymentDirectDebitMandate, PaymentMandate {
  id: ID!
  transactions(
  first: Int! = 50
  after: String
  filters: TransactionsFiltersInput
): TransactionConnection
  reference: String!
  scheme: SEPAPaymentMandateScheme!
  statusInfo: PaymentMandateStatusInfo!
  sequence: SEPAPaymentMandateSequence!
  mandateDocumentUrl: String!
  debtor: SEPAPaymentMandateDebtor!
  ultimateCreditorName: String
  creditor: SEPAPaymentMandateCreditor!
  signatureDate: Date
  createdAt: DateTime!
  updatedAt: DateTime!
  executedAt: DateTime
  expiredAt: Date
  accountHolder: AccountHolder!
  name: String
}

Fields​

SEPAPaymentDirectDebitMandate.id ● ID! non-null scalar​

Unique identifier of the SEPA Direct Debit Payment Mandate

SEPAPaymentDirectDebitMandate.transactions ● TransactionConnection object​

List of transactions associated with the SEPA Payment Direct Debit Mandate.

SEPAPaymentDirectDebitMandate.transactions.first ● Int! non-null scalar​

number of elements in the list (default value 50)

SEPAPaymentDirectDebitMandate.transactions.after ● String scalar​

When the list of elements needs to start after a element

SEPAPaymentDirectDebitMandate.transactions.filters ● TransactionsFiltersInput input​

When the list of elements needs to be filtered

SEPAPaymentDirectDebitMandate.reference ● String! non-null scalar​

Unique reference of the SEPA Direct Debit Payment Mandate

SEPAPaymentDirectDebitMandate.scheme ● SEPAPaymentMandateScheme! non-null enum​

SEPA Direct Debit Payment Mandate scheme

SEPAPaymentDirectDebitMandate.statusInfo ● PaymentMandateStatusInfo! non-null interface​

SEPA Direct Debit Payment Mandate status information

SEPAPaymentDirectDebitMandate.sequence ● SEPAPaymentMandateSequence! non-null enum​

SEPA Direct Debit Payment Mandate sequence

SEPAPaymentDirectDebitMandate.mandateDocumentUrl ● String! non-null scalar​

SEPA Direct Debit Payment Mandate PDF document URL

SEPAPaymentDirectDebitMandate.debtor ● SEPAPaymentMandateDebtor! non-null object​

SEPA Direct Debit Payment Mandate debtor information

SEPAPaymentDirectDebitMandate.ultimateCreditorName ● String scalar​

SEPA direct debit ultimate creditor name

SEPAPaymentDirectDebitMandate.creditor ● SEPAPaymentMandateCreditor! non-null object​

SEPA Direct Debit Payment Mandate creditor information

SEPAPaymentDirectDebitMandate.signatureDate ● Date scalar​

Signature date of the SEPA Direct Debit Payment Mandate

SEPAPaymentDirectDebitMandate.createdAt ● DateTime! non-null scalar​

Creation date of the SEPA Direct Debit Payment Mandate

SEPAPaymentDirectDebitMandate.updatedAt ● DateTime! non-null scalar​

Last Update date of the SEPA Direct Debit Payment Mandate

SEPAPaymentDirectDebitMandate.executedAt ● DateTime scalar​

Date of the the last transaction executed for the concerned SEPA Direct Debit Payment Mandate

SEPAPaymentDirectDebitMandate.expiredAt ● Date scalar​

Expiry date of the SEPA Direct Debit Payment Mandate

SEPAPaymentDirectDebitMandate.accountHolder ● AccountHolder! non-null object​

Account Holder information

SEPAPaymentDirectDebitMandate.name ● String scalar​

Custom name of the mandate

Interfaces​

SEPADirectDebitMandate interface​

PaymentDirectDebitMandate interface​

PaymentMandate interface​

Member of​

AddSepaDirectDebitPaymentMandateSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/sepapayment-mandate-creditor/index.html b/api-reference/objects/sepapayment-mandate-creditor/index.html index ede7837b3ac..9ed5ea633d7 100644 --- a/api-reference/objects/sepapayment-mandate-creditor/index.html +++ b/api-reference/objects/sepapayment-mandate-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPAPaymentMandateCreditor

No description

type SEPAPaymentMandateCreditor implements PaymentMandateCreditor {
  id: ID!
  identifier: SepaCreditorIdentifier!
  name: String!
  address: Address!
}

Fields​

SEPAPaymentMandateCreditor.id ● ID! non-null scalar​

SEPA Direct Debit Payment Mandate creditor UUID

SEPAPaymentMandateCreditor.identifier ● SepaCreditorIdentifier! non-null scalar​

SEPA Direct Debit Payment Mandate Sepa Creditor Idenfier (SCI)

SEPAPaymentMandateCreditor.name ● String! non-null scalar​

SEPA Direct Debit Payment Mandate creditor name

SEPAPaymentMandateCreditor.address ● Address! non-null object​

SEPA Direct Debit Payment Mandate creditor address

Interfaces​

PaymentMandateCreditor interface​

Member of​

SEPAPaymentDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/objects/sepapayment-mandate-debtor/index.html b/api-reference/objects/sepapayment-mandate-debtor/index.html index 2ea196f4c30..fe34f02d38c 100644 --- a/api-reference/objects/sepapayment-mandate-debtor/index.html +++ b/api-reference/objects/sepapayment-mandate-debtor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPAPaymentMandateDebtor

No description

type SEPAPaymentMandateDebtor implements PaymentMandateDebtor {
  name: String!
  iban: IBAN!
  email: String
  country: CCA3!
  address: Address
}

Fields​

SEPAPaymentMandateDebtor.name ● String! non-null scalar​

SEPA Direct Debit Payment Mandate debtor name

SEPAPaymentMandateDebtor.iban ● IBAN! non-null scalar​

SEPA Direct Debit Payment Mandate debtor IBAN

SEPAPaymentMandateDebtor.email ● String scalar​

SEPA Direct Debit Payment Mandate debtor e-mail

SEPAPaymentMandateDebtor.country ● CCA3! non-null scalar​

SEPA Direct Debit Payment Mandate debtor country

SEPAPaymentMandateDebtor.address ● Address object​

SEPA Direct Debit Payment Mandate debtor address. Mandatory for non EEA Countries

Interfaces​

PaymentMandateDebtor interface​

Member of​

SEPAPaymentDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/objects/separeceived-direct-debit-mandate-creditor/index.html b/api-reference/objects/separeceived-direct-debit-mandate-creditor/index.html index 3f039d13b84..57fd6d8809c 100644 --- a/api-reference/objects/separeceived-direct-debit-mandate-creditor/index.html +++ b/api-reference/objects/separeceived-direct-debit-mandate-creditor/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPAReceivedDirectDebitMandateCreditor

SEPA received direct debit mandate creditor

type SEPAReceivedDirectDebitMandateCreditor {
  identifier: String!
  name: String!
  address: Address!
}

Fields​

SEPAReceivedDirectDebitMandateCreditor.identifier ● String! non-null scalar​

SEPA Creditor identifier (SCI)

SEPAReceivedDirectDebitMandateCreditor.name ● String! non-null scalar​

Name of the SEPA creditor

SEPAReceivedDirectDebitMandateCreditor.address ● Address! non-null object​

Address of the SEPA creditor

Member of​

SEPAReceivedDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/objects/separeceived-direct-debit-mandate/index.html b/api-reference/objects/separeceived-direct-debit-mandate/index.html index 00a21609cd8..684289d7eb7 100644 --- a/api-reference/objects/separeceived-direct-debit-mandate/index.html +++ b/api-reference/objects/separeceived-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SEPAReceivedDirectDebitMandate

Received direct debit mandate for SEPA

type SEPAReceivedDirectDebitMandate implements SEPADirectDebitMandate, ReceivedDirectDebitMandate {
  id: ID!
  transactions(
  first: Int! = 50
  after: String
  filters: TransactionsFiltersInput
): TransactionConnection
  version: String!
  createdAt: DateTime!
  updatedAt: DateTime!
  reference: String!
  scheme: SEPAReceivedDirectDebitMandateScheme!
  sequence: SEPAReceivedDirectDebitMandateSequence!
  creditor: SEPAReceivedDirectDebitMandateCreditor!
  ultimateCreditorName: String
  executedAt: DateTime
  signatureDate: Date
  expiredAt: Date
  statusInfo: ReceivedDirectDebitMandateStatusInfo!
  account: Account
  iban: IBAN!
  name: String
}

Fields​

SEPAReceivedDirectDebitMandate.id ● ID! non-null scalar​

Unique identifier of the received SEPA direct debit mandate, generated by Swan

SEPAReceivedDirectDebitMandate.transactions ● TransactionConnection object​

List of transactions associated with the SEPA Receive Direct Debit Mandate.

SEPAReceivedDirectDebitMandate.transactions.first ● Int! non-null scalar​

number of elements in the list (default value 50)

SEPAReceivedDirectDebitMandate.transactions.after ● String scalar​

When the list of elements needs to start after a element

SEPAReceivedDirectDebitMandate.transactions.filters ● TransactionsFiltersInput input​

When the list of elements needs to be filtered

SEPAReceivedDirectDebitMandate.version ● String! non-null scalar​

Version of the received SEPA direct debit mandate

SEPAReceivedDirectDebitMandate.createdAt ● DateTime! non-null scalar​

Creation date of the received SEPA direct debit mandate

SEPAReceivedDirectDebitMandate.updatedAt ● DateTime! non-null scalar​

Last Update date of the received SEPA direct debit mandate

SEPAReceivedDirectDebitMandate.reference ● String! non-null scalar​

Received SEPA direct debit Unique Mandate Reference (UMR)

SEPAReceivedDirectDebitMandate.scheme ● SEPAReceivedDirectDebitMandateScheme! non-null enum​

Received SEPA direct debit mandate scheme

SEPAReceivedDirectDebitMandate.sequence ● SEPAReceivedDirectDebitMandateSequence! non-null enum​

Received SEPA direct debit mandate sequence

SEPAReceivedDirectDebitMandate.creditor ● SEPAReceivedDirectDebitMandateCreditor! non-null object​

Received SEPA direct debit creditor

SEPAReceivedDirectDebitMandate.ultimateCreditorName ● String scalar​

Received SEPA direct debit ultimate creditor name

SEPAReceivedDirectDebitMandate.executedAt ● DateTime scalar​

Date of the last SEPA direct debit transaction executed for the concerned received SEPA direct debit mandate

SEPAReceivedDirectDebitMandate.signatureDate ● Date scalar​

Date of signature of the received SEPA direct debit mandate

SEPAReceivedDirectDebitMandate.expiredAt ● Date scalar​

Expiry date of the received SEPA direct debit mandate, computed automatically (36 months from the executedAt date)

SEPAReceivedDirectDebitMandate.statusInfo ● ReceivedDirectDebitMandateStatusInfo! non-null interface​

Mandate status information of the received SEPA direct debit mandate

SEPAReceivedDirectDebitMandate.account ● Account object​

Account of the received SEPA direct debit mandate debtor

SEPAReceivedDirectDebitMandate.iban ● IBAN! non-null scalar​

Iban of the received SEPA direct debit mandate debtor

SEPAReceivedDirectDebitMandate.name ● String scalar​

Mandate name

Interfaces​

SEPADirectDebitMandate interface​

ReceivedDirectDebitMandate interface​

Interface for Received Direct Debit Mandate

- + \ No newline at end of file diff --git a/api-reference/objects/server-consent-credentials-not-valid-or-outdated-rejection/index.html b/api-reference/objects/server-consent-credentials-not-valid-or-outdated-rejection/index.html index 184d76951d7..bfa2dadc4df 100644 --- a/api-reference/objects/server-consent-credentials-not-valid-or-outdated-rejection/index.html +++ b/api-reference/objects/server-consent-credentials-not-valid-or-outdated-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/server-consent-not-allowed-for-consent-operation-rejection/index.html b/api-reference/objects/server-consent-not-allowed-for-consent-operation-rejection/index.html index c67b96f81f8..e427794c316 100644 --- a/api-reference/objects/server-consent-not-allowed-for-consent-operation-rejection/index.html +++ b/api-reference/objects/server-consent-not-allowed-for-consent-operation-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/server-consent-not-allowed-for-project-rejection/index.html b/api-reference/objects/server-consent-not-allowed-for-project-rejection/index.html index b7ebc4d03fc..52c65cbe660 100644 --- a/api-reference/objects/server-consent-not-allowed-for-project-rejection/index.html +++ b/api-reference/objects/server-consent-not-allowed-for-project-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/server-consent-project-credential-missing-rejection/index.html b/api-reference/objects/server-consent-project-credential-missing-rejection/index.html index 207a4d0af49..bf8a322e61f 100644 --- a/api-reference/objects/server-consent-project-credential-missing-rejection/index.html +++ b/api-reference/objects/server-consent-project-credential-missing-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/server-consent-project-credential-not-found-rejection/index.html b/api-reference/objects/server-consent-project-credential-not-found-rejection/index.html index aee7e717074..4b3b5cc6d07 100644 --- a/api-reference/objects/server-consent-project-credential-not-found-rejection/index.html +++ b/api-reference/objects/server-consent-project-credential-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/server-consent-project-settings-not-found-rejection/index.html b/api-reference/objects/server-consent-project-settings-not-found-rejection/index.html index 003a28ed912..24bf72bbe5e 100644 --- a/api-reference/objects/server-consent-project-settings-not-found-rejection/index.html +++ b/api-reference/objects/server-consent-project-settings-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/server-consent-signature-not-valid-rejection/index.html b/api-reference/objects/server-consent-signature-not-valid-rejection/index.html index b60afc6aed3..08dd34a32be 100644 --- a/api-reference/objects/server-consent-signature-not-valid-rejection/index.html +++ b/api-reference/objects/server-consent-signature-not-valid-rejection/index.html @@ -7,14 +7,14 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/shareholder/index.html b/api-reference/objects/shareholder/index.html index 644b1d4ad9c..a4612b13005 100644 --- a/api-reference/objects/shareholder/index.html +++ b/api-reference/objects/shareholder/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Shareholder

Shareholder of a company creating a Capital Deposit Case

type Shareholder {
  id: ID!
  capitalDepositAmount: Amount!
  onboarding: Onboarding
  accountId: String
  status: ShareholderStatus!
  info: ShareholderInfo!
  documents: [CapitalDepositDocument!]!
  createdAt: DateTime!
  updatedAt: DateTime!
  relatedCapitalDepositCase: CapitalDepositCase!
}

Fields​

Shareholder.id ● ID! non-null scalar​

Unique identifier of a shareholder.

Shareholder.capitalDepositAmount ● Amount! non-null object​

Amount the shareholder has to deposit.

Shareholder.onboarding ● Onboarding object​

Onboarding information of the shareholder.

Shareholder.accountId ● String scalar​

Unique identifier of the shareholder account.

Shareholder.status ● ShareholderStatus! non-null enum​

Status of the shareholder during the process with Swan.

Shareholder.info ● ShareholderInfo! non-null union​

Extra information about the shareholder

Shareholder.documents ● [CapitalDepositDocument!]! non-null object​

Shareholder documents for the capital deposit case

Shareholder.createdAt ● DateTime! non-null scalar​

Created date

Shareholder.updatedAt ● DateTime! non-null scalar​

Updated date

Shareholder.relatedCapitalDepositCase ● CapitalDepositCase! non-null object​

Information about capital deposit case.

Returned by​

shareholder query

Member of​

CapitalDepositCase object ● CapitalDepositDocument object

- + \ No newline at end of file diff --git a/api-reference/objects/spending-limit/index.html b/api-reference/objects/spending-limit/index.html index 4d0d222e2e4..5cf8e37768b 100644 --- a/api-reference/objects/spending-limit/index.html +++ b/api-reference/objects/spending-limit/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SpendingLimit

Spending limits

type SpendingLimit {
  type: SpendingLimitType!
  period: SpendingLimitPeriod!
  amount: Amount!
}

Fields​

SpendingLimit.type ● SpendingLimitType! non-null enum​

type of limit (defined by the Partner, defined by Swan, etc.)

SpendingLimit.period ● SpendingLimitPeriod! non-null enum​

period concerned

SpendingLimit.amount ● Amount! non-null object​

sum of amount of spending authorized during the period

Member of​

AccountMembership object ● Card object ● CardProduct object

- + \ No newline at end of file diff --git a/api-reference/objects/spending/index.html b/api-reference/objects/spending/index.html index 4fb562c9d46..7d33e529ce7 100644 --- a/api-reference/objects/spending/index.html +++ b/api-reference/objects/spending/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/standing-order-canceled-status-info/index.html b/api-reference/objects/standing-order-canceled-status-info/index.html index fe8a9afd946..fd68fa35d75 100644 --- a/api-reference/objects/standing-order-canceled-status-info/index.html +++ b/api-reference/objects/standing-order-canceled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/standing-order-connection/index.html b/api-reference/objects/standing-order-connection/index.html index 164bcb5efb2..cc68ab3eec9 100644 --- a/api-reference/objects/standing-order-connection/index.html +++ b/api-reference/objects/standing-order-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

StandingOrderConnection

Please see the Connection interface

type StandingOrderConnection implements Connection {
  pageInfo: PageInfo!
  edges: [StandingOrderEdge!]!
  totalCount: Int!
}

Fields​

StandingOrderConnection.pageInfo ● PageInfo! non-null object​

StandingOrderConnection.edges ● [StandingOrderEdge!]! non-null object​

StandingOrderConnection.totalCount ● Int! non-null scalar​

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

Account object

- + \ No newline at end of file diff --git a/api-reference/objects/standing-order-consent-pending-status-info/index.html b/api-reference/objects/standing-order-consent-pending-status-info/index.html index 384d467c51f..5602b09abda 100644 --- a/api-reference/objects/standing-order-consent-pending-status-info/index.html +++ b/api-reference/objects/standing-order-consent-pending-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/standing-order-edge/index.html b/api-reference/objects/standing-order-edge/index.html index 07dadfbe129..ebd7539069e 100644 --- a/api-reference/objects/standing-order-edge/index.html +++ b/api-reference/objects/standing-order-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

StandingOrderEdge

Please see the Connection interface

type StandingOrderEdge implements Edge {
  node: StandingOrder!
  cursor: String!
}

Fields​

StandingOrderEdge.node ● StandingOrder! non-null object​

StandingOrderEdge.cursor ● String! non-null scalar​

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

StandingOrderConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/standing-order-enabled-status-info/index.html b/api-reference/objects/standing-order-enabled-status-info/index.html index 0482ab848be..a218ddb3ff1 100644 --- a/api-reference/objects/standing-order-enabled-status-info/index.html +++ b/api-reference/objects/standing-order-enabled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/standing-order-not-found-rejection/index.html b/api-reference/objects/standing-order-not-found-rejection/index.html index c01386d6e85..7d1ef66f603 100644 --- a/api-reference/objects/standing-order-not-found-rejection/index.html +++ b/api-reference/objects/standing-order-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/standing-order/index.html b/api-reference/objects/standing-order/index.html index 9a0ec8aa749..7d9679b6043 100644 --- a/api-reference/objects/standing-order/index.html +++ b/api-reference/objects/standing-order/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

StandingOrder

No description

type StandingOrder {
  id: ID!
  payments(
  first: Int! = 50
  offset: Int
  after: String
  orderBy: PaymentOrderByInput
  filters: PaymentFiltersInput
): PaymentConnection!
  reference: String
  label: String
  amount: Amount
  targetAvailableBalance: Amount
  period: StandingOrderPeriod!
  firstExecutionDate: DateTime
  lastExecutionDate: DateTime
  sepaBeneficiary: SEPABeneficiary!
  statusInfo: StandingOrderStatusInfo!
  createdAt: Date!
  updatedAt: Date!
  account: Account!
  createdBy: User!
  nextExecutionDate: Date
  creditTransferMode: CreditTransferMode
}

Fields​

StandingOrder.id ● ID! non-null scalar​

Standing Order unique identifier

StandingOrder.payments ● PaymentConnection! non-null object​

A list of payments of an standing order.

StandingOrder.payments.first ● Int! non-null scalar​

number of elements in the list (default value 50)

StandingOrder.payments.offset ● Int scalar​

When the list of elements needs to start at a specific offset

StandingOrder.payments.after ● String scalar​

When the list of elements needs to start after a element

StandingOrder.payments.orderBy ● PaymentOrderByInput input​

When the list of elements needs to be ordered

StandingOrder.payments.filters ● PaymentFiltersInput input​

When the list of elements needs to be filtered

StandingOrder.reference ● String scalar​

reference that will be transferred to the beneficiary throughout the entire end-to-end chain

StandingOrder.label ● String scalar​

label that will be transferred to the beneficiary

StandingOrder.amount ● Amount object​

Fixed Amount that will be regularly transferred

StandingOrder.targetAvailableBalance ● Amount object​

Target available balance value that will be used for periodically clipping the account

StandingOrder.period ● StandingOrderPeriod! non-null enum​

Scheduled period of Standing Order

StandingOrder.firstExecutionDate ● DateTime scalar​

Earlier date the Standing Order will be executed

StandingOrder.lastExecutionDate ● DateTime scalar​

Latest date the Standing Order will be executed

StandingOrder.sepaBeneficiary ● SEPABeneficiary! non-null object​

SEPA beneficiary of the Standing Order

StandingOrder.statusInfo ● StandingOrderStatusInfo! non-null interface​

Status of the Standing Order

StandingOrder.createdAt ● Date! non-null scalar​

Date the Standing Order has been created

StandingOrder.updatedAt ● Date! non-null scalar​

Last date the Standing Order has been updated

StandingOrder.account ● Account! non-null object​

Account of the Standing Order

StandingOrder.createdBy ● User! non-null object​

Identity that scheduled the Standing Order

StandingOrder.nextExecutionDate ● Date scalar​

Next execution date of the Standing Order, if any

StandingOrder.creditTransferMode ● CreditTransferMode enum​

Transfer mode of the Standing Order

Returned by​

standingOrder query

Member of​

CancelStandingOrderSuccessPayload object ● Payment object ● ScheduleStandingOrderSuccessPayload object ● StandingOrderEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/started-identification-level-status-info/index.html b/api-reference/objects/started-identification-level-status-info/index.html index 77430ef6648..930cfc1762b 100644 --- a/api-reference/objects/started-identification-level-status-info/index.html +++ b/api-reference/objects/started-identification-level-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/statement-connection/index.html b/api-reference/objects/statement-connection/index.html index 15a3a3cdb1d..d5bface9a75 100644 --- a/api-reference/objects/statement-connection/index.html +++ b/api-reference/objects/statement-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

StatementConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More).

type StatementConnection implements Connection {
  pageInfo: PageInfo!
  totalCount: Int!
  edges: [StatementEdge!]!
}

Fields​

StatementConnection.pageInfo ● PageInfo! non-null object​

StatementConnection.totalCount ● Int! non-null scalar​

StatementConnection.edges ● [StatementEdge!]! non-null object​

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

Account object

- + \ No newline at end of file diff --git a/api-reference/objects/statement-edge/index.html b/api-reference/objects/statement-edge/index.html index 43ada11f7f0..4d7d14d496a 100644 --- a/api-reference/objects/statement-edge/index.html +++ b/api-reference/objects/statement-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

StatementEdge

Implements the Relay Edge interface.

type StatementEdge implements Edge {
  node: Statement!
  cursor: String!
}

Fields​

StatementEdge.node ● Statement! non-null object​

StatementEdge.cursor ● String! non-null scalar​

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

StatementConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/statement/index.html b/api-reference/objects/statement/index.html index a5b19fb0b6e..54f07bcf646 100644 --- a/api-reference/objects/statement/index.html +++ b/api-reference/objects/statement/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Statement

A statement represent metadata around a banking document that list all of the BOOKED banking transactions that have happened between startDate and endDate

type Statement {
  id: ID!
  account: Account!
  openingBalance: Amount!
  closingBalance: Amount!
  openingDate: DateTime!
  closingDate: DateTime!
  status: StatementStatus!
  period: StatementPeriod
  totalCredits: Amount!
  totalDebits: Amount!
  fees: Amount!
  type: [StatementInfo]!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

Statement.id ● ID! non-null scalar​

unique identifier of the statement

Statement.account ● Account! non-null object​

account of the statement

Statement.openingBalance ● Amount! non-null object​

booked balance at the start of the window

Statement.closingBalance ● Amount! non-null object​

booked balance at the end of the window

Statement.openingDate ● DateTime! non-null scalar​

starting date of the date window

Statement.closingDate ● DateTime! non-null scalar​

ending date of the date window

Statement.status ● StatementStatus! non-null enum​

status of the statement

Statement.period ● StatementPeriod enum​

period of statement (either custom or monthly)

Statement.totalCredits ● Amount! non-null object​

the sum of credit transactions during the window

Statement.totalDebits ● Amount! non-null object​

the sum of debit transactions during the window

Statement.fees ● Amount! non-null object​

the sum of fee transactions during the window

Statement.type ● [StatementInfo]! non-null interface​

type of statements (ex: PDF)

Statement.createdAt ● DateTime! non-null scalar​

created date

Statement.updatedAt ● DateTime! non-null scalar​

updated date

Returned by​

accountStatement query ● generateAccountStatement mutation

Member of​

StatementEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-approved-status-info/index.html b/api-reference/objects/supporting-document-collection-approved-status-info/index.html index c0b163acce5..f7ee196cfcb 100644 --- a/api-reference/objects/supporting-document-collection-approved-status-info/index.html +++ b/api-reference/objects/supporting-document-collection-approved-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionApprovedStatusInfo

Supporting document collection with Approved status

type SupportingDocumentCollectionApprovedStatusInfo implements SupportingDocumentCollectionStatusInfo {
  status: SupportingDocumentCollectionStatus!
  approvedAt: DateTime!
}

Fields​

SupportingDocumentCollectionApprovedStatusInfo.status ● SupportingDocumentCollectionStatus! non-null enum​

When the supporting document collection is approved

SupportingDocumentCollectionApprovedStatusInfo.approvedAt ● DateTime! non-null scalar​

Date on which the supporting document collection has been approved

Interfaces​

SupportingDocumentCollectionStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-canceled-status-info/index.html b/api-reference/objects/supporting-document-collection-canceled-status-info/index.html index 2d933064408..9931ace028d 100644 --- a/api-reference/objects/supporting-document-collection-canceled-status-info/index.html +++ b/api-reference/objects/supporting-document-collection-canceled-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionCanceledStatusInfo

Supporting document collection with Canceled status

type SupportingDocumentCollectionCanceledStatusInfo implements SupportingDocumentCollectionStatusInfo {
  status: SupportingDocumentCollectionStatus!
  canceledAt: DateTime!
}

Fields​

SupportingDocumentCollectionCanceledStatusInfo.status ● SupportingDocumentCollectionStatus! non-null enum​

When the supporting document collection is canceled

SupportingDocumentCollectionCanceledStatusInfo.canceledAt ● DateTime! non-null scalar​

Date on which the supporting document collection has been canceled

Interfaces​

SupportingDocumentCollectionStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-connection/index.html b/api-reference/objects/supporting-document-collection-connection/index.html index f27adbb6220..a60c688b805 100644 --- a/api-reference/objects/supporting-document-collection-connection/index.html +++ b/api-reference/objects/supporting-document-collection-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type SupportingDocumentCollectionConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [SupportingDocumentCollectionEdge!]!
}

Fields​

SupportingDocumentCollectionConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

SupportingDocumentCollectionConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

SupportingDocumentCollectionConnection.edges ● [SupportingDocumentCollectionEdge!]! non-null object​

SupportingDocumentCollectionEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

AccountHolder object

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-edge/index.html b/api-reference/objects/supporting-document-collection-edge/index.html index 0798672dbe7..ea370fa55cd 100644 --- a/api-reference/objects/supporting-document-collection-edge/index.html +++ b/api-reference/objects/supporting-document-collection-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

SupportingDocumentCollectionEdge

Implements the Relay Edge interface

type SupportingDocumentCollectionEdge implements Edge {
  cursor: String!
  node: SupportingDocumentCollection!
}

Fields​

SupportingDocumentCollectionEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

SupportingDocumentCollectionEdge.node ● SupportingDocumentCollection! non-null object​

The supporting document collection

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

SupportingDocumentCollectionConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-not-found-rejection/index.html b/api-reference/objects/supporting-document-collection-not-found-rejection/index.html index 917f21bfebb..4708c098bad 100644 --- a/api-reference/objects/supporting-document-collection-not-found-rejection/index.html +++ b/api-reference/objects/supporting-document-collection-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionNotFoundRejection

Rejection returned if the supporting document collection was not found

type SupportingDocumentCollectionNotFoundRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

SupportingDocumentCollectionNotFoundRejection.id ● String! non-null scalar​

SupportingDocumentCollectionNotFoundRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

DeleteSupportingDocumentPayload union ● GenerateSupportingDocumentUploadUrlPayload union ● RequestSupportingDocumentCollectionReviewPayload union ● UpdateSupportingDocumentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-pending-review-status-info/index.html b/api-reference/objects/supporting-document-collection-pending-review-status-info/index.html index 3e3c5243088..0a0a46ed4c8 100644 --- a/api-reference/objects/supporting-document-collection-pending-review-status-info/index.html +++ b/api-reference/objects/supporting-document-collection-pending-review-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionPendingReviewStatusInfo

Supporting document collection with PendingReview status

type SupportingDocumentCollectionPendingReviewStatusInfo implements SupportingDocumentCollectionStatusInfo {
  status: SupportingDocumentCollectionStatus!
}

Fields​

SupportingDocumentCollectionPendingReviewStatusInfo.status ● SupportingDocumentCollectionStatus! non-null enum​

When the supporting document collection is completed and in compliance review

Interfaces​

SupportingDocumentCollectionStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-rejected-status-info/index.html b/api-reference/objects/supporting-document-collection-rejected-status-info/index.html index dc1fedd1b2b..959b32ff015 100644 --- a/api-reference/objects/supporting-document-collection-rejected-status-info/index.html +++ b/api-reference/objects/supporting-document-collection-rejected-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionRejectedStatusInfo

Supporting document collection with Rejected status

type SupportingDocumentCollectionRejectedStatusInfo implements SupportingDocumentCollectionStatusInfo {
  status: SupportingDocumentCollectionStatus!
  rejectedAt: DateTime!
}

Fields​

SupportingDocumentCollectionRejectedStatusInfo.status ● SupportingDocumentCollectionStatus! non-null enum​

When the supporting document collection is rejected

SupportingDocumentCollectionRejectedStatusInfo.rejectedAt ● DateTime! non-null scalar​

Date on which the supporting document collection has been rejected

Interfaces​

SupportingDocumentCollectionStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-status-does-not-allow-deletion-rejection/index.html b/api-reference/objects/supporting-document-collection-status-does-not-allow-deletion-rejection/index.html index e3c4c08c7f2..6d537e834c0 100644 --- a/api-reference/objects/supporting-document-collection-status-does-not-allow-deletion-rejection/index.html +++ b/api-reference/objects/supporting-document-collection-status-does-not-allow-deletion-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection

Rejection returned if supporting document cannot be deleted because its supporting document collection status is not WaitingForDocument

type SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection implements Rejection {
  message: String!
  supportingDocumentCollectionStatus: SupportingDocumentCollectionStatus!
  supportingDocumentCollection: SupportingDocumentCollection!
}

Fields​

SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection.message ● String! non-null scalar​

SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection.supportingDocumentCollectionStatus ● SupportingDocumentCollectionStatus! non-null enum​

SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection.supportingDocumentCollection ● SupportingDocumentCollection! non-null object​

Interfaces​

Rejection interface​

Implemented by​

DeleteSupportingDocumentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-status-does-not-allow-update-rejection/index.html b/api-reference/objects/supporting-document-collection-status-does-not-allow-update-rejection/index.html index ca357ac54b1..f2d02a7da95 100644 --- a/api-reference/objects/supporting-document-collection-status-does-not-allow-update-rejection/index.html +++ b/api-reference/objects/supporting-document-collection-status-does-not-allow-update-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection

Rejection returned if supporting document cannot be updated because its supporting document collection status is not WaitingForDocument

type SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection implements Rejection {
  message: String!
  supportingDocumentCollectionStatus: SupportingDocumentCollectionStatus!
  supportingDocumentCollection: SupportingDocumentCollection!
}

Fields​

SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection.message ● String! non-null scalar​

SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection.supportingDocumentCollectionStatus ● SupportingDocumentCollectionStatus! non-null enum​

SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection.supportingDocumentCollection ● SupportingDocumentCollection! non-null object​

Interfaces​

Rejection interface​

Implemented by​

UpdateSupportingDocumentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-status-not-allowed-rejection/index.html b/api-reference/objects/supporting-document-collection-status-not-allowed-rejection/index.html index cd0a944d3d3..0428139182a 100644 --- a/api-reference/objects/supporting-document-collection-status-not-allowed-rejection/index.html +++ b/api-reference/objects/supporting-document-collection-status-not-allowed-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionStatusNotAllowedRejection

Rejection returned if the status transition is not allowed

type SupportingDocumentCollectionStatusNotAllowedRejection implements Rejection {
  oldStatus: SupportingDocumentCollectionStatus!
  newStatus: SupportingDocumentCollectionStatus!
  message: String!
}

Fields​

SupportingDocumentCollectionStatusNotAllowedRejection.oldStatus ● SupportingDocumentCollectionStatus! non-null enum​

SupportingDocumentCollectionStatusNotAllowedRejection.newStatus ● SupportingDocumentCollectionStatus! non-null enum​

SupportingDocumentCollectionStatusNotAllowedRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

RequestSupportingDocumentCollectionReviewPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection-waiting-for-document-status-info/index.html b/api-reference/objects/supporting-document-collection-waiting-for-document-status-info/index.html index 83fed3ef006..ea1ec8e81fa 100644 --- a/api-reference/objects/supporting-document-collection-waiting-for-document-status-info/index.html +++ b/api-reference/objects/supporting-document-collection-waiting-for-document-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollectionWaitingForDocumentStatusInfo

Supporting document collection with WaitingForUpload status

type SupportingDocumentCollectionWaitingForDocumentStatusInfo implements SupportingDocumentCollectionStatusInfo {
  status: SupportingDocumentCollectionStatus!
}

Fields​

SupportingDocumentCollectionWaitingForDocumentStatusInfo.status ● SupportingDocumentCollectionStatus! non-null enum​

When the Supporting Document Collection is created

Interfaces​

SupportingDocumentCollectionStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-collection/index.html b/api-reference/objects/supporting-document-collection/index.html index 0308e09d3bc..a5d3a8c05cd 100644 --- a/api-reference/objects/supporting-document-collection/index.html +++ b/api-reference/objects/supporting-document-collection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentCollection

Collection of supporting documents used for compliance

Fetching SupportingDocument is restricted to Project access token

type SupportingDocumentCollection {
  id: String!
  statusInfo: SupportingDocumentCollectionStatusInfo!
  createdAt: DateTime!
  updatedAt: DateTime!
  supportingDocuments: [SupportingDocument]!
  requiredSupportingDocumentPurposes: [SupportingDocumentPurpose!]!
}

Fields​

SupportingDocumentCollection.id ● String! non-null scalar​

Unique identifier of the supporting document collection

SupportingDocumentCollection.statusInfo ● SupportingDocumentCollectionStatusInfo! non-null interface​

Status of the supporting document collection

SupportingDocumentCollection.createdAt ● DateTime! non-null scalar​

Created date

SupportingDocumentCollection.updatedAt ● DateTime! non-null scalar​

Updated date

SupportingDocumentCollection.supportingDocuments ● [SupportingDocument]! non-null object​

List of supported documents contained in the supporting document collection

SupportingDocumentCollection.requiredSupportingDocumentPurposes ● [SupportingDocumentPurpose!]! non-null object​

List of required supporting document purposes for this supporting document collection

Returned by​

supportingDocumentCollection query

Member of​

Onboarding object ● OnboardingInfo object ● RequestSupportingDocumentCollectionReviewSuccessPayload object ● SupportingDocumentCollectionEdge object ● SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection object ● SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection object

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-not-found-rejection/index.html b/api-reference/objects/supporting-document-not-found-rejection/index.html index 99bf1f1ad73..aa594668efc 100644 --- a/api-reference/objects/supporting-document-not-found-rejection/index.html +++ b/api-reference/objects/supporting-document-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentNotFoundRejection

Rejection returned if the supporting document was not found

type SupportingDocumentNotFoundRejection implements Rejection {
  id: String!
  message: String!
}

Fields​

SupportingDocumentNotFoundRejection.id ● String! non-null scalar​

SupportingDocumentNotFoundRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

DeleteSupportingDocumentPayload union ● UpdateSupportingDocumentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-not-uploaded-status-info/index.html b/api-reference/objects/supporting-document-not-uploaded-status-info/index.html index 2ba29721173..8580a05fdab 100644 --- a/api-reference/objects/supporting-document-not-uploaded-status-info/index.html +++ b/api-reference/objects/supporting-document-not-uploaded-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-post-field/index.html b/api-reference/objects/supporting-document-post-field/index.html index b40bfa179d2..955fbd459fe 100644 --- a/api-reference/objects/supporting-document-post-field/index.html +++ b/api-reference/objects/supporting-document-post-field/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-purpose/index.html b/api-reference/objects/supporting-document-purpose/index.html index 0e8e2392470..2f6036a4cc7 100644 --- a/api-reference/objects/supporting-document-purpose/index.html +++ b/api-reference/objects/supporting-document-purpose/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentPurpose

Details of a supporting document purpose

type SupportingDocumentPurpose {
  name: SupportingDocumentPurposeEnum!
  acceptableSupportingDocumentTypes: [SupportingDocumentType!]!
}

Fields​

SupportingDocumentPurpose.name ● SupportingDocumentPurposeEnum! non-null enum​

Technical name of the purpose

SupportingDocumentPurpose.acceptableSupportingDocumentTypes ● [SupportingDocumentType!]! non-null enum​

Corresponding supporting document types accepted for this supporting document purpose

Member of​

SupportingDocumentCollection object

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-refused-status-info/index.html b/api-reference/objects/supporting-document-refused-status-info/index.html index 4c6f975289d..f3c64e604ac 100644 --- a/api-reference/objects/supporting-document-refused-status-info/index.html +++ b/api-reference/objects/supporting-document-refused-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentRefusedStatusInfo

Supporting document with Refused status

type SupportingDocumentRefusedStatusInfo implements SupportingDocumentStatusInfo {
  status: SupportingDocumentStatus!
  downloadUrl: String!
  refusedAt: DateTime!
  reason: String!
  filename: String!
}

Fields​

SupportingDocumentRefusedStatusInfo.status ● SupportingDocumentStatus! non-null enum​

When the document has been refused by Swan

SupportingDocumentRefusedStatusInfo.downloadUrl ● String! non-null scalar​

An unique URL and one-time URL to download the Document

SupportingDocumentRefusedStatusInfo.refusedAt ● DateTime! non-null scalar​

Date on which the supporting document collection has been refused

SupportingDocumentRefusedStatusInfo.reason ● String! non-null scalar​

Reason why the supporting document has been refused

SupportingDocumentRefusedStatusInfo.filename ● String! non-null scalar​

Original file name

Interfaces​

SupportingDocumentStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-settings/index.html b/api-reference/objects/supporting-document-settings/index.html index 2fadefab717..794a0390fa7 100644 --- a/api-reference/objects/supporting-document-settings/index.html +++ b/api-reference/objects/supporting-document-settings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentSettings

No description

type SupportingDocumentSettings {
  collectMode: SupportingDocumentCollectMode!
  communicationLanguage: SupportingDocumentCommunicationLanguageSettings
  emailContact: String
}

Fields​

SupportingDocumentSettings.collectMode ● SupportingDocumentCollectMode! non-null enum​

SupportingDocumentSettings.communicationLanguage ● SupportingDocumentCommunicationLanguageSettings enum​

SupportingDocumentSettings.emailContact ● String scalar​

Member of​

ProjectInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-status-does-not-allow-deletion-rejection/index.html b/api-reference/objects/supporting-document-status-does-not-allow-deletion-rejection/index.html index 2766948348c..7930fe98fdb 100644 --- a/api-reference/objects/supporting-document-status-does-not-allow-deletion-rejection/index.html +++ b/api-reference/objects/supporting-document-status-does-not-allow-deletion-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentStatusDoesNotAllowDeletionRejection

Rejection returned if supporting document cannot be deleted because of its status

type SupportingDocumentStatusDoesNotAllowDeletionRejection implements Rejection {
  supportingDocument: SupportingDocument!
  status: SupportingDocumentStatus!
  message: String!
}

Fields​

SupportingDocumentStatusDoesNotAllowDeletionRejection.supportingDocument ● SupportingDocument! non-null object​

SupportingDocumentStatusDoesNotAllowDeletionRejection.status ● SupportingDocumentStatus! non-null enum​

SupportingDocumentStatusDoesNotAllowDeletionRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

DeleteSupportingDocumentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-status-does-not-allow-update-rejection/index.html b/api-reference/objects/supporting-document-status-does-not-allow-update-rejection/index.html index ca7fdd89078..27470ccdad0 100644 --- a/api-reference/objects/supporting-document-status-does-not-allow-update-rejection/index.html +++ b/api-reference/objects/supporting-document-status-does-not-allow-update-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentStatusDoesNotAllowUpdateRejection

Rejection returned if supporting document cannot be updated because of its status

type SupportingDocumentStatusDoesNotAllowUpdateRejection implements Rejection {
  supportingDocument: SupportingDocument!
  status: SupportingDocumentStatus!
  message: String!
}

Fields​

SupportingDocumentStatusDoesNotAllowUpdateRejection.supportingDocument ● SupportingDocument! non-null object​

SupportingDocumentStatusDoesNotAllowUpdateRejection.status ● SupportingDocumentStatus! non-null enum​

SupportingDocumentStatusDoesNotAllowUpdateRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

UpdateSupportingDocumentPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-status-not-allowed-rejection/index.html b/api-reference/objects/supporting-document-status-not-allowed-rejection/index.html index 21cc64bd394..48a23056056 100644 --- a/api-reference/objects/supporting-document-status-not-allowed-rejection/index.html +++ b/api-reference/objects/supporting-document-status-not-allowed-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentStatusNotAllowedRejection

Rejection returned if the status transition is not allowed

type SupportingDocumentStatusNotAllowedRejection implements Rejection {
  oldStatus: SupportingDocumentStatus!
  newStatus: SupportingDocumentStatus!
  message: String!
}

Fields​

SupportingDocumentStatusNotAllowedRejection.oldStatus ● SupportingDocumentStatus! non-null enum​

SupportingDocumentStatusNotAllowedRejection.newStatus ● SupportingDocumentStatus! non-null enum​

SupportingDocumentStatusNotAllowedRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-upload-info/index.html b/api-reference/objects/supporting-document-upload-info/index.html index 62b4124b789..366d06a268e 100644 --- a/api-reference/objects/supporting-document-upload-info/index.html +++ b/api-reference/objects/supporting-document-upload-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-upload-not-allowed-rejection/index.html b/api-reference/objects/supporting-document-upload-not-allowed-rejection/index.html index 9b3957bf4ca..1a7c1df9f2d 100644 --- a/api-reference/objects/supporting-document-upload-not-allowed-rejection/index.html +++ b/api-reference/objects/supporting-document-upload-not-allowed-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentUploadNotAllowedRejection

Rejection returned if the supporting document collection cannot receive supporting documents anymore

type SupportingDocumentUploadNotAllowedRejection implements Rejection {
  supportingDocumentCollectionStatus: SupportingDocumentCollectionStatus!
  message: String!
}

Fields​

SupportingDocumentUploadNotAllowedRejection.supportingDocumentCollectionStatus ● SupportingDocumentCollectionStatus! non-null enum​

SupportingDocumentUploadNotAllowedRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

GenerateSupportingDocumentUploadUrlPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-uploaded-status-info/index.html b/api-reference/objects/supporting-document-uploaded-status-info/index.html index bff6035e591..97288eb2bd3 100644 --- a/api-reference/objects/supporting-document-uploaded-status-info/index.html +++ b/api-reference/objects/supporting-document-uploaded-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentUploadedStatusInfo

Supporting document with Uploaded status

type SupportingDocumentUploadedStatusInfo implements SupportingDocumentStatusInfo {
  status: SupportingDocumentStatus!
  downloadUrl: String!
  filename: String!
}

Fields​

SupportingDocumentUploadedStatusInfo.status ● SupportingDocumentStatus! non-null enum​

When the document has been uploaded but not verified by Swan yet

SupportingDocumentUploadedStatusInfo.downloadUrl ● String! non-null scalar​

An unique URL and one-time URL to download the Document

SupportingDocumentUploadedStatusInfo.filename ● String! non-null scalar​

Original file name

Interfaces​

SupportingDocumentStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-validated-status-info/index.html b/api-reference/objects/supporting-document-validated-status-info/index.html index 92ed813276e..11cff8a291e 100644 --- a/api-reference/objects/supporting-document-validated-status-info/index.html +++ b/api-reference/objects/supporting-document-validated-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentValidatedStatusInfo

Supporting document with Validated status

type SupportingDocumentValidatedStatusInfo implements SupportingDocumentStatusInfo {
  status: SupportingDocumentStatus!
  downloadUrl: String!
  validatedAt: DateTime!
  filename: String!
}

Fields​

SupportingDocumentValidatedStatusInfo.status ● SupportingDocumentStatus! non-null enum​

When the document has been uploaded and verified by Swan

SupportingDocumentValidatedStatusInfo.downloadUrl ● String! non-null scalar​

An unique URL and one-time URL to download the Document

SupportingDocumentValidatedStatusInfo.validatedAt ● DateTime! non-null scalar​

Date on which the supporting document has been validated

SupportingDocumentValidatedStatusInfo.filename ● String! non-null scalar​

Original file name

Interfaces​

SupportingDocumentStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document-waiting-for-upload-status-info/index.html b/api-reference/objects/supporting-document-waiting-for-upload-status-info/index.html index a508dbf4c54..20f59835ba5 100644 --- a/api-reference/objects/supporting-document-waiting-for-upload-status-info/index.html +++ b/api-reference/objects/supporting-document-waiting-for-upload-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocumentWaitingForUploadStatusInfo

Supporting document with WaitingForUpload status

type SupportingDocumentWaitingForUploadStatusInfo implements SupportingDocumentStatusInfo {
  status: SupportingDocumentStatus!
  upload: SupportingDocumentUploadInfo!
}

Fields​

SupportingDocumentWaitingForUploadStatusInfo.status ● SupportingDocumentStatus! non-null enum​

When the document is not uploaded yet

SupportingDocumentWaitingForUploadStatusInfo.upload ● SupportingDocumentUploadInfo! non-null object​

Info to upload the document : url and fields to add along file in form (POST)

Interfaces​

SupportingDocumentStatusInfo interface​

- + \ No newline at end of file diff --git a/api-reference/objects/supporting-document/index.html b/api-reference/objects/supporting-document/index.html index bc4307956e9..43f62ce4c0f 100644 --- a/api-reference/objects/supporting-document/index.html +++ b/api-reference/objects/supporting-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SupportingDocument

Supporting document used for compliance

type SupportingDocument {
  id: String!
  statusInfo: SupportingDocumentStatusInfo!
  supportingDocumentType: SupportingDocumentType
  supportingDocumentPurpose: SupportingDocumentPurposeEnum!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

SupportingDocument.id ● String! non-null scalar​

Unique identifier of the document

SupportingDocument.statusInfo ● SupportingDocumentStatusInfo! non-null interface​

Supporting document status information

SupportingDocument.supportingDocumentType ● SupportingDocumentType enum​

Type of supporting Document

SupportingDocument.supportingDocumentPurpose ● SupportingDocumentPurposeEnum! non-null enum​

Purpose of supporting document

SupportingDocument.createdAt ● DateTime! non-null scalar​

Created date

SupportingDocument.updatedAt ● DateTime! non-null scalar​

Updated date

Member of​

SupportingDocumentCollection object ● SupportingDocumentStatusDoesNotAllowDeletionRejection object ● SupportingDocumentStatusDoesNotAllowUpdateRejection object ● UpdateSupportingDocumentSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/suspend-account-membership-success-payload/index.html b/api-reference/objects/suspend-account-membership-success-payload/index.html index 6ced0ac934a..81fc128180f 100644 --- a/api-reference/objects/suspend-account-membership-success-payload/index.html +++ b/api-reference/objects/suspend-account-membership-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/suspend-account-reason/index.html b/api-reference/objects/suspend-account-reason/index.html index fd4c74f2b28..6a2db20143e 100644 --- a/api-reference/objects/suspend-account-reason/index.html +++ b/api-reference/objects/suspend-account-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/suspend-physical-card-success-payload/index.html b/api-reference/objects/suspend-physical-card-success-payload/index.html index e1d020cf45f..f826d6f73da 100644 --- a/api-reference/objects/suspend-physical-card-success-payload/index.html +++ b/api-reference/objects/suspend-physical-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/suspend-received-direct-debit-mandate-success-payload/index.html b/api-reference/objects/suspend-received-direct-debit-mandate-success-payload/index.html index c505a581f06..c43fc164df5 100644 --- a/api-reference/objects/suspend-received-direct-debit-mandate-success-payload/index.html +++ b/api-reference/objects/suspend-received-direct-debit-mandate-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SuspendReceivedDirectDebitMandateSuccessPayload

Return type in case of a successful response of the suspendReceivedDirectDebitMandate mutation

type SuspendReceivedDirectDebitMandateSuccessPayload {
  receivedDirectDebitMandate: ReceivedDirectDebitMandate!
}

Fields​

SuspendReceivedDirectDebitMandateSuccessPayload.receivedDirectDebitMandate ● ReceivedDirectDebitMandate! non-null interface​

the received direct debit mandate is suspended

Implemented by​

SuspendReceivedDirectDebitMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/suspend-received-direct-debit-mandated-rejection/index.html b/api-reference/objects/suspend-received-direct-debit-mandated-rejection/index.html index b20a38ece3c..e92caa0a88e 100644 --- a/api-reference/objects/suspend-received-direct-debit-mandated-rejection/index.html +++ b/api-reference/objects/suspend-received-direct-debit-mandated-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SuspendReceivedDirectDebitMandatedRejection

Rejection returned if the SuspendReceivedDirectDebitMandatedRejection mutation is rejected

type SuspendReceivedDirectDebitMandatedRejection implements Rejection {
  message: String!
  reason: SuspendReceivedDirectDebitMandatedRejectionReason!
}

Fields​

SuspendReceivedDirectDebitMandatedRejection.message ● String! non-null scalar​

SuspendReceivedDirectDebitMandatedRejection.reason ● SuspendReceivedDirectDebitMandatedRejectionReason! non-null enum​

Interfaces​

Rejection interface​

Implemented by​

SuspendReceivedDirectDebitMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/suspended-funding-limit-settings-status-info/index.html b/api-reference/objects/suspended-funding-limit-settings-status-info/index.html index 66710e049de..9bd9df6f6c3 100644 --- a/api-reference/objects/suspended-funding-limit-settings-status-info/index.html +++ b/api-reference/objects/suspended-funding-limit-settings-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SuspendedFundingLimitSettingsStatusInfo

StatusInfo when funding limit settings has been suspended

type SuspendedFundingLimitSettingsStatusInfo implements FundingLimitSettingsStatusInfo {
  status: FundingLimitSettingsStatus!
  reason: String!
}

Fields​

SuspendedFundingLimitSettingsStatusInfo.status ● FundingLimitSettingsStatus! non-null enum​

SuspendedFundingLimitSettingsStatusInfo.reason ● String! non-null scalar​

Interfaces​

FundingLimitSettingsStatusInfo interface​

Object containing details about funding limit settings status

- + \ No newline at end of file diff --git a/api-reference/objects/suspended-funding-source-status-info/index.html b/api-reference/objects/suspended-funding-source-status-info/index.html index 7f123125ee4..27dceeb249a 100644 --- a/api-reference/objects/suspended-funding-source-status-info/index.html +++ b/api-reference/objects/suspended-funding-source-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SuspendedFundingSourceStatusInfo

Funding Source Suspended status information

type SuspendedFundingSourceStatusInfo implements FundingSourceStatusInfo {
  status: FundingSourceStatus!
  suspendedAt: Date!
}

Fields​

SuspendedFundingSourceStatusInfo.status ● FundingSourceStatus! non-null enum​

Funding Source Suspended status

SuspendedFundingSourceStatusInfo.suspendedAt ● Date! non-null scalar​

Date at which the funding source was suspended

Interfaces​

FundingSourceStatusInfo interface​

Funding Source status information

- + \ No newline at end of file diff --git a/api-reference/objects/suspended-merchant-payment-method-status-info/index.html b/api-reference/objects/suspended-merchant-payment-method-status-info/index.html index 83572e9c378..67e443350ff 100644 --- a/api-reference/objects/suspended-merchant-payment-method-status-info/index.html +++ b/api-reference/objects/suspended-merchant-payment-method-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SuspendedMerchantPaymentMethodStatusInfo

SuspendedMerchantPaymentMethodStatusInfo

type SuspendedMerchantPaymentMethodStatusInfo implements MerchantPaymentMethodStatusInfo {
  status: MerchantPaymentMethodStatus!
  suspendedAt: Date!
}

Fields​

SuspendedMerchantPaymentMethodStatusInfo.status ● MerchantPaymentMethodStatus! non-null enum​

SuspendedMerchantPaymentMethodStatusInfo.suspendedAt ● Date! non-null scalar​

Merchant Payment Method suspended date

Interfaces​

MerchantPaymentMethodStatusInfo interface​

The payment method status information

- + \ No newline at end of file diff --git a/api-reference/objects/suspended-merchant-profile-status-info/index.html b/api-reference/objects/suspended-merchant-profile-status-info/index.html index ade7d3fbe47..3f966b44930 100644 --- a/api-reference/objects/suspended-merchant-profile-status-info/index.html +++ b/api-reference/objects/suspended-merchant-profile-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/swan-tcudocument-not-found-rejection/index.html b/api-reference/objects/swan-tcudocument-not-found-rejection/index.html index 83c107b0298..a83af918e64 100644 --- a/api-reference/objects/swan-tcudocument-not-found-rejection/index.html +++ b/api-reference/objects/swan-tcudocument-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/swan-tcudocument-status-not-allowed-rejection/index.html b/api-reference/objects/swan-tcudocument-status-not-allowed-rejection/index.html index a5ebd5b7b3e..f1aee69bed2 100644 --- a/api-reference/objects/swan-tcudocument-status-not-allowed-rejection/index.html +++ b/api-reference/objects/swan-tcudocument-status-not-allowed-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/text-field/index.html b/api-reference/objects/text-field/index.html index 3d2595fea8c..601f71bd323 100644 --- a/api-reference/objects/text-field/index.html +++ b/api-reference/objects/text-field/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

TextField

No description

type TextField implements Field {
  displayFormat: String
  example: String
  key: String!
  maxLength: Int
  minLength: Int
  name: String!
  refreshDynamicFieldsOnChange: Boolean!
  required: Boolean!
  validationRegex: String
}

Fields​

TextField.displayFormat ● String scalar​

TextField.example ● String scalar​

TextField.key ● String! non-null scalar​

TextField.maxLength ● Int scalar​

TextField.minLength ● Int scalar​

TextField.name ● String! non-null scalar​

TextField.refreshDynamicFieldsOnChange ● Boolean! non-null scalar​

TextField.required ● Boolean! non-null scalar​

TextField.validationRegex ● String scalar​

Interfaces​

Field interface​

- + \ No newline at end of file diff --git a/api-reference/objects/too-many-child-consents-rejection/index.html b/api-reference/objects/too-many-child-consents-rejection/index.html index 3ec516e5669..130447f7ede 100644 --- a/api-reference/objects/too-many-child-consents-rejection/index.html +++ b/api-reference/objects/too-many-child-consents-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/too-many-items-rejection/index.html b/api-reference/objects/too-many-items-rejection/index.html index 9fbd7bb0c8a..4c865491263 100644 --- a/api-reference/objects/too-many-items-rejection/index.html +++ b/api-reference/objects/too-many-items-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/transaction-connection/index.html b/api-reference/objects/transaction-connection/index.html index 8a3e41a1db8..fd46f47e11e 100644 --- a/api-reference/objects/transaction-connection/index.html +++ b/api-reference/objects/transaction-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

TransactionConnection

Please see the Connection interface

type TransactionConnection implements Connection {
  pageInfo: PageInfo!
  totalCount: Int!
  edges: [TransactionEdge!]!
}

Fields​

TransactionConnection.pageInfo ● PageInfo! non-null object​

TransactionConnection.totalCount ● Int! non-null scalar​

TransactionConnection.edges ● [TransactionEdge!]! non-null object​

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

transactions query

Member of​

Account object ● Card object ● InternalPaymentDirectDebitMandate object ● InternalReceivedDirectDebitMandate object ● Payment object ● SEPAPaymentDirectDebitMandate object ● SEPAReceivedDirectDebitMandate object

- + \ No newline at end of file diff --git a/api-reference/objects/transaction-edge/index.html b/api-reference/objects/transaction-edge/index.html index 4d37bb3b7b6..329ab3c82b7 100644 --- a/api-reference/objects/transaction-edge/index.html +++ b/api-reference/objects/transaction-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

TransactionEdge

Please see the Edge interface

type TransactionEdge implements Edge {
  node: Transaction!
  cursor: String!
}

Fields​

TransactionEdge.node ● Transaction! non-null interface​

TransactionEdge.cursor ● String! non-null scalar​

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

TransactionConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/transaction-not-found-rejection/index.html b/api-reference/objects/transaction-not-found-rejection/index.html index d71617384ea..80462243aff 100644 --- a/api-reference/objects/transaction-not-found-rejection/index.html +++ b/api-reference/objects/transaction-not-found-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/ultimate-beneficial-direct-owner-company-info/index.html b/api-reference/objects/ultimate-beneficial-direct-owner-company-info/index.html index 80460a39001..866bf07e19e 100644 --- a/api-reference/objects/ultimate-beneficial-direct-owner-company-info/index.html +++ b/api-reference/objects/ultimate-beneficial-direct-owner-company-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UltimateBeneficialDirectOwnerCompanyInfo

Ultimate beneficial Direct Owner company info.

type UltimateBeneficialDirectOwnerCompanyInfo implements UltimateBeneficialOwnerInfo {
  id: ID!
  type: UltimateBeneficialOwnerType!
  parentCompanyShareRatio: Float!
  name: String!
  registrationNumber: String!
}

Fields​

UltimateBeneficialDirectOwnerCompanyInfo.id ● ID! non-null scalar​

Ultimate Beneficial Owner Unique Identifier .

UltimateBeneficialDirectOwnerCompanyInfo.type ● UltimateBeneficialOwnerType! non-null enum​

Ultimate beneficial Direct Owner Company type.

UltimateBeneficialDirectOwnerCompanyInfo.parentCompanyShareRatio ● Float! non-null scalar​

Shares ratio of the parent company. Example: 50 if the share ratio is 50%.

UltimateBeneficialDirectOwnerCompanyInfo.name ● String! non-null scalar​

Name of the company.

UltimateBeneficialDirectOwnerCompanyInfo.registrationNumber ● String! non-null scalar​

Registration number.

Interfaces​

UltimateBeneficialOwnerInfo interface​

The Ultimate Beneficial Owner could be for an Individual or a Company and these can Direct or Indirect

- + \ No newline at end of file diff --git a/api-reference/objects/ultimate-beneficial-direct-owner-individual-info/index.html b/api-reference/objects/ultimate-beneficial-direct-owner-individual-info/index.html index eb2d2235d48..5736b5ba173 100644 --- a/api-reference/objects/ultimate-beneficial-direct-owner-individual-info/index.html +++ b/api-reference/objects/ultimate-beneficial-direct-owner-individual-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UltimateBeneficialDirectOwnerIndividualInfo

Ultimate beneficial Direct Owner individual info.

type UltimateBeneficialDirectOwnerIndividualInfo implements UltimateBeneficialOwnerInfo {
  id: ID!
  type: UltimateBeneficialOwnerType!
  parentCompanyShareRatio: Float!
  firstName: String!
  lastName: String!
  birthDate: Date!
}

Fields​

UltimateBeneficialDirectOwnerIndividualInfo.id ● ID! non-null scalar​

Ultimate Beneficial Owner Unique Identifier .

UltimateBeneficialDirectOwnerIndividualInfo.type ● UltimateBeneficialOwnerType! non-null enum​

Ultimate beneficial Direct owner Individual type .

UltimateBeneficialDirectOwnerIndividualInfo.parentCompanyShareRatio ● Float! non-null scalar​

Shares ratio of the parent company. Example: 50 if the share ratio is 50%.

UltimateBeneficialDirectOwnerIndividualInfo.firstName ● String! non-null scalar​

First name.

UltimateBeneficialDirectOwnerIndividualInfo.lastName ● String! non-null scalar​

Last name.

UltimateBeneficialDirectOwnerIndividualInfo.birthDate ● Date! non-null scalar​

Birth date.

Interfaces​

UltimateBeneficialOwnerInfo interface​

The Ultimate Beneficial Owner could be for an Individual or a Company and these can Direct or Indirect

- + \ No newline at end of file diff --git a/api-reference/objects/ultimate-beneficial-indirect-owner-company-info/index.html b/api-reference/objects/ultimate-beneficial-indirect-owner-company-info/index.html index e53a3e6409c..3ea1100d618 100644 --- a/api-reference/objects/ultimate-beneficial-indirect-owner-company-info/index.html +++ b/api-reference/objects/ultimate-beneficial-indirect-owner-company-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UltimateBeneficialIndirectOwnerCompanyInfo

Ultimate beneficial owner company info.

type UltimateBeneficialIndirectOwnerCompanyInfo implements UltimateBeneficialOwnerInfo {
  id: ID!
  type: UltimateBeneficialOwnerType!
  parentCompanyReference: String!
  parentCompanyShareRatio: Float!
  name: String!
  registrationNumber: String!
}

Fields​

UltimateBeneficialIndirectOwnerCompanyInfo.id ● ID! non-null scalar​

Ultimate Beneficial Owner Unique Identifier .

UltimateBeneficialIndirectOwnerCompanyInfo.type ● UltimateBeneficialOwnerType! non-null enum​

Ultimate beneficial Indirect Owner Company type.

UltimateBeneficialIndirectOwnerCompanyInfo.parentCompanyReference ● String! non-null scalar​

Unique Reference of the Parent Company.

UltimateBeneficialIndirectOwnerCompanyInfo.parentCompanyShareRatio ● Float! non-null scalar​

Shares ratio of the parent company. Example: 50 if the share ratio is 50%.

UltimateBeneficialIndirectOwnerCompanyInfo.name ● String! non-null scalar​

Name of the company.

UltimateBeneficialIndirectOwnerCompanyInfo.registrationNumber ● String! non-null scalar​

Registration number.

Interfaces​

UltimateBeneficialOwnerInfo interface​

The Ultimate Beneficial Owner could be for an Individual or a Company and these can Direct or Indirect

- + \ No newline at end of file diff --git a/api-reference/objects/ultimate-beneficial-indirect-owner-individual-info/index.html b/api-reference/objects/ultimate-beneficial-indirect-owner-individual-info/index.html index f8a6ef65ccb..1f540cdb66f 100644 --- a/api-reference/objects/ultimate-beneficial-indirect-owner-individual-info/index.html +++ b/api-reference/objects/ultimate-beneficial-indirect-owner-individual-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UltimateBeneficialIndirectOwnerIndividualInfo

Ultimate beneficial Indirect Owner individual info.

type UltimateBeneficialIndirectOwnerIndividualInfo implements UltimateBeneficialOwnerInfo {
  id: ID!
  type: UltimateBeneficialOwnerType!
  parentCompanyReference: String!
  parentCompanyShareRatio: Float!
  firstName: String!
  lastName: String!
  birthDate: Date!
}

Fields​

UltimateBeneficialIndirectOwnerIndividualInfo.id ● ID! non-null scalar​

Ultimate Beneficial Owner Unique Identifier.

UltimateBeneficialIndirectOwnerIndividualInfo.type ● UltimateBeneficialOwnerType! non-null enum​

Ultimate beneficial Indirect Owner Individual type .

UltimateBeneficialIndirectOwnerIndividualInfo.parentCompanyReference ● String! non-null scalar​

Unique Reference of the Parent Company.

UltimateBeneficialIndirectOwnerIndividualInfo.parentCompanyShareRatio ● Float! non-null scalar​

Shares ratio of the parent company. Example: 50 if the share ratio is 50%.

UltimateBeneficialIndirectOwnerIndividualInfo.firstName ● String! non-null scalar​

First name.

UltimateBeneficialIndirectOwnerIndividualInfo.lastName ● String! non-null scalar​

Last name.

UltimateBeneficialIndirectOwnerIndividualInfo.birthDate ● Date! non-null scalar​

Birth date.

Interfaces​

UltimateBeneficialOwnerInfo interface​

The Ultimate Beneficial Owner could be for an Individual or a Company and these can Direct or Indirect

- + \ No newline at end of file diff --git a/api-reference/objects/upcoming-transaction-status-info/index.html b/api-reference/objects/upcoming-transaction-status-info/index.html index 88f3648da93..d8fab19ce60 100644 --- a/api-reference/objects/upcoming-transaction-status-info/index.html +++ b/api-reference/objects/upcoming-transaction-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpcomingTransactionStatusInfo

Upcoming transaction status information

type UpcomingTransactionStatusInfo implements TransactionStatusInfo {
  status: TransactionStatus!
  executionDate: DateTime!
}

Fields​

UpcomingTransactionStatusInfo.status ● TransactionStatus! non-null enum​

status of the transaction

UpcomingTransactionStatusInfo.executionDate ● DateTime! non-null scalar​

The date when the transaction will be executed

Interfaces​

TransactionStatusInfo interface​

Transaction Status information

- + \ No newline at end of file diff --git a/api-reference/objects/update-account-holder-success-payload/index.html b/api-reference/objects/update-account-holder-success-payload/index.html index 7331cc86e8e..a610e58d26c 100644 --- a/api-reference/objects/update-account-holder-success-payload/index.html +++ b/api-reference/objects/update-account-holder-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/update-account-membership-success-payload/index.html b/api-reference/objects/update-account-membership-success-payload/index.html index 94f0b32c5ef..1120f5fa422 100644 --- a/api-reference/objects/update-account-membership-success-payload/index.html +++ b/api-reference/objects/update-account-membership-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/update-account-success-payload/index.html b/api-reference/objects/update-account-success-payload/index.html index 7fb01a0fcf6..e3676606943 100644 --- a/api-reference/objects/update-account-success-payload/index.html +++ b/api-reference/objects/update-account-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/update-card-success-payload/index.html b/api-reference/objects/update-card-success-payload/index.html index 5230c0f3a16..7a4b66412aa 100644 --- a/api-reference/objects/update-card-success-payload/index.html +++ b/api-reference/objects/update-card-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/update-company-onboarding-success-payload/index.html b/api-reference/objects/update-company-onboarding-success-payload/index.html index d9d973fc89f..074ebc709d9 100644 --- a/api-reference/objects/update-company-onboarding-success-payload/index.html +++ b/api-reference/objects/update-company-onboarding-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/update-individual-onboarding-success-payload/index.html b/api-reference/objects/update-individual-onboarding-success-payload/index.html index 72929a91b81..2f062fc409b 100644 --- a/api-reference/objects/update-individual-onboarding-success-payload/index.html +++ b/api-reference/objects/update-individual-onboarding-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/update-received-sepa-direct-debit-b2-b-mandate-success-payload/index.html b/api-reference/objects/update-received-sepa-direct-debit-b2-b-mandate-success-payload/index.html index f92f207083a..50f29ae0658 100644 --- a/api-reference/objects/update-received-sepa-direct-debit-b2-b-mandate-success-payload/index.html +++ b/api-reference/objects/update-received-sepa-direct-debit-b2-b-mandate-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateReceivedSepaDirectDebitB2bMandateSuccessPayload

Return type in case of a successful response of the updateReceivedSepaDirectDebitB2bMandate mutation

type UpdateReceivedSepaDirectDebitB2bMandateSuccessPayload {
  receivedDirectDebitMandate: ReceivedDirectDebitMandate!
}

Fields​

UpdateReceivedSepaDirectDebitB2bMandateSuccessPayload.receivedDirectDebitMandate ● ReceivedDirectDebitMandate! non-null interface​

The received direct debit mandate updated

Implemented by​

UpdateReceivedSepaDirectDebitB2bMandatePayload union

- + \ No newline at end of file diff --git a/api-reference/objects/update-supporting-document-success-payload/index.html b/api-reference/objects/update-supporting-document-success-payload/index.html index 6b1cef70344..c2524e85240 100644 --- a/api-reference/objects/update-supporting-document-success-payload/index.html +++ b/api-reference/objects/update-supporting-document-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/update-user-consent-settings-success-payload/index.html b/api-reference/objects/update-user-consent-settings-success-payload/index.html index dc2f2f1f12a..f9acdaa573c 100644 --- a/api-reference/objects/update-user-consent-settings-success-payload/index.html +++ b/api-reference/objects/update-user-consent-settings-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/update-user-consent-settings-token-rejection/index.html b/api-reference/objects/update-user-consent-settings-token-rejection/index.html index 022e2c143fa..a4f3afd5626 100644 --- a/api-reference/objects/update-user-consent-settings-token-rejection/index.html +++ b/api-reference/objects/update-user-consent-settings-token-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/user-connection/index.html b/api-reference/objects/user-connection/index.html index 0645e18f94d..4a7730adec0 100644 --- a/api-reference/objects/user-connection/index.html +++ b/api-reference/objects/user-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UserConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type UserConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [UserEdge!]!
}

Fields​

UserConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

UserConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

UserConnection.edges ● [UserEdge!]! non-null object​

UserEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Returned by​

users query

- + \ No newline at end of file diff --git a/api-reference/objects/user-consent-settings/index.html b/api-reference/objects/user-consent-settings/index.html index 676233f2c63..c1b6c20c114 100644 --- a/api-reference/objects/user-consent-settings/index.html +++ b/api-reference/objects/user-consent-settings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UserConsentSettings

No description

type UserConsentSettings {
  preferredNotificationChannel: PreferredNotificationChannel!
  userId: String!
  projectId: String!
}

Fields​

UserConsentSettings.preferredNotificationChannel ● PreferredNotificationChannel! non-null enum​

Preferred notification channel

UserConsentSettings.userId ● String! non-null scalar​

User identifier

UserConsentSettings.projectId ● String! non-null scalar​

Project identifier

Member of​

UpdateUserConsentSettingsSuccessPayload object

- + \ No newline at end of file diff --git a/api-reference/objects/user-edge/index.html b/api-reference/objects/user-edge/index.html index c7b8dcfe201..d806e1666e3 100644 --- a/api-reference/objects/user-edge/index.html +++ b/api-reference/objects/user-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

UserEdge

Implements the Relay Edge interface

type UserEdge implements Edge {
  cursor: String!
  node: User!
}

Fields​

UserEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this consent node in the pagination mechanism

UserEdge.node ● User! non-null object​

The consent

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

UserConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/user-not-allowed-to-disable-its-own-account-membership-rejection/index.html b/api-reference/objects/user-not-allowed-to-disable-its-own-account-membership-rejection/index.html index 9b6d5cda77c..2f177b81ced 100644 --- a/api-reference/objects/user-not-allowed-to-disable-its-own-account-membership-rejection/index.html +++ b/api-reference/objects/user-not-allowed-to-disable-its-own-account-membership-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UserNotAllowedToDisableItsOwnAccountMembershipRejection

No description

type UserNotAllowedToDisableItsOwnAccountMembershipRejection implements Rejection {
  accountMembershipId: String!
  message: String!
}

Fields​

UserNotAllowedToDisableItsOwnAccountMembershipRejection.accountMembershipId ● String! non-null scalar​

UserNotAllowedToDisableItsOwnAccountMembershipRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

DisableAccountMembershipPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/user-not-allowed-to-manage-account-membership-rejection/index.html b/api-reference/objects/user-not-allowed-to-manage-account-membership-rejection/index.html index 57ab55d6308..32391cd35a7 100644 --- a/api-reference/objects/user-not-allowed-to-manage-account-membership-rejection/index.html +++ b/api-reference/objects/user-not-allowed-to-manage-account-membership-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UserNotAllowedToManageAccountMembershipRejection

Rejection returned if a identity does not have enough permission to manage account membership

type UserNotAllowedToManageAccountMembershipRejection implements Rejection {
  message: String!
}

Fields​

UserNotAllowedToManageAccountMembershipRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

ResumeAccountMembershipPayload union ● SuspendAccountMembershipPayload union ● UpdateAccountMembershipPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/user-not-allowed-to-suspend-its-own-account-membership-rejection/index.html b/api-reference/objects/user-not-allowed-to-suspend-its-own-account-membership-rejection/index.html index e066a311d3c..dea83593bfe 100644 --- a/api-reference/objects/user-not-allowed-to-suspend-its-own-account-membership-rejection/index.html +++ b/api-reference/objects/user-not-allowed-to-suspend-its-own-account-membership-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UserNotAllowedToSuspendItsOwnAccountMembershipRejection

No description

type UserNotAllowedToSuspendItsOwnAccountMembershipRejection implements Rejection {
  accountMembershipId: String!
  message: String!
}

Fields​

UserNotAllowedToSuspendItsOwnAccountMembershipRejection.accountMembershipId ● String! non-null scalar​

UserNotAllowedToSuspendItsOwnAccountMembershipRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

SuspendAccountMembershipPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/user-not-card-holder-rejection/index.html b/api-reference/objects/user-not-card-holder-rejection/index.html index 8db7fcb3943..4df06f8b0dd 100644 --- a/api-reference/objects/user-not-card-holder-rejection/index.html +++ b/api-reference/objects/user-not-card-holder-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UserNotCardHolderRejection

Rejection returned when the User is not the Card Holder

type UserNotCardHolderRejection implements Rejection {
  message: String!
}

Fields​

UserNotCardHolderRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

ActivatePhysicalCardPayload union ● AddDigitalCardPayload union ● ResumePhysicalCardPayload union ● ViewCardNumbersPayload union ● ViewPhysicalCardNumbersPayload union ● ViewPhysicalCardPinPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/user/index.html b/api-reference/objects/user/index.html index 75acf9801f6..a74e45dc451 100644 --- a/api-reference/objects/user/index.html +++ b/api-reference/objects/user/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

User

The User is the unique user, natural person, of the Swan app.

type User {
  id: ID!
  accountMemberships(
  first: Int! = 50
  before: String
  after: String
  filters: AccountMembershipsFilterInput
): AccountMembershipConnection!
  mobilePhoneNumber: PhoneNumber
  firstName: String
  lastName: String
  allFirstNames: [String!]
  birthDate: Date
  nationalityCCA3: CCA3
  idVerified: Boolean!
  authenticators: [Authenticator!]
  identificationStatus: IdentificationStatus
  identificationLevels: IdentificationLevels
  preferredNotificationChannel: PreferredNotificationChannel
  createdAt: DateTime!
  updatedAt: DateTime!
  joinedAt: DateTime!
  identifications(
  first: Int! = 50
  after: String
  filters: IdentificationFiltersInput
  orderBy: IdentificationsOrderByInput
): IdentificationConnection
}

Fields​

User.id ● ID! non-null scalar​

unique identifier of the user

User.accountMemberships ● AccountMembershipConnection! non-null object​

The list of account memberships

User.accountMemberships.first ● Int! non-null scalar​
User.accountMemberships.before ● String scalar​
User.accountMemberships.after ● String scalar​
User.accountMemberships.filters ● AccountMembershipsFilterInput input​

User.mobilePhoneNumber ● PhoneNumber scalar​

mobile phone number with the international format (Example: +33689788967)

User.firstName ● String scalar​

first name

User.lastName ● String scalar​

last name

User.allFirstNames ● [String!] list scalar​

list of first names

User.birthDate ● Date scalar​

birth date

User.nationalityCCA3 ● CCA3 scalar​

nationality

User.idVerified ● Boolean! non-null scalar​

true if Swan has verified the user's identity

User.authenticators ● [Authenticator!] list object​

the methods used to authenticate this user

User.identificationStatus ● IdentificationStatus enum​

Identification status

Each attempt to go through our identity verification process will update this value.

This field is only available for the current user.

User.identificationLevels ● IdentificationLevels object​

List of identification levels available for the user.

Whenever TRUE, it means the identification was successful for the associated level.

User.preferredNotificationChannel ● PreferredNotificationChannel enum​

Preferred notification channel

When it is "null" it means that the preferences have not been updated. Default SMS in use

User.createdAt ● DateTime! non-null scalar​

Creation date of the user

User.updatedAt ● DateTime! non-null scalar​

Last update date of the user

User.joinedAt ● DateTime! non-null scalar​

Date on which the user joined the project. Joining the project is done after the first accepted OAuth login.

User.identifications ● IdentificationConnection object​

User.identifications.first ● Int! non-null scalar​

Maximum number of elements in the list (default value 50)

User.identifications.after ● String scalar​

When the list of elements needs to start after an element

User.identifications.filters ● IdentificationFiltersInput input​

When the list of identifications needs to be filtered

User.identifications.orderBy ● IdentificationsOrderByInput input​

When the list of identifications needs to be ordered, by default the list will be ordered by the latest identification (valid or not)

Returned by​

user query

Member of​

AccountHolderIndividualInfo object ● AccountMembership object ● Consent object ● StandingOrder object ● UserEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/valid-iban/index.html b/api-reference/objects/valid-iban/index.html index 6c3378cb407..85f5877209f 100644 --- a/api-reference/objects/valid-iban/index.html +++ b/api-reference/objects/valid-iban/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ValidIban

Information extracted from a valid IBAN

type ValidIban {
  iban: IBAN!
  accountNumber: String!
  checksum: String!
  bank: Bank!
  reachability: Reachability!
}

Fields​

ValidIban.iban ● IBAN! non-null scalar​

Iban from input

ValidIban.accountNumber ● String! non-null scalar​

Account Number extracted from the IBAN

ValidIban.checksum ● String! non-null scalar​

Checksum extracted from the IBAN

ValidIban.bank ● Bank! non-null object​

Bank that owns this IBAN

ValidIban.reachability ● Reachability! non-null object​

Reachability of this IBAN over different payment methods

Implemented by​

IbanValidationResult union

- + \ No newline at end of file diff --git a/api-reference/objects/valid-identification-level-status-info/index.html b/api-reference/objects/valid-identification-level-status-info/index.html index 36c5bf759ca..82389366ff8 100644 --- a/api-reference/objects/valid-identification-level-status-info/index.html +++ b/api-reference/objects/valid-identification-level-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/validation-error/index.html b/api-reference/objects/validation-error/index.html index bd2e3133ca7..3fc722a2ea5 100644 --- a/api-reference/objects/validation-error/index.html +++ b/api-reference/objects/validation-error/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/validation-field-error/index.html b/api-reference/objects/validation-field-error/index.html index c557a39df8a..fed01e6746e 100644 --- a/api-reference/objects/validation-field-error/index.html +++ b/api-reference/objects/validation-field-error/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/validation-rejection/index.html b/api-reference/objects/validation-rejection/index.html index 2065b10ee75..86d303a5103 100644 --- a/api-reference/objects/validation-rejection/index.html +++ b/api-reference/objects/validation-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ValidationRejection

Rejection returned if an input contains invalid data

type ValidationRejection implements Rejection {
  fields: [ValidationFieldError!]!
  message: String!
}

Fields​

ValidationRejection.fields ● [ValidationFieldError!]! non-null object​

ValidationRejection.message ● String! non-null scalar​

Interfaces​

Rejection interface​

Implemented by​

ActivatePhysicalCardPayload union ● AddAccountMembershipPayload union ● AddAccountMembershipsPayload union ● AddCardPayload union ● AddCardsPayload union ● AddCardsWithGroupDeliveryPayload union ● AddDigitalCardPayload union ● AddDirectDebitFundingSourcePayload union ● AddExternalAccountBalancePayload union ● AddExternalAccountPayload union ● AddFundingLimitSettingsChangeRequestPayload union ● AddOrUpdateExternalAccountBalancePayload union ● AddSepaDirectDebitPaymentMandatePayload union ● AddSingleUseVirtualCardPayload union ● AddSingleUseVirtualCardsPayload union ● AddVirtualIbanEntryPayload union ● AllowSddPayload union ● AllowSddVirtualIbanEntryPayload union ● BindAccountMembershipPayload union ● CancelCardPayload union ● CancelDigitalCardPayload union ● CancelPhysicalCardPayload union ● CancelVirtualIbanEntryPayload union ● CloseAccountPayload union ● CreateMerchantPaymentLinkPayload union ● DeleteSupportingDocumentPayload union ● DenySddPayload union ● DenySddVirtualIbanEntryPayload union ● DisableAccountMembershipPayload union ● FinalizeOnboardingPayload union ● GenerateSupportingDocumentUploadUrlPayload union ● InitiateFundingRequestPayload union ● InitiateInternationalCreditTransferResponsePayload union ● InitiateMerchantPaymentCollectionPayload union ● OnboardCompanyAccountHolderPayload union ● OnboardIndividualAccountHolderPayload union ● PrintPhysicalCardPayload union ● RequestMerchantPaymentMethodsPayload union ● RequestSupportingDocumentCollectionReviewPayload union ● ResumeAccountMembershipPayload union ● ResumePhysicalCardPayload union ● SuspendAccountMembershipPayload union ● SuspendPhysicalCardPayload union ● UpdateAccountHolderPayload union ● UpdateAccountMembershipPayload union ● UpdateAccountPayload union ● UpdateCardPayload union ● UpdateCompanyOnboardingPayload union ● UpdateIndividualOnboardingPayload union ● UpdateSupportingDocumentPayload union ● ViewCardNumbersPayload union ● ViewPhysicalCardNumbersPayload union ● ViewPhysicalCardPinPayload union

- + \ No newline at end of file diff --git a/api-reference/objects/verified-status-info/index.html b/api-reference/objects/verified-status-info/index.html index 1862b62036c..1931ef7cc42 100644 --- a/api-reference/objects/verified-status-info/index.html +++ b/api-reference/objects/verified-status-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

VerifiedStatusInfo

Enabled Information

type VerifiedStatusInfo implements AccountVerificationStatusInfo {
  verifiedAt: DateTime!
  status: AccountVerificationStatus!
}

Fields​

VerifiedStatusInfo.verifiedAt ● DateTime! non-null scalar​

Date at which the verification was verified

VerifiedStatusInfo.status ● AccountVerificationStatus! non-null enum​

Account verification status (Verified)

Interfaces​

AccountVerificationStatusInfo interface​

Account Verification Status Information

- + \ No newline at end of file diff --git a/api-reference/objects/view-card-numbers-success-payload/index.html b/api-reference/objects/view-card-numbers-success-payload/index.html index f95fd586c96..88e9f179161 100644 --- a/api-reference/objects/view-card-numbers-success-payload/index.html +++ b/api-reference/objects/view-card-numbers-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/view-physical-card-numbers-success-payload/index.html b/api-reference/objects/view-physical-card-numbers-success-payload/index.html index 79a85ccf149..d0fe9e071cb 100644 --- a/api-reference/objects/view-physical-card-numbers-success-payload/index.html +++ b/api-reference/objects/view-physical-card-numbers-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/view-physical-card-pin-success-payload/index.html b/api-reference/objects/view-physical-card-pin-success-payload/index.html index ff46f48ea0f..74082c4407d 100644 --- a/api-reference/objects/view-physical-card-pin-success-payload/index.html +++ b/api-reference/objects/view-physical-card-pin-success-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/virtual-ibanentry-connection/index.html b/api-reference/objects/virtual-ibanentry-connection/index.html index 528594e1ae0..957b1323b29 100644 --- a/api-reference/objects/virtual-ibanentry-connection/index.html +++ b/api-reference/objects/virtual-ibanentry-connection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

VirtualIBANEntryConnection

Implements the Relay Connection interface, used to paginate list of element (Learn More)

type VirtualIBANEntryConnection implements Connection {
  totalCount: Int!
  pageInfo: PageInfo!
  edges: [VirtualIBANEntryEdge!]!
}

Fields​

VirtualIBANEntryConnection.totalCount ● Int! non-null scalar​

Total number of element in the list

VirtualIBANEntryConnection.pageInfo ● PageInfo! non-null object​

Information about the current, the previous and the next page

VirtualIBANEntryConnection.edges ● [VirtualIBANEntryEdge!]! non-null object​

VirtualIBANEntryEdge list

Interfaces​

Connection interface​

Relay Connection type, used to paginate list of element (Learn More)

Member of​

Account object

- + \ No newline at end of file diff --git a/api-reference/objects/virtual-ibanentry-edge/index.html b/api-reference/objects/virtual-ibanentry-edge/index.html index 40658e71981..0d03b74abf5 100644 --- a/api-reference/objects/virtual-ibanentry-edge/index.html +++ b/api-reference/objects/virtual-ibanentry-edge/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

VirtualIBANEntryEdge

Implements the Relay Edge interface

type VirtualIBANEntryEdge implements Edge {
  cursor: String!
  node: VirtualIBANEntry!
}

Fields​

VirtualIBANEntryEdge.cursor ● String! non-null scalar​

Opaque identifier pointing to this node in the pagination mechanism

VirtualIBANEntryEdge.node ● VirtualIBANEntry! non-null object​

The virtual iban entry

Interfaces​

Edge interface​

Edge type containing the node and cursor. The node is not defined in the interface because generic is not supported by GraphQL but all implementation contains its own node property according to the paginated type.

Member of​

VirtualIBANEntryConnection object

- + \ No newline at end of file diff --git a/api-reference/objects/virtual-ibanentry/index.html b/api-reference/objects/virtual-ibanentry/index.html index 464944f4358..5acd73007ec 100644 --- a/api-reference/objects/virtual-ibanentry/index.html +++ b/api-reference/objects/virtual-ibanentry/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

VirtualIBANEntry

Virtual IBAN can be used by the account holder to receive SCT (Sepa Credit Transfer) or to be debited by SDD (Sepa Direct Debit).

type VirtualIBANEntry {
  id: ID!
  IBAN: IBAN!
  BIC: BIC!
  label: String
  status: IBANStatus!
  blockSDD: Boolean!
}

Fields​

VirtualIBANEntry.id ● ID! non-null scalar​

Unique identifier of a Virtual IBAN entry

VirtualIBANEntry.IBAN ● IBAN! non-null scalar​

International Bank Account Number

VirtualIBANEntry.BIC ● BIC! non-null scalar​

Bank Identifier Code

VirtualIBANEntry.label ● String scalar​

Label (could be used to identify)

VirtualIBANEntry.status ● IBANStatus! non-null enum​

Status of the Iban

VirtualIBANEntry.blockSDD ● Boolean! non-null scalar​

true if the Virtual IBAN refuses all Sepa Direct Debit received

Member of​

AddVirtualIbanEntrySuccessPayload object ● AllowSddVirtualIbanEntrySuccessPayload object ● CancelVirtualIbanEntrySuccessPayload object ● DenySddVirtualIbanEntrySuccessPayload object ● VirtualIBANEntryEdge object

- + \ No newline at end of file diff --git a/api-reference/objects/wallet-provider/index.html b/api-reference/objects/wallet-provider/index.html index 2e82fa17395..1a529bd437c 100644 --- a/api-reference/objects/wallet-provider/index.html +++ b/api-reference/objects/wallet-provider/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/objects/web-banking-settings/index.html b/api-reference/objects/web-banking-settings/index.html index 4cd4a8c001f..51de2183e99 100644 --- a/api-reference/objects/web-banking-settings/index.html +++ b/api-reference/objects/web-banking-settings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

WebBankingSettings

No description

type WebBankingSettings {
  canViewAccountDetails: Boolean
  canViewAccountStatement: Boolean
  canManageVirtualIbans: Boolean
  canInitiatePaymentsToNewBeneficiaries: Boolean
  canViewPaymentList: Boolean
  canOrderVirtualCards: Boolean
  canOrderPhysicalCards: Boolean
  canViewMembers: Boolean
  canAddNewMembers: Boolean
}

Fields​

WebBankingSettings.canViewAccountDetails ● Boolean scalar​

WebBankingSettings.canViewAccountStatement ● Boolean scalar​

WebBankingSettings.canManageVirtualIbans ● Boolean scalar​

WebBankingSettings.canInitiatePaymentsToNewBeneficiaries ● Boolean scalar​

WebBankingSettings.canViewPaymentList ● Boolean scalar​

WebBankingSettings.canOrderVirtualCards ● Boolean scalar​

WebBankingSettings.canOrderPhysicalCards ● Boolean scalar​

WebBankingSettings.canViewMembers ● Boolean scalar​

WebBankingSettings.canAddNewMembers ● Boolean scalar​

Member of​

ProjectInfo object

- + \ No newline at end of file diff --git a/api-reference/objects/wrong-value-provided-rejection/index.html b/api-reference/objects/wrong-value-provided-rejection/index.html index 73a2a1c9b15..95e889331d4 100644 --- a/api-reference/objects/wrong-value-provided-rejection/index.html +++ b/api-reference/objects/wrong-value-provided-rejection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/account-holder/index.html b/api-reference/queries/account-holder/index.html index 9923faede8d..48ab7d858f4 100644 --- a/api-reference/queries/account-holder/index.html +++ b/api-reference/queries/account-holder/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

accountHolder

Returns an account holder from its id.

accountHolder(
  id: ID!
): AccountHolder

Arguments​

accountHolder.id ● ID! non-null scalar​

Type​

AccountHolder object​

The account holder is the person who owns the money stored in the account. The account holder can be one of your customers, whether it is a natural person or a legal person, or quite simply you.

- + \ No newline at end of file diff --git a/api-reference/queries/account-holders/index.html b/api-reference/queries/account-holders/index.html index b296f9f1af9..0671c66e5e2 100644 --- a/api-reference/queries/account-holders/index.html +++ b/api-reference/queries/account-holders/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

accountHolders

Returns the list of account holders.

For a Project access token, this is all the account holders of the project and for an User access token, these are the holders of the accounts of which the user has an account membership.

accountHolders(
  first: Int! = 50
  before: String
  filters: AccountHolderFilterInput
  orderBy: AccountHolderOrderByInput
  after: String
): AccountHolderConnection!

Arguments​

accountHolders.first ● Int! non-null scalar​

accountHolders.before ● String scalar​

accountHolders.filters ● AccountHolderFilterInput input​

accountHolders.orderBy ● AccountHolderOrderByInput input​

accountHolders.after ● String scalar​

Type​

AccountHolderConnection object​

Implements the Relay Connection interface, used to paginate list of element (Learn More).

- + \ No newline at end of file diff --git a/api-reference/queries/account-invoice/index.html b/api-reference/queries/account-invoice/index.html index 24857e6e720..1e1744f3cbd 100644 --- a/api-reference/queries/account-invoice/index.html +++ b/api-reference/queries/account-invoice/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/account-membership/index.html b/api-reference/queries/account-membership/index.html index 60471162e84..8e4911a3245 100644 --- a/api-reference/queries/account-membership/index.html +++ b/api-reference/queries/account-membership/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

accountMembership

Returns an account membership from its id.

accountMembership(
  id: ID!
): AccountMembership

Arguments​

accountMembership.id ● ID! non-null scalar​

Type​

AccountMembership object​

An account membership represents the rights of a user for a given account.

Each account is administered by an account membership having the capacity of legal representative. He has the possibility of delegating rights on this account to other users.

- + \ No newline at end of file diff --git a/api-reference/queries/account-memberships/index.html b/api-reference/queries/account-memberships/index.html index d4124e3699d..6b960aafab1 100644 --- a/api-reference/queries/account-memberships/index.html +++ b/api-reference/queries/account-memberships/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

accountMemberships

The list of account memberships

accountMemberships(
  first: Int! = 50
  before: String
  after: String
  filters: AccountMembershipsFilterInput
  orderBy: AccountMembershipOrderByInput
): AccountMembershipConnection!

Arguments​

accountMemberships.first ● Int! non-null scalar​

accountMemberships.before ● String scalar​

accountMemberships.after ● String scalar​

accountMemberships.filters ● AccountMembershipsFilterInput input​

accountMemberships.orderBy ● AccountMembershipOrderByInput input​

Type​

AccountMembershipConnection object​

Implements the Relay Connection interface, used to paginate list of element (Learn More)

- + \ No newline at end of file diff --git a/api-reference/queries/account-statement/index.html b/api-reference/queries/account-statement/index.html index 104e7ce2aa0..5b512ce7ff0 100644 --- a/api-reference/queries/account-statement/index.html +++ b/api-reference/queries/account-statement/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

accountStatement

Returns an account statement by id

accountStatement(
  id: ID!
): Statement!

Arguments​

accountStatement.id ● ID! non-null scalar​

Type​

Statement object​

A statement represent metadata around a banking document that list all of the BOOKED banking transactions that have happened between startDate and endDate

- + \ No newline at end of file diff --git a/api-reference/queries/account/index.html b/api-reference/queries/account/index.html index aad8211d1d6..561bb79d8c7 100644 --- a/api-reference/queries/account/index.html +++ b/api-reference/queries/account/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

account

Returns an account from its id.

account(
  accountId: ID!
): Account

Arguments​

account.accountId ● ID! non-null scalar​

Type​

Account object​

Whether you call it a wallet, monetary account, payment account or bank account, the notion of account is fundamental at Swan. All payment flows necessarily go through an account.

- + \ No newline at end of file diff --git a/api-reference/queries/accounts/index.html b/api-reference/queries/accounts/index.html index 0f591ffb946..f1af28458ef 100644 --- a/api-reference/queries/accounts/index.html +++ b/api-reference/queries/accounts/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

accounts

Returns the list of accounts.

For a Project access token, this is all the accounts of the project and for an User access token, these are the accounts of which the user has an account membership.

accounts(
  first: Int! = 50
  before: String
  after: String
  filters: AccountFilterInput
  orderBy: AccountOrderByInput
): AccountConnection!

Arguments​

accounts.first ● Int! non-null scalar​

accounts.before ● String scalar​

accounts.after ● String scalar​

accounts.filters ● AccountFilterInput input​

accounts.orderBy ● AccountOrderByInput input​

Type​

AccountConnection object​

Implements the Relay Connection interface, used to paginate list of element (Learn More)

- + \ No newline at end of file diff --git a/api-reference/queries/capital-deposit-case/index.html b/api-reference/queries/capital-deposit-case/index.html index 0572e44d28d..649836d0877 100644 --- a/api-reference/queries/capital-deposit-case/index.html +++ b/api-reference/queries/capital-deposit-case/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/capital-deposit-cases/index.html b/api-reference/queries/capital-deposit-cases/index.html index 9d0169b8a0b..755b43f01cd 100644 --- a/api-reference/queries/capital-deposit-cases/index.html +++ b/api-reference/queries/capital-deposit-cases/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

capitalDepositCases

Returns the list of capital deposit cases.

This query is restricted to a Project access token (Learn More)

capitalDepositCases(
  first: Int! = 50
  before: String
  after: String
  filters: CapitalDepositCaseFiltersInput
  orderBy: CapitalDepositCaseOrderByInput
): CapitalDepositCaseConnection!

Arguments​

capitalDepositCases.first ● Int! non-null scalar​

capitalDepositCases.before ● String scalar​

capitalDepositCases.after ● String scalar​

capitalDepositCases.filters ● CapitalDepositCaseFiltersInput input​

capitalDepositCases.orderBy ● CapitalDepositCaseOrderByInput input​

Type​

CapitalDepositCaseConnection object​

Implements the Relay Connection interface, used to paginate list of elements (Learn More)

- + \ No newline at end of file diff --git a/api-reference/queries/capital-deposit-document/index.html b/api-reference/queries/capital-deposit-document/index.html index 8d48b5bfb20..1805d428deb 100644 --- a/api-reference/queries/capital-deposit-document/index.html +++ b/api-reference/queries/capital-deposit-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/card/index.html b/api-reference/queries/card/index.html index 41b1dcaab1f..272f953570e 100644 --- a/api-reference/queries/card/index.html +++ b/api-reference/queries/card/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/cards/index.html b/api-reference/queries/cards/index.html index a12addefa03..522ae30f261 100644 --- a/api-reference/queries/cards/index.html +++ b/api-reference/queries/cards/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

cards

Returns the list of cards.

For a Project access token, this is all the cards of the project and for an User access token, these are the cards owned by the user whom have an account membership.

cards(
  first: Int! = 50
  before: String
  after: String
  orderBy: CardOrderByInput
  filters: CardFiltersInput
): CardConnection!

Arguments​

cards.first ● Int! non-null scalar​

cards.before ● String scalar​

cards.after ● String scalar​

cards.orderBy ● CardOrderByInput input​

When the list of elements needs to be ordered

cards.filters ● CardFiltersInput input​

When the list of elements needs to be filtered

Type​

CardConnection object​

Implements the Relay Connection interface, used to paginate list of element (Learn More)

- + \ No newline at end of file diff --git a/api-reference/queries/consent/index.html b/api-reference/queries/consent/index.html index d6c826264b3..ed348e03cac 100644 --- a/api-reference/queries/consent/index.html +++ b/api-reference/queries/consent/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

consent

Returns a consent by its id.

consent(
  id: ID!
): Consent!

Arguments​

consent.id ● ID! non-null scalar​

Type​

Consent object​

Some sensitive operation at Swan, such as initiating a payment, require consent

- + \ No newline at end of file diff --git a/api-reference/queries/consents/index.html b/api-reference/queries/consents/index.html index 682564640d6..50651dba7e2 100644 --- a/api-reference/queries/consents/index.html +++ b/api-reference/queries/consents/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

consents

Return the list of consents

For a User access token : return the list of consents for the signed-in user For a Project access token : return the list of consents for the project. This list can be filtered by userId

(Learn more on authentication)

consents(
  first: Int! = 50
  after: String
  filters: ConsentsFiltersInput
): ConsentConnection!

Arguments​

consents.first ● Int! non-null scalar​

consents.after ● String scalar​

consents.filters ● ConsentsFiltersInput input​

Type​

ConsentConnection object​

Implements the Relay Connection interface, used to paginate list of element (Learn More)

- + \ No newline at end of file diff --git a/api-reference/queries/funding-limit-settings-change-request/index.html b/api-reference/queries/funding-limit-settings-change-request/index.html index 04b0dc8c8f7..ba8e973c5aa 100644 --- a/api-reference/queries/funding-limit-settings-change-request/index.html +++ b/api-reference/queries/funding-limit-settings-change-request/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/funding-source/index.html b/api-reference/queries/funding-source/index.html index c6fae40e4cb..14f9a22c403 100644 --- a/api-reference/queries/funding-source/index.html +++ b/api-reference/queries/funding-source/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/iban-validation/index.html b/api-reference/queries/iban-validation/index.html index deebaeec8e9..279484c3395 100644 --- a/api-reference/queries/iban-validation/index.html +++ b/api-reference/queries/iban-validation/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/international-beneficiary-dynamic-forms/index.html b/api-reference/queries/international-beneficiary-dynamic-forms/index.html index f1c64f12c96..00f310145c6 100644 --- a/api-reference/queries/international-beneficiary-dynamic-forms/index.html +++ b/api-reference/queries/international-beneficiary-dynamic-forms/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

internationalBeneficiaryDynamicForms

Returns an international beneficiary dynamic forms.

internationalBeneficiaryDynamicForms(
  amount: AmountInput!
  language: InternationalCreditTransferDisplayLanguage
  dynamicFields: [InternationalBeneficiaryDetailsInput!]
): InternationalBeneficiaryDynamicForms

Arguments​

internationalBeneficiaryDynamicForms.amount ● AmountInput! non-null input​

internationalBeneficiaryDynamicForms.language ● InternationalCreditTransferDisplayLanguage enum​

internationalBeneficiaryDynamicForms.dynamicFields ● [InternationalBeneficiaryDetailsInput!] list input​

Type​

InternationalBeneficiaryDynamicForms object​

COMING SOON International Beneficiary Dynamic Forms

- + \ No newline at end of file diff --git a/api-reference/queries/international-credit-transfer-quote/index.html b/api-reference/queries/international-credit-transfer-quote/index.html index 765b02fcccc..858495a1c1c 100644 --- a/api-reference/queries/international-credit-transfer-quote/index.html +++ b/api-reference/queries/international-credit-transfer-quote/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

internationalCreditTransferQuote

Request an international credit transfer quote.

internationalCreditTransferQuote(
  accountId: ID!
  targetAmount: AmountInput!
  language: InternationalCreditTransferDisplayLanguage
): InternationalCreditTransferQuote

Arguments​

internationalCreditTransferQuote.accountId ● ID! non-null scalar​

internationalCreditTransferQuote.targetAmount ● AmountInput! non-null input​

internationalCreditTransferQuote.language ● InternationalCreditTransferDisplayLanguage enum​

Type​

InternationalCreditTransferQuote object​

COMING SOON International Quote

- + \ No newline at end of file diff --git a/api-reference/queries/international-credit-transfer-transaction-details-dynamic-form/index.html b/api-reference/queries/international-credit-transfer-transaction-details-dynamic-form/index.html index b6d353835a1..7fc4ba1c34c 100644 --- a/api-reference/queries/international-credit-transfer-transaction-details-dynamic-form/index.html +++ b/api-reference/queries/international-credit-transfer-transaction-details-dynamic-form/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

internationalCreditTransferTransactionDetailsDynamicForm

Returns an international credit transfer dynamic form.

internationalCreditTransferTransactionDetailsDynamicForm(
  targetAmount: AmountInput!
  language: InternationalCreditTransferDisplayLanguage
  internationalBeneficiary: InternationalBeneficiaryInput!
  refreshableFields: [InternationalCreditTransferDetailsInput!]
): InternationalCreditTransferDynamicForm

Arguments​

internationalCreditTransferTransactionDetailsDynamicForm.targetAmount ● AmountInput! non-null input​

internationalCreditTransferTransactionDetailsDynamicForm.language ● InternationalCreditTransferDisplayLanguage enum​

internationalCreditTransferTransactionDetailsDynamicForm.internationalBeneficiary ● InternationalBeneficiaryInput! non-null input​

internationalCreditTransferTransactionDetailsDynamicForm.refreshableFields ● [InternationalCreditTransferDetailsInput!] list input​

Type​

InternationalCreditTransferDynamicForm object​

COMING SOON International Credit Transfer Dynamic Form

- + \ No newline at end of file diff --git a/api-reference/queries/merchant-profile/index.html b/api-reference/queries/merchant-profile/index.html index d1321eab8d5..073d35f8026 100644 --- a/api-reference/queries/merchant-profile/index.html +++ b/api-reference/queries/merchant-profile/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/onboarding/index.html b/api-reference/queries/onboarding/index.html index 0dc5fa37a3a..71534a78b07 100644 --- a/api-reference/queries/onboarding/index.html +++ b/api-reference/queries/onboarding/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

onboarding

Returns an onboarding from its id.

This query is restricted to a Project access token (Learn More)

onboarding(
  id: ID!
): Onboarding!

Arguments​

onboarding.id ● ID! non-null scalar​

Type​

Onboarding object​

Information provided during the onboarding process of an individual or a company

- + \ No newline at end of file diff --git a/api-reference/queries/onboardings/index.html b/api-reference/queries/onboardings/index.html index 02f9a917674..36e5bcdc36a 100644 --- a/api-reference/queries/onboardings/index.html +++ b/api-reference/queries/onboardings/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

onboardings

Returns the list of onboardings.

This query is restricted to a Project access token (Learn More)

onboardings(
  first: Int! = 50
  before: String
  after: String
  filters: OnboardingFiltersInput
  orderBy: OnboardingOrderByInput
): OnboardingConnection!

Arguments​

onboardings.first ● Int! non-null scalar​

onboardings.before ● String scalar​

onboardings.after ● String scalar​

onboardings.filters ● OnboardingFiltersInput input​

onboardings.orderBy ● OnboardingOrderByInput input​

Type​

OnboardingConnection object​

Implements the Relay Connection interface, used to paginate list of element (Learn More)

- + \ No newline at end of file diff --git a/api-reference/queries/payment/index.html b/api-reference/queries/payment/index.html index 3ba44f56b3d..e7bc55ef3eb 100644 --- a/api-reference/queries/payment/index.html +++ b/api-reference/queries/payment/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

payment

Returns a payment from its id.

payment(
  id: ID!
): Payment!

Arguments​

payment.id ● ID! non-null scalar​

Type​

Payment object​

A Payment represents a set of transactions linked to the same payment act.

This payment act can be initiated:

  • either from a user
  • either from a merchant
  • either from you
  • either from Swan
- + \ No newline at end of file diff --git a/api-reference/queries/payments/index.html b/api-reference/queries/payments/index.html index de147110f19..7c1cddea251 100644 --- a/api-reference/queries/payments/index.html +++ b/api-reference/queries/payments/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

payments

Returns the list of payments.

For a Project access token, this is all the payments of the project and for an User access token, these are the payments initiated by the user

payments(
  first: Int! = 50
  after: String
  before: String
  orderBy: PaymentOrderByInput
  filters: PaymentFiltersInput
): PaymentConnection!

Arguments​

payments.first ● Int! non-null scalar​

number of elements in the list (default value 50)

payments.after ● String scalar​

When the list of elements needs to start after a element

payments.before ● String scalar​

When the list of elements needs to end before a element

payments.orderBy ● PaymentOrderByInput input​

When the list of elements needs to be ordered

payments.filters ● PaymentFiltersInput input​

When the list of elements needs to be filtered

Type​

PaymentConnection object​

Please see the Connection interface

- + \ No newline at end of file diff --git a/api-reference/queries/project-info/index.html b/api-reference/queries/project-info/index.html index 529a708b56c..fa62513e277 100644 --- a/api-reference/queries/project-info/index.html +++ b/api-reference/queries/project-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

projectInfo

Returns the project infos you set in the dashboard.

projectInfo: ProjectInfo!

Type​

ProjectInfo object​

Public information of a Project

- + \ No newline at end of file diff --git a/api-reference/queries/received-direct-debit-mandate/index.html b/api-reference/queries/received-direct-debit-mandate/index.html index a93db4eb7f4..433f897aeef 100644 --- a/api-reference/queries/received-direct-debit-mandate/index.html +++ b/api-reference/queries/received-direct-debit-mandate/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/shareholder/index.html b/api-reference/queries/shareholder/index.html index 932d328dcc4..c4c99ed41f4 100644 --- a/api-reference/queries/shareholder/index.html +++ b/api-reference/queries/shareholder/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/standing-order/index.html b/api-reference/queries/standing-order/index.html index ac60eecc011..01c01148116 100644 --- a/api-reference/queries/standing-order/index.html +++ b/api-reference/queries/standing-order/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/supporting-document-collection/index.html b/api-reference/queries/supporting-document-collection/index.html index 91f5ccfbfda..4601715f2b7 100644 --- a/api-reference/queries/supporting-document-collection/index.html +++ b/api-reference/queries/supporting-document-collection/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/transaction/index.html b/api-reference/queries/transaction/index.html index 692fb75a2b2..9f4611ba63c 100644 --- a/api-reference/queries/transaction/index.html +++ b/api-reference/queries/transaction/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/queries/transactions/index.html b/api-reference/queries/transactions/index.html index 23d24c167a3..9566519f70e 100644 --- a/api-reference/queries/transactions/index.html +++ b/api-reference/queries/transactions/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

transactions

A list of transactions of a project.

For a Project access token, this is all the transactions of the project (only available with project access token)

transactions(
  after: String
  filters: TransactionsFiltersInput
  first: Int! = 50
  orderBy: TransactionsOrderByInput
): TransactionConnection!

Arguments​

transactions.after ● String scalar​

When the list of elements needs to start after a element

transactions.filters ● TransactionsFiltersInput input​

When the list of elements needs to be filtered

transactions.first ● Int! non-null scalar​

number of elements in the list (default value 50)

transactions.orderBy ● TransactionsOrderByInput input​

When the list of elements needs to be sorted (default value UpdatedAt desc)

Type​

TransactionConnection object​

Please see the Connection interface

- + \ No newline at end of file diff --git a/api-reference/queries/user/index.html b/api-reference/queries/user/index.html index 76155ff4097..e67fdb43978 100644 --- a/api-reference/queries/user/index.html +++ b/api-reference/queries/user/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

user

Returns a User

For a Project access token : it requires a user id and returns the user for the given id For a User access token : returns the signed-in user and all of their data at Swan

(Learn more on authentication)

user(
  id: String
): User

Arguments​

user.id ● String scalar​

Type​

User object​

The User is the unique user, natural person, of the Swan app.

- + \ No newline at end of file diff --git a/api-reference/queries/users/index.html b/api-reference/queries/users/index.html index debd12684dc..b4665577691 100644 --- a/api-reference/queries/users/index.html +++ b/api-reference/queries/users/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

users

Returns the list of user that joined the project The search field allows to search in : id, phonNumber, firstName, allFirstNames, lastName

This query is restricted to a Project access token (Learn More)

users(
  after: String
  before: String
  filters: UserFilterInput
  first: Int! = 50
  search: String
): UserConnection!

Arguments​

users.after ● String scalar​

users.before ● String scalar​

users.filters ● UserFilterInput input​

users.first ● Int! non-null scalar​

users.search ● String scalar​

@deprecated(reason: "use the search field in UserFilterInput")

Type​

UserConnection object​

Implements the Relay Connection interface, used to paginate list of element (Learn More)

- + \ No newline at end of file diff --git a/api-reference/scalars/account-number/index.html b/api-reference/scalars/account-number/index.html index dfba9856b8e..4baccdc5901 100644 --- a/api-reference/scalars/account-number/index.html +++ b/api-reference/scalars/account-number/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AccountNumber

Swan account number

scalar AccountNumber

Member of​

Account object ● FeeCreditor interface ● FeeDebtor interface ● FeeInCreditor object ● FeeInDebtor object ● FeeOutCreditor object ● FeeOutDebtor object ● InitiateCreditTransfersInput input ● InitiateInternationalCreditTransferInput input ● InternalBeneficiary object ● InternalCreditTransferCreditor interface ● InternalCreditTransferDebtor interface ● InternalCreditTransferInCreditor object ● InternalCreditTransferInDebtor object ● InternalCreditTransferOutCreditor object ● InternalCreditTransferOutDebtor object ● SEPACreditTransferInCreditor object ● SEPACreditTransferInternalInDebtor object ● SEPACreditTransferInternalOutCreditor object ● SEPACreditTransferOutDebtor object ● SEPADirectDebitInCreditor object ● SEPADirectDebitOutDebtor object ● SwanAccountBeneficiaryInput input

- + \ No newline at end of file diff --git a/api-reference/scalars/amount-value/index.html b/api-reference/scalars/amount-value/index.html index f7b1d4a3cda..c56e858d247 100644 --- a/api-reference/scalars/amount-value/index.html +++ b/api-reference/scalars/amount-value/index.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@ 5768.2 -1.50 5877.78

scalar AmountValue

Member of​

Amount object ● AmountInput input

- + \ No newline at end of file diff --git a/api-reference/scalars/audit-id/index.html b/api-reference/scalars/audit-id/index.html index cc4c43901a6..a61b5855140 100644 --- a/api-reference/scalars/audit-id/index.html +++ b/api-reference/scalars/audit-id/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/authorization-id/index.html b/api-reference/scalars/authorization-id/index.html index 2cb041b444b..e08a3087971 100644 --- a/api-reference/scalars/authorization-id/index.html +++ b/api-reference/scalars/authorization-id/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/bic/index.html b/api-reference/scalars/bic/index.html index 2adbcfd5b45..a0f113cae9b 100644 --- a/api-reference/scalars/bic/index.html +++ b/api-reference/scalars/bic/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/boolean/index.html b/api-reference/scalars/boolean/index.html index 7de0636314c..f5c3af45593 100644 --- a/api-reference/scalars/boolean/index.html +++ b/api-reference/scalars/boolean/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Boolean

The Boolean scalar type represents true or false.

scalar Boolean

Member of​

Account object ● AccountMembership object ● AccountMembershipBindingUserErrorStatusInfo object ● AccountMembershipsFilterInput input ● AddAccountMembershipInput input ● AddCardInput input ● AddSingleUseVirtualCardInput input ● Beneficiary interface ● Card object ● CardConfigInput input ● CardConfigWithGroupDeliveryInput input ● CardProduct object ● CardSettings object ● CheckPaymentMethodInput input ● Consent object ● DateField object ● Field interface ● IdentificationLevels object ● include directive ● IndividualUltimateBeneficialOwnerInput input ● IndividualUltimateBeneficialOwnerTypeHasCapital object ● InitiateFundingRequestInput input ● InternalBeneficiary object ● InternalDirectDebitB2BPaymentMethodInput input ● InternalDirectDebitStandardPaymentMethodInput input ● MembershipInfoInput input ● MembershipsFilterInput input ● OnboardCompanyAccountHolderInput input ● OnboardingCompanyAccountHolderInfo object ● PageInfo object ● PhysicalCardRenewedStatusInfo object ● PhysicalCardToActivateStatusInfo object ● PreProvisioningSUVCardSettings object ● PrintPhysicalCardInput input ● ProjectInfo object ● RadioField object ● Reachability object ● RejectedTransactionStatusInfo object ● SelectField object ● SEPABeneficiary object ● SepaBeneficiaryInput input ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitB2BPaymentMethodInput input ● SepaDirectDebitCoreMerchantPaymentMethod object ● SepaDirectDebitCorePaymentMethodInput input ● skip directive ● SwanAccountBeneficiaryInput input ● TextField object ● TransactionsFiltersInput input ● UpdateAccountMembershipInput input ● UpdateCardInput input ● UpdateCompanyOnboardingInput input ● User object ● VirtualIBANEntry object ● WebBankingSettings object

- + \ No newline at end of file diff --git a/api-reference/scalars/card-token/index.html b/api-reference/scalars/card-token/index.html index a647693855f..0106f6e2885 100644 --- a/api-reference/scalars/card-token/index.html +++ b/api-reference/scalars/card-token/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/cca2/index.html b/api-reference/scalars/cca2/index.html index 17bae71ad94..99ade468470 100644 --- a/api-reference/scalars/cca2/index.html +++ b/api-reference/scalars/cca2/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/cca3/index.html b/api-reference/scalars/cca3/index.html index f716f354817..c4f8cfd5f7b 100644 --- a/api-reference/scalars/cca3/index.html +++ b/api-reference/scalars/cca3/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CCA3

Country code alpha 3 (ISO 3166)

scalar CCA3

Member of​

AddExternalAccountInput input ● Address object ● AddressInfo object ● AddressInformation object ● AddressInformationInput input ● AddressInput input ● Card object ● CardTransaction object ● CompleteAddressInput input ● CompleteAddressWithContactInput input ● ExternalAccount object ● FinancialInstitution object ● IndividualShareholder object ● IndividualUltimateBeneficialOwner object ● IndividualUltimateBeneficialOwnerInput input ● InternalPaymentMandateDebtor object ● OnboardIndividualShareholderInput input ● PaymentMandateDebtor interface ● ResidencyAddressInput input ● SEPAPaymentMandateDebtor object ● User object ● UserFilterInput input

- + \ No newline at end of file diff --git a/api-reference/scalars/currency/index.html b/api-reference/scalars/currency/index.html index bf0197cd03c..7bbed79ce78 100644 --- a/api-reference/scalars/currency/index.html +++ b/api-reference/scalars/currency/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/date-time/index.html b/api-reference/scalars/date-time/index.html index 257acd56b8b..9229789e785 100644 --- a/api-reference/scalars/date-time/index.html +++ b/api-reference/scalars/date-time/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

DateTime

Date time (ISO 8601 with time information) ex: 2021-04-12T16:28:22.867Z

scalar DateTime

Member of​

Account object ● AccountHolder object ● AccountMembership object ● AccountVerification interface ● ActiveMerchantPaymentLinkStatusInfo object ● AddCardInput input ● AddExternalAccountBalanceInput input ● AddExternalAccountInput input ● AddOrUpdateExternalAccountBalanceInput input ● BookedTransactionStatusInfo object ● CanceledMerchantPaymentLinkStatusInfo object ● CanceledTransactionStatusInfo object ● CapitalDepositCase object ● CapitalDepositDocument object ● Card object ● CardConfigInput input ● CardConfigWithGroupDeliveryInput input ● CardDesignBackground object ● CardProduct object ● CardProductDesign object ● CardSettings object ● CardSettingsBackground object ● CardTransaction object ● CheckTransaction object ● CompleteDigitalCard object ● CompletedMerchantPaymentLinkStatusInfo object ● Consent object ● CreateMerchantPaymentLinkInput input ● CreditTransferInput input ● CsvStatement object ● DigitalCard interface ● DigitalCardCanceledStatusInfo object ● DigitalCardEnabledStatusInfo object ● DigitalCardSuspendedStatusInfo object ● DirectDebitAccountVerification object ● DirectDebitFundingSource object ● ExpiredMerchantPaymentLinkStatusInfo object ● ExternalAccount object ● ExternalAccountBalance object ● ExternalAccountBalanceAlreadyExistsRejection object ● ExternalAccountBalanceInput input ● FeeTransaction object ● FundingSource interface ● GenerateAccountStatementInput input ● Identification object ● IndividualUltimateBeneficialOwner object ● InitiateFundingRequestInput input ● InternalCreditTransfer object ● InternalDirectDebitPaymentCollectionInput input ● InternalDirectDebitTransaction object ● InternalPaymentDirectDebitMandate object ● InternalReceivedDirectDebitMandate object ● InternationalCreditTransferTransaction object ● Invoice object ● LegalDocumentActiveStatusInfo object ● LegalDocumentInactiveStatusInfo object ● LegalDocumentUpcomingStatusInfo object ● MerchantPaymentLink object ● MerchantProfile object ● Onboarding object ● PartnershipAcceptedStatusInfo object ● PartnershipCanceledStatusInfo object ● PartnershipCancelingStatusInfo object ● Payment object ● PdfStatement object ● PendingDigitalCard object ● PendingTransactionStatusInfo object ● PhysicalCardRenewedStatusInfo object ● PhysicalCardToActivateStatusInfo object ● ReceivedDirectDebitMandate interface ● ReceivedDirectDebitMandateStatusInfoCanceled object ● ReceivedDirectDebitMandateStatusInfoEnabled object ● ReceivedDirectDebitMandateStatusInfoSuspended object ● RefundTransaction input ● RejectedVerificationStatusInfo object ● ReleasedTransactionStatusInfo object ● RequestMerchantProfileUpdate object ● ScheduleStandingOrderInput input ● SEPACreditTransferTransaction object ● SepaDirectDebitPaymentCollectionInput input ● SEPADirectDebitTransaction object ● SEPAPaymentDirectDebitMandate object ● SEPAReceivedDirectDebitMandate object ● Shareholder object ● StandingOrder object ● Statement object ● StatementFiltersInput input ● SupportingDocument object ● SupportingDocumentCollection object ● SupportingDocumentCollectionApprovedStatusInfo object ● SupportingDocumentCollectionCanceledStatusInfo object ● SupportingDocumentCollectionRejectedStatusInfo object ● SupportingDocumentRefusedStatusInfo object ● SupportingDocumentValidatedStatusInfo object ● Transaction interface ● TransactionsFiltersInput input ● UpcomingTransactionStatusInfo object ● UpdateCardInput input ● User object ● VerifiedStatusInfo object

- + \ No newline at end of file diff --git a/api-reference/scalars/date/index.html b/api-reference/scalars/date/index.html index 327fce6a598..5f287ca29a9 100644 --- a/api-reference/scalars/date/index.html +++ b/api-reference/scalars/date/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Date

Date with YYYY-MM-DD format

scalar Date

Member of​

AccountHolderCompanyInfo object ● AddInternalDirectDebitPaymentMandateInput input ● AddReceivedSepaDirectDebitB2bMandateInput input ● AddSepaDirectDebitPaymentMandateInput input ● CanceledFundingSourceStatusInfo object ● CanceledMerchantPaymentMethodStatusInfo object ● CanceledMerchantProfileStatusInfo object ● CapitalDepositDocument object ● CheckMerchantPaymentMethod object ● DisabledMerchantPaymentMethodStatusInfo object ● EnabledFundingSourceStatusInfo object ● EnabledMerchantPaymentMethodStatusInfo object ● EnabledMerchantProfileStatusInfo object ● ExpiredIdentificationLevelStatusInfo object ● FundingLimitSettingsChangeRequest object ● IdCardDocument object ● InternalDirectDebitB2BMerchantPaymentMethod object ● InternalDirectDebitStandardMerchantPaymentMethod object ● InternalPaymentDirectDebitMandate object ● InternalReceivedDirectDebitMandate object ● MerchantPaymentMethod interface ● PassportDocument object ● ReceivedDirectDebitMandate interface ● RejectedFundingSourceStatusInfo object ● RejectedMerchantPaymentMethodStatusInfo object ● RejectedMerchantProfileStatusInfo object ● ReportExchangeRate object ● ResidencePermitDocument object ● RestrictedTo object ● RestrictedToInput input ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitCoreMerchantPaymentMethod object ● SEPAPaymentDirectDebitMandate object ● SEPAReceivedDirectDebitMandate object ● StandingOrder object ● StandingOrderCanceledStatusInfo object ● SuspendedFundingSourceStatusInfo object ● SuspendedMerchantPaymentMethodStatusInfo object ● SuspendedMerchantProfileStatusInfo object ● UltimateBeneficialDirectOwnerIndividualInfo object ● UltimateBeneficialIndirectOwnerIndividualInfo object ● UpdatedRestrictedToInput input ● User object ● UserFilterInput input

- + \ No newline at end of file diff --git a/api-reference/scalars/email-address/index.html b/api-reference/scalars/email-address/index.html index f3823f01b4c..346db788db2 100644 --- a/api-reference/scalars/email-address/index.html +++ b/api-reference/scalars/email-address/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/float/index.html b/api-reference/scalars/float/index.html index f66a7e851ea..2718fa35432 100644 --- a/api-reference/scalars/float/index.html +++ b/api-reference/scalars/float/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

scalar Float

Member of​

IndividualUltimateBeneficialOwnerInput input ● IndividualUltimateBeneficialOwnerTypeHasCapital object ● PreProvisioningSUVCardSettings object ● ReportExchangeRate object ● UltimateBeneficialDirectOwnerCompanyInfo object ● UltimateBeneficialDirectOwnerIndividualInfo object ● UltimateBeneficialIndirectOwnerCompanyInfo object ● UltimateBeneficialIndirectOwnerIndividualInfo object ● UltimateBeneficialOwnerInfo interface

- + \ No newline at end of file diff --git a/api-reference/scalars/hex-color-code/index.html b/api-reference/scalars/hex-color-code/index.html index 9e1875f1a9e..057937bb069 100644 --- a/api-reference/scalars/hex-color-code/index.html +++ b/api-reference/scalars/hex-color-code/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/iban/index.html b/api-reference/scalars/iban/index.html index e0eac6fdec9..0aab8f284d2 100644 --- a/api-reference/scalars/iban/index.html +++ b/api-reference/scalars/iban/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IBAN

International Bank Account Number

scalar IBAN

Member of​

Account object ● AddDirectDebitFundingSourceInput input ● AddExternalAccountInput input ● DirectDebitAccountVerification object ● DirectDebitFundingSource object ● ExternalAccount object ● IbanValidationInput input ● InternalReceivedDirectDebitMandate object ● InvalidIban object ● SepaBeneficiaryInput input ● SEPAPaymentMandateDebtor object ● SEPAReceivedDirectDebitMandate object ● ValidIban object ● VirtualIBANEntry object

- + \ No newline at end of file diff --git a/api-reference/scalars/id/index.html b/api-reference/scalars/id/index.html index 3a4085b38c3..b35e8902612 100644 --- a/api-reference/scalars/id/index.html +++ b/api-reference/scalars/id/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

scalar ID

Member of​

Account object ● account query ● AccountHolder object ● accountHolder query ● accountInvoice query ● AccountMembership object ● accountMembership query ● accountStatement query ● AccountVerification interface ● AddAccountMembershipInput input ● AddAccountMembershipsInput input ● AddCardInput input ● AddCardsInput input ● AddCardsWithGroupDeliveryInput input ● AddDigitalCardInput input ● AddDirectDebitFundingSourceInput input ● AddExternalAccountBalanceInput input ● AddExternalAccountInput input ● AddFundingLimitSettingsChangeRequestInput input ● AddInternalDirectDebitPaymentMandateInput input ● AddMerchantProfileInput input ● AddOrUpdateExternalAccountBalanceInput input ● AddReceivedInternalDirectDebitB2bMandateInput input ● AddSepaDirectDebitPaymentMandateInput input ● AddSingleUseVirtualCardInput input ● AddSingleUseVirtualCardsInput input ● AddVirtualIbanInput input ● AllowSddInput input ● AllowSddVirtualIbanEntryInput input ● Beneficiary interface ● BindAccountMembershipInput input ● CancelCardInput input ● CancelConsentInput input ● CancelDigitalCardInput input ● CancelFundingSourceInput input ● CancelPhysicalCardInput input ● CancelTransactionInput input ● CancelVirtualIbanEntryInput input ● capitalDepositCase query ● capitalDepositDocument query ● Card object ● card query ● CardConfigInput input ● CardConfigWithGroupDeliveryInput input ● CardDesignBackground object ● CardProduct object ● CardProductDesign object ● CardSettings object ● CardSettingsBackground object ● CardTransaction object ● CheckMerchantPaymentMethod object ● CheckPaymentCollectionInput input ● CheckTransaction object ● CloseAccountInput input ● CompleteDigitalCard object ● Consent object ● consent query ● CreateMerchantPaymentLinkInput input ● CreditTransferInput input ● DeleteSupportingDocumentInput input ● DenySddInput input ● DenySddVirtualIbanEntryInput input ● DigitalCard interface ● DirectDebitAccountVerification object ● DirectDebitFundingSource object ● DisableAccountMembershipInput input ● EnableReceivedDirectDebitMandateInput input ● ExternalAccount object ● ExternalAccountBalance object ● FeeTransaction object ● FinancialInstitution object ● FundingLimitSettingsChangeRequest object ● fundingLimitSettingsChangeRequest query ● FundingSource interface ● fundingSource query ● GenerateAccountStatementInput input ● GenerateCapitalDepositDocumentUploadUrlInput input ● GenerateSupportingDocumentUploadUrlInput input ● GrantConsentWithServerSignatureInput input ● InitiateCreditTransfersInput input ● InitiateFundingRequestInput input ● InitiateInternationalCreditTransferInput input ● InternalBeneficiary object ● InternalCreditTransfer object ● InternalDirectDebitB2BMerchantPaymentMethod object ● InternalDirectDebitCreditor object ● InternalDirectDebitDebtor object ● InternalDirectDebitMandate interface ● InternalDirectDebitPaymentCollectionInput input ● InternalDirectDebitStandardMerchantPaymentMethod object ● InternalDirectDebitTransaction object ● InternalPaymentDirectDebitMandate object ● InternalPaymentMandateCreditor object ● InternalPaymentMandateDebtor object ● InternalReceivedDirectDebitMandate object ● internationalCreditTransferQuote query ● InternationalCreditTransferTransaction object ● Invoice object ● LegalDocument object ● MerchantPaymentLink object ● MerchantPaymentMethod interface ● MerchantProfile object ● merchantProfile query ● onboarding query ● Payment object ● payment query ● PaymentDirectDebitMandate interface ● PaymentMandate interface ● PaymentMandateCreditor interface ● PendingDigitalCard object ● PreProvisioningSUVCardSettings object ● PrintPhysicalCardInput input ● ProjectCardDesigns object ● ProjectCardSettings object ● ProjectInfo object ● ReceivedDirectDebitMandate interface ● receivedDirectDebitMandate query ● RequestMerchantPaymentMethodsInput input ● RequestMerchantProfileUpdate object ● RequestMerchantProfileUpdateInput input ● RequestSupportingDocumentCollectionReviewInput input ● ResumeAccountMembershipInput input ● ResumePhysicalCardInput input ● SEPABeneficiary object ● SEPACreditTransferInCreditor object ● SEPACreditTransferInDebtor object ● SEPACreditTransferInternalInDebtor object ● SEPACreditTransferInternalOutCreditor object ● SEPACreditTransferOutDebtor object ● SEPACreditTransferTransaction object ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitCoreMerchantPaymentMethod object ● SEPADirectDebitInCreditor object ● SEPADirectDebitInDebtor object ● SEPADirectDebitMandate interface ● SEPADirectDebitOutCreditor object ● SEPADirectDebitOutDebtor object ● SepaDirectDebitPaymentCollectionInput input ● SEPADirectDebitTransaction object ● SEPAPaymentDirectDebitMandate object ● SEPAPaymentMandateCreditor object ● SEPAReceivedDirectDebitMandate object ● Shareholder object ● shareholder query ● SingleUseVirtualCardConfigInput input ● StandingOrder object ● standingOrder query ● Statement object ● supportingDocumentCollection query ● SuspendAccountMembershipInput input ● SuspendPhysicalCardInput input ● SuspendReceivedDirectDebitMandateInput input ● Transaction interface ● transaction query ● TransactionNotFoundRejection object ● UltimateBeneficialDirectOwnerCompanyInfo object ● UltimateBeneficialDirectOwnerIndividualInfo object ● UltimateBeneficialIndirectOwnerCompanyInfo object ● UltimateBeneficialIndirectOwnerIndividualInfo object ● UltimateBeneficialOwnerInfo interface ● UpdateAccountHolderInput input ● UpdateAccountInput input ● UpdateAccountMembershipInput input ● UpdateCardInput input ● UpdateCompanyOnboardingInput input ● UpdateIndividualOnboardingInput input ● UpdateReceivedSepaDirectDebitB2bMandateInput input ● UpdateSupportingDocumentInput input ● UpdateUserConsentSettingsInput input ● User object ● ViewCardNumbersInput input ● ViewPhysicalCardNumbersInput input ● ViewPhysicalCardPinInput input ● VirtualIBANEntry object

- + \ No newline at end of file diff --git a/api-reference/scalars/int/index.html b/api-reference/scalars/int/index.html index 8996211c02c..70e5cb7075f 100644 --- a/api-reference/scalars/int/index.html +++ b/api-reference/scalars/int/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

scalar Int

Member of​

AccountConnection object ● AccountHolderConnection object ● accountHolders query ● AccountMembershipConnection object ● accountMemberships query ● accounts query ● CapitalDepositCaseConnection object ● capitalDepositCases query ● CardConnection object ● CardProductDesign object ● cards query ● CardSettings object ● CheckMerchantPaymentMethod object ● Connection interface ● ConsentConnection object ● ConsentIdWithOrder input ● consents query ● DigitalCardConnection object ● ExternalAccountConnection object ● ExternalBalanceConnection object ● FundingLimit object ● FundingLimitSettingsChangeRequestConnection object ● FundingSourceConnection object ● IdentificationConnection object ● InternalDirectDebitB2BMerchantPaymentMethod object ● InternalDirectDebitStandardMerchantPaymentMethod object ● InternationalCreditTransferDynamicForm object ● InvoiceConnection object ● LegalDocumentConnection object ● MerchantPaymentMethod interface ● MerchantProfileConnection object ● OnboardingConnection object ● onboardings query ● PaymentConnection object ● PaymentMandateConnection object ● payments query ● PreProvisioningSUVCardSettings object ● ReceivedDirectDebitMandateConnection object ● RollingReserve object ● Scheme object ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitCoreMerchantPaymentMethod object ● StandingOrderConnection object ● StatementConnection object ● SupportingDocumentCollectionConnection object ● TextField object ● TransactionConnection object ● transactions query ● UserConnection object ● users query ● VirtualIBANEntryConnection object

- + \ No newline at end of file diff --git a/api-reference/scalars/phone-number/index.html b/api-reference/scalars/phone-number/index.html index 537c2aaa0e8..bb84000f5f7 100644 --- a/api-reference/scalars/phone-number/index.html +++ b/api-reference/scalars/phone-number/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/pin/index.html b/api-reference/scalars/pin/index.html index 49bc332fea9..45d349a3810 100644 --- a/api-reference/scalars/pin/index.html +++ b/api-reference/scalars/pin/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/sepa-creditor-identifier/index.html b/api-reference/scalars/sepa-creditor-identifier/index.html index e7c7a6f0bb0..dfe2c14e192 100644 --- a/api-reference/scalars/sepa-creditor-identifier/index.html +++ b/api-reference/scalars/sepa-creditor-identifier/index.html @@ -7,7 +7,7 @@ - + @@ -20,7 +20,7 @@ 8 - 35: Creditor National Identifier – a consecutive number that will be assigned by country example: FR11ABC123456

scalar SepaCreditorIdentifier

Member of​

SEPAPaymentMandateCreditor object

- + \ No newline at end of file diff --git a/api-reference/scalars/sepa-reference/index.html b/api-reference/scalars/sepa-reference/index.html index a81de88f80e..3c8e456fa56 100644 --- a/api-reference/scalars/sepa-reference/index.html +++ b/api-reference/scalars/sepa-reference/index.html @@ -7,7 +7,7 @@ - + @@ -21,7 +21,7 @@ with some follow extra rules : Content must not start or end with a ‘/’ Content must not contain ‘//’s

scalar SepaReference
- + \ No newline at end of file diff --git a/api-reference/scalars/string/index.html b/api-reference/scalars/string/index.html index 9a8b38c654a..05d52cdc94c 100644 --- a/api-reference/scalars/string/index.html +++ b/api-reference/scalars/string/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

scalar String

Member of​

Account object ● AccountClosedStatus object ● AccountClosingStatus object ● AccountEdge object ● AccountFilterInput input ● AccountHolderCanceledStatusInfo object ● AccountHolderCompanyInfo object ● AccountHolderEdge object ● AccountHolderFilterInput input ● AccountHolderIndividualInfo object ● AccountHolderInfo interface ● AccountHolderNotFoundRejection object ● accountHolders query ● AccountHolderSuspendedStatusInfo object ● AccountHolderTypeIndividualRejection object ● AccountMembership object ● AccountMembershipCannotBeDisabledRejection object ● AccountMembershipCannotBeUpdatedRejection object ● AccountMembershipDisabledStatusInfo object ● AccountMembershipEdge object ● AccountMembershipNotAllowedRejection object ● AccountMembershipNotFoundRejection object ● AccountMembershipNotReadyToBeBoundRejection object ● accountMemberships query ● AccountMembershipsFilterInput input ● AccountMembershipSuspendedStatusInfo object ● AccountNotEligibleRejection object ● AccountNotFoundRejection object ● accounts query ● AccountSuspendedStatus object ● AccountVerificationAlreadyRejectedRejection object ● AccountVerificationWrongStatusRejection object ● ActivatePhysicalCardInput input ● AddAccountMembershipInput input ● AddAccountMembershipsInput input ● AddCardInput input ● AddCardsInput input ● AddCardsWithGroupDeliveryInput input ● AddDigitalCardInput input ● AddDirectDebitFundingSourceInput input ● AddExternalAccountInput input ● AddingCardsToDifferentAccountsRejection object ● AddInternalDirectDebitPaymentMandateInput input ● AddMerchantProfileInput input ● AddReceivedInternalDirectDebitB2bMandateInput input ● AddReceivedSepaDirectDebitB2bMandateInput input ● Address object ● AddressInfo object ● AddressInformation object ● AddressInformationInput input ● AddressInput input ● AddSepaDirectDebitPaymentMandateInput input ● AddSingleUseVirtualCardInput input ● AddSingleUseVirtualCardsInput input ● AllowedValue object ● AlreadyValidPhysicalCardRejection object ● ApplePayNotAllowedForProjectRejection object ● Authenticator object ● BadAccountStatusRejection object ● BadRequestRejection object ● Bank object ● Beneficiary interface ● CancelStandingOrderInput input ● CancelTransactionSuccessPayload object ● CannotActivatePhysicalCardRejection object ● CapitalDepositCase object ● CapitalDepositCaseEdge object ● CapitalDepositCaseFiltersInput input ● capitalDepositCases query ● CapitalDepositDocument object ● CapitalDepositDocumentCanNotBeUploaded object ● CapitalDepositDocumentCanNotBeUploadedRejection object ● Card object ● CardCanceledStatusInfo object ● CardCancelingStatusInfo object ● CardCanNotBeDigitalizedRejection object ● CardConfidential object ● CardConfigInput input ● CardConfigWithGroupDeliveryInput input ● CardDesignBackground object ● CardEdge object ● CardFiltersInput input ● CardNotFoundRejection object ● CardProduct object ● CardProductDesign object ● CardProductDisabledRejection object ● CardProductNotApplicableToPhysicalCardsRejection object ● CardProductNotFoundRejection object ● CardProductSuspendedRejection object ● CardProductUsedRejection object ● cards query ● CardSettings object ● CardSettingsBackground object ● CardTransaction object ● CardWrongStatusRejection object ● Certificate input ● CheckPaymentCollectionInput input ● CheckTransaction object ● CloseAccountInput input ● CloseAccountReason object ● CompanyInfo object ● CompanyShareholder object ● CompleteAddressInput input ● CompleteAddressWithContactInput input ● CompleteDigitalCard object ● Consent object ● ConsentEdge object ● ConsentIdWithOrder input ● ConsentNotFoundRejection object ● consents query ● ConsentsAlreadyLinkedToMultiConsentRejection object ● ConsentsFiltersInput input ● ConsentsNotAllInCreatedStatusRejection object ● ConsentsNotFoundRejection object ● ConsentTypeNotSupportedByServerConsentRejection object ● CreateCapitalDepositCaseInput input ● CreateMerchantPaymentLinkInput input ● CreateMultiConsentInput input ● CreditTransferInput input ● CsvStatement object ● Customer object ● CustomerInput input ● DateField object ● DebtorAccountClosedRejection object ● DebtorAccountNotAllowedRejection object ● DeleteSupportingDocumentSuccessPayload object ● deprecated directive ● Device object ● DigitalCardEdge object ● DigitalCardFiltersInput input ● DigitalCardNotFoundRejection object ● DirectDebitFundingSource object ● DisabledFundingLimitSettingsStatusInfo object ● DocumentFile interface ● DriversLicenseDocument object ● DriversLicenseDocumentFile object ● Edge interface ● EnabledCardDesignNotFoundRejection object ● EnableReceivedDirectDebitMandateInput input ● ExternalAccount object ● ExternalAccountAlreadyExistsRejection object ● ExternalAccountBalanceAlreadyExistsRejection object ● ExternalAccountDataSource object ● ExternalAccountEdge object ● ExternalBalanceEdge object ● FacePhotoDocument object ● FeeCreditor interface ● FeeDebtor interface ● FeeInCreditor object ● FeeInDebtor object ● FeeOutCreditor object ● FeeOutDebtor object ● FeeSettingsNotFoundRejection object ● FeeTransaction object ● Field interface ● FinalizeOnboardingInput input ● FinancialInstitution object ● ForbiddenRejection object ● FundingLimitExceededRejection object ● FundingLimitSettingsChangeRequestApprovedStatusInfo object ● FundingLimitSettingsChangeRequestBadAmountRejection object ● FundingLimitSettingsChangeRequestEdge object ● FundingLimitSettingsChangeRequestFiltersInput input ● FundingLimitSettingsChangeRequestRefusedStatusInfo object ● FundingSource interface ● FundingSourceEdge object ● FundingSourceNotFoundRejection object ● FundingSourceWrongStatusRejection object ● GenerateCapitalDepositDocumentUploadUrlInput input ● GenerateCapitalDepositDocumentUploadUrlSuccessPayload object ● GenerateSupportingDocumentUploadUrlInput input ● GenerateSupportingDocumentUploadUrlSuccessPayload object ● GlobalFundingLimitExceededRejection object ● GlobalInstantFundingLimitExceededRejection object ● GrantConsentWithServerSignatureInput input ● Headquarters object ● IBANNotReachableRejection object ● IBANNotValidRejection object ● IbanValidationRejection object ● IdCardDocument object ● IdCardDocumentFile object ● Identification object ● IdentificationEdge object ● IdentityAlreadyBindToAccountMembershipRejection object ● InAppProvisioningData object ● IndividualShareholder object ● IndividualUltimateBeneficialOwner object ● IndividualUltimateBeneficialOwnerInput input ● InitiateCreditTransfersInput input ● InitiateFundingRequestInput input ● InitiateInternationalCreditTransferInput input ● InitiateMerchantPaymentCollectionInput input ● InstantFundingLimitExceededRejection object ● InsufficientFundsRejection object ● InternalBeneficiary object ● InternalCreditTransfer object ● InternalCreditTransferCreditor interface ● InternalCreditTransferDebtor interface ● InternalCreditTransferInCreditor object ● InternalCreditTransferInDebtor object ● InternalCreditTransferOutCreditor object ● InternalCreditTransferOutDebtor object ● InternalDirectDebitTransaction object ● InternalErrorRejection object ● InternalPaymentDirectDebitMandate object ● InternalPaymentMandateCreditor object ● InternalPaymentMandateDebtor object ● InternalReceivedDirectDebitMandate object ● InternalReceivedDirectDebitMandateCreditor object ● InternationalAddressInput input ● InternationalBeneficiaryDetailsInput input ● InternationalBeneficiaryInput input ● InternationalCreditTransferCurrencyExchange object ● InternationalCreditTransferDetails object ● InternationalCreditTransferDetailsInput input ● InternationalCreditTransferOutCreditor object ● InternationalCreditTransferOutDebtor object ● InternationalCreditTransferQuote object ● InternationalCreditTransferTransaction object ● InvalidArgumentRejection object ● InvalidArgumentRejectionField object ● InvalidIban object ● InvalidPhoneNumberRejection object ● InvalidSirenNumberRejection object ● Invoice object ● InvoiceEdge object ● LegalDocument object ● LegalDocumentEdge object ● LegalRepresentativeAccountMembershipCannotBeDisabledRejection object ● LegalRepresentativeAccountMembershipCannotBeSuspendedRejection object ● MembershipInfoInput input ● MembershipsFilterInput input ● MerchantPaymentLink object ● MerchantPaymentMethodNotActiveRejection object ● MerchantProfile object ● MerchantProfileEdge object ● MerchantProfileWrongStatusRejection object ● MissingMandatoryFieldRejection object ● NotFoundRejection object ● NotReachableConsentStatusRejection object ● NotSupportedCountryRejection object ● OAuthRedirectParameters object ● OAuthRedirectParametersInput input ● OnboardCompanyAccountHolderInput input ● OnboardCompanyShareholderInput input ● OnboardIndividualAccountHolderInput input ● OnboardIndividualShareholderInput input ● Onboarding object ● OnboardingCompanyAccountHolderInfo object ● OnboardingEdge object ● OnboardingFiltersInput input ● OnboardingIndividualAccountHolderInfo object ● OnboardingInfo object ● OnboardingNotCompletedRejection object ● onboardings query ● PageInfo object ● PartnerCloseAccountReasonInput input ● PartnershipCanceledStatusInfo object ● PassportDocument object ● PassportDocumentFile object ● PaymentEdge object ● PaymentMandateCreditor interface ● PaymentMandateDebtor interface ● PaymentMandateEdge object ● PaymentMandateMandateNotFoundRejection object ● PaymentMandateReferenceAlreadyUsedRejection object ● PaymentMethodNotCompatibleRejection object ● PaymentRejected object ● payments query ● PdfStatement object ● PermissionCannotBeGrantedRejection object ● PhysicalCard object ● PhysicalCardCanceledStatusInfo object ● PhysicalCardCancelingStatusInfo object ● PhysicalCardCustomOptions object ● PhysicalCardCustomOptionsForGroupDeliveryInput input ● PhysicalCardCustomOptionsForPrintInput input ● PhysicalCardCustomOptionsInput input ● PhysicalCardNotFoundRejection object ● PhysicalCardRenewedStatusInfo object ● PhysicalCardSuspendedStatusInfo object ● PhysicalCardToActivateStatusInfo object ● PhysicalCardWrongStatusRejection object ● PINNotReadyRejection object ● PrintPhysicalCardInput input ● ProjectCardDesigns object ● ProjectCardSettings object ● ProjectForbiddenRejection object ● ProjectFundingLimitExceededRejection object ● ProjectInfo object ● ProjectInstantFundingLimitExceededRejection object ● ProjectInvalidStatusRejection object ● ProjectNotFound object ● ProjectNotFoundRejection object ● ProjectSettingsForbiddenError object ● ProjectSettingsNotFound object ● ProjectSettingsStatusNotReachable object ● PublicOnboardingDisabledRejection object ● RadioField object ● Reason interface ● ReasonInput input ● ReceivedDirectDebitMandate interface ● ReceivedDirectDebitMandateAlreadyExistRejection object ● ReceivedDirectDebitMandateCanceledRejection object ● ReceivedDirectDebitMandateEdge object ● ReceivedDirectDebitMandateNotB2bRejection object ● ReceivedDirectDebitMandateNotFoundRejection object ● RefundInput input ● RefundRejection object ● RefundTransaction input ● Rejection interface ● ReportDocument object ● ReportDocumentFile object ● ReportExchangeRate object ● RequestMerchantProfileUpdate object ● RequestMerchantProfileUpdateInput input ● ResidencePermitDocument object ● ResidencePermitDocumentFile object ● ResidencyAddressInput input ● RestrictedTo object ● RestrictedToInput input ● RestrictedToUserRejection object ● ResumeAccountMembershipInput input ● ResumePhysicalCardInput input ● ScheduleStandingOrderInput input ● Scheme object ● SchemeWrongRejection object ● SelectField object ● SEPABeneficiary object ● SepaBeneficiaryInput input ● SEPACreditTransferCreditor interface ● SEPACreditTransferDebtor interface ● SEPACreditTransferInCreditor object ● SEPACreditTransferInDebtor object ● SEPACreditTransferInternalInDebtor object ● SEPACreditTransferInternalOutCreditor object ● SEPACreditTransferOutCreditor object ● SEPACreditTransferOutDebtor object ● SEPACreditTransferTransaction object ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitB2BPaymentMethodInput input ● SepaDirectDebitCoreMerchantPaymentMethod object ● SepaDirectDebitCorePaymentMethodInput input ● SEPADirectDebitCreditor interface ● SEPADirectDebitDebtor interface ● SEPADirectDebitInCreditor object ● SEPADirectDebitInDebtor object ● SEPADirectDebitOutCreditor object ● SEPADirectDebitOutDebtor object ● SEPADirectDebitTransaction object ● SEPAPaymentDirectDebitMandate object ● SEPAPaymentMandateCreditor object ● SEPAPaymentMandateDebtor object ● SepaPaymentMandateDebtorInput input ● SEPAReceivedDirectDebitMandate object ● SEPAReceivedDirectDebitMandateCreditor object ● ServerConsentCredentialsNotValidOrOutdatedRejection object ● ServerConsentNotAllowedForConsentOperationRejection object ● ServerConsentNotAllowedForProjectRejection object ● ServerConsentProjectCredentialMissingRejection object ● ServerConsentProjectCredentialNotFoundRejection object ● ServerConsentProjectSettingsNotFoundRejection object ● ServerConsentSignatureNotValidRejection object ● Shareholder object ● SignatureData input ● SingleUseVirtualCardConfigInput input ● specifiedBy directive ● StandingOrder object ● StandingOrderEdge object ● StandingOrderNotFoundRejection object ● StatementEdge object ● SupportingDocument object ● SupportingDocumentCollection object ● SupportingDocumentCollectionEdge object ● SupportingDocumentCollectionNotFoundRejection object ● SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection object ● SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection object ● SupportingDocumentCollectionStatusNotAllowedRejection object ● SupportingDocumentNotFoundRejection object ● SupportingDocumentPostField object ● SupportingDocumentRefusedStatusInfo object ● SupportingDocumentSettings object ● SupportingDocumentStatusDoesNotAllowDeletionRejection object ● SupportingDocumentStatusDoesNotAllowUpdateRejection object ● SupportingDocumentStatusNotAllowedRejection object ● SupportingDocumentUploadedStatusInfo object ● SupportingDocumentUploadInfo object ● SupportingDocumentUploadNotAllowedRejection object ● SupportingDocumentValidatedStatusInfo object ● SuspendAccountReason object ● SuspendAccountReasonInput input ● SuspendedFundingLimitSettingsStatusInfo object ● SuspendReceivedDirectDebitMandatedRejection object ● SwanAccountBeneficiaryInput input ● SwanTCUDocumentNotFoundRejection object ● SwanTCUDocumentStatusNotAllowedRejection object ● TextField object ● TooManyChildConsentsRejection object ● TooManyItemsRejection object ● Transaction interface ● TransactionEdge object ● TransactionNotFoundRejection object ● transactions query ● TransactionsFiltersInput input ● UltimateBeneficialDirectOwnerCompanyInfo object ● UltimateBeneficialDirectOwnerIndividualInfo object ● UltimateBeneficialIndirectOwnerCompanyInfo object ● UltimateBeneficialIndirectOwnerIndividualInfo object ● UpdateAccountHolderInput input ● UpdateAccountInput input ● UpdateAccountMembershipInput input ● UpdateCardInput input ● UpdateCompanyOnboardingInput input ● UpdatedRestrictedToInput input ● UpdateIndividualOnboardingInput input ● UpdateReceivedSepaDirectDebitB2bMandateInput input ● UpdateUserConsentSettingsTokenRejection object ● User object ● user query ● UserConsentSettings object ● UserEdge object ● UserFilterInput input ● UserNotAllowedToDisableItsOwnAccountMembershipRejection object ● UserNotAllowedToManageAccountMembershipRejection object ● UserNotAllowedToSuspendItsOwnAccountMembershipRejection object ● UserNotCardHolderRejection object ● users query ● ValidationError object ● ValidationFieldError object ● ValidationRejection object ● ValidIban object ● ViewCardNumbersInput input ● ViewPhysicalCardNumbersInput input ● ViewPhysicalCardPinInput input ● VirtualIBANEntry object ● VirtualIBANEntryEdge object ● WalletProvider object ● WrongValueProvidedRejection object

- + \ No newline at end of file diff --git a/api-reference/scalars/token-requestor-id/index.html b/api-reference/scalars/token-requestor-id/index.html index 9be27ea69ea..a4d2fca85a5 100644 --- a/api-reference/scalars/token-requestor-id/index.html +++ b/api-reference/scalars/token-requestor-id/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/upload/index.html b/api-reference/scalars/upload/index.html index 2a4a98d5dc5..c45e384ecbc 100644 --- a/api-reference/scalars/upload/index.html +++ b/api-reference/scalars/upload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/url/index.html b/api-reference/scalars/url/index.html index 4d6144206a4..04af99ae7cf 100644 --- a/api-reference/scalars/url/index.html +++ b/api-reference/scalars/url/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/scalars/wallet-token/index.html b/api-reference/scalars/wallet-token/index.html index bb25e8ea65c..ae7ac416557 100644 --- a/api-reference/scalars/wallet-token/index.html +++ b/api-reference/scalars/wallet-token/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/activate-physical-card-payload/index.html b/api-reference/unions/activate-physical-card-payload/index.html index f35147744f6..e391be668ae 100644 --- a/api-reference/unions/activate-physical-card-payload/index.html +++ b/api-reference/unions/activate-physical-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ActivatePhysicalCardPayload

No description

union ActivatePhysicalCardPayload = ActivatePhysicalCardSuccessPayload | BadAccountStatusRejection | PhysicalCardNotFoundRejection | PhysicalCardWrongStatusRejection | CannotActivatePhysicalCardRejection | ForbiddenRejection | CardNotFoundRejection | UserNotCardHolderRejection | ValidationRejection

Possible types​

ActivatePhysicalCardSuccessPayload object​

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

PhysicalCardNotFoundRejection object​

Rejection returned when the Physical Card does not exist

PhysicalCardWrongStatusRejection object​

Rejection returned when the Physical Card is not the expected status

CannotActivatePhysicalCardRejection object​

Rejection returned when the Physical Card cannot be activated

ForbiddenRejection object​

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

UserNotCardHolderRejection object​

Rejection returned when the User is not the Card Holder

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

activatePhysicalCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-account-membership-payload/index.html b/api-reference/unions/add-account-membership-payload/index.html index 77b91c975ee..983b79cc74b 100644 --- a/api-reference/unions/add-account-membership-payload/index.html +++ b/api-reference/unions/add-account-membership-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddAccountMembershipPayload

No description

union AddAccountMembershipPayload = AddAccountMembershipSuccessPayload | BadAccountStatusRejection | ForbiddenRejection | InvalidPhoneNumberRejection | PermissionCannotBeGrantedRejection | ValidationRejection

Possible types​

AddAccountMembershipSuccessPayload object​

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

ForbiddenRejection object​

InvalidPhoneNumberRejection object​

Rejection returned if phone number is not well formatted

PermissionCannotBeGrantedRejection object​

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addAccountMembership mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-account-memberships-payload/index.html b/api-reference/unions/add-account-memberships-payload/index.html index 5eebb346262..9ef840052f0 100644 --- a/api-reference/unions/add-account-memberships-payload/index.html +++ b/api-reference/unions/add-account-memberships-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddAccountMembershipsPayload

No description

union AddAccountMembershipsPayload = AddAccountMembershipsSuccessPayload | BadAccountStatusRejection | ForbiddenRejection | InvalidPhoneNumberRejection | PermissionCannotBeGrantedRejection | TooManyItemsRejection | ValidationRejection

Possible types​

AddAccountMembershipsSuccessPayload object​

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

ForbiddenRejection object​

InvalidPhoneNumberRejection object​

Rejection returned if phone number is not well formatted

PermissionCannotBeGrantedRejection object​

TooManyItemsRejection object​

Rejection returned if too many items are given

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addAccountMemberships mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-card-payload/index.html b/api-reference/unions/add-card-payload/index.html index 8730578813f..01218ae1f39 100644 --- a/api-reference/unions/add-card-payload/index.html +++ b/api-reference/unions/add-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddCardPayload

No description

union AddCardPayload = AddCardSuccessPayload | AccountMembershipNotAllowedRejection | BadAccountStatusRejection | CardProductDisabledRejection | CardProductSuspendedRejection | EnabledCardDesignNotFoundRejection | ForbiddenRejection | MissingMandatoryFieldRejection | ValidationRejection

Possible types​

AddCardSuccessPayload object​

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

CardProductDisabledRejection object​

Rejection returned if the card product is disabled.

CardProductSuspendedRejection object​

Rejection returned if the card product is suspended.

EnabledCardDesignNotFoundRejection object​

Rejection returned if the card product don't have a card design enabled

ForbiddenRejection object​

MissingMandatoryFieldRejection object​

Rejection returned when mandatory fields are missing from the call.

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-cards-payload/index.html b/api-reference/unions/add-cards-payload/index.html index 158a3fc3524..cdecd792850 100644 --- a/api-reference/unions/add-cards-payload/index.html +++ b/api-reference/unions/add-cards-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddCardsPayload

No description

union AddCardsPayload = AddCardsSuccessPayload | AddingCardsToDifferentAccountsRejection | BadAccountStatusRejection | TooManyItemsRejection | AccountMembershipNotAllowedRejection | CardProductSuspendedRejection | CardProductNotApplicableToPhysicalCardsRejection | CardProductDisabledRejection | EnabledCardDesignNotFoundRejection | MissingMandatoryFieldRejection | ValidationRejection

Possible types​

AddCardsSuccessPayload object​

AddingCardsToDifferentAccountsRejection object​

Rejection returned if the attempting to add cards to different accounts.

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

TooManyItemsRejection object​

Rejection returned if too many items are given

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

CardProductSuspendedRejection object​

Rejection returned if the card product is suspended.

CardProductNotApplicableToPhysicalCardsRejection object​

Rejection returned if the card product is not applicable to physical card.

CardProductDisabledRejection object​

Rejection returned if the card product is disabled.

EnabledCardDesignNotFoundRejection object​

Rejection returned if the card product don't have a card design enabled

MissingMandatoryFieldRejection object​

Rejection returned when mandatory fields are missing from the call.

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addCards mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-cards-with-group-delivery-payload/index.html b/api-reference/unions/add-cards-with-group-delivery-payload/index.html index 547aea39eb5..1fa22d8fb85 100644 --- a/api-reference/unions/add-cards-with-group-delivery-payload/index.html +++ b/api-reference/unions/add-cards-with-group-delivery-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddCardsWithGroupDeliveryPayload

No description

union AddCardsWithGroupDeliveryPayload = AddCardsWithGroupDeliverySuccessPayload | AddingCardsToDifferentAccountsRejection | BadAccountStatusRejection | TooManyItemsRejection | AccountMembershipNotAllowedRejection | CardProductSuspendedRejection | CardProductNotApplicableToPhysicalCardsRejection | CardProductDisabledRejection | EnabledCardDesignNotFoundRejection | MissingMandatoryFieldRejection | ValidationRejection

Possible types​

AddCardsWithGroupDeliverySuccessPayload object​

AddingCardsToDifferentAccountsRejection object​

Rejection returned if the attempting to add cards to different accounts.

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

TooManyItemsRejection object​

Rejection returned if too many items are given

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

CardProductSuspendedRejection object​

Rejection returned if the card product is suspended.

CardProductNotApplicableToPhysicalCardsRejection object​

Rejection returned if the card product is not applicable to physical card.

CardProductDisabledRejection object​

Rejection returned if the card product is disabled.

EnabledCardDesignNotFoundRejection object​

Rejection returned if the card product don't have a card design enabled

MissingMandatoryFieldRejection object​

Rejection returned when mandatory fields are missing from the call.

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addCardsWithGroupDelivery mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-digital-card-payload/index.html b/api-reference/unions/add-digital-card-payload/index.html index deddd3b4184..e673d426f69 100644 --- a/api-reference/unions/add-digital-card-payload/index.html +++ b/api-reference/unions/add-digital-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddDigitalCardPayload

Payload returned on mutation completion

union AddDigitalCardPayload = AddDigitalCardSuccessPayload | CardNotFoundRejection | CardCanNotBeDigitalizedRejection | ApplePayNotAllowedForProjectRejection | BadAccountStatusRejection | AccountMembershipNotAllowedRejection | UserNotCardHolderRejection | CardProductDisabledRejection | EnabledCardDesignNotFoundRejection | MissingMandatoryFieldRejection | ValidationRejection

Possible types​

AddDigitalCardSuccessPayload object​

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

CardCanNotBeDigitalizedRejection object​

Rejection returned if the card could not be digitalized

ApplePayNotAllowedForProjectRejection object​

Rejection return if the project is not configured to allow Apple Pay

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

UserNotCardHolderRejection object​

Rejection returned when the User is not the Card Holder

CardProductDisabledRejection object​

Rejection returned if the card product is disabled.

EnabledCardDesignNotFoundRejection object​

Rejection returned if the card product don't have a card design enabled

MissingMandatoryFieldRejection object​

Rejection returned when mandatory fields are missing from the call.

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addDigitalCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-direct-debit-funding-source-payload/index.html b/api-reference/unions/add-direct-debit-funding-source-payload/index.html index 36ac5aa0f87..5e94ea18b50 100644 --- a/api-reference/unions/add-direct-debit-funding-source-payload/index.html +++ b/api-reference/unions/add-direct-debit-funding-source-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddDirectDebitFundingSourcePayload

Add Direct Debit Funding Source Payload

union AddDirectDebitFundingSourcePayload = AddDirectDebitFundingSourceSuccessPayload | ForbiddenRejection | NotFoundRejection | AccountVerificationAlreadyRejectedRejection | IBANNotReachableRejection | ValidationRejection

Possible types​

AddDirectDebitFundingSourceSuccessPayload object​

Add Direct Debit Funding Source Success Payload

ForbiddenRejection object​

NotFoundRejection object​

Rejection returned if the entity was not found or if the user does not have the rights to know that the account exists

AccountVerificationAlreadyRejectedRejection object​

Rejection returned when the external account has already been rejected.

In such a case, contact Swan directly to resolve the situation for this specific account holder.

IBANNotReachableRejection object​

Rejection returned when the IBAN is not reachable

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addDirectDebitFundingSource mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-external-account-balance-payload/index.html b/api-reference/unions/add-external-account-balance-payload/index.html index 9597db494d3..59ccc3fb714 100644 --- a/api-reference/unions/add-external-account-balance-payload/index.html +++ b/api-reference/unions/add-external-account-balance-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddExternalAccountBalancePayload

No description

union AddExternalAccountBalancePayload = AddExternalAccountBalanceSuccessPayload | ValidationRejection | ExternalAccountBalanceAlreadyExistsRejection | ForbiddenRejection

Possible types​

AddExternalAccountBalanceSuccessPayload object​

ValidationRejection object​

Rejection returned if an input contains invalid data

ExternalAccountBalanceAlreadyExistsRejection object​

ForbiddenRejection object​

Returned by​

addExternalAccountBalance mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-external-account-payload/index.html b/api-reference/unions/add-external-account-payload/index.html index 4f9c76d8f56..1b042d20ece 100644 --- a/api-reference/unions/add-external-account-payload/index.html +++ b/api-reference/unions/add-external-account-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddExternalAccountPayload

No description

union AddExternalAccountPayload = AddExternalAccountSuccessPayload | ValidationRejection | IbanValidationRejection | ExternalAccountAlreadyExistsRejection | ForbiddenRejection

Possible types​

AddExternalAccountSuccessPayload object​

ValidationRejection object​

Rejection returned if an input contains invalid data

IbanValidationRejection object​

ExternalAccountAlreadyExistsRejection object​

ForbiddenRejection object​

Returned by​

addExternalAccount mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-funding-limit-settings-change-request-payload/index.html b/api-reference/unions/add-funding-limit-settings-change-request-payload/index.html index 7f94a7d931d..def5731c8c3 100644 --- a/api-reference/unions/add-funding-limit-settings-change-request-payload/index.html +++ b/api-reference/unions/add-funding-limit-settings-change-request-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddFundingLimitSettingsChangeRequestPayload

Payload returned on mutation completion

union AddFundingLimitSettingsChangeRequestPayload = AddFundingLimitSettingsChangeRequestSuccessPayload | FundingLimitSettingsChangeRequestBadAmountRejection | AccountHolderNotFoundRejection | ForbiddenRejection | ValidationRejection

Possible types​

AddFundingLimitSettingsChangeRequestSuccessPayload object​

Add Funding Limit Settings Change Request Success Payload

FundingLimitSettingsChangeRequestBadAmountRejection object​

Funding Limit Settings Change Request Bad Amount Rejection

AccountHolderNotFoundRejection object​

Rejection returned when the Account Holder was not found

ForbiddenRejection object​

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addFundingLimitSettingsChangeRequest mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-internal-direct-debit-payment-mandate-payload/index.html b/api-reference/unions/add-internal-direct-debit-payment-mandate-payload/index.html index 4178692f522..b783120905a 100644 --- a/api-reference/unions/add-internal-direct-debit-payment-mandate-payload/index.html +++ b/api-reference/unions/add-internal-direct-debit-payment-mandate-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddInternalDirectDebitPaymentMandatePayload

Union type return by the addInternalDirectDebitPaymentMandate mutation

union AddInternalDirectDebitPaymentMandatePayload = AddInternalDirectDebitPaymentMandateSuccessPayload | ForbiddenRejection | NotFoundRejection | DebtorAccountNotAllowedRejection | DebtorAccountClosedRejection | SchemeWrongRejection | PaymentMandateReferenceAlreadyUsedRejection | InternalErrorRejection

Possible types​

AddInternalDirectDebitPaymentMandateSuccessPayload object​

Return type in case of a successful response of the addInternalDirectDebitPaymentMandate mutation

ForbiddenRejection object​

NotFoundRejection object​

Rejection returned if the entity was not found or if the user does not have the rights to know that the account exists

DebtorAccountNotAllowedRejection object​

Rejection returned when the Debtor does not belong to the same project as the creditor

DebtorAccountClosedRejection object​

Rejection returned when the Debtor is closed

SchemeWrongRejection object​

Rejection returned when adding a B2B mandate with an Individual debtor

PaymentMandateReferenceAlreadyUsedRejection object​

Rejection returned if the payment mandate reference is already used for the same creditor

InternalErrorRejection object​

Rejection returned on unexpected server error

Returned by​

addInternalDirectDebitPaymentMandate mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-merchant-profile-payload/index.html b/api-reference/unions/add-merchant-profile-payload/index.html index a78e9d6badf..0d992f0f939 100644 --- a/api-reference/unions/add-merchant-profile-payload/index.html +++ b/api-reference/unions/add-merchant-profile-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddMerchantProfilePayload

Add Merchant Profile Payload

union AddMerchantProfilePayload = AddMerchantProfileSuccessPayload | ForbiddenRejection | AccountNotFoundRejection | InternalErrorRejection

Possible types​

AddMerchantProfileSuccessPayload object​

Add Merchant Profile Success Payload

ForbiddenRejection object​

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

InternalErrorRejection object​

Rejection returned on unexpected server error

Returned by​

addMerchantProfile mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-or-update-external-account-balance-payload/index.html b/api-reference/unions/add-or-update-external-account-balance-payload/index.html index 7fdd62acc91..9bf819ebd2f 100644 --- a/api-reference/unions/add-or-update-external-account-balance-payload/index.html +++ b/api-reference/unions/add-or-update-external-account-balance-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/add-received-internal-direct-debit-b2-b-mandate-payload/index.html b/api-reference/unions/add-received-internal-direct-debit-b2-b-mandate-payload/index.html index bbef1530111..a8450369443 100644 --- a/api-reference/unions/add-received-internal-direct-debit-b2-b-mandate-payload/index.html +++ b/api-reference/unions/add-received-internal-direct-debit-b2-b-mandate-payload/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AddReceivedInternalDirectDebitB2bMandatePayload

Union type return by the addReceivedInternalDirectDebitB2bMandate mutation

union AddReceivedInternalDirectDebitB2bMandatePayload = AddReceivedInternalDirectDebitB2bMandateSuccessPayload | ForbiddenRejection | PaymentMandateMandateNotFoundRejection | AccountHolderTypeIndividualRejection

Possible types​

AddReceivedInternalDirectDebitB2bMandateSuccessPayload object​

Return type in case of a successful response of the addReceivedInternalDirectDebitB2bMandate mutation

ForbiddenRejection object​

PaymentMandateMandateNotFoundRejection object​

Error returned if the payment mandate was not found

AccountHolderTypeIndividualRejection object​

Rejection returned if the account holder type is individual. An individual account holder can't create a b2b received direct debit mandate.

Returned by​

addReceivedInternalDirectDebitB2bMandate mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-received-sepa-direct-debit-b2-b-mandate-payload/index.html b/api-reference/unions/add-received-sepa-direct-debit-b2-b-mandate-payload/index.html index ee71e209796..a31aa8b450b 100644 --- a/api-reference/unions/add-received-sepa-direct-debit-b2-b-mandate-payload/index.html +++ b/api-reference/unions/add-received-sepa-direct-debit-b2-b-mandate-payload/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

AddReceivedSepaDirectDebitB2bMandatePayload

Union type return by the addReceivedSepaDirectDebitB2bMandate mutation

union AddReceivedSepaDirectDebitB2bMandatePayload = AddReceivedSepaDirectDebitB2bMandateSuccessPayload | ForbiddenRejection | AccountNotFoundRejection | AccountHolderTypeIndividualRejection

Possible types​

AddReceivedSepaDirectDebitB2bMandateSuccessPayload object​

Return type in case of a successful response of the addReceivedSepaDirectDebitB2bMandate mutation

ForbiddenRejection object​

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

AccountHolderTypeIndividualRejection object​

Rejection returned if the account holder type is individual. An individual account holder can't create a b2b received direct debit mandate.

Returned by​

addReceivedSepaDirectDebitB2bMandate mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-sepa-direct-debit-payment-mandate-payload/index.html b/api-reference/unions/add-sepa-direct-debit-payment-mandate-payload/index.html index 1315f38c1c5..c8612ff466e 100644 --- a/api-reference/unions/add-sepa-direct-debit-payment-mandate-payload/index.html +++ b/api-reference/unions/add-sepa-direct-debit-payment-mandate-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddSepaDirectDebitPaymentMandatePayload

Union type return by the addSepaDirectDebitPaymentMandate mutation

union AddSepaDirectDebitPaymentMandatePayload = AddSepaDirectDebitPaymentMandateSuccessPayload | ForbiddenRejection | NotFoundRejection | DebtorAccountNotAllowedRejection | DebtorAccountClosedRejection | SchemeWrongRejection | PaymentMandateReferenceAlreadyUsedRejection | ValidationRejection | PaymentMethodNotCompatibleRejection | InternalErrorRejection

Possible types​

AddSepaDirectDebitPaymentMandateSuccessPayload object​

Return type in case of a successful response of the addSepaDirectDebitPaymentMandate mutation

ForbiddenRejection object​

NotFoundRejection object​

Rejection returned if the entity was not found or if the user does not have the rights to know that the account exists

DebtorAccountNotAllowedRejection object​

Rejection returned when the Debtor does not belong to the same project as the creditor

DebtorAccountClosedRejection object​

Rejection returned when the Debtor is closed

SchemeWrongRejection object​

Rejection returned when adding a B2B mandate with an Individual debtor

PaymentMandateReferenceAlreadyUsedRejection object​

Rejection returned if the payment mandate reference is already used for the same creditor

ValidationRejection object​

Rejection returned if an input contains invalid data

PaymentMethodNotCompatibleRejection object​

Rejection returned when a payment method is not compatible for the requested mutation

InternalErrorRejection object​

Rejection returned on unexpected server error

Returned by​

addSepaDirectDebitPaymentMandate mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-single-use-virtual-card-payload/index.html b/api-reference/unions/add-single-use-virtual-card-payload/index.html index 8bae808eee2..70cc84ec3ee 100644 --- a/api-reference/unions/add-single-use-virtual-card-payload/index.html +++ b/api-reference/unions/add-single-use-virtual-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddSingleUseVirtualCardPayload

No description

union AddSingleUseVirtualCardPayload = AddSingleUseVirtualCardSuccessForUserPayload | AddSingleUseVirtualCardSuccessForProjectOwnerPayload | BadAccountStatusRejection | AccountMembershipNotAllowedRejection | CardProductSuspendedRejection | CardProductDisabledRejection | EnabledCardDesignNotFoundRejection | MissingMandatoryFieldRejection | ValidationRejection

Possible types​

AddSingleUseVirtualCardSuccessForUserPayload object​

AddSingleUseVirtualCardSuccessForProjectOwnerPayload object​

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

CardProductSuspendedRejection object​

Rejection returned if the card product is suspended.

CardProductDisabledRejection object​

Rejection returned if the card product is disabled.

EnabledCardDesignNotFoundRejection object​

Rejection returned if the card product don't have a card design enabled

MissingMandatoryFieldRejection object​

Rejection returned when mandatory fields are missing from the call.

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addSingleUseVirtualCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-single-use-virtual-cards-payload/index.html b/api-reference/unions/add-single-use-virtual-cards-payload/index.html index 617ba149604..00c77cde51e 100644 --- a/api-reference/unions/add-single-use-virtual-cards-payload/index.html +++ b/api-reference/unions/add-single-use-virtual-cards-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddSingleUseVirtualCardsPayload

No description

union AddSingleUseVirtualCardsPayload = AddSingleUseVirtualCardsSuccessPayload | AddingCardsToDifferentAccountsRejection | TooManyItemsRejection | BadAccountStatusRejection | AccountMembershipNotAllowedRejection | CardProductSuspendedRejection | CardProductDisabledRejection | EnabledCardDesignNotFoundRejection | MissingMandatoryFieldRejection | ValidationRejection

Possible types​

AddSingleUseVirtualCardsSuccessPayload object​

AddingCardsToDifferentAccountsRejection object​

Rejection returned if the attempting to add cards to different accounts.

TooManyItemsRejection object​

Rejection returned if too many items are given

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

CardProductSuspendedRejection object​

Rejection returned if the card product is suspended.

CardProductDisabledRejection object​

Rejection returned if the card product is disabled.

EnabledCardDesignNotFoundRejection object​

Rejection returned if the card product don't have a card design enabled

MissingMandatoryFieldRejection object​

Rejection returned when mandatory fields are missing from the call.

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addSingleUseVirtualCards mutation

- + \ No newline at end of file diff --git a/api-reference/unions/add-virtual-iban-entry-payload/index.html b/api-reference/unions/add-virtual-iban-entry-payload/index.html index 006fdbd3533..4c94318746a 100644 --- a/api-reference/unions/add-virtual-iban-entry-payload/index.html +++ b/api-reference/unions/add-virtual-iban-entry-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

AddVirtualIbanEntryPayload

No description

union AddVirtualIbanEntryPayload = AddVirtualIbanEntrySuccessPayload | AccountNotFoundRejection | BadAccountStatusRejection | ForbiddenRejection | ValidationRejection

Possible types​

AddVirtualIbanEntrySuccessPayload object​

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

ForbiddenRejection object​

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

addVirtualIbanEntry mutation

- + \ No newline at end of file diff --git a/api-reference/unions/allow-sdd-payload/index.html b/api-reference/unions/allow-sdd-payload/index.html index cd565e534d9..47f4d3793c9 100644 --- a/api-reference/unions/allow-sdd-payload/index.html +++ b/api-reference/unions/allow-sdd-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/allow-sdd-virtual-iban-entry-payload/index.html b/api-reference/unions/allow-sdd-virtual-iban-entry-payload/index.html index fc0e50e2672..f885121226f 100644 --- a/api-reference/unions/allow-sdd-virtual-iban-entry-payload/index.html +++ b/api-reference/unions/allow-sdd-virtual-iban-entry-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/bind-account-membership-payload/index.html b/api-reference/unions/bind-account-membership-payload/index.html index 7f07517908c..6dde9222902 100644 --- a/api-reference/unions/bind-account-membership-payload/index.html +++ b/api-reference/unions/bind-account-membership-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

BindAccountMembershipPayload

No description

union BindAccountMembershipPayload = BindAccountMembershipSuccessPayload | BadAccountStatusRejection | AccountMembershipNotFoundRejection | AccountMembershipNotReadyToBeBoundRejection | IdentityAlreadyBindToAccountMembershipRejection | RestrictedToUserRejection | ValidationRejection

Possible types​

BindAccountMembershipSuccessPayload object​

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

AccountMembershipNotFoundRejection object​

AccountMembershipNotReadyToBeBoundRejection object​

Rejection returned if invitation has not been sent to user yet

IdentityAlreadyBindToAccountMembershipRejection object​

Rejection returned if identity and the account memberships are already bind

RestrictedToUserRejection object​

Rejection returned if the mutation cannot be executed in another context than user

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

bindAccountMembership mutation

- + \ No newline at end of file diff --git a/api-reference/unions/cancel-card-payload/index.html b/api-reference/unions/cancel-card-payload/index.html index 9c30ae8dabe..4243e3e2036 100644 --- a/api-reference/unions/cancel-card-payload/index.html +++ b/api-reference/unions/cancel-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CancelCardPayload

No description

union CancelCardPayload = CancelCardSuccessPayload | AccountMembershipNotAllowedRejection | CardNotFoundRejection | ForbiddenRejection | ValidationRejection

Possible types​

CancelCardSuccessPayload object​

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

ForbiddenRejection object​

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

cancelCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/cancel-consent-payload/index.html b/api-reference/unions/cancel-consent-payload/index.html index 9c0d189324c..2371da3c601 100644 --- a/api-reference/unions/cancel-consent-payload/index.html +++ b/api-reference/unions/cancel-consent-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CancelConsentPayload

Payload of the cancelConsent mutation

union CancelConsentPayload = CancelConsentSuccessPayload | ConsentNotFoundRejection | NotReachableConsentStatusRejection

Possible types​

CancelConsentSuccessPayload object​

Success payload of the cancelConsent mutation

ConsentNotFoundRejection object​

Rejection returned if a consent was not found

NotReachableConsentStatusRejection object​

Rejection returned when consent status couldn't change

Returned by​

cancelConsent mutation

- + \ No newline at end of file diff --git a/api-reference/unions/cancel-digital-card-payload/index.html b/api-reference/unions/cancel-digital-card-payload/index.html index 902a0851318..23bbddad8fe 100644 --- a/api-reference/unions/cancel-digital-card-payload/index.html +++ b/api-reference/unions/cancel-digital-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CancelDigitalCardPayload

No description

union CancelDigitalCardPayload = CancelDigitalCardSuccessPayload | AccountMembershipNotAllowedRejection | CardNotFoundRejection | DigitalCardNotFoundRejection | ForbiddenRejection | ValidationRejection

Possible types​

CancelDigitalCardSuccessPayload object​

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

DigitalCardNotFoundRejection object​

Rejection returned when the Digital Card does not exist

ForbiddenRejection object​

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

cancelDigitalCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/cancel-funding-source-payload/index.html b/api-reference/unions/cancel-funding-source-payload/index.html index 672d8d3bd9a..07b84a84c85 100644 --- a/api-reference/unions/cancel-funding-source-payload/index.html +++ b/api-reference/unions/cancel-funding-source-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CancelFundingSourcePayload

Cancel Funding Source Payload

union CancelFundingSourcePayload = CancelFundingSourceSuccessPayload | ForbiddenRejection | NotFoundRejection

Possible types​

CancelFundingSourceSuccessPayload object​

Cancel Funding Source Success Payload

ForbiddenRejection object​

NotFoundRejection object​

Rejection returned if the entity was not found or if the user does not have the rights to know that the account exists

Returned by​

cancelFundingSource mutation

- + \ No newline at end of file diff --git a/api-reference/unions/cancel-physical-card-payload/index.html b/api-reference/unions/cancel-physical-card-payload/index.html index 9598bcf479f..a380481350e 100644 --- a/api-reference/unions/cancel-physical-card-payload/index.html +++ b/api-reference/unions/cancel-physical-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CancelPhysicalCardPayload

No description

union CancelPhysicalCardPayload = CancelPhysicalCardSuccessPayload | AccountMembershipNotAllowedRejection | CardNotFoundRejection | ForbiddenRejection | PhysicalCardNotFoundRejection | ValidationRejection

Possible types​

CancelPhysicalCardSuccessPayload object​

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

ForbiddenRejection object​

PhysicalCardNotFoundRejection object​

Rejection returned when the Physical Card does not exist

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

cancelPhysicalCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/cancel-standing-order-payload/index.html b/api-reference/unions/cancel-standing-order-payload/index.html index 21274d31988..d40424e3d20 100644 --- a/api-reference/unions/cancel-standing-order-payload/index.html +++ b/api-reference/unions/cancel-standing-order-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CancelStandingOrderPayload

No description

union CancelStandingOrderPayload = CancelStandingOrderSuccessPayload | ForbiddenRejection | InternalErrorRejection | StandingOrderNotFoundRejection

Possible types​

CancelStandingOrderSuccessPayload object​

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

StandingOrderNotFoundRejection object​

Rejection returned when Standing Order is not found

Returned by​

cancelStandingOrder mutation

- + \ No newline at end of file diff --git a/api-reference/unions/cancel-transaction-payload/index.html b/api-reference/unions/cancel-transaction-payload/index.html index 4604b17a979..65f045ed480 100644 --- a/api-reference/unions/cancel-transaction-payload/index.html +++ b/api-reference/unions/cancel-transaction-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/cancel-virtual-iban-entry-payload/index.html b/api-reference/unions/cancel-virtual-iban-entry-payload/index.html index 90a90116a17..d31daa97ad1 100644 --- a/api-reference/unions/cancel-virtual-iban-entry-payload/index.html +++ b/api-reference/unions/cancel-virtual-iban-entry-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CancelVirtualIbanEntryPayload

No description

union CancelVirtualIbanEntryPayload = CancelVirtualIbanEntrySuccessPayload | AccountNotFoundRejection | BadAccountStatusRejection | InternalErrorRejection | ValidationRejection

Possible types​

CancelVirtualIbanEntrySuccessPayload object​

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

InternalErrorRejection object​

Rejection returned on unexpected server error

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

cancelVirtualIbanEntry mutation

- + \ No newline at end of file diff --git a/api-reference/unions/close-account-payload/index.html b/api-reference/unions/close-account-payload/index.html index 8569aad8539..4067528bc38 100644 --- a/api-reference/unions/close-account-payload/index.html +++ b/api-reference/unions/close-account-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CloseAccountPayload

No description

union CloseAccountPayload = CloseAccountSuccessPayload | AccountNotFoundRejection | BadAccountStatusRejection | ForbiddenRejection | InternalErrorRejection | ValidationRejection

Possible types​

CloseAccountSuccessPayload object​

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

closeAccount mutation

- + \ No newline at end of file diff --git a/api-reference/unions/close-account-status-reason/index.html b/api-reference/unions/close-account-status-reason/index.html index a5cb9783615..5820dea447a 100644 --- a/api-reference/unions/close-account-status-reason/index.html +++ b/api-reference/unions/close-account-status-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/create-capital-deposit-case-payload/index.html b/api-reference/unions/create-capital-deposit-case-payload/index.html index 33b90df381d..5f63cc2b822 100644 --- a/api-reference/unions/create-capital-deposit-case-payload/index.html +++ b/api-reference/unions/create-capital-deposit-case-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/create-merchant-payment-link-payload/index.html b/api-reference/unions/create-merchant-payment-link-payload/index.html index 41ca23b3883..398bb14b43d 100644 --- a/api-reference/unions/create-merchant-payment-link-payload/index.html +++ b/api-reference/unions/create-merchant-payment-link-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CreateMerchantPaymentLinkPayload

No description

union CreateMerchantPaymentLinkPayload = CreateMerchantPaymentLinkSuccessPayload | MerchantProfileWrongStatusRejection | MerchantPaymentMethodNotActiveRejection | PaymentMethodNotCompatibleRejection | InternalErrorRejection | ForbiddenRejection | ValidationRejection

Possible types​

CreateMerchantPaymentLinkSuccessPayload object​

MerchantProfileWrongStatusRejection object​

Rejection returned when the Merchant Profile is not in the expected status

MerchantPaymentMethodNotActiveRejection object​

Rejection returned when the Merchant Payment Method is not active

PaymentMethodNotCompatibleRejection object​

Rejection returned when a payment method is not compatible for the requested mutation

InternalErrorRejection object​

Rejection returned on unexpected server error

ForbiddenRejection object​

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

createMerchantPaymentLink mutation

- + \ No newline at end of file diff --git a/api-reference/unions/create-multi-consent-payload/index.html b/api-reference/unions/create-multi-consent-payload/index.html index af27b378750..611489454eb 100644 --- a/api-reference/unions/create-multi-consent-payload/index.html +++ b/api-reference/unions/create-multi-consent-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

CreateMultiConsentPayload

Payload of the createMultiConsent mutation

union CreateMultiConsentPayload = CreateMultiConsentSuccessPayload | ConsentsNotAllInCreatedStatusRejection | ConsentsNotFoundRejection | TooManyChildConsentsRejection | ConsentsAlreadyLinkedToMultiConsentRejection

Possible types​

CreateMultiConsentSuccessPayload object​

Success payload of the createMultiConsent mutation

ConsentsNotAllInCreatedStatusRejection object​

Rejection returned when all provided consents are not in created status

ConsentsNotFoundRejection object​

Rejection returned when a consent ID passed as input does not exist.

TooManyChildConsentsRejection object​

Rejection returned when trying to create a multi consent with too many child consents

ConsentsAlreadyLinkedToMultiConsentRejection object​

Rejection returned when a the consent is already linked to another multi consent

Returned by​

createMultiConsent mutation

- + \ No newline at end of file diff --git a/api-reference/unions/delete-supporting-document-payload/index.html b/api-reference/unions/delete-supporting-document-payload/index.html index bd2b8ba1ea1..89e17c80a18 100644 --- a/api-reference/unions/delete-supporting-document-payload/index.html +++ b/api-reference/unions/delete-supporting-document-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DeleteSupportingDocumentPayload

No description

union DeleteSupportingDocumentPayload = DeleteSupportingDocumentSuccessPayload | ForbiddenRejection | InternalErrorRejection | SupportingDocumentCollectionNotFoundRejection | SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection | SupportingDocumentNotFoundRejection | SupportingDocumentStatusDoesNotAllowDeletionRejection | ValidationRejection

Possible types​

DeleteSupportingDocumentSuccessPayload object​

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

SupportingDocumentCollectionNotFoundRejection object​

Rejection returned if the supporting document collection was not found

SupportingDocumentCollectionStatusDoesNotAllowDeletionRejection object​

Rejection returned if supporting document cannot be deleted because its supporting document collection status is not WaitingForDocument

SupportingDocumentNotFoundRejection object​

Rejection returned if the supporting document was not found

SupportingDocumentStatusDoesNotAllowDeletionRejection object​

Rejection returned if supporting document cannot be deleted because of its status

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

deleteSupportingDocument mutation

- + \ No newline at end of file diff --git a/api-reference/unions/deny-sdd-payload/index.html b/api-reference/unions/deny-sdd-payload/index.html index 22b6d360cea..e43699d27ed 100644 --- a/api-reference/unions/deny-sdd-payload/index.html +++ b/api-reference/unions/deny-sdd-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DenySddPayload

No description

union DenySddPayload = DenySddSuccessPayload | BadAccountStatusRejection | AccountNotFoundRejection | InvalidArgumentRejection | ValidationRejection

Possible types​

DenySddSuccessPayload object​

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

InvalidArgumentRejection object​

Rejection returned on invalid argument error

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

denySdd mutation

- + \ No newline at end of file diff --git a/api-reference/unions/deny-sdd-virtual-iban-entry-payload/index.html b/api-reference/unions/deny-sdd-virtual-iban-entry-payload/index.html index 14529418f91..3ba26a21ec0 100644 --- a/api-reference/unions/deny-sdd-virtual-iban-entry-payload/index.html +++ b/api-reference/unions/deny-sdd-virtual-iban-entry-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/disable-account-membership-payload/index.html b/api-reference/unions/disable-account-membership-payload/index.html index f985aa1c425..d9598e96034 100644 --- a/api-reference/unions/disable-account-membership-payload/index.html +++ b/api-reference/unions/disable-account-membership-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

DisableAccountMembershipPayload

No description

union DisableAccountMembershipPayload = DisableAccountMembershipSuccessPayload | AccountMembershipCannotBeDisabledRejection | AccountMembershipNotFoundRejection | ForbiddenRejection | InternalErrorRejection | LegalRepresentativeAccountMembershipCannotBeDisabledRejection | UserNotAllowedToDisableItsOwnAccountMembershipRejection | ValidationRejection

Possible types​

DisableAccountMembershipSuccessPayload object​

AccountMembershipCannotBeDisabledRejection object​

AccountMembershipNotFoundRejection object​

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

LegalRepresentativeAccountMembershipCannotBeDisabledRejection object​

UserNotAllowedToDisableItsOwnAccountMembershipRejection object​

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

disableAccountMembership mutation

- + \ No newline at end of file diff --git a/api-reference/unions/enable-received-direct-debit-mandate-payload/index.html b/api-reference/unions/enable-received-direct-debit-mandate-payload/index.html index c20394da1ef..f64f29feb18 100644 --- a/api-reference/unions/enable-received-direct-debit-mandate-payload/index.html +++ b/api-reference/unions/enable-received-direct-debit-mandate-payload/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

EnableReceivedDirectDebitMandatePayload

Union type return by the enableReceivedDirectDebitMandate mutation

union EnableReceivedDirectDebitMandatePayload = EnableReceivedDirectDebitMandateSuccessPayload | ReceivedDirectDebitMandateNotFoundRejection | ReceivedDirectDebitMandateCanceledRejection | ForbiddenRejection

Possible types​

EnableReceivedDirectDebitMandateSuccessPayload object​

Return type in case of a successful response of the enableReceivedDirectDebitMandate mutation

ReceivedDirectDebitMandateNotFoundRejection object​

Error returned if the received direct debit mandate was not found or if the user does not have the rights to receive information abo ut the existence of the received direct debit mandate

ReceivedDirectDebitMandateCanceledRejection object​

Received direct debit mandate is canceled and therefore can't be enabled/suspended or updated

ForbiddenRejection object​

Returned by​

enableReceivedDirectDebitMandate mutation

- + \ No newline at end of file diff --git a/api-reference/unions/finalize-onboarding-payload/index.html b/api-reference/unions/finalize-onboarding-payload/index.html index ae2c4a4be38..54513bdc265 100644 --- a/api-reference/unions/finalize-onboarding-payload/index.html +++ b/api-reference/unions/finalize-onboarding-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

FinalizeOnboardingPayload

No description

union FinalizeOnboardingPayload = FinalizeOnboardingSuccessPayload | InternalErrorRejection | ForbiddenRejection | OnboardingNotCompletedRejection | ValidationRejection

Possible types​

FinalizeOnboardingSuccessPayload object​

InternalErrorRejection object​

Rejection returned on unexpected server error

ForbiddenRejection object​

OnboardingNotCompletedRejection object​

Rejection returned if an onboarding is not completed

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

finalizeOnboarding mutation

- + \ No newline at end of file diff --git a/api-reference/unions/generate-capital-deposit-document-upload-url-payload/index.html b/api-reference/unions/generate-capital-deposit-document-upload-url-payload/index.html index 3328b3bfa09..43d07dfd019 100644 --- a/api-reference/unions/generate-capital-deposit-document-upload-url-payload/index.html +++ b/api-reference/unions/generate-capital-deposit-document-upload-url-payload/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

GenerateCapitalDepositDocumentUploadUrlPayload

No description

union GenerateCapitalDepositDocumentUploadUrlPayload = GenerateCapitalDepositDocumentUploadUrlSuccessPayload | CapitalDepositDocumentCanNotBeUploaded | CapitalDepositDocumentCanNotBeUploadedRejection | ForbiddenRejection | BadRequestRejection | InternalErrorRejection

Possible types​

GenerateCapitalDepositDocumentUploadUrlSuccessPayload object​

CapitalDepositDocumentCanNotBeUploaded object​

Rejection returned if the document from a capital deposit case cannot be uploaded in its context @deprecated(reason: "use CapitalDepositDocumentCanNotBeUploadedRejection instead")

CapitalDepositDocumentCanNotBeUploadedRejection object​

Rejection returned if the document from a capital deposit case cannot be uploaded in its context

ForbiddenRejection object​

BadRequestRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

Returned by​

generateCapitalDepositDocumentUploadUrl mutation

- + \ No newline at end of file diff --git a/api-reference/unions/generate-supporting-document-upload-url-payload/index.html b/api-reference/unions/generate-supporting-document-upload-url-payload/index.html index 8e2fa9b8ece..1c40b78f245 100644 --- a/api-reference/unions/generate-supporting-document-upload-url-payload/index.html +++ b/api-reference/unions/generate-supporting-document-upload-url-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

GenerateSupportingDocumentUploadUrlPayload

No description

union GenerateSupportingDocumentUploadUrlPayload = GenerateSupportingDocumentUploadUrlSuccessPayload | SupportingDocumentCollectionNotFoundRejection | ForbiddenRejection | InternalErrorRejection | SupportingDocumentUploadNotAllowedRejection | ValidationRejection

Possible types​

GenerateSupportingDocumentUploadUrlSuccessPayload object​

SupportingDocumentCollectionNotFoundRejection object​

Rejection returned if the supporting document collection was not found

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

SupportingDocumentUploadNotAllowedRejection object​

Rejection returned if the supporting document collection cannot receive supporting documents anymore

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

generateSupportingDocumentUploadUrl mutation

- + \ No newline at end of file diff --git a/api-reference/unions/grant-consent-with-server-signature-payload/index.html b/api-reference/unions/grant-consent-with-server-signature-payload/index.html index 954bb175281..2f47a6a16ce 100644 --- a/api-reference/unions/grant-consent-with-server-signature-payload/index.html +++ b/api-reference/unions/grant-consent-with-server-signature-payload/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

GrantConsentWithServerSignaturePayload

Payload of the grantConsentWithServerSignature mutation

union GrantConsentWithServerSignaturePayload = GrantConsentWithServerSignatureSuccessPayload | ConsentNotFoundRejection | NotReachableConsentStatusRejection | ForbiddenRejection | ConsentTypeNotSupportedByServerConsentRejection | ServerConsentNotAllowedForConsentOperationRejection | ProjectNotFoundRejection | ServerConsentNotAllowedForProjectRejection | ServerConsentProjectSettingsNotFoundRejection | ServerConsentProjectCredentialMissingRejection | ServerConsentProjectCredentialNotFoundRejection | ServerConsentCredentialsNotValidOrOutdatedRejection | ServerConsentSignatureNotValidRejection

Possible types​

GrantConsentWithServerSignatureSuccessPayload object​

Success payload of the grantConsentWithServerSignature mutation

ConsentNotFoundRejection object​

Rejection returned if a consent was not found

NotReachableConsentStatusRejection object​

Rejection returned when consent status couldn't change

ForbiddenRejection object​

ConsentTypeNotSupportedByServerConsentRejection object​

ServerConsentNotAllowedForConsentOperationRejection object​

Rejection returned when server consent is not allowed on the consent

ProjectNotFoundRejection object​

Rejection returned when the project is not found

ServerConsentNotAllowedForProjectRejection object​

Rejection returned when server consent is not allowed for the project associated with the consent

ServerConsentProjectSettingsNotFoundRejection object​

Rejection returned when the server consent project settings are not found

ServerConsentProjectCredentialMissingRejection object​

Rejection returned when there are no server consent credentials for the project

ServerConsentProjectCredentialNotFoundRejection object​

Rejection returned when the server consent project credentials are not found

ServerConsentCredentialsNotValidOrOutdatedRejection object​

Rejection returned when signature is not valid or remote IP address is not allowed

ServerConsentSignatureNotValidRejection object​

Rejection returned when the signature is not valid @Deprecated

Returned by​

grantConsentWithServerSignature mutation

- + \ No newline at end of file diff --git a/api-reference/unions/iban-validation-result/index.html b/api-reference/unions/iban-validation-result/index.html index d8dc9e6b1c0..cf33b478410 100644 --- a/api-reference/unions/iban-validation-result/index.html +++ b/api-reference/unions/iban-validation-result/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/identification-document/index.html b/api-reference/unions/identification-document/index.html index 22d0607ff12..2da25a285b2 100644 --- a/api-reference/unions/identification-document/index.html +++ b/api-reference/unions/identification-document/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

IdentificationDocument

Union representing all the possible identification document types

union IdentificationDocument = IdCardDocument | PassportDocument | ResidencePermitDocument | DriversLicenseDocument | FacePhotoDocument | ReportDocument

Possible types​

IdCardDocument object​

The document corresponding to an ID card

PassportDocument object​

The document corresponding to a passport

ResidencePermitDocument object​

The document corresponding to a residence permit

DriversLicenseDocument object​

The document corresponding to a driver's license

FacePhotoDocument object​

The document corresponding to a face photo

ReportDocument object​

The document corresponding to a identification report

Member of​

Identification object

- + \ No newline at end of file diff --git a/api-reference/unions/identification-level-status-info/index.html b/api-reference/unions/identification-level-status-info/index.html index c5a7fc6412f..85b6e09cdef 100644 --- a/api-reference/unions/identification-level-status-info/index.html +++ b/api-reference/unions/identification-level-status-info/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

IdentificationLevelStatusInfo

Union representing all the possible statuses: not supported, not started, pending, valid, invalid, cancelled, expired Each variant contains its relevant data, for example invalid contains a reason field, expired contains an expiredAt field, valid contains a documents field

union IdentificationLevelStatusInfo = NotSupportedIdentificationLevelStatusInfo | NotStartedIdentificationLevelStatusInfo | StartedIdentificationLevelStatusInfo | PendingIdentificationLevelStatusInfo | ValidIdentificationLevelStatusInfo | InvalidIdentificationLevelStatusInfo | CanceledIdentificationLevelStatusInfo | ExpiredIdentificationLevelStatusInfo

Possible types​

NotSupportedIdentificationLevelStatusInfo object​

Describes an identification level that's not supported for the process of the current identification

NotStartedIdentificationLevelStatusInfo object​

Describes an identification level that hasn't started for the process of the current identification

StartedIdentificationLevelStatusInfo object​

Describes an identification level that has started for the process of the current identification

PendingIdentificationLevelStatusInfo object​

Describes an identification level that is pending for the process of the current identification, requiring an operation not related to the end-user to progress

ValidIdentificationLevelStatusInfo object​

Describes a valid identification level for the process associated to this identification, and identification documents can be accessed

InvalidIdentificationLevelStatusInfo object​

Describes an invalid identification level for the process associated to this identification, and the invalid reason can be accessed

CanceledIdentificationLevelStatusInfo object​

Describes an identification level for the process associated to this identification that has been cancelled by the end-user

ExpiredIdentificationLevelStatusInfo object​

Describes an identification level for the process associated to this identification that has expired and is no longer considered valid

Member of​

IdentificationLevelStatusesInfo object

- + \ No newline at end of file diff --git a/api-reference/unions/initiate-credit-transfers-payload/index.html b/api-reference/unions/initiate-credit-transfers-payload/index.html index ff3b15bd4ca..fda9622d31c 100644 --- a/api-reference/unions/initiate-credit-transfers-payload/index.html +++ b/api-reference/unions/initiate-credit-transfers-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/initiate-funding-request-payload/index.html b/api-reference/unions/initiate-funding-request-payload/index.html index 6508a52c0f0..c76e6572acc 100644 --- a/api-reference/unions/initiate-funding-request-payload/index.html +++ b/api-reference/unions/initiate-funding-request-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InitiateFundingRequestPayload

Initiate A Funding Request Payload

union InitiateFundingRequestPayload = InitiateFundingRequestSuccessPayload | ForbiddenRejection | ValidationRejection | FundingLimitExceededRejection | ProjectFundingLimitExceededRejection | GlobalFundingLimitExceededRejection | FundingSourceWrongStatusRejection | FundingSourceNotFoundRejection | InsufficientFundsRejection | InstantFundingLimitExceededRejection | ProjectInstantFundingLimitExceededRejection | GlobalInstantFundingLimitExceededRejection | AccountVerificationWrongStatusRejection

Possible types​

InitiateFundingRequestSuccessPayload object​

Initiate A Funding Request Success Payload

ForbiddenRejection object​

ValidationRejection object​

Rejection returned if an input contains invalid data

FundingLimitExceededRejection object​

Rejection returned when the Account Holder Funding has been exceeded

ProjectFundingLimitExceededRejection object​

Rejection returned when the Project Funding has been exceeded

GlobalFundingLimitExceededRejection object​

Rejection returned when the Global Funding has been exceeded

FundingSourceWrongStatusRejection object​

Rejection returned when the Funding Source is not in the expected status

FundingSourceNotFoundRejection object​

InsufficientFundsRejection object​

Rejection returned when the Available balance is insufficient

InstantFundingLimitExceededRejection object​

Rejection returned when the Account Holder Instant Funding limit has been exceeded

ProjectInstantFundingLimitExceededRejection object​

Rejection returned when the Project Instant Funding limit has been exceeded

GlobalInstantFundingLimitExceededRejection object​

Rejection returned when the Global Instant Funding limit has been exceeded

AccountVerificationWrongStatusRejection object​

Rejection returned when the Account Verification is not in the expected status

Returned by​

initiateFundingRequest mutation

- + \ No newline at end of file diff --git a/api-reference/unions/initiate-international-credit-transfer-response-payload/index.html b/api-reference/unions/initiate-international-credit-transfer-response-payload/index.html index 517bf551aa2..e9b817fb89e 100644 --- a/api-reference/unions/initiate-international-credit-transfer-response-payload/index.html +++ b/api-reference/unions/initiate-international-credit-transfer-response-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InitiateInternationalCreditTransferResponsePayload

Initiate International Credit Transfer Response Payload

union InitiateInternationalCreditTransferResponsePayload = InitiateInternationalCreditTransferResponseSuccessPayload | AccountNotFoundRejection | ForbiddenRejection | InternalErrorRejection | ValidationRejection

Possible types​

InitiateInternationalCreditTransferResponseSuccessPayload object​

Initiate International Credit Transfer Response Success Payload

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

initiateInternationalCreditTransfer mutation

- + \ No newline at end of file diff --git a/api-reference/unions/initiate-merchant-payment-collection-payload/index.html b/api-reference/unions/initiate-merchant-payment-collection-payload/index.html index 3c038ce0bd5..a5a22e5499c 100644 --- a/api-reference/unions/initiate-merchant-payment-collection-payload/index.html +++ b/api-reference/unions/initiate-merchant-payment-collection-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

InitiateMerchantPaymentCollectionPayload

No description

union InitiateMerchantPaymentCollectionPayload = InitiateMerchantPaymentCollectionSuccessPayload | ForbiddenRejection | NotFoundRejection | InternalErrorRejection | ValidationRejection

Possible types​

InitiateMerchantPaymentCollectionSuccessPayload object​

ForbiddenRejection object​

NotFoundRejection object​

Rejection returned if the entity was not found or if the user does not have the rights to know that the account exists

InternalErrorRejection object​

Rejection returned on unexpected server error

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

initiateMerchantPaymentCollection mutation

- + \ No newline at end of file diff --git a/api-reference/unions/onboard-company-account-holder-payload/index.html b/api-reference/unions/onboard-company-account-holder-payload/index.html index 79513c9405c..19c0176c35e 100644 --- a/api-reference/unions/onboard-company-account-holder-payload/index.html +++ b/api-reference/unions/onboard-company-account-holder-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/onboard-individual-account-holder-payload/index.html b/api-reference/unions/onboard-individual-account-holder-payload/index.html index ab94f9ec2fd..8ed8e2a98de 100644 --- a/api-reference/unions/onboard-individual-account-holder-payload/index.html +++ b/api-reference/unions/onboard-individual-account-holder-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/print-physical-card-payload/index.html b/api-reference/unions/print-physical-card-payload/index.html index 3ce6d7c1fd1..e46bd9f59cf 100644 --- a/api-reference/unions/print-physical-card-payload/index.html +++ b/api-reference/unions/print-physical-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

PrintPhysicalCardPayload

No description

union PrintPhysicalCardPayload = PrintPhysicalCardSuccessPayload | AccountMembershipNotAllowedRejection | AlreadyValidPhysicalCardRejection | BadAccountStatusRejection | BadRequestRejection | CardNotFoundRejection | CardProductNotApplicableToPhysicalCardsRejection | CardProductDisabledRejection | MissingMandatoryFieldRejection | ValidationRejection

Possible types​

PrintPhysicalCardSuccessPayload object​

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

AlreadyValidPhysicalCardRejection object​

Rejection returned if card already has a valid Physical Card

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

BadRequestRejection object​

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

CardProductNotApplicableToPhysicalCardsRejection object​

Rejection returned if the card product is not applicable to physical card.

CardProductDisabledRejection object​

Rejection returned if the card product is disabled.

MissingMandatoryFieldRejection object​

Rejection returned when mandatory fields are missing from the call.

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

printPhysicalCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/refund-payload/index.html b/api-reference/unions/refund-payload/index.html index 687803ec020..19fb3b29877 100644 --- a/api-reference/unions/refund-payload/index.html +++ b/api-reference/unions/refund-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RefundPayload

The respond body to a refund mutation

union RefundPayload = RefundSuccessPayload | RefundRejection

Possible types​

RefundSuccessPayload object​

Consent generated by the refund mutation

RefundRejection object​

Rejection returned if the transaction status is not correct for the desired action

Returned by​

refund mutation

- + \ No newline at end of file diff --git a/api-reference/unions/request-merchant-payment-methods-payload/index.html b/api-reference/unions/request-merchant-payment-methods-payload/index.html index 6df9a9a3ae1..2f710f601bb 100644 --- a/api-reference/unions/request-merchant-payment-methods-payload/index.html +++ b/api-reference/unions/request-merchant-payment-methods-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RequestMerchantPaymentMethodsPayload

No description

union RequestMerchantPaymentMethodsPayload = RequestMerchantPaymentMethodsSuccessPayload | ForbiddenRejection | NotFoundRejection | InternalErrorRejection | ValidationRejection

Possible types​

RequestMerchantPaymentMethodsSuccessPayload object​

ForbiddenRejection object​

NotFoundRejection object​

Rejection returned if the entity was not found or if the user does not have the rights to know that the account exists

InternalErrorRejection object​

Rejection returned on unexpected server error

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

requestMerchantPaymentMethods mutation

- + \ No newline at end of file diff --git a/api-reference/unions/request-merchant-profile-update-payload/index.html b/api-reference/unions/request-merchant-profile-update-payload/index.html index 8942aae39d0..62216daed01 100644 --- a/api-reference/unions/request-merchant-profile-update-payload/index.html +++ b/api-reference/unions/request-merchant-profile-update-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RequestMerchantProfileUpdatePayload

Add Merchant Profile Payload

union RequestMerchantProfileUpdatePayload = RequestMerchantProfileUpdateSuccessPayload | ForbiddenRejection | AccountNotFoundRejection | InternalErrorRejection

Possible types​

RequestMerchantProfileUpdateSuccessPayload object​

Add Merchant Profile Success Payload

ForbiddenRejection object​

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

InternalErrorRejection object​

Rejection returned on unexpected server error

Returned by​

requestMerchantProfileUpdate mutation

- + \ No newline at end of file diff --git a/api-reference/unions/request-supporting-document-collection-review-payload/index.html b/api-reference/unions/request-supporting-document-collection-review-payload/index.html index 3f9fbb432e6..f94be329eb5 100644 --- a/api-reference/unions/request-supporting-document-collection-review-payload/index.html +++ b/api-reference/unions/request-supporting-document-collection-review-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

RequestSupportingDocumentCollectionReviewPayload

No description

union RequestSupportingDocumentCollectionReviewPayload = RequestSupportingDocumentCollectionReviewSuccessPayload | ForbiddenRejection | SupportingDocumentCollectionNotFoundRejection | SupportingDocumentCollectionStatusNotAllowedRejection | ValidationRejection

Possible types​

RequestSupportingDocumentCollectionReviewSuccessPayload object​

ForbiddenRejection object​

SupportingDocumentCollectionNotFoundRejection object​

Rejection returned if the supporting document collection was not found

SupportingDocumentCollectionStatusNotAllowedRejection object​

Rejection returned if the status transition is not allowed

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

requestSupportingDocumentCollectionReview mutation

- + \ No newline at end of file diff --git a/api-reference/unions/resume-account-membership-payload/index.html b/api-reference/unions/resume-account-membership-payload/index.html index 53e761c94ce..b296546fbb7 100644 --- a/api-reference/unions/resume-account-membership-payload/index.html +++ b/api-reference/unions/resume-account-membership-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ResumeAccountMembershipPayload

No description

union ResumeAccountMembershipPayload = ResumeAccountMembershipSuccessPayload | ForbiddenRejection | UserNotAllowedToManageAccountMembershipRejection | ValidationRejection

Possible types​

ResumeAccountMembershipSuccessPayload object​

ForbiddenRejection object​

UserNotAllowedToManageAccountMembershipRejection object​

Rejection returned if a identity does not have enough permission to manage account membership

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

resumeAccountMembership mutation

- + \ No newline at end of file diff --git a/api-reference/unions/resume-physical-card-payload/index.html b/api-reference/unions/resume-physical-card-payload/index.html index ef73c9a97dd..823e7ecb0ba 100644 --- a/api-reference/unions/resume-physical-card-payload/index.html +++ b/api-reference/unions/resume-physical-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ResumePhysicalCardPayload

No description

union ResumePhysicalCardPayload = ResumePhysicalCardSuccessPayload | ForbiddenRejection | CardNotFoundRejection | UserNotCardHolderRejection | PhysicalCardNotFoundRejection | PhysicalCardWrongStatusRejection | ValidationRejection

Possible types​

ResumePhysicalCardSuccessPayload object​

ForbiddenRejection object​

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

UserNotCardHolderRejection object​

Rejection returned when the User is not the Card Holder

PhysicalCardNotFoundRejection object​

Rejection returned when the Physical Card does not exist

PhysicalCardWrongStatusRejection object​

Rejection returned when the Physical Card is not the expected status

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

resumePhysicalCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/schedule-standing-order-payload/index.html b/api-reference/unions/schedule-standing-order-payload/index.html index f51991bf982..37849b2fd13 100644 --- a/api-reference/unions/schedule-standing-order-payload/index.html +++ b/api-reference/unions/schedule-standing-order-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ScheduleStandingOrderPayload

No description

union ScheduleStandingOrderPayload = ScheduleStandingOrderSuccessPayload | ForbiddenRejection | InternalErrorRejection | InvalidArgumentRejection

Possible types​

ScheduleStandingOrderSuccessPayload object​

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

InvalidArgumentRejection object​

Rejection returned on invalid argument error

Returned by​

scheduleStandingOrder mutation

- + \ No newline at end of file diff --git a/api-reference/unions/shareholder-info/index.html b/api-reference/unions/shareholder-info/index.html index 1b9aa53960b..90cd09f1a8c 100644 --- a/api-reference/unions/shareholder-info/index.html +++ b/api-reference/unions/shareholder-info/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/suspend-account-membership-payload/index.html b/api-reference/unions/suspend-account-membership-payload/index.html index 4cccec5890c..63595d43b0c 100644 --- a/api-reference/unions/suspend-account-membership-payload/index.html +++ b/api-reference/unions/suspend-account-membership-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SuspendAccountMembershipPayload

No description

union SuspendAccountMembershipPayload = SuspendAccountMembershipSuccessPayload | InternalErrorRejection | LegalRepresentativeAccountMembershipCannotBeSuspendedRejection | UserNotAllowedToManageAccountMembershipRejection | UserNotAllowedToSuspendItsOwnAccountMembershipRejection | ValidationRejection

Possible types​

SuspendAccountMembershipSuccessPayload object​

InternalErrorRejection object​

Rejection returned on unexpected server error

LegalRepresentativeAccountMembershipCannotBeSuspendedRejection object​

UserNotAllowedToManageAccountMembershipRejection object​

Rejection returned if a identity does not have enough permission to manage account membership

UserNotAllowedToSuspendItsOwnAccountMembershipRejection object​

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

suspendAccountMembership mutation

- + \ No newline at end of file diff --git a/api-reference/unions/suspend-account-status-reason/index.html b/api-reference/unions/suspend-account-status-reason/index.html index 8b7adfef51a..348e3154b5d 100644 --- a/api-reference/unions/suspend-account-status-reason/index.html +++ b/api-reference/unions/suspend-account-status-reason/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/suspend-physical-card-payload/index.html b/api-reference/unions/suspend-physical-card-payload/index.html index c2ebac0367a..aef90af3980 100644 --- a/api-reference/unions/suspend-physical-card-payload/index.html +++ b/api-reference/unions/suspend-physical-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

SuspendPhysicalCardPayload

No description

union SuspendPhysicalCardPayload = SuspendPhysicalCardSuccessPayload | AccountMembershipNotAllowedRejection | CardNotFoundRejection | ForbiddenRejection | PhysicalCardNotFoundRejection | ValidationRejection

Possible types​

SuspendPhysicalCardSuccessPayload object​

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

ForbiddenRejection object​

PhysicalCardNotFoundRejection object​

Rejection returned when the Physical Card does not exist

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

suspendPhysicalCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/suspend-received-direct-debit-mandate-payload/index.html b/api-reference/unions/suspend-received-direct-debit-mandate-payload/index.html index 78340277b0d..4ceb9a70ffd 100644 --- a/api-reference/unions/suspend-received-direct-debit-mandate-payload/index.html +++ b/api-reference/unions/suspend-received-direct-debit-mandate-payload/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

SuspendReceivedDirectDebitMandatePayload

Union type returned by the suspendReceivedDirectDebitMandate mutation

union SuspendReceivedDirectDebitMandatePayload = SuspendReceivedDirectDebitMandateSuccessPayload | SuspendReceivedDirectDebitMandatedRejection | ReceivedDirectDebitMandateNotFoundRejection | ReceivedDirectDebitMandateCanceledRejection | ForbiddenRejection

Possible types​

SuspendReceivedDirectDebitMandateSuccessPayload object​

Return type in case of a successful response of the suspendReceivedDirectDebitMandate mutation

SuspendReceivedDirectDebitMandatedRejection object​

Rejection returned if the SuspendReceivedDirectDebitMandatedRejection mutation is rejected

ReceivedDirectDebitMandateNotFoundRejection object​

Error returned if the received direct debit mandate was not found or if the user does not have the rights to receive information abo ut the existence of the received direct debit mandate

ReceivedDirectDebitMandateCanceledRejection object​

Received direct debit mandate is canceled and therefore can't be enabled/suspended or updated

ForbiddenRejection object​

Returned by​

suspendReceivedDirectDebitMandate mutation

- + \ No newline at end of file diff --git a/api-reference/unions/update-account-holder-payload/index.html b/api-reference/unions/update-account-holder-payload/index.html index ad56f4b1af7..286614d2a8e 100644 --- a/api-reference/unions/update-account-holder-payload/index.html +++ b/api-reference/unions/update-account-holder-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/update-account-membership-payload/index.html b/api-reference/unions/update-account-membership-payload/index.html index 9f5c8578d09..738e3980386 100644 --- a/api-reference/unions/update-account-membership-payload/index.html +++ b/api-reference/unions/update-account-membership-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateAccountMembershipPayload

No description

union UpdateAccountMembershipPayload = UpdateAccountMembershipSuccessPayload | AccountMembershipCannotBeUpdatedRejection | AccountMembershipNotFoundRejection | ForbiddenRejection | InvalidPhoneNumberRejection | PermissionCannotBeGrantedRejection | UserNotAllowedToManageAccountMembershipRejection | ValidationRejection

Possible types​

UpdateAccountMembershipSuccessPayload object​

AccountMembershipCannotBeUpdatedRejection object​

AccountMembershipNotFoundRejection object​

ForbiddenRejection object​

InvalidPhoneNumberRejection object​

Rejection returned if phone number is not well formatted

PermissionCannotBeGrantedRejection object​

UserNotAllowedToManageAccountMembershipRejection object​

Rejection returned if a identity does not have enough permission to manage account membership

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

updateAccountMembership mutation

- + \ No newline at end of file diff --git a/api-reference/unions/update-account-payload/index.html b/api-reference/unions/update-account-payload/index.html index 6040a4b3c58..209dee1f015 100644 --- a/api-reference/unions/update-account-payload/index.html +++ b/api-reference/unions/update-account-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateAccountPayload

No description

union UpdateAccountPayload = UpdateAccountSuccessPayload | AccountNotFoundRejection | BadAccountStatusRejection | ForbiddenRejection | InternalErrorRejection | ValidationRejection

Possible types​

UpdateAccountSuccessPayload object​

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

BadAccountStatusRejection object​

Rejection returned if the status account is not valid

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

updateAccount mutation

- + \ No newline at end of file diff --git a/api-reference/unions/update-card-payload/index.html b/api-reference/unions/update-card-payload/index.html index 44c4ca61c27..30607fb1751 100644 --- a/api-reference/unions/update-card-payload/index.html +++ b/api-reference/unions/update-card-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateCardPayload

No description

union UpdateCardPayload = UpdateCardSuccessPayload | AccountNotFoundRejection | CardNotFoundRejection | AccountMembershipNotAllowedRejection | ValidationRejection

Possible types​

UpdateCardSuccessPayload object​

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

AccountMembershipNotAllowedRejection object​

Rejection returned when the Account Membership is not allowed to use an operation.

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

updateCard mutation

- + \ No newline at end of file diff --git a/api-reference/unions/update-company-onboarding-payload/index.html b/api-reference/unions/update-company-onboarding-payload/index.html index bd95a846f51..812fab5996a 100644 --- a/api-reference/unions/update-company-onboarding-payload/index.html +++ b/api-reference/unions/update-company-onboarding-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateCompanyOnboardingPayload

Possible results for mutation updateCompanyOnboarding

union UpdateCompanyOnboardingPayload = ForbiddenRejection | InternalErrorRejection | UpdateCompanyOnboardingSuccessPayload | ValidationRejection

Possible types​

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

UpdateCompanyOnboardingSuccessPayload object​

Result when updateCompanyOnboarding is a success

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

updateCompanyOnboarding mutation

- + \ No newline at end of file diff --git a/api-reference/unions/update-individual-onboarding-payload/index.html b/api-reference/unions/update-individual-onboarding-payload/index.html index 645b0868ffe..02c005faae0 100644 --- a/api-reference/unions/update-individual-onboarding-payload/index.html +++ b/api-reference/unions/update-individual-onboarding-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateIndividualOnboardingPayload

Possible result types for updateIndividualOnboarding

union UpdateIndividualOnboardingPayload = ForbiddenRejection | InternalErrorRejection | UpdateIndividualOnboardingSuccessPayload | ValidationRejection

Possible types​

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

UpdateIndividualOnboardingSuccessPayload object​

Type of result when updateIndividualOnboarding is a success

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

updateIndividualOnboarding mutation

- + \ No newline at end of file diff --git a/api-reference/unions/update-received-sepa-direct-debit-b2-b-mandate-payload/index.html b/api-reference/unions/update-received-sepa-direct-debit-b2-b-mandate-payload/index.html index 140f4ed0e21..f90147432e5 100644 --- a/api-reference/unions/update-received-sepa-direct-debit-b2-b-mandate-payload/index.html +++ b/api-reference/unions/update-received-sepa-direct-debit-b2-b-mandate-payload/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

UpdateReceivedSepaDirectDebitB2bMandatePayload

Union type returned by the updateReceivedSepaDirectDebitB2bMandate mutation

union UpdateReceivedSepaDirectDebitB2bMandatePayload = UpdateReceivedSepaDirectDebitB2bMandateSuccessPayload | ReceivedDirectDebitMandateNotFoundRejection | ForbiddenRejection | ReceivedDirectDebitMandateAlreadyExistRejection | ReceivedDirectDebitMandateNotB2bRejection | AccountNotFoundRejection

Possible types​

UpdateReceivedSepaDirectDebitB2bMandateSuccessPayload object​

Return type in case of a successful response of the updateReceivedSepaDirectDebitB2bMandate mutation

ReceivedDirectDebitMandateNotFoundRejection object​

Error returned if the received direct debit mandate was not found or if the user does not have the rights to receive information abo ut the existence of the received direct debit mandate

ForbiddenRejection object​

ReceivedDirectDebitMandateAlreadyExistRejection object​

Rejection returned if the received direct debit mandate already exist

ReceivedDirectDebitMandateNotB2bRejection object​

Rejection returned if the received direct debit mandate is not a B2b mandate

AccountNotFoundRejection object​

Rejection returned if the account was not found or if the user does not have the rights to know that the card exists

Returned by​

updateReceivedSepaDirectDebitB2bMandate mutation

- + \ No newline at end of file diff --git a/api-reference/unions/update-supporting-document-payload/index.html b/api-reference/unions/update-supporting-document-payload/index.html index cd04d6cfad7..d2d652f1712 100644 --- a/api-reference/unions/update-supporting-document-payload/index.html +++ b/api-reference/unions/update-supporting-document-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

UpdateSupportingDocumentPayload

No description

union UpdateSupportingDocumentPayload = UpdateSupportingDocumentSuccessPayload | ForbiddenRejection | InternalErrorRejection | SupportingDocumentCollectionNotFoundRejection | SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection | SupportingDocumentNotFoundRejection | SupportingDocumentStatusDoesNotAllowUpdateRejection | ValidationRejection

Possible types​

UpdateSupportingDocumentSuccessPayload object​

ForbiddenRejection object​

InternalErrorRejection object​

Rejection returned on unexpected server error

SupportingDocumentCollectionNotFoundRejection object​

Rejection returned if the supporting document collection was not found

SupportingDocumentCollectionStatusDoesNotAllowUpdateRejection object​

Rejection returned if supporting document cannot be updated because its supporting document collection status is not WaitingForDocument

SupportingDocumentNotFoundRejection object​

Rejection returned if the supporting document was not found

SupportingDocumentStatusDoesNotAllowUpdateRejection object​

Rejection returned if supporting document cannot be updated because of its status

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

updateSupportingDocument mutation

- + \ No newline at end of file diff --git a/api-reference/unions/update-user-consent-settings-payload/index.html b/api-reference/unions/update-user-consent-settings-payload/index.html index a8ef2b38166..40d4544eef7 100644 --- a/api-reference/unions/update-user-consent-settings-payload/index.html +++ b/api-reference/unions/update-user-consent-settings-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api-reference/unions/view-card-numbers-payload/index.html b/api-reference/unions/view-card-numbers-payload/index.html index e06937d71c3..d92efdaa8f8 100644 --- a/api-reference/unions/view-card-numbers-payload/index.html +++ b/api-reference/unions/view-card-numbers-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ViewCardNumbersPayload

No description

union ViewCardNumbersPayload = ViewCardNumbersSuccessPayload | UserNotCardHolderRejection | CardNotFoundRejection | ValidationRejection

Possible types​

ViewCardNumbersSuccessPayload object​

UserNotCardHolderRejection object​

Rejection returned when the User is not the Card Holder

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

viewCardNumbers mutation

- + \ No newline at end of file diff --git a/api-reference/unions/view-physical-card-numbers-payload/index.html b/api-reference/unions/view-physical-card-numbers-payload/index.html index 177ec215a82..62478770a56 100644 --- a/api-reference/unions/view-physical-card-numbers-payload/index.html +++ b/api-reference/unions/view-physical-card-numbers-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ViewPhysicalCardNumbersPayload

No description

union ViewPhysicalCardNumbersPayload = ViewPhysicalCardNumbersSuccessPayload | UserNotCardHolderRejection | CardNotFoundRejection | ValidationRejection

Possible types​

ViewPhysicalCardNumbersSuccessPayload object​

UserNotCardHolderRejection object​

Rejection returned when the User is not the Card Holder

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

viewPhysicalCardNumbers mutation

- + \ No newline at end of file diff --git a/api-reference/unions/view-physical-card-pin-payload/index.html b/api-reference/unions/view-physical-card-pin-payload/index.html index 797261418ef..7cd8a0b413f 100644 --- a/api-reference/unions/view-physical-card-pin-payload/index.html +++ b/api-reference/unions/view-physical-card-pin-payload/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

ViewPhysicalCardPinPayload

No description

union ViewPhysicalCardPinPayload = ViewPhysicalCardPinSuccessPayload | CardNotFoundRejection | PhysicalCardNotFoundRejection | PINNotReadyRejection | UserNotCardHolderRejection | ValidationRejection

Possible types​

ViewPhysicalCardPinSuccessPayload object​

CardNotFoundRejection object​

Rejection returned if the card was not found or if the user does not have the rights to know that the account exists

PhysicalCardNotFoundRejection object​

Rejection returned when the Physical Card does not exist

PINNotReadyRejection object​

UserNotCardHolderRejection object​

Rejection returned when the User is not the Card Holder

ValidationRejection object​

Rejection returned if an input contains invalid data

Returned by​

viewPhysicalCardPin mutation

- + \ No newline at end of file diff --git a/assets/js/52a00ac0.287a32a3.js b/assets/js/52a00ac0.e0c01c31.js similarity index 98% rename from assets/js/52a00ac0.287a32a3.js rename to assets/js/52a00ac0.e0c01c31.js index 23be1a73d66..c8666596d57 100644 --- a/assets/js/52a00ac0.287a32a3.js +++ b/assets/js/52a00ac0.e0c01c31.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_swan_io_docs=self.webpackChunk_swan_io_docs||[]).push([[11353],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),u=s(n),f=a,d=u["".concat(l,".").concat(f)]||u[f]||m[f]||o;return n?r.createElement(d,i(i({ref:t},p),{},{components:n})):r.createElement(d,i({ref:t},p))}));function d(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c[u]="string"==typeof e?e:a,i[1]=c;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>c,toc:()=>s});var r=n(83117),a=(n(67294),n(3905));const o={id:"schema",slug:"/api-reference",title:"Schema Documentation",sidebar_position:1,hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,sidebar_class_name:"navbar__toggle"},i=void 0,c={unversionedId:"api-reference/schema",id:"api-reference/schema",title:"Schema Documentation",description:"This documentation has been automatically generated from the GraphQL schema.",source:"@site/docs/api-reference/generated.md",sourceDirName:"api-reference",slug:"/api-reference",permalink:"/api-reference",draft:!1,editUrl:"https://github.com/swan-io/docs/edit/main/docs/docs/api-reference/generated.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"schema",slug:"/api-reference",title:"Schema Documentation",sidebar_position:1,hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,sidebar_class_name:"navbar__toggle"}},l={},s=[],p={toc:s},u="wrapper";function m(e){let{components:t,...n}=e;return(0,a.kt)(u,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"This documentation has been automatically generated from the GraphQL schema."),(0,a.kt)("p",null,"Use the docs in the sidebar to find out how to use the schema:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Allowed operations"),": queries and mutations."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Schema-defined types"),": scalars, objects, enums, interfaces, unions, and input objects.")),(0,a.kt)("small",null,(0,a.kt)("i",null,"Generated on 12/5/2023, 12:17:51 AM.")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunk_swan_io_docs=self.webpackChunk_swan_io_docs||[]).push([[11353],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>d});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),s=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),u=s(n),f=a,d=u["".concat(l,".").concat(f)]||u[f]||m[f]||o;return n?r.createElement(d,i(i({ref:t},p),{},{components:n})):r.createElement(d,i({ref:t},p))}));function d(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c[u]="string"==typeof e?e:a,i[1]=c;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>c,toc:()=>s});var r=n(83117),a=(n(67294),n(3905));const o={id:"schema",slug:"/api-reference",title:"Schema Documentation",sidebar_position:1,hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,sidebar_class_name:"navbar__toggle"},i=void 0,c={unversionedId:"api-reference/schema",id:"api-reference/schema",title:"Schema Documentation",description:"This documentation has been automatically generated from the GraphQL schema.",source:"@site/docs/api-reference/generated.md",sourceDirName:"api-reference",slug:"/api-reference",permalink:"/api-reference",draft:!1,editUrl:"https://github.com/swan-io/docs/edit/main/docs/docs/api-reference/generated.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"schema",slug:"/api-reference",title:"Schema Documentation",sidebar_position:1,hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,sidebar_class_name:"navbar__toggle"}},l={},s=[],p={toc:s},u="wrapper";function m(e){let{components:t,...n}=e;return(0,a.kt)(u,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"This documentation has been automatically generated from the GraphQL schema."),(0,a.kt)("p",null,"Use the docs in the sidebar to find out how to use the schema:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Allowed operations"),": queries and mutations."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("strong",{parentName:"li"},"Schema-defined types"),": scalars, objects, enums, interfaces, unions, and input objects.")),(0,a.kt)("small",null,(0,a.kt)("i",null,"Generated on 12/6/2023, 12:18:01 AM.")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.dc214df1.js b/assets/js/runtime~main.ed093517.js similarity index 99% rename from assets/js/runtime~main.dc214df1.js rename to assets/js/runtime~main.ed093517.js index 9390a0c9d02..ed0aeee5fb1 100644 --- a/assets/js/runtime~main.dc214df1.js +++ b/assets/js/runtime~main.ed093517.js @@ -1 +1 @@ -(()=>{"use strict";var c,e,b,a,f,d={},t={};function r(c){var e=t[c];if(void 0!==e)return e.exports;var b=t[c]={id:c,loaded:!1,exports:{}};return d[c].call(b.exports,b,b.exports,r),b.loaded=!0,b.exports}r.m=d,r.c=t,c=[],r.O=(e,b,a,f)=>{if(!b){var d=1/0;for(i=0;i=f)&&Object.keys(r.O).every((c=>r.O[c](b[o])))?b.splice(o--,1):(t=!1,f0&&c[i-1][2]>f;i--)c[i]=c[i-1];c[i]=[b,a,f]},r.n=c=>{var e=c&&c.__esModule?()=>c.default:()=>c;return r.d(e,{a:e}),e},b=Object.getPrototypeOf?c=>Object.getPrototypeOf(c):c=>c.__proto__,r.t=function(c,a){if(1&a&&(c=this(c)),8&a)return c;if("object"==typeof c&&c){if(4&a&&c.__esModule)return c;if(16&a&&"function"==typeof c.then)return c}var f=Object.create(null);r.r(f);var d={};e=e||[null,b({}),b([]),b(b)];for(var t=2&a&&c;"object"==typeof t&&!~e.indexOf(t);t=b(t))Object.getOwnPropertyNames(t).forEach((e=>d[e]=()=>c[e]));return d.default=()=>c,r.d(f,d),f},r.d=(c,e)=>{for(var b in e)r.o(e,b)&&!r.o(c,b)&&Object.defineProperty(c,b,{enumerable:!0,get:e[b]})},r.f={},r.e=c=>Promise.all(Object.keys(r.f).reduce(((e,b)=>(r.f[b](c,e),e)),[])),r.u=c=>"assets/js/"+({26:"3b1e8a04",188:"906be0f5",197:"537e891e",226:"ea98434a",338:"086f8d41",383:"7e4776c6",464:"7e418921",525:"0e645450",551:"b2c78190",563:"5d026d5b",598:"6ad82f9f",618:"c4a78fec",624:"99f09de0",819:"57afb12e",893:"cc624da4",1002:"13c60c15",1296:"46ea937d",1440:"4003e254",1554:"a13e61a2",1569:"97bdb81e",1725:"24abe6c9",1776:"0726a80a",1792:"1cf8363a",1969:"56cdcb55",1978:"95036120",2020:"f5fed7b4",2139:"1f2cae39",2203:"f180e4fd",2379:"aeec9328",2624:"083b5ee8",2641:"97cecdc7",2843:"aebc2649",2864:"1eaf0a35",2865:"d0afdb2d",2867:"f0009b6d",2933:"da0b5971",2972:"06598b01",2987:"3aacd70e",3046:"73eb95b3",3047:"39bec462",3291:"127d0327",3459:"933633e8",3600:"c5d1a363",3635:"22a8b3e5",3787:"61eb9ea3",4074:"98e30f2f",4121:"50c72a68",4202:"261a3c4c",4209:"5404c6be",4222:"47295864",4261:"db7e6e07",4277:"1d792ce4",4389:"0dadcc1e",4420:"6d4bff2e",4487:"d6eb8501",4488:"45c3a72d",4566:"e21395a6",4624:"37289545",4696:"2d92d3d5",4754:"4e5e925f",4801:"cf577441",4884:"9cc83235",4903:"9b1e992b",5007:"f991dec4",5028:"964e7fd1",5263:"cca24708",5375:"9d6f8c56",5405:"fd528e1c",5584:"b612009c",5600:"c883a7d2",5603:"15f51de4",5647:"685e914e",5728:"4f0ea51f",5810:"21124f8f",5826:"6ce587a7",6051:"8dc06929",6202:"6b962ab1",6267:"ba3d63bb",6584:"ff7950bf",6604:"dd8a41d8",6753:"1d4593ba",6801:"2b931e2a",6950:"82d44727",7059:"25c39f22",7096:"a3fb4be0",7173:"8850d7c4",7207:"7f6f7401",7285:"d42050ab",7314:"6119656b",7442:"23095ca6",7560:"fa7407c8",7685:"11f9c043",7755:"9c17e59b",7890:"dc1c2387",7956:"65aea855",8196:"065500c2",8489:"d6be9dd8",8557:"61358661",8619:"d785bf34",8707:"ea02488d",8719:"c0ae11fb",8757:"95a967db",8839:"e9b66c06",8850:"314c70b6",8884:"8ecee473",9060:"c3c45dd1",9126:"231e519f",9337:"d125fffa",9595:"bc3592ca",9624:"3dc458f1",9630:"a61a29c6",9643:"5a7373d1",9714:"6f89da90",9720:"f59a48f5",9730:"a03b08dd",9773:"6d9cd1c7",10230:"8f507c52",10278:"6c071a02",10388:"c97ea729",10483:"c4cd5cb0",10638:"e799bcae",10727:"a0089c72",10770:"a8cae02b",10800:"099be5df",10814:"62ad48cd",10882:"83f52709",10908:"c22afb16",10963:"d5ccaf8c",10973:"26b44581",11074:"a32c2e8f",11145:"a403b8e5",11153:"63fc0890",11224:"0984c047",11303:"b6981fe2",11353:"52a00ac0",11475:"9f135918",11544:"108d6373",11647:"a19c031b",11651:"efa62701",11664:"51b8fc83",11796:"f52c0eca",12067:"8a7333e7",12127:"d647beeb",12291:"44f979a3",12454:"9bc0fec8",12567:"6239da7f",12653:"ba291cc5",12658:"34a4c1ef",12707:"0a9480b9",12723:"bbad6248",12743:"4fb704a5",12760:"1f6e0f09",13511:"c48e9267",13592:"af5ff4a8",13629:"680a02ad",13650:"4ae49aac",14025:"85a71def",14050:"2bd866c9",14061:"32b53397",14167:"4c3162b5",14733:"cdd15c63",14840:"7aacce42",14842:"c3f4f527",14914:"cc3efc88",15013:"885af34c",15052:"847878ab",15180:"52e0ffdd",15283:"1861b089",15295:"1b5a6a39",15299:"2314758f",15378:"b30e2096",15579:"ad09e4f2",15592:"81fcdb1a",15707:"5303177b",15778:"67a4571f",15913:"e254b817",15971:"d1eaeaed",16077:"09bc9840",16317:"9c9cb554",16370:"f87dd7c3",16579:"d4ebab5c",16633:"8bdfcaf4",16672:"7a283c56",16756:"5d71ce26",16759:"6c105199",16762:"c79960d7",16774:"0ddd1b1b",16872:"8cb31f65",16901:"e2ab92e6",17054:"abb82bb2",17134:"f4d6c510",17155:"10a1121f",17177:"e2294cb2",17347:"288ff6dd",17421:"a0ffd745",17704:"a5251a71",17709:"40c0f930",17797:"916e7802",17951:"c8dcf605",18015:"5ac43825",18034:"9951ca2b",18208:"988fba77",18213:"ada2d469",18335:"56b21ce1",18443:"25c0dc6d",18514:"9af30fc0",18530:"a8272bf5",18545:"3027b40c",18563:"c59dc8af",18598:"8015a322",18681:"9e41ed88",18757:"1e436d1a",18803:"b807fc4f",18943:"a7d26b7e",18989:"6162d70a",18990:"e31d0546",18991:"45dc364c",19037:"1e9fbabd",19070:"963b198d",19088:"0d899299",19165:"2acac63a",19283:"049b698e",19334:"2c8652ef",19394:"2d013051",19517:"6a4c1420",19561:"baa6e992",19621:"a7cbd17c",19682:"c18b3dd3",19726:"0e555118",19981:"fa05e9a5",20057:"0a89b070",20078:"2a99c066",20092:"839ba15c",20372:"39d45e0f",20477:"6c80d7a1",20504:"6f1a1ca8",20534:"b77877a9",20535:"3e43a2b2",20592:"a5f653a7",20623:"17187cda",20656:"b2e3041d",20662:"b4defd80",20773:"7e044534",20930:"bd79b770",20969:"a6798804",21052:"37eacde6",21064:"df994e82",21092:"10d6e584",21117:"48867f70",21130:"fab27b4b",21141:"8ab7b0cd",21252:"94c15580",21290:"889bb296",21322:"e397a29c",21414:"f35c768e",21461:"a30ec1ba",21502:"797a29cf",21524:"d5bd3fe5",21661:"df4f48df",21748:"2d934cf3",21830:"1df635da",21911:"8157c2dd",21921:"e4bec3b4",21964:"e6bb218f",22010:"ccb7b808",22022:"f27f83f6",22294:"f823c609",22341:"717eed18",22495:"d252dd99",22638:"5011814c",22645:"7cbcba93",22852:"6a1fc806",22963:"7390d34f",22992:"7639e195",23022:"4e1c7b49",23054:"225e92a1",23128:"370ba5bb",23221:"0b34dda5",23327:"effbb39b",23418:"60c8650b",23442:"79dba252",23474:"3dae3655",23577:"801281af",23613:"9a5fc07a",23637:"bc521218",23737:"4b910cd9",23778:"0c5a975b",23798:"6b67672f",24079:"69c976eb",24082:"1dccb938",24083:"d452ad1f",24132:"864a1832",24369:"5e7874ef",24475:"cec929a1",24506:"5ab9c5bb",24564:"51e24d73",24617:"1d4a58b2",24722:"d521ca07",24748:"a1694c7f",24753:"be177392",24758:"d816822b",24881:"b472f62c",24884:"68d59462",24938:"8da44a2f",25056:"969f08fc",25118:"75cd7400",25197:"9f8006c1",25264:"12f84441",25290:"2c65fa8f",25332:"7f277d92",25398:"425e8d85",25453:"acf6d009",25562:"a14955b7",25588:"0abe0fe0",25781:"4343afaa",25942:"2b4f8af7",26094:"e38dcdaf",26101:"9a42e497",26282:"c2aa9606",26354:"267cf944",26381:"116e6c65",26698:"36eb0943",26871:"9d4344f6",26971:"e17a71f3",27006:"4356cfc6",27146:"033b8e71",27262:"f84941ff",27309:"e9f7d2c3",27363:"adb2bd7f",27501:"d5dc8cd0",27534:"23065245",27663:"e4eca706",27678:"761392cf",27850:"64b0b10e",27918:"17896441",28100:"9905859b",28290:"20126dcc",28407:"b22c8d77",28432:"872b574f",28505:"0839c2f2",28644:"c20f32fe",28678:"a37b42b8",28926:"65439e23",28970:"52c5d90f",29025:"292e8373",29043:"f6b07c9c",29242:"2272e4a0",29333:"506b7af1",29336:"f7448900",29473:"5fdd6e70",29497:"95f798c9",29514:"1be78505",29627:"935b2aef",29650:"6c8b5710",29654:"4ec98ed4",29685:"05747eec",29698:"38e0aa1b",29728:"6a6856d7",29751:"aa49738c",29899:"fc9c7bcb",29998:"e398b309",30010:"a14bba07",30058:"d7fd2129",30089:"a1720262",30115:"4b49353c",30147:"5c56d4eb",30326:"317022e7",30572:"92a099f2",30735:"2618151e",30801:"e2bb2cb5",31029:"1931bcc3",31074:"8a0d38f2",31189:"23bab739",31474:"0a67da07",31500:"bdd2828a",31636:"95fc7c58",31752:"4129c5c1",31885:"e53b72e5",31895:"39251080",31907:"3f2d9761",32028:"43ec88e9",32066:"54ac0390",32067:"8ddac3e7",32069:"f4664bca",32211:"71bd3347",32310:"890ce2a7",32408:"a68e5d78",32417:"4b1cfb23",32747:"c587f49b",32800:"fe68b5e4",32845:"c65e1a11",32900:"05619c3b",33005:"f78aacb3",33031:"090ef090",33035:"bdd9896c",33036:"b180c4b3",33064:"1931fdd9",33107:"db09fed0",33124:"4139b91a",33229:"f5008ea7",33273:"6b3ff6cc",33296:"aeaf9c67",33308:"b4d7d4ad",33392:"fa784e22",33617:"3704b249",33892:"ecc7bc3e",33898:"4bfd2db8",34071:"1aa8ceda",34173:"4edc808e",34204:"815a3dac",34236:"520f27a2",34288:"e8fc3664",34298:"b6c80156",34522:"565c7e7a",34548:"014fea84",34579:"ecb406fd",34607:"e8f88bc2",34641:"92cbc932",34698:"f9761c5e",34736:"d54c413d",34864:"f7c61839",34960:"9c9f4b72",34991:"9a2c7022",35022:"310d826d",35101:"00c5a843",35133:"7c9ab105",35377:"6b418b9d",35630:"ce85cb6e",35679:"1e8bd5b0",35708:"b967ba9e",35730:"b3d49b53",35775:"b167da58",35874:"96dae183",35978:"1370613c",35994:"9b399d10",36050:"2a9cb50e",36052:"a3657298",36125:"88cfda8b",36161:"401f64d8",36282:"3c881dfe",36299:"cfa4d47c",36344:"b182ba5a",36364:"29beb3fc",36389:"13f01a8a",36420:"d0b8f6f2",36516:"531d36a8",36557:"37f62d04",36569:"f2936bbd",36712:"e41b2273",36776:"be3a27c1",36797:"dc535e8b",36840:"a0e83a2e",37366:"e8f1b8cc",37419:"e3090d6c",37501:"57a52ec7",37581:"ec80f0f8",37644:"89a0769b",37775:"8fa063df",37897:"0222bab5",38073:"7dc96604",38266:"43fc11eb",38310:"b9099eab",38369:"6355eb0e",38468:"c2c9f624",38491:"b6ca6818",38537:"e9754802",38574:"f2cad8f8",38626:"c8867ead",38696:"137c07e2",38786:"9a86d8cc",38793:"34c58755",38908:"01a29863",39013:"c6756e66",39160:"952b6790",39182:"6a9ba154",39242:"d913284c",39260:"511dcd27",39515:"c64a672c",39586:"bd3a40d0",39607:"bc0dc214",39610:"64882008",39619:"e12a3758",39805:"2da5c4d8",39821:"553ac137",39894:"0eb675f4",39955:"e50f849d",39961:"75933c16",39978:"4bac9b1f",40049:"a3bb5839",40060:"c1e74a4c",40086:"9a89681b",40323:"bfc68003",40333:"16eb2325",40350:"8de80b01",40358:"75bfabaf",40543:"bb87ec56",40905:"0f6f90b2",41085:"18612f1d",41096:"bbeccb15",41103:"228df3ee",41104:"354a9724",41217:"4e658f9f",41335:"80159696",41348:"990c7218",41403:"3a50ac54",41408:"564774e4",41409:"34a00c10",41444:"1cecf61d",41476:"f5341953",41653:"4c412ed3",41735:"a6c97d01",41736:"88bdac60",41772:"0b34e84c",41832:"9625e3cf",41909:"b3dbcea3",42654:"cdac7eee",42689:"5fb625f6",42801:"59733b92",42827:"816e92e0",43055:"6dff6091",43092:"f9500687",43152:"b76fe286",43524:"aba58f6c",43557:"5acbe74d",43585:"e2a45f08",43638:"06e611a4",43688:"dc3d7fec",43696:"1632ccbd",43792:"7eb8af8a",43899:"b8583e9d",43989:"9cb826bf",44326:"cf96f01e",44339:"ac53eefd",44345:"ce76d2d2",44450:"b8eded90",44666:"09ab147a",44705:"6494d608",44909:"2c586235",45019:"bf268afd",45074:"473c41fb",45137:"6058e000",45230:"fb37a63f",45357:"8428dc8e",45384:"b183078b",45504:"fca10f8f",45661:"99dcad14",45784:"5e2ed9e0",45785:"9562f221",45860:"522ef36b",45879:"9ba75874",45910:"329d1cb3",45938:"d037a7a8",45954:"0d45fbb6",45960:"bf5b21c2",45997:"46f7fadb",46003:"d73d1478",46532:"0d97815c",46550:"ebb8b189",46694:"12d9b1bd",46784:"33ddb308",46808:"52d7d962",46908:"cb228c6f",47044:"3f613908",47104:"b615932b",47315:"4ad894f8",47357:"14b34cf0",47380:"63089e85",47457:"1ac3e25d",47497:"afe3715f",47675:"b9b4cc70",47682:"427b33e3",47706:"6f86928c",47730:"36121d87",47826:"10109baf",47844:"7c63c948",47901:"afa13d6c",48024:"b808e4e2",48173:"01def2f0",48216:"88087531",48243:"98ad38c6",48244:"2a49ba60",48304:"a175cf8b",48384:"b02f9910",48541:"2dedc8a4",48604:"a3e8cdfd",48745:"ff16d4d9",48783:"956b4570",48817:"5dfde814",49018:"1cc5ecbe",49020:"8750ec25",49058:"90f9c342",49070:"466913f7",49076:"4e721e97",49139:"adcc1d8e",49284:"3685cb1b",49450:"3a277a94",49473:"fb9b5d58",49547:"2bc58688",49581:"0891475e",49611:"3f5a9aec",49660:"7cf026eb",49701:"a671d179",49770:"86929204",49885:"fabd6154",49893:"042e442b",49998:"a06c4f73",50001:"fb2f18e8",50094:"dacd0a27",50103:"29c4964b",50154:"fe23e6b8",50472:"e02048e8",50598:"ce404f5b",50629:"644a76c8",50703:"2b52c7ce",50901:"121548f7",50931:"d0321f76",50996:"31b043b0",51201:"6f799ed7",51211:"99eee64d",51297:"e659bcf2",51301:"1fe18e32",51388:"63a20395",51427:"00deb6ac",51440:"18d02db7",51586:"fccf4da8",51623:"81cdb831",51637:"1ae90838",51760:"228e0e4a",51880:"3a558158",52060:"e820cfef",52137:"4d564705",52205:"ae9e0374",52289:"3b8c5879",52303:"e3716ac0",52351:"97b652a2",52412:"fbc04c9c",52467:"3eb0e82d",52645:"5d918b0d",52720:"17f8d39f",52947:"c52d395c",52969:"6e4ce4c4",53072:"e6e5635e",53118:"85f27db4",53124:"278ca12b",53172:"723df87b",53218:"83429edb",53378:"91c3c2b4",53418:"cfef71aa",53511:"8604e9d1",53622:"ad555afc",53698:"af646d81",53873:"daa78cd9",53896:"c2c02732",53897:"291af9ca",53946:"b3ffaa5d",53956:"c53da6e2",54068:"eea5c50e",54149:"4ee205e8",54157:"0bb30126",54174:"e3ae4459",54317:"2c48271a",54396:"f797c0d1",54543:"a5782e6c",54781:"4bd5222a",54895:"b6e1792b",54928:"e78fce63",54992:"88ce8468",55030:"7412879b",55126:"4d5fcd64",55133:"0bb5cb3b",55165:"a6ce14aa",55207:"2642e3b9",55239:"16756a68",55251:"a5d8d2c0",55362:"15e029d2",55417:"7113b392",55470:"cd9fcd8b",55474:"278c3025",55488:"c12755ef",55793:"e17f4cbd",55846:"0f276f47",55940:"ac7a7d4b",55968:"899eb281",56124:"404bc1a3",56192:"6162ad7c",56373:"9281c204",56469:"0d3ce22a",56584:"2b017db6",56640:"34ba053d",56976:"d541116e",57045:"75f7345d",57252:"54e35760",57291:"50d0703e",57316:"5c8f4dd6",57355:"fe1d7d76",57372:"f7dd5460",57411:"5e0eddb9",57477:"55ec9319",57511:"c14439a5",57596:"c2cc4b3d",57679:"3c721eea",57698:"55c9ddce",57855:"085530f7",57867:"b8e222b7",58148:"77ec448e",58188:"63f6e2ef",58228:"1bdd8362",58299:"19b24147",58300:"a55d2b67",58388:"c29d33ae",58504:"f09de917",58533:"faebfef1",58588:"01eff7bb",58671:"14e8926f",58703:"cc6e8ac5",58902:"8eeac047",58951:"2ae384d0",58954:"1441571f",59003:"dc75d149",59009:"e414dbe6",59020:"91a669f2",59032:"8f371e5f",59065:"2563e8e0",59148:"25185f0e",59219:"3bc32dbb",59260:"e85ac3d2",59293:"295bad4c",59320:"2dc1fad6",59334:"247783bb",59407:"07cc5864",59487:"88c4a046",59522:"042b05c7",59590:"033aa841",59700:"12a4832c",59782:"c651b04a",60019:"80f93b6a",60023:"71b18881",60070:"bd05747c",60344:"026d8b4a",60418:"19dd9055",60553:"0c7f2f7d",60722:"df9d2e0e",60746:"a6278bdf",60800:"e90bfa87",60829:"3466985c",60843:"cc0a4513",60899:"0a58537d",61022:"8f735039",61210:"fd6d72c8",61324:"d1bcbecc",61385:"b1843cea",61427:"89b93789",61683:"319e16c8",61691:"4e18715a",61749:"19b75377",61787:"bbd11534",62e3:"7fcaa117",62013:"6a4cfdc3",62080:"fde3b619",62171:"761c0fee",62257:"1070ce60",62530:"0ac661cd",62656:"88f0c610",62704:"6ed227de",62756:"5db048a0",62866:"6f9fe13d",62886:"c24ffec6",62910:"0163d222",62917:"b10334f9",63152:"487820d5",63274:"2c444a10",63424:"0a55acc3",63767:"de0b42a2",63860:"6d8d2f2d",64065:"f79e1d52",64129:"4f2a10e5",64172:"4d78e6a7",64231:"d2ad78df",64339:"63bf94b5",64441:"e5798c32",64509:"6c6a3c28",64633:"cb3894f2",64634:"5561a7b6",64701:"9c790e35",64955:"2b52cffa",64994:"2bb60e70",65134:"c519648a",65329:"d327bfa8",65350:"e5b99c64",65392:"c856918f",65546:"434eb2b3",65826:"c1d3d149",65952:"4fa7e8ec",66050:"1fb294c0",66053:"4e3c9c36",66198:"6324826a",66221:"3a5b218f",66235:"c6c4f55e",66288:"56bbc919",66385:"59b068d1",66560:"867ce6c5",66674:"125c6f18",66730:"9b326bb9",66865:"2ad15ba3",66975:"1ffbea02",66983:"4463978c",66995:"5cdd0279",66997:"f33ae72c",67141:"a3f20d95",67169:"a408a83e",67178:"59d9644b",67179:"2d35682d",67395:"5f6d7dc2",67461:"b179e805",67570:"82378c3d",67571:"d79eea0f",67630:"fb8b85c0",67715:"5bc7d28f",67759:"015f3359",67983:"af5b8f37",68005:"5e8bc7eb",68041:"a8546f28",68072:"554e0e92",68257:"7c81aff9",68317:"855cc29f",68428:"ff332aec",68532:"94bf1f11",68567:"4c7d984b",68623:"ec258617",68626:"b93ce049",68632:"2093545b",68872:"dabd12eb",68883:"975678f9",68917:"9467a3a7",69089:"6f265f1e",69125:"83c14c5b",69131:"86be6eb7",69301:"46994613",69376:"52c0afd0",69637:"08bfe654",69638:"a21e3f2b",69747:"4971b70e",69853:"85b33b51",69859:"e6963609",70049:"dec461d7",70247:"c99c2808",70254:"6e1b0d5d",70262:"8357b658",70283:"dbb4b0dd",70319:"2f679eca",70322:"e740f973",70361:"4eda58a2",70466:"3c2019bf",70517:"581c1936",70710:"66f7d59f",70735:"fbf8a582",70861:"58d70cba",70875:"23c8d0ec",71015:"a852c08e",71126:"464f51d8",71135:"9efc327a",71165:"592a270e",71181:"3424d603",71235:"2075c0e7",71292:"50ddb176",71370:"2763779d",71371:"532df885",71822:"0e0784f8",72051:"cc4926bd",72137:"d72358c5",72238:"05847173",72260:"ff3d1153",72321:"43c15dd6",72342:"160f3a79",72418:"2cc3cbd0",72626:"cc51bb94",72782:"cfe23f40",72846:"7f490342",73080:"cb2c479a",73181:"b3f9dbb3",73309:"eb134d49",73407:"fe669216",73481:"deeedaab",73495:"95f72fa5",73708:"d3337921",73714:"49d02f2b",73788:"16af972d",73855:"b8b08371",73907:"2ae6ee92",73953:"98fad2e1",74134:"3a9ce421",74181:"d3d63dbd",74192:"b0e2212e",74398:"759e8857",74404:"953bfb97",74455:"e342c8de",74459:"e0d18a7f",74498:"1bc96b4f",74799:"fbcf7722",74843:"b591fba7",74857:"3d32fb4a",74919:"fa8b7820",74986:"ce2e9252",75012:"586f596e",75093:"8b060552",75161:"2a7e9090",75223:"dce33e1f",75275:"4f49b4a6",75634:"bcf3c208",75719:"0d7e0438",75730:"4343594b",75746:"2a38130d",75786:"5ce80a97",75812:"3f3bc418",75857:"8e99cb43",75993:"4cb8fa66",76015:"62ff3f98",76042:"baa2ddd1",76233:"efc08881",76468:"ea7a23e5",76802:"0f573e36",77053:"97f09500",77102:"aa19dd49",77169:"54d368d0",77243:"b9f191e0",77286:"175ab1e6",77332:"04fe8bc7",77375:"dbb0c5ba",77445:"735d0569",77645:"a7434565",77669:"8021ccb9",77722:"afb57966",77792:"5be0fa3d",77943:"86fd3823",78107:"611d7e33",78112:"b4031aab",78197:"9f6eb29d",78222:"feb1c55f",78350:"5eeb66fc",78436:"8af6147a",78636:"00d30b51",78866:"78a121f7",79096:"448e9ff0",79104:"39109a85",79162:"d74be7d9",79260:"07e92a52",79265:"ef3ff2c2",79274:"e40db110",79286:"00a77e21",79388:"8c7c8eb3",79398:"24fa4cec",79418:"1a3d40eb",79512:"bbba91a4",79548:"8c7ba56e",79652:"45e2ccab",79783:"e6724f00",79792:"b3e24b6b",79916:"8a1a46cf",79994:"3ccf320e",80053:"935f2afb",80060:"43039bb0",80090:"526c94fd",80142:"925ec2c4",80169:"33152f28",80237:"4fbefc11",80309:"f30e2f4e",80322:"8285bf0a",80534:"3378914f",80589:"2368976d",80631:"9c105a4a",80706:"2cc9756f",80731:"bba534cb",80817:"2b66fdf3",80831:"9a4b7ed4",80872:"ffe0d0d7",80906:"a1c220e1",81093:"61d1e172",81177:"fc11e017",81208:"fd0a352e",81242:"29a89901",81269:"30fab45c",81476:"2550b685",81502:"d6f53db0",81617:"6a61db4c",81646:"e3a94193",81650:"582cf9cf",81701:"3f6ccc4d",81743:"a8a098e3",81884:"1d717d5f",82154:"5e72b495",82214:"87963f8e",82401:"b49dfbe6",82788:"2a054627",82833:"68e7302e",82913:"bdc9175c",82918:"eead291e",82941:"779a5035",83057:"b8fc97f5",83096:"0846aa9c",83105:"6606b81d",83153:"c22b7e4d",83157:"55f3c723",83337:"da59ca95",83435:"31f6e61c",83447:"beeaecb2",83576:"92a4540d",83593:"c01d5add",83695:"007417dc",83787:"b225e9f7",83819:"18b7481c",83911:"025c3845",84084:"6ab254e3",84094:"e1b037a6",84101:"3603dc64",84109:"c9307803",84275:"67b9a9ed",84342:"016c99f5",84533:"2093a25c",84589:"ccbe36b5",84609:"d43711a2",84793:"e3bc6914",84816:"a1505666",84861:"9f063840",84890:"41da606f",84959:"720ef584",85054:"0e698270",85198:"e20e5b1b",85235:"b7a47829",85486:"6f230234",85510:"fb6fbcbc",85642:"60667150",85657:"f8817707",85688:"bb5adb3f",85731:"40500d46",85760:"9985b6b4",85925:"93403402",86381:"1e7bea2b",86407:"54b20349",86438:"d919af83",86461:"4c12bb41",86569:"a1d6df89",86616:"67e7a7a2",86638:"f6bb5feb",86706:"1ac80f48",86842:"32e1a604",86845:"bb1a22fe",86947:"e562837c",86965:"608605fe",87311:"537d16fa",87399:"77e0268b",87401:"a7de3171",87486:"b9583340",87535:"31fb3847",87631:"830d9274",87658:"def52b90",87706:"628f19ed",87762:"124cf492",87767:"3087f363",88012:"4f36b0ab",88135:"1800faa3",88406:"ba6c4f44",88571:"43bd0f3e",88733:"e7ffdf0e",88744:"7ea3161b",88858:"75bcd1ec",88877:"e86f1faf",88976:"b4cbc673",89126:"16888267",89183:"9f60fd43",89281:"533e4ee8",89343:"78be5594",89525:"74842326",89563:"17a3c4c7",89608:"179e41e0",89633:"4e42ba9b",89722:"a57c97e1",89744:"b511d978",89772:"59f94b0a",89780:"27ba56f5",89781:"d39426f1",89955:"40357306",90032:"e2c26865",90093:"3758fb0e",90318:"b7db8f42",90353:"686a27f5",90551:"a6c0c96a",90645:"3db4b834",90717:"92a67a5e",90757:"fa29f323",90758:"81617aef",90781:"e08af2f7",90788:"dcfeeef5",91002:"2b3d484b",91016:"6ef156d1",91147:"6faf837f",91170:"784cefee",91234:"57b3bd5a",91437:"c3b842f0",91475:"e14d3193",91500:"c3a56b2b",91645:"0c0856cf",91667:"a72e3859",91692:"de7187cd",91760:"cc1ec4e2",91819:"d82dae9c",91889:"78acccc5",91971:"dc306ea3",92166:"cc53792f",92192:"9aa8b2ce",92279:"e2f2321d",92345:"4493ef81",92463:"321507eb",92541:"a677fec3",92580:"c34595d4",92886:"e5331bbf",92906:"0b59f9d9",92977:"11020189",93093:"0fafb84a",93104:"95ae2e11",93117:"fec91b88",93124:"1a47e540",93178:"750bdf24",93387:"e35fe59d",93564:"d9db9575",93658:"ca92d177",93666:"d6c89a37",93677:"b5ae6a43",94039:"905d5f29",94242:"4bdf8047",94445:"485fd60f",94808:"7cb78d0e",95018:"56acf746",95043:"54890881",95075:"025c8e15",95111:"1b7953ef",95170:"5c00a2ae",95283:"8ba07a28",95422:"008d8ed8",95428:"b59ff28b",95480:"bd292e6b",95508:"9a1f0ffb",95551:"d6b34693",95554:"a4bba936",95738:"c7dee171",95808:"fa9f7ab7",95827:"b6607c60",95847:"579e796e",95885:"0a8b996c",95901:"39630c6f",95961:"2974c85a",96048:"063c6f4a",96054:"e9bd8d12",96074:"293b7ec8",96137:"3bfcb7ef",96168:"13052e62",96298:"731b568d",96470:"962c73d5",96550:"e6762b5d",96636:"86369399",96766:"d13d7913",96915:"463c6316",96965:"de3f1c9c",96994:"4eecffc4",97077:"7b44e488",97221:"06470666",97466:"64ca5894",97603:"d7d4ca84",97607:"2e5a906c",97878:"793d570b",97920:"1a4e3797",97955:"d941769a",97981:"88494be0",97982:"1b7f2ddb",97984:"3ee0fc6b",97987:"7b9635e1",98004:"fbc0a5af",98054:"f171655a",98181:"845352e9",98365:"ab40f74c",98440:"17c256d3",98476:"3708790d",98487:"be96c5c5",98518:"c2e1fe96",98558:"036bdd50",98698:"3bbd7fdc",98707:"5a9f8cc2",98758:"a10f0673",99023:"0120a125",99236:"5f623ea8",99242:"48d023ac",99252:"fb85aa06",99256:"2c72cb8a",99369:"a07ff668",99384:"6935d919",99444:"05b090b6",99481:"d4dc7dcd",99505:"4966510b",99524:"9f37195c",99537:"fd8bf6ff",99582:"0c1e2e5e",99776:"50f34778",99867:"1bc5c1c5"}[c]||c)+"."+{26:"2e2e2d40",188:"f3fce124",197:"3fe28d52",226:"7d7506d1",338:"32b10e9f",383:"a30a3e5f",464:"bb4270b2",525:"6b684867",551:"7c033c3d",563:"29456321",598:"048e13c9",618:"895c2a01",624:"a0ede0df",724:"61cd8661",819:"fa96a5fc",893:"a1ec4917",1002:"435a77c5",1296:"95565614",1440:"ac028b2c",1554:"69ec5182",1569:"eb856577",1574:"f362b59d",1725:"99cc06e8",1776:"bd146d51",1792:"be424f4c",1969:"8405cd48",1978:"17c4b93f",2020:"e0131aed",2139:"ed585595",2203:"11e55646",2379:"4fcf0b82",2624:"a999a8ab",2641:"ccfebce7",2843:"0ce0017f",2864:"be8a9c87",2865:"acf2be21",2867:"8b2cc0b7",2933:"2113667d",2972:"3ce7b89c",2987:"356191be",3046:"5e94b212",3047:"d57ead06",3291:"3bb0f97b",3459:"9731eac8",3600:"0ac79a22",3635:"fd4e8746",3787:"af5b9608",4074:"813893e3",4121:"577939c4",4202:"d7a51594",4209:"83fd529a",4222:"9845b70b",4261:"7e1fe9a1",4277:"d780a055",4389:"056da692",4420:"d0613aa8",4487:"94cf1290",4488:"9b7ba1da",4566:"85ed7419",4624:"dd337e38",4696:"d31da03f",4754:"20976f37",4801:"f5963fb1",4884:"9399f7e8",4903:"aa5bec42",4972:"6f2a554b",5007:"53f09041",5028:"8a57ad8c",5263:"949d1a25",5375:"4765bd91",5405:"ee57a38e",5584:"5152778c",5600:"3989a907",5603:"f2df3478",5647:"4d6e541b",5728:"92605b66",5810:"372e3e87",5826:"79a9f373",6051:"32292e44",6202:"5168f6cd",6267:"2ff0e227",6584:"0180d5d7",6604:"27549a5c",6753:"0c2eac85",6801:"18847e46",6950:"f4322d13",7059:"7bee2cb5",7096:"51e350dc",7173:"930d8587",7207:"34557ee0",7285:"2c3bb157",7314:"bbabddd9",7442:"2a7ba622",7560:"4e38c118",7685:"b9b8d495",7755:"c749b63a",7890:"ef635735",7956:"cbf20299",8196:"36baac25",8489:"aca9aa62",8557:"2e82b18f",8619:"a275c20f",8707:"30ee84e3",8719:"4e111dfd",8757:"7479cab4",8839:"cb1650bb",8850:"efbc75c8",8884:"e25e0746",9060:"15ef201d",9126:"4471f2c8",9337:"d7d2c0c5",9595:"f45ee0d8",9624:"813eadcc",9630:"e73f1493",9643:"ebe148f7",9714:"cc61305d",9720:"434ae041",9730:"8bc3f4c5",9773:"03a055be",10230:"8fb633ff",10278:"d5deb0b6",10388:"c3ad0351",10483:"36a85800",10638:"a3d79a18",10727:"b553f187",10768:"9f9f442e",10770:"d17d5042",10800:"d1cd16df",10814:"882283a0",10882:"83012574",10908:"f025e8b4",10963:"31b8b53a",10973:"42498b90",11074:"5a9e55d2",11145:"b9127983",11153:"d502ee10",11224:"2f93eb11",11303:"f6110cbc",11353:"287a32a3",11475:"08e699f7",11544:"e9eebbee",11647:"18a0859f",11651:"dc23dcd1",11664:"863d1432",11796:"9b57d5fc",12067:"e06e134d",12127:"a7bae4d0",12291:"60717462",12454:"80aa4000",12567:"0adf99f7",12653:"b5f07e99",12658:"8f6d73d9",12707:"c03a0ed3",12723:"4bd69950",12743:"cf277668",12760:"b931f7b9",13511:"aafc09b1",13571:"fd584bc7",13592:"0b7a0dd7",13629:"97c75437",13650:"008acde6",14025:"6c67f319",14050:"7dc0213d",14061:"fdd9a2d7",14167:"87c07323",14733:"77d4ea3e",14840:"b8f7f6e5",14842:"f948616f",14914:"5b0753a8",15013:"15e6a123",15052:"8334ac5e",15180:"9d1b499a",15283:"5e22886c",15295:"60209ff3",15299:"d7883dec",15378:"20e07c98",15579:"448500cb",15592:"3ba82556",15707:"789de38e",15778:"d44c182c",15913:"26cc528d",15971:"e4519a53",16077:"c006ba63",16317:"13a797b8",16370:"99002720",16579:"c72b0d10",16633:"a835bc18",16672:"38f751ad",16756:"e1677ee3",16759:"c1125db4",16762:"724ba98e",16774:"8d6550b8",16872:"0d8bdb32",16901:"cadbada8",17054:"2e4be7c7",17134:"8f42a6f1",17155:"6e840a67",17177:"4c2c9dc7",17347:"a8eff7ed",17421:"4b67d4d3",17481:"72657b20",17704:"3e5624ca",17709:"f816fa64",17797:"7a757662",17951:"284bb095",18015:"b6db7fe9",18034:"07ebe229",18208:"12617f08",18213:"e57e15a1",18335:"e7f49d1f",18443:"b2d7251a",18514:"4ce863ee",18530:"d2a80a73",18545:"665e455f",18563:"44cb1533",18598:"62cf62c1",18681:"27a77fe7",18757:"b4f109e3",18803:"d894a08b",18894:"ab503a98",18943:"8b739018",18989:"91c12b77",18990:"6dc98016",18991:"4e703d1c",19037:"b497f5e7",19070:"d21b9743",19088:"d5e6be91",19165:"24346565",19283:"97c719ce",19334:"5d81eae5",19394:"ba453488",19487:"61c58325",19517:"75f37528",19561:"3c5bc7e0",19621:"463608b5",19682:"52a92c16",19726:"5238454d",19744:"0b656cff",19981:"3bd71053",20057:"399b0262",20078:"d3422383",20092:"35588286",20372:"ffda2d2a",20477:"cd76695a",20504:"1773c1c8",20534:"091d5bec",20535:"2804a992",20592:"6d1385a9",20623:"973ca172",20656:"a36dd962",20662:"00eece41",20773:"52b968ce",20930:"41b715f5",20969:"f1ca434c",21052:"3bd01265",21064:"d0042643",21092:"47272528",21117:"961cb40c",21130:"b0126cb1",21141:"add6ef20",21252:"69128550",21290:"eeb323fa",21322:"5de4ec91",21414:"e8d7d56b",21461:"497f3df3",21502:"629e96cc",21524:"7960b767",21661:"db3677cd",21748:"8164ff18",21830:"3313f8f5",21911:"2580099b",21921:"e747285f",21964:"016bf5ee",22010:"22cb9d5e",22022:"b11cf23c",22294:"38fe9e4c",22341:"072da9f6",22495:"832cbde6",22638:"2a3035e8",22645:"4a08a6db",22852:"47109b45",22963:"335b4cbd",22992:"dee60447",23022:"aa116b7a",23054:"52b95b2c",23128:"e61e61ce",23221:"f320439d",23327:"8e05c3e3",23418:"adda618e",23442:"e84592d7",23474:"e969e733",23577:"e138d3f0",23613:"977a729f",23637:"d151d5c3",23737:"42312636",23778:"29665074",23798:"6c0aa906",24079:"22d15611",24082:"80ed9bb7",24083:"41ae870c",24132:"b3d37ee7",24178:"b9736b9c",24369:"57465c3e",24475:"39ce61ee",24506:"904c30d2",24564:"21134882",24617:"ed264594",24722:"2b0ecce0",24748:"44004b33",24753:"72b8f292",24758:"e88f4aed",24881:"94b280c1",24884:"067a13a9",24938:"b3296a8a",25056:"cb3c90d7",25118:"e31b1657",25197:"d0437979",25264:"05ad3ee4",25290:"07dab1f5",25332:"bd7328bd",25398:"31326937",25453:"c0a9505f",25562:"1c33aa14",25588:"86e02ae1",25781:"565d8e7a",25942:"ea05e1d5",26079:"7c4bb28f",26094:"5084e79e",26101:"455cba60",26105:"0028b786",26282:"c724df40",26354:"07033eb5",26381:"6477c89c",26698:"124a0216",26871:"ac28bf8b",26971:"2ba93431",27006:"65d10f33",27146:"8c048561",27262:"effc1ff1",27309:"12142dcc",27363:"ef8d7853",27501:"210cb4c5",27534:"05481b31",27588:"98e95b73",27663:"63e7b939",27678:"90bc39ee",27850:"7470a970",27918:"0cd27aec",28100:"c0bf7eb1",28290:"00626fd7",28407:"1114a95c",28432:"9026ffa0",28505:"286fe80c",28644:"4baee7dc",28678:"c57cd199",28926:"2be69459",28970:"9d1ce1c5",29025:"086abbbe",29043:"b4ee8020",29242:"611d512f",29333:"8c2f4719",29336:"22e0d3cb",29473:"0c93b429",29497:"3bd52d12",29514:"f68da1eb",29627:"c243283d",29650:"0c35bb1f",29654:"05c0b778",29685:"781ee0c1",29698:"53a0d6c3",29728:"023027ea",29751:"c5c5b16e",29899:"6077446d",29998:"73c5eab4",30010:"55557b5b",30058:"7f9d3018",30089:"c313a8cf",30115:"b12d0cdd",30147:"3bea2ca6",30326:"053950d9",30572:"173f9677",30735:"d9793191",30801:"d34153ca",31029:"921a2f17",31074:"c94afe8b",31189:"4d4b78df",31474:"039491e4",31500:"24ea237e",31636:"b1953863",31752:"8ce7e980",31885:"4ffa4f31",31895:"f19fff03",31907:"9c4ff058",32028:"547b5f33",32066:"26e66a48",32067:"91f0942a",32069:"9386a30a",32211:"653abf07",32310:"c64e3181",32408:"0adc48da",32417:"5fc0d5f2",32573:"ad1d44ac",32747:"5ccc4ae5",32800:"a0af3723",32845:"6f965de9",32900:"e4fa8564",33005:"dc156300",33031:"21801bd0",33035:"8e1f79cc",33036:"076f96c3",33064:"45ff6518",33107:"a7a7fecc",33124:"7ffa84c7",33229:"9f97d342",33273:"89486caa",33296:"a78db1b0",33308:"25d611aa",33392:"1064edd3",33617:"68b80e8a",33892:"aa3f541d",33898:"ae42d64f",34071:"b747c264",34173:"bc8a8105",34204:"61a2757a",34236:"5880be61",34288:"05c53a1d",34298:"897b239a",34522:"1f9c9eec",34548:"36ce9de8",34579:"e1d356c2",34607:"9b8445f0",34641:"9b856104",34698:"e1d70b6e",34736:"ef6f7f93",34864:"3a8b9a23",34960:"02433ab3",34991:"80316f24",35022:"b5d98990",35101:"d0e29181",35133:"afb50350",35377:"d4da0e5a",35630:"04b2ac27",35679:"a86cb65f",35708:"b9aba4f7",35730:"f8085cfc",35775:"eeb59660",35874:"25168567",35978:"32b18e07",35994:"46211b70",36050:"5917e79f",36052:"c088702e",36125:"807e34e2",36161:"4e52c673",36282:"86ef58a0",36299:"529d05b8",36344:"e0756ae4",36364:"fb10bdcf",36389:"704ac5b0",36420:"2ef0796b",36516:"6ed55d8d",36557:"1315d492",36569:"e346d380",36712:"29fcb16b",36776:"1ace43df",36797:"8c3d6f10",36840:"a6afa7a4",37366:"d945dec7",37419:"ca55ea81",37501:"9f98b1a0",37581:"de10e155",37644:"91083ab2",37775:"4a8894d0",37897:"8bcd22c2",38073:"51e27b82",38266:"0dcd989b",38310:"ba4baa9f",38369:"8f6feda6",38468:"f25b02c3",38491:"985d9095",38537:"1f909ad2",38574:"9779a16a",38626:"6f77d676",38696:"d15346b8",38786:"40a847d2",38793:"709a942a",38908:"fb6b36db",39013:"e4f7b1d8",39160:"ab03c6c5",39182:"d21bb929",39242:"b4fa28c9",39260:"898330e9",39515:"3132d067",39586:"2bc435c7",39607:"a4eb8b4a",39610:"257b15bb",39619:"0505a5d2",39805:"455cf824",39821:"001ca72e",39894:"bd6a0a56",39955:"12309cea",39961:"28348efd",39978:"6e8631c0",40049:"e90ede11",40060:"f717c2f8",40086:"bd112efa",40323:"f24941ea",40333:"030e1b66",40350:"977a24ee",40358:"bd637838",40543:"54575388",40905:"d9ac5e9d",41085:"718cd2eb",41096:"5139357c",41103:"739a4ed6",41104:"6414a86d",41217:"59d75392",41335:"42d9e08d",41348:"c32cd089",41403:"9b732a24",41408:"11e80298",41409:"4fc0264c",41444:"1b3165ee",41476:"80614a65",41653:"37e3a49b",41735:"075ed52b",41736:"83c70b4c",41772:"efcb8ca1",41832:"e55d8ce4",41909:"43d8ed23",42098:"df9c8b90",42654:"ba51b6c8",42689:"976384d9",42801:"08d8ce37",42827:"497cdb6d",43055:"345e9baf",43092:"84fc389f",43152:"162908b0",43524:"12d4ac62",43557:"0636d48a",43585:"ee223613",43638:"107bd1a6",43688:"9dcaf722",43696:"8be46aff",43792:"01f5082f",43899:"b0c24462",43989:"5b1db205",44326:"dc618ebf",44339:"666524af",44345:"8c2085c0",44450:"282f4c5d",44666:"374b7d82",44705:"0cb3dcd6",44909:"257ebcd1",45019:"130fd343",45074:"440bc37f",45092:"049ef51c",45137:"d9598802",45230:"067148e9",45357:"22f9f63b",45384:"f91bd69b",45504:"90dac8fd",45661:"3f0b34aa",45784:"ea60c27c",45785:"bdd0b355",45860:"a795a8c2",45879:"30c02d06",45910:"592a858b",45938:"0feca01f",45954:"a054ab75",45960:"a6829d39",45997:"3750752e",46003:"dbc18d33",46532:"2fd91201",46550:"e8940713",46694:"9954453d",46784:"63f0b3d2",46808:"494fe7ac",46908:"9141f5d1",46945:"b9c02393",47044:"f8cfd1e5",47104:"330c9459",47315:"44066121",47357:"3c7515ae",47380:"b39229ad",47457:"c018a1b8",47497:"d4a6d559",47675:"c4ad702c",47682:"c3801ed8",47706:"20fe8154",47724:"54acbd95",47730:"c7eba3b5",47826:"9ab41fcf",47844:"fc8eec02",47901:"7bc91270",48024:"4574cafb",48173:"4a541f8d",48216:"ed8ca11b",48243:"1d46d1e7",48244:"81a58839",48304:"61216a83",48384:"916bb925",48541:"cd45a01a",48604:"983a470f",48745:"531dbd5a",48783:"6b2deb5d",48817:"c866bde0",49018:"fee7ae00",49020:"0238475b",49058:"fa24aa81",49070:"6f3d06dd",49076:"b3835c00",49139:"40db9a2d",49284:"f33237d9",49450:"c986efa5",49473:"e3f735c1",49547:"507fb2c8",49581:"a25e05d1",49611:"de8db0e4",49660:"8c8b57f0",49701:"bcaa5d54",49770:"28e5e959",49885:"c82e8910",49893:"f1ec195b",49998:"1c1ad747",50001:"2d28229d",50094:"6b334c11",50103:"d8b62bd8",50154:"0ca71e93",50472:"0383414d",50598:"de3c8388",50629:"32bf5ad6",50703:"eef3e040",50901:"a4412671",50931:"1588b18b",50996:"22d306f6",51201:"fb3766af",51211:"2d1c4642",51297:"66fa8c75",51301:"931802f6",51388:"163d52d1",51427:"48e41f27",51440:"d310f38c",51586:"bc2603f2",51623:"7413074e",51637:"6f403746",51760:"3982291f",51880:"bfb1c458",52060:"f482c2a8",52137:"a4540e02",52198:"bfdb2ef1",52205:"e97dad6d",52289:"76042967",52303:"42bd8ee9",52351:"7b8f8fee",52412:"f1dcc897",52467:"8d606401",52645:"71c881d0",52720:"d29b15ae",52947:"f9496ea8",52969:"0feccd95",53072:"b5b0636d",53118:"9d408569",53124:"ab65cd6e",53172:"65eeac7d",53218:"1a1d9179",53378:"7beaf063",53418:"8a752056",53511:"77cd5cb1",53622:"c3d5716f",53698:"15195224",53873:"f816a2e2",53896:"18cc04e2",53897:"6df77872",53946:"5006e2d4",53956:"3d085682",54068:"e69dbe79",54149:"808c5341",54157:"b17f7850",54174:"5cecab18",54317:"f1bbd900",54396:"4587bdc6",54543:"569712ab",54781:"fcae3271",54895:"11a869e2",54928:"93ce8a0f",54980:"d1159c54",54992:"0c86496e",55030:"e9bea07e",55126:"8a086da5",55133:"dbb99ea0",55165:"49f59014",55207:"38033cb7",55239:"1f23ecf4",55251:"af42ee75",55362:"a4d33f0a",55417:"abb783a2",55470:"f835719f",55474:"3cb87607",55488:"e0b95d74",55739:"0f376ce5",55793:"3b3535ba",55846:"cd17497c",55940:"fe0b74d4",55968:"1ce13225",56124:"0dd8c0fb",56192:"a63ba040",56373:"6494837b",56469:"76a9317d",56584:"e95e569a",56640:"9f40a20d",56976:"8b1a03f0",57045:"02a7fe96",57252:"3fe11bdf",57291:"91538b9a",57316:"d8f1c6d8",57355:"2f0df212",57372:"ec080a45",57411:"cae223a1",57471:"c007c502",57477:"d6a4e3ff",57511:"c706cd40",57596:"22af1c99",57679:"e62b6088",57698:"4169bcd9",57855:"6199b352",57867:"c2cff559",58148:"21f32f66",58188:"ea733d8d",58228:"100c6abd",58299:"47d604d6",58300:"b1ed2148",58388:"d5609d26",58504:"750ef235",58533:"d596895a",58588:"666ae3c2",58671:"f4f2186f",58703:"81b8a279",58902:"cf71b301",58951:"341a2e39",58954:"b27bba36",59003:"60270ed4",59009:"b3fa3678",59020:"7f946067",59032:"c0657eaa",59065:"ed21197c",59148:"65d36ff4",59219:"ab899a1c",59260:"733d80a3",59293:"ab163170",59320:"77a16165",59334:"33dd5c2d",59407:"1ef8407c",59487:"a495dafa",59522:"8bd43a05",59590:"b090eb80",59700:"266c7656",59782:"5d99c00d",60019:"ed736a66",60023:"f4a0d19e",60070:"935ff3be",60344:"916817f1",60418:"e7c76945",60553:"7d0afea5",60722:"1f75d95d",60746:"e64a43ed",60800:"c6327bc7",60829:"36d85c88",60843:"ac3aa644",60845:"cd615554",60899:"5a602931",61022:"b1714da1",61210:"bd4b696c",61324:"daa91a6f",61385:"67b5cbce",61427:"7340f4b8",61683:"cde5e515",61691:"2e6468f0",61749:"947b3b80",61787:"ff0efb3f",62e3:"91083b1f",62013:"1c2ffc7b",62080:"3d1108ea",62171:"16a07297",62257:"95017957",62530:"0ded4c81",62656:"c0b09bcc",62704:"70249dc9",62756:"955fedde",62866:"c2df68ac",62886:"d13788ac",62910:"3776f168",62917:"9a575d8b",63152:"01caff99",63274:"7a3f1211",63424:"44cacaf9",63767:"df83cc55",63860:"a94e18b3",64065:"f2ec185b",64129:"afc5a8d1",64172:"65ac66b3",64231:"df9536cd",64339:"36fcc3c8",64441:"44962610",64509:"b80064d8",64633:"b55b93ba",64634:"79e5ddf0",64701:"87dc3184",64955:"6f3c676e",64994:"ba900224",65134:"491c2671",65329:"bd92b2bf",65350:"3643c5f1",65392:"8f52414a",65546:"8213fc31",65826:"419da6a0",65952:"a733aded",66050:"fa2d2397",66053:"dde992c5",66198:"7d6aee8d",66221:"9ed35e0d",66235:"488e03ce",66288:"92898ce1",66385:"c5f1debe",66560:"1c03c4c5",66674:"894a6122",66730:"0511956a",66865:"05bc7a2b",66975:"dfd27b97",66983:"1c0fd615",66995:"a293f4a4",66997:"6799955f",67141:"5ed8906d",67169:"b956140c",67178:"a019daa4",67179:"31b05dbf",67395:"fa4cda2a",67461:"1cb1bff0",67570:"6f122e55",67571:"257016bb",67630:"4187ab32",67662:"826c9574",67715:"52c50ad5",67759:"342c18b5",67983:"f85ad06f",68005:"379bcf87",68041:"45b13429",68072:"d33b70c4",68257:"a23a607e",68317:"3cd1ef02",68428:"7cb9d4af",68532:"90d8b43b",68567:"a34b36e9",68623:"e41347e4",68626:"42b9c223",68632:"50e84ffe",68872:"bce97a50",68883:"e55a04f9",68917:"1d40d5be",69089:"9763190d",69125:"6e971acf",69131:"42ce3521",69301:"0437b040",69376:"b3d17ad8",69637:"10c9ce26",69638:"38a992da",69747:"7a41843e",69853:"744f0ba5",69859:"662e143c",70049:"d888f4c6",70247:"461ab652",70254:"3d228f8b",70262:"95c01692",70283:"8ce19a4a",70319:"5bdb5319",70322:"eae06d3d",70361:"56499f7e",70466:"76a7988a",70517:"2e957c95",70710:"7e12b2b4",70735:"4b8beeb1",70861:"d47b9838",70875:"8dbd5b3f",71015:"923278c2",71126:"4c85dc9a",71135:"dee37ce3",71165:"9e1e0d0b",71181:"d3867df0",71235:"14443b71",71292:"dbd751cb",71370:"8da27144",71371:"16a6056d",71441:"d263260a",71822:"97098856",72051:"df6a68ff",72137:"e8ce8e40",72238:"d1f2dd7d",72260:"153cf8f9",72321:"611bc24f",72342:"4bd9e707",72418:"ff571cad",72626:"53757bf9",72782:"6fd1f5dc",72846:"b435c2cd",73080:"99f507fc",73181:"bf775a4a",73309:"55cd9daf",73407:"a99ef0e2",73481:"a1b51b50",73495:"15a55805",73708:"5fe394a2",73714:"d2296fd5",73788:"8e16fb46",73855:"b89f3fc6",73907:"bda65761",73953:"7e2445ad",74134:"c594c2d3",74181:"7510ad05",74192:"43fe083f",74398:"16fcb3cd",74404:"609b3a73",74455:"2a52634f",74459:"cc0015d5",74498:"c31a6f7d",74799:"bec67e70",74843:"664ca616",74857:"bfc94c68",74919:"cce0aba0",74986:"3f432d40",75012:"884354f7",75093:"07800c72",75161:"e9f7a0df",75223:"ad0ec433",75275:"9ade45d9",75634:"f529b656",75719:"7366813e",75730:"5899503c",75746:"208dffe6",75786:"9beff5e5",75812:"ec7a99a7",75857:"41300285",75993:"3c94b77d",76015:"33c5ff6b",76042:"9901c278",76233:"0f7e3122",76468:"c86cee85",76780:"a29f6a7f",76802:"7c172222",77053:"ade54cf2",77102:"a4f12bc5",77169:"17f42dfe",77243:"d34ef1d6",77286:"acc91c46",77332:"b6585406",77375:"486ee5e3",77445:"2e4b7bc7",77645:"8451ed4c",77669:"3af0089a",77722:"7300ae36",77792:"f2dfc908",77943:"e1a62755",78107:"49b43c59",78112:"1628a4f1",78197:"677905f0",78222:"f6442f46",78350:"28a654cb",78436:"aca1271a",78636:"f10bb308",78866:"ed8e8d1e",79096:"bb400c47",79104:"bb8fb37a",79162:"95c45a2d",79260:"be7affe9",79265:"c47ba125",79274:"7c42e26d",79286:"8a3aae79",79388:"dbe699a8",79398:"5bca3818",79418:"b54c31df",79512:"1ae01931",79548:"272c612d",79652:"ff0f02da",79783:"1c417b3c",79792:"05d178aa",79916:"afbfc56b",79994:"4faf3055",80053:"cb28f32f",80060:"5542aba6",80090:"5c5a2fc0",80142:"9a3293da",80169:"89e02059",80237:"57154231",80309:"e5d0903b",80322:"63d5e275",80534:"4b821f1d",80589:"858f143b",80631:"8f8b986a",80706:"fc32ce52",80731:"a2828737",80817:"66f9c07e",80831:"c52b651e",80872:"5b3fce72",80906:"9ec9c966",81093:"a102ed69",81177:"d1247bb6",81208:"c8504298",81242:"5f240a13",81269:"09ff435b",81476:"09c87795",81502:"56bc2541",81617:"a0d0ccfd",81646:"f3d1360f",81650:"e0d6f06e",81701:"84b41c91",81743:"206f9b84",81884:"89fc86bc",82154:"acbb84a3",82214:"884c6e0e",82401:"6002f9c6",82788:"578b6740",82833:"0f74871f",82913:"e47286ef",82918:"355f0317",82941:"959915e5",83057:"c117c8d2",83096:"4af965b2",83105:"d7da4467",83153:"72918dd3",83157:"3e0da6e7",83337:"3b87c8d3",83435:"4892a6a5",83447:"ae01566e",83576:"90786004",83593:"6d1e9976",83695:"2c914fc5",83787:"ae4a6231",83819:"de996987",83911:"f2dc03da",84084:"f7df0fcd",84094:"cbd359de",84101:"e427ae61",84109:"fcaeac01",84275:"960b3581",84342:"758d002f",84533:"a4827c7e",84589:"9823c36b",84609:"c4bcbdec",84793:"533d8ff2",84816:"20a008b5",84861:"2c8f4d7d",84890:"734390a6",84959:"9248b47d",85054:"ca4f51ec",85198:"0604ee53",85235:"0ff8a654",85486:"be163d29",85510:"e952a728",85642:"164c0642",85657:"b2360ac2",85688:"8e4e464c",85731:"73ff116d",85760:"e4732bd7",85925:"ed2cd121",85995:"9220d8bc",86381:"0cb7bff9",86407:"50ae68f7",86438:"477242fd",86461:"04ffcd52",86569:"25f866de",86616:"08592fba",86638:"e2d4813a",86706:"4c99b3b0",86842:"b4342c9e",86845:"af737499",86896:"1ea9e98b",86947:"4988d838",86965:"289a3c43",87311:"2e968ccf",87399:"e8a80265",87401:"3c1ff041",87486:"848e5906",87535:"77082ee9",87631:"c6d271a2",87658:"393140ed",87706:"f84f0971",87762:"08352b38",87767:"f8b4f552",88012:"0ae87b0a",88135:"3545a087",88406:"902119a2",88571:"60f8236f",88733:"50bdc2cd",88744:"ebf47ad1",88858:"3a77547f",88877:"5a61a6fb",88976:"3d17df73",89126:"f9e892f2",89183:"ea1266c9",89281:"29ceca9f",89343:"cf87bf8e",89525:"b0347e80",89563:"0afd93b0",89608:"441eb09d",89633:"7d968139",89722:"7dcbb2e8",89744:"f342b245",89772:"6c8b995f",89780:"39adb92f",89781:"7adbb575",89863:"a7edf75e",89955:"ec994b5f",90032:"0ad98c7b",90093:"d88acdf7",90318:"353057eb",90353:"82cc9870",90551:"52f4b046",90645:"f75c1d35",90717:"d82d7fb0",90757:"b0536ebf",90758:"783eeef1",90781:"858aca1f",90788:"185a0fb8",91002:"28e98dfb",91016:"2daf1c87",91147:"a19fecda",91170:"1fa4dc5a",91234:"ff0a1cc5",91437:"b895b9f1",91475:"b5ca1b6f",91500:"917c8aa4",91645:"e403d208",91667:"856e1195",91692:"7e46b438",91760:"27a1cfb7",91819:"55eca4fb",91889:"8a0c6ffc",91971:"e770d4cb",92166:"59820d37",92192:"baa1a5c8",92279:"53e45c4a",92345:"db3f4472",92463:"80f304e0",92541:"762b4b09",92580:"604c2721",92886:"dee151ec",92906:"dd640a64",92977:"20e68412",93093:"6ecc84f1",93104:"8cb458e3",93117:"bc03d886",93124:"35ab44c4",93178:"7a581169",93200:"c0df696f",93387:"84a8aaf0",93564:"1f3f43e6",93658:"333ad072",93666:"158df98d",93677:"df5e2524",94039:"e9ff9e42",94242:"eccb3d7b",94445:"e1030b17",94808:"2c7b16ac",95018:"b6495426",95043:"72489a78",95075:"44338c0c",95111:"a2299f5d",95170:"35e66818",95283:"27789056",95422:"227a34fc",95428:"2bd2023f",95480:"932559b0",95508:"b5a5a555",95551:"073885ef",95554:"7ef1ce2f",95738:"7cc6adf9",95808:"37f39392",95827:"8fa81f60",95847:"9bc46117",95885:"78346ac9",95901:"2274c648",95961:"41f6d804",96048:"e518c2a9",96054:"2e2223ba",96074:"a928bed9",96137:"d6a04eaf",96168:"484a5382",96298:"82b1a655",96316:"f236fce4",96470:"a21d11e8",96550:"b00b68e9",96636:"fdbf288b",96766:"1dee2add",96915:"53b3a491",96965:"9e8acb87",96994:"789d6a6d",97077:"30757c69",97221:"26ddd277",97466:"d5c4cef7",97480:"2d338cc2",97603:"b677e33e",97607:"44cf88f0",97878:"481b1f06",97920:"4c7533f0",97955:"65d2d330",97981:"119cfa67",97982:"291486e1",97984:"19e7d4ae",97987:"33cfc9f6",98004:"5ce25514",98054:"c7695051",98181:"af4daabe",98365:"c76820d1",98440:"23b7f55d",98476:"5714988c",98487:"ad9625fb",98518:"09d007b4",98558:"afc330a4",98698:"b91d74be",98707:"50a728f8",98758:"e0d77e2f",99023:"32e79cbb",99236:"4cdbecd4",99242:"a2ff24c8",99252:"eb0a3f89",99256:"156d1958",99369:"69fa0668",99384:"250f07b7",99444:"ea9bd2bf",99481:"fcd3ffac",99505:"4e489cbd",99524:"d74674cc",99537:"b63a4dc3",99582:"28b2a6f8",99776:"401719cb",99867:"8c1c78b7"}[c]+".js",r.miniCssF=c=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(c){if("object"==typeof window)return window}}(),r.o=(c,e)=>Object.prototype.hasOwnProperty.call(c,e),a={},f="@swan-io/docs:",r.l=(c,e,b,d)=>{if(a[c])a[c].push(e);else{var t,o;if(void 0!==b)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=a[c];if(delete a[c],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((c=>c(b))),e)return e(b)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=c=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(c,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(c,"__esModule",{value:!0})},r.p="/",r.gca=function(c){return c={11020189:"92977",16888267:"89126",17896441:"27918",23065245:"27534",37289545:"4624",39251080:"31895",40357306:"89955",46994613:"69301",47295864:"4222",54890881:"95043",60667150:"85642",61358661:"8557",64882008:"39610",74842326:"89525",80159696:"41335",86369399:"96636",86929204:"49770",88087531:"48216",93403402:"85925",95036120:"1978","3b1e8a04":"26","906be0f5":"188","537e891e":"197",ea98434a:"226","086f8d41":"338","7e4776c6":"383","7e418921":"464","0e645450":"525",b2c78190:"551","5d026d5b":"563","6ad82f9f":"598",c4a78fec:"618","99f09de0":"624","57afb12e":"819",cc624da4:"893","13c60c15":"1002","46ea937d":"1296","4003e254":"1440",a13e61a2:"1554","97bdb81e":"1569","24abe6c9":"1725","0726a80a":"1776","1cf8363a":"1792","56cdcb55":"1969",f5fed7b4:"2020","1f2cae39":"2139",f180e4fd:"2203",aeec9328:"2379","083b5ee8":"2624","97cecdc7":"2641",aebc2649:"2843","1eaf0a35":"2864",d0afdb2d:"2865",f0009b6d:"2867",da0b5971:"2933","06598b01":"2972","3aacd70e":"2987","73eb95b3":"3046","39bec462":"3047","127d0327":"3291","933633e8":"3459",c5d1a363:"3600","22a8b3e5":"3635","61eb9ea3":"3787","98e30f2f":"4074","50c72a68":"4121","261a3c4c":"4202","5404c6be":"4209",db7e6e07:"4261","1d792ce4":"4277","0dadcc1e":"4389","6d4bff2e":"4420",d6eb8501:"4487","45c3a72d":"4488",e21395a6:"4566","2d92d3d5":"4696","4e5e925f":"4754",cf577441:"4801","9cc83235":"4884","9b1e992b":"4903",f991dec4:"5007","964e7fd1":"5028",cca24708:"5263","9d6f8c56":"5375",fd528e1c:"5405",b612009c:"5584",c883a7d2:"5600","15f51de4":"5603","685e914e":"5647","4f0ea51f":"5728","21124f8f":"5810","6ce587a7":"5826","8dc06929":"6051","6b962ab1":"6202",ba3d63bb:"6267",ff7950bf:"6584",dd8a41d8:"6604","1d4593ba":"6753","2b931e2a":"6801","82d44727":"6950","25c39f22":"7059",a3fb4be0:"7096","8850d7c4":"7173","7f6f7401":"7207",d42050ab:"7285","6119656b":"7314","23095ca6":"7442",fa7407c8:"7560","11f9c043":"7685","9c17e59b":"7755",dc1c2387:"7890","65aea855":"7956","065500c2":"8196",d6be9dd8:"8489",d785bf34:"8619",ea02488d:"8707",c0ae11fb:"8719","95a967db":"8757",e9b66c06:"8839","314c70b6":"8850","8ecee473":"8884",c3c45dd1:"9060","231e519f":"9126",d125fffa:"9337",bc3592ca:"9595","3dc458f1":"9624",a61a29c6:"9630","5a7373d1":"9643","6f89da90":"9714",f59a48f5:"9720",a03b08dd:"9730","6d9cd1c7":"9773","8f507c52":"10230","6c071a02":"10278",c97ea729:"10388",c4cd5cb0:"10483",e799bcae:"10638",a0089c72:"10727",a8cae02b:"10770","099be5df":"10800","62ad48cd":"10814","83f52709":"10882",c22afb16:"10908",d5ccaf8c:"10963","26b44581":"10973",a32c2e8f:"11074",a403b8e5:"11145","63fc0890":"11153","0984c047":"11224",b6981fe2:"11303","52a00ac0":"11353","9f135918":"11475","108d6373":"11544",a19c031b:"11647",efa62701:"11651","51b8fc83":"11664",f52c0eca:"11796","8a7333e7":"12067",d647beeb:"12127","44f979a3":"12291","9bc0fec8":"12454","6239da7f":"12567",ba291cc5:"12653","34a4c1ef":"12658","0a9480b9":"12707",bbad6248:"12723","4fb704a5":"12743","1f6e0f09":"12760",c48e9267:"13511",af5ff4a8:"13592","680a02ad":"13629","4ae49aac":"13650","85a71def":"14025","2bd866c9":"14050","32b53397":"14061","4c3162b5":"14167",cdd15c63:"14733","7aacce42":"14840",c3f4f527:"14842",cc3efc88:"14914","885af34c":"15013","847878ab":"15052","52e0ffdd":"15180","1861b089":"15283","1b5a6a39":"15295","2314758f":"15299",b30e2096:"15378",ad09e4f2:"15579","81fcdb1a":"15592","5303177b":"15707","67a4571f":"15778",e254b817:"15913",d1eaeaed:"15971","09bc9840":"16077","9c9cb554":"16317",f87dd7c3:"16370",d4ebab5c:"16579","8bdfcaf4":"16633","7a283c56":"16672","5d71ce26":"16756","6c105199":"16759",c79960d7:"16762","0ddd1b1b":"16774","8cb31f65":"16872",e2ab92e6:"16901",abb82bb2:"17054",f4d6c510:"17134","10a1121f":"17155",e2294cb2:"17177","288ff6dd":"17347",a0ffd745:"17421",a5251a71:"17704","40c0f930":"17709","916e7802":"17797",c8dcf605:"17951","5ac43825":"18015","9951ca2b":"18034","988fba77":"18208",ada2d469:"18213","56b21ce1":"18335","25c0dc6d":"18443","9af30fc0":"18514",a8272bf5:"18530","3027b40c":"18545",c59dc8af:"18563","8015a322":"18598","9e41ed88":"18681","1e436d1a":"18757",b807fc4f:"18803",a7d26b7e:"18943","6162d70a":"18989",e31d0546:"18990","45dc364c":"18991","1e9fbabd":"19037","963b198d":"19070","0d899299":"19088","2acac63a":"19165","049b698e":"19283","2c8652ef":"19334","2d013051":"19394","6a4c1420":"19517",baa6e992:"19561",a7cbd17c:"19621",c18b3dd3:"19682","0e555118":"19726",fa05e9a5:"19981","0a89b070":"20057","2a99c066":"20078","839ba15c":"20092","39d45e0f":"20372","6c80d7a1":"20477","6f1a1ca8":"20504",b77877a9:"20534","3e43a2b2":"20535",a5f653a7:"20592","17187cda":"20623",b2e3041d:"20656",b4defd80:"20662","7e044534":"20773",bd79b770:"20930",a6798804:"20969","37eacde6":"21052",df994e82:"21064","10d6e584":"21092","48867f70":"21117",fab27b4b:"21130","8ab7b0cd":"21141","94c15580":"21252","889bb296":"21290",e397a29c:"21322",f35c768e:"21414",a30ec1ba:"21461","797a29cf":"21502",d5bd3fe5:"21524",df4f48df:"21661","2d934cf3":"21748","1df635da":"21830","8157c2dd":"21911",e4bec3b4:"21921",e6bb218f:"21964",ccb7b808:"22010",f27f83f6:"22022",f823c609:"22294","717eed18":"22341",d252dd99:"22495","5011814c":"22638","7cbcba93":"22645","6a1fc806":"22852","7390d34f":"22963","7639e195":"22992","4e1c7b49":"23022","225e92a1":"23054","370ba5bb":"23128","0b34dda5":"23221",effbb39b:"23327","60c8650b":"23418","79dba252":"23442","3dae3655":"23474","801281af":"23577","9a5fc07a":"23613",bc521218:"23637","4b910cd9":"23737","0c5a975b":"23778","6b67672f":"23798","69c976eb":"24079","1dccb938":"24082",d452ad1f:"24083","864a1832":"24132","5e7874ef":"24369",cec929a1:"24475","5ab9c5bb":"24506","51e24d73":"24564","1d4a58b2":"24617",d521ca07:"24722",a1694c7f:"24748",be177392:"24753",d816822b:"24758",b472f62c:"24881","68d59462":"24884","8da44a2f":"24938","969f08fc":"25056","75cd7400":"25118","9f8006c1":"25197","12f84441":"25264","2c65fa8f":"25290","7f277d92":"25332","425e8d85":"25398",acf6d009:"25453",a14955b7:"25562","0abe0fe0":"25588","4343afaa":"25781","2b4f8af7":"25942",e38dcdaf:"26094","9a42e497":"26101",c2aa9606:"26282","267cf944":"26354","116e6c65":"26381","36eb0943":"26698","9d4344f6":"26871",e17a71f3:"26971","4356cfc6":"27006","033b8e71":"27146",f84941ff:"27262",e9f7d2c3:"27309",adb2bd7f:"27363",d5dc8cd0:"27501",e4eca706:"27663","761392cf":"27678","64b0b10e":"27850","9905859b":"28100","20126dcc":"28290",b22c8d77:"28407","872b574f":"28432","0839c2f2":"28505",c20f32fe:"28644",a37b42b8:"28678","65439e23":"28926","52c5d90f":"28970","292e8373":"29025",f6b07c9c:"29043","2272e4a0":"29242","506b7af1":"29333",f7448900:"29336","5fdd6e70":"29473","95f798c9":"29497","1be78505":"29514","935b2aef":"29627","6c8b5710":"29650","4ec98ed4":"29654","05747eec":"29685","38e0aa1b":"29698","6a6856d7":"29728",aa49738c:"29751",fc9c7bcb:"29899",e398b309:"29998",a14bba07:"30010",d7fd2129:"30058",a1720262:"30089","4b49353c":"30115","5c56d4eb":"30147","317022e7":"30326","92a099f2":"30572","2618151e":"30735",e2bb2cb5:"30801","1931bcc3":"31029","8a0d38f2":"31074","23bab739":"31189","0a67da07":"31474",bdd2828a:"31500","95fc7c58":"31636","4129c5c1":"31752",e53b72e5:"31885","3f2d9761":"31907","43ec88e9":"32028","54ac0390":"32066","8ddac3e7":"32067",f4664bca:"32069","71bd3347":"32211","890ce2a7":"32310",a68e5d78:"32408","4b1cfb23":"32417",c587f49b:"32747",fe68b5e4:"32800",c65e1a11:"32845","05619c3b":"32900",f78aacb3:"33005","090ef090":"33031",bdd9896c:"33035",b180c4b3:"33036","1931fdd9":"33064",db09fed0:"33107","4139b91a":"33124",f5008ea7:"33229","6b3ff6cc":"33273",aeaf9c67:"33296",b4d7d4ad:"33308",fa784e22:"33392","3704b249":"33617",ecc7bc3e:"33892","4bfd2db8":"33898","1aa8ceda":"34071","4edc808e":"34173","815a3dac":"34204","520f27a2":"34236",e8fc3664:"34288",b6c80156:"34298","565c7e7a":"34522","014fea84":"34548",ecb406fd:"34579",e8f88bc2:"34607","92cbc932":"34641",f9761c5e:"34698",d54c413d:"34736",f7c61839:"34864","9c9f4b72":"34960","9a2c7022":"34991","310d826d":"35022","00c5a843":"35101","7c9ab105":"35133","6b418b9d":"35377",ce85cb6e:"35630","1e8bd5b0":"35679",b967ba9e:"35708",b3d49b53:"35730",b167da58:"35775","96dae183":"35874","1370613c":"35978","9b399d10":"35994","2a9cb50e":"36050",a3657298:"36052","88cfda8b":"36125","401f64d8":"36161","3c881dfe":"36282",cfa4d47c:"36299",b182ba5a:"36344","29beb3fc":"36364","13f01a8a":"36389",d0b8f6f2:"36420","531d36a8":"36516","37f62d04":"36557",f2936bbd:"36569",e41b2273:"36712",be3a27c1:"36776",dc535e8b:"36797",a0e83a2e:"36840",e8f1b8cc:"37366",e3090d6c:"37419","57a52ec7":"37501",ec80f0f8:"37581","89a0769b":"37644","8fa063df":"37775","0222bab5":"37897","7dc96604":"38073","43fc11eb":"38266",b9099eab:"38310","6355eb0e":"38369",c2c9f624:"38468",b6ca6818:"38491",e9754802:"38537",f2cad8f8:"38574",c8867ead:"38626","137c07e2":"38696","9a86d8cc":"38786","34c58755":"38793","01a29863":"38908",c6756e66:"39013","952b6790":"39160","6a9ba154":"39182",d913284c:"39242","511dcd27":"39260",c64a672c:"39515",bd3a40d0:"39586",bc0dc214:"39607",e12a3758:"39619","2da5c4d8":"39805","553ac137":"39821","0eb675f4":"39894",e50f849d:"39955","75933c16":"39961","4bac9b1f":"39978",a3bb5839:"40049",c1e74a4c:"40060","9a89681b":"40086",bfc68003:"40323","16eb2325":"40333","8de80b01":"40350","75bfabaf":"40358",bb87ec56:"40543","0f6f90b2":"40905","18612f1d":"41085",bbeccb15:"41096","228df3ee":"41103","354a9724":"41104","4e658f9f":"41217","990c7218":"41348","3a50ac54":"41403","564774e4":"41408","34a00c10":"41409","1cecf61d":"41444",f5341953:"41476","4c412ed3":"41653",a6c97d01:"41735","88bdac60":"41736","0b34e84c":"41772","9625e3cf":"41832",b3dbcea3:"41909",cdac7eee:"42654","5fb625f6":"42689","59733b92":"42801","816e92e0":"42827","6dff6091":"43055",f9500687:"43092",b76fe286:"43152",aba58f6c:"43524","5acbe74d":"43557",e2a45f08:"43585","06e611a4":"43638",dc3d7fec:"43688","1632ccbd":"43696","7eb8af8a":"43792",b8583e9d:"43899","9cb826bf":"43989",cf96f01e:"44326",ac53eefd:"44339",ce76d2d2:"44345",b8eded90:"44450","09ab147a":"44666","6494d608":"44705","2c586235":"44909",bf268afd:"45019","473c41fb":"45074","6058e000":"45137",fb37a63f:"45230","8428dc8e":"45357",b183078b:"45384",fca10f8f:"45504","99dcad14":"45661","5e2ed9e0":"45784","9562f221":"45785","522ef36b":"45860","9ba75874":"45879","329d1cb3":"45910",d037a7a8:"45938","0d45fbb6":"45954",bf5b21c2:"45960","46f7fadb":"45997",d73d1478:"46003","0d97815c":"46532",ebb8b189:"46550","12d9b1bd":"46694","33ddb308":"46784","52d7d962":"46808",cb228c6f:"46908","3f613908":"47044",b615932b:"47104","4ad894f8":"47315","14b34cf0":"47357","63089e85":"47380","1ac3e25d":"47457",afe3715f:"47497",b9b4cc70:"47675","427b33e3":"47682","6f86928c":"47706","36121d87":"47730","10109baf":"47826","7c63c948":"47844",afa13d6c:"47901",b808e4e2:"48024","01def2f0":"48173","98ad38c6":"48243","2a49ba60":"48244",a175cf8b:"48304",b02f9910:"48384","2dedc8a4":"48541",a3e8cdfd:"48604",ff16d4d9:"48745","956b4570":"48783","5dfde814":"48817","1cc5ecbe":"49018","8750ec25":"49020","90f9c342":"49058","466913f7":"49070","4e721e97":"49076",adcc1d8e:"49139","3685cb1b":"49284","3a277a94":"49450",fb9b5d58:"49473","2bc58688":"49547","0891475e":"49581","3f5a9aec":"49611","7cf026eb":"49660",a671d179:"49701",fabd6154:"49885","042e442b":"49893",a06c4f73:"49998",fb2f18e8:"50001",dacd0a27:"50094","29c4964b":"50103",fe23e6b8:"50154",e02048e8:"50472",ce404f5b:"50598","644a76c8":"50629","2b52c7ce":"50703","121548f7":"50901",d0321f76:"50931","31b043b0":"50996","6f799ed7":"51201","99eee64d":"51211",e659bcf2:"51297","1fe18e32":"51301","63a20395":"51388","00deb6ac":"51427","18d02db7":"51440",fccf4da8:"51586","81cdb831":"51623","1ae90838":"51637","228e0e4a":"51760","3a558158":"51880",e820cfef:"52060","4d564705":"52137",ae9e0374:"52205","3b8c5879":"52289",e3716ac0:"52303","97b652a2":"52351",fbc04c9c:"52412","3eb0e82d":"52467","5d918b0d":"52645","17f8d39f":"52720",c52d395c:"52947","6e4ce4c4":"52969",e6e5635e:"53072","85f27db4":"53118","278ca12b":"53124","723df87b":"53172","83429edb":"53218","91c3c2b4":"53378",cfef71aa:"53418","8604e9d1":"53511",ad555afc:"53622",af646d81:"53698",daa78cd9:"53873",c2c02732:"53896","291af9ca":"53897",b3ffaa5d:"53946",c53da6e2:"53956",eea5c50e:"54068","4ee205e8":"54149","0bb30126":"54157",e3ae4459:"54174","2c48271a":"54317",f797c0d1:"54396",a5782e6c:"54543","4bd5222a":"54781",b6e1792b:"54895",e78fce63:"54928","88ce8468":"54992","7412879b":"55030","4d5fcd64":"55126","0bb5cb3b":"55133",a6ce14aa:"55165","2642e3b9":"55207","16756a68":"55239",a5d8d2c0:"55251","15e029d2":"55362","7113b392":"55417",cd9fcd8b:"55470","278c3025":"55474",c12755ef:"55488",e17f4cbd:"55793","0f276f47":"55846",ac7a7d4b:"55940","899eb281":"55968","404bc1a3":"56124","6162ad7c":"56192","9281c204":"56373","0d3ce22a":"56469","2b017db6":"56584","34ba053d":"56640",d541116e:"56976","75f7345d":"57045","54e35760":"57252","50d0703e":"57291","5c8f4dd6":"57316",fe1d7d76:"57355",f7dd5460:"57372","5e0eddb9":"57411","55ec9319":"57477",c14439a5:"57511",c2cc4b3d:"57596","3c721eea":"57679","55c9ddce":"57698","085530f7":"57855",b8e222b7:"57867","77ec448e":"58148","63f6e2ef":"58188","1bdd8362":"58228","19b24147":"58299",a55d2b67:"58300",c29d33ae:"58388",f09de917:"58504",faebfef1:"58533","01eff7bb":"58588","14e8926f":"58671",cc6e8ac5:"58703","8eeac047":"58902","2ae384d0":"58951","1441571f":"58954",dc75d149:"59003",e414dbe6:"59009","91a669f2":"59020","8f371e5f":"59032","2563e8e0":"59065","25185f0e":"59148","3bc32dbb":"59219",e85ac3d2:"59260","295bad4c":"59293","2dc1fad6":"59320","247783bb":"59334","07cc5864":"59407","88c4a046":"59487","042b05c7":"59522","033aa841":"59590","12a4832c":"59700",c651b04a:"59782","80f93b6a":"60019","71b18881":"60023",bd05747c:"60070","026d8b4a":"60344","19dd9055":"60418","0c7f2f7d":"60553",df9d2e0e:"60722",a6278bdf:"60746",e90bfa87:"60800","3466985c":"60829",cc0a4513:"60843","0a58537d":"60899","8f735039":"61022",fd6d72c8:"61210",d1bcbecc:"61324",b1843cea:"61385","89b93789":"61427","319e16c8":"61683","4e18715a":"61691","19b75377":"61749",bbd11534:"61787","7fcaa117":"62000","6a4cfdc3":"62013",fde3b619:"62080","761c0fee":"62171","1070ce60":"62257","0ac661cd":"62530","88f0c610":"62656","6ed227de":"62704","5db048a0":"62756","6f9fe13d":"62866",c24ffec6:"62886","0163d222":"62910",b10334f9:"62917","487820d5":"63152","2c444a10":"63274","0a55acc3":"63424",de0b42a2:"63767","6d8d2f2d":"63860",f79e1d52:"64065","4f2a10e5":"64129","4d78e6a7":"64172",d2ad78df:"64231","63bf94b5":"64339",e5798c32:"64441","6c6a3c28":"64509",cb3894f2:"64633","5561a7b6":"64634","9c790e35":"64701","2b52cffa":"64955","2bb60e70":"64994",c519648a:"65134",d327bfa8:"65329",e5b99c64:"65350",c856918f:"65392","434eb2b3":"65546",c1d3d149:"65826","4fa7e8ec":"65952","1fb294c0":"66050","4e3c9c36":"66053","6324826a":"66198","3a5b218f":"66221",c6c4f55e:"66235","56bbc919":"66288","59b068d1":"66385","867ce6c5":"66560","125c6f18":"66674","9b326bb9":"66730","2ad15ba3":"66865","1ffbea02":"66975","4463978c":"66983","5cdd0279":"66995",f33ae72c:"66997",a3f20d95:"67141",a408a83e:"67169","59d9644b":"67178","2d35682d":"67179","5f6d7dc2":"67395",b179e805:"67461","82378c3d":"67570",d79eea0f:"67571",fb8b85c0:"67630","5bc7d28f":"67715","015f3359":"67759",af5b8f37:"67983","5e8bc7eb":"68005",a8546f28:"68041","554e0e92":"68072","7c81aff9":"68257","855cc29f":"68317",ff332aec:"68428","94bf1f11":"68532","4c7d984b":"68567",ec258617:"68623",b93ce049:"68626","2093545b":"68632",dabd12eb:"68872","975678f9":"68883","9467a3a7":"68917","6f265f1e":"69089","83c14c5b":"69125","86be6eb7":"69131","52c0afd0":"69376","08bfe654":"69637",a21e3f2b:"69638","4971b70e":"69747","85b33b51":"69853",e6963609:"69859",dec461d7:"70049",c99c2808:"70247","6e1b0d5d":"70254","8357b658":"70262",dbb4b0dd:"70283","2f679eca":"70319",e740f973:"70322","4eda58a2":"70361","3c2019bf":"70466","581c1936":"70517","66f7d59f":"70710",fbf8a582:"70735","58d70cba":"70861","23c8d0ec":"70875",a852c08e:"71015","464f51d8":"71126","9efc327a":"71135","592a270e":"71165","3424d603":"71181","2075c0e7":"71235","50ddb176":"71292","2763779d":"71370","532df885":"71371","0e0784f8":"71822",cc4926bd:"72051",d72358c5:"72137","05847173":"72238",ff3d1153:"72260","43c15dd6":"72321","160f3a79":"72342","2cc3cbd0":"72418",cc51bb94:"72626",cfe23f40:"72782","7f490342":"72846",cb2c479a:"73080",b3f9dbb3:"73181",eb134d49:"73309",fe669216:"73407",deeedaab:"73481","95f72fa5":"73495",d3337921:"73708","49d02f2b":"73714","16af972d":"73788",b8b08371:"73855","2ae6ee92":"73907","98fad2e1":"73953","3a9ce421":"74134",d3d63dbd:"74181",b0e2212e:"74192","759e8857":"74398","953bfb97":"74404",e342c8de:"74455",e0d18a7f:"74459","1bc96b4f":"74498",fbcf7722:"74799",b591fba7:"74843","3d32fb4a":"74857",fa8b7820:"74919",ce2e9252:"74986","586f596e":"75012","8b060552":"75093","2a7e9090":"75161",dce33e1f:"75223","4f49b4a6":"75275",bcf3c208:"75634","0d7e0438":"75719","4343594b":"75730","2a38130d":"75746","5ce80a97":"75786","3f3bc418":"75812","8e99cb43":"75857","4cb8fa66":"75993","62ff3f98":"76015",baa2ddd1:"76042",efc08881:"76233",ea7a23e5:"76468","0f573e36":"76802","97f09500":"77053",aa19dd49:"77102","54d368d0":"77169",b9f191e0:"77243","175ab1e6":"77286","04fe8bc7":"77332",dbb0c5ba:"77375","735d0569":"77445",a7434565:"77645","8021ccb9":"77669",afb57966:"77722","5be0fa3d":"77792","86fd3823":"77943","611d7e33":"78107",b4031aab:"78112","9f6eb29d":"78197",feb1c55f:"78222","5eeb66fc":"78350","8af6147a":"78436","00d30b51":"78636","78a121f7":"78866","448e9ff0":"79096","39109a85":"79104",d74be7d9:"79162","07e92a52":"79260",ef3ff2c2:"79265",e40db110:"79274","00a77e21":"79286","8c7c8eb3":"79388","24fa4cec":"79398","1a3d40eb":"79418",bbba91a4:"79512","8c7ba56e":"79548","45e2ccab":"79652",e6724f00:"79783",b3e24b6b:"79792","8a1a46cf":"79916","3ccf320e":"79994","935f2afb":"80053","43039bb0":"80060","526c94fd":"80090","925ec2c4":"80142","33152f28":"80169","4fbefc11":"80237",f30e2f4e:"80309","8285bf0a":"80322","3378914f":"80534","2368976d":"80589","9c105a4a":"80631","2cc9756f":"80706",bba534cb:"80731","2b66fdf3":"80817","9a4b7ed4":"80831",ffe0d0d7:"80872",a1c220e1:"80906","61d1e172":"81093",fc11e017:"81177",fd0a352e:"81208","29a89901":"81242","30fab45c":"81269","2550b685":"81476",d6f53db0:"81502","6a61db4c":"81617",e3a94193:"81646","582cf9cf":"81650","3f6ccc4d":"81701",a8a098e3:"81743","1d717d5f":"81884","5e72b495":"82154","87963f8e":"82214",b49dfbe6:"82401","2a054627":"82788","68e7302e":"82833",bdc9175c:"82913",eead291e:"82918","779a5035":"82941",b8fc97f5:"83057","0846aa9c":"83096","6606b81d":"83105",c22b7e4d:"83153","55f3c723":"83157",da59ca95:"83337","31f6e61c":"83435",beeaecb2:"83447","92a4540d":"83576",c01d5add:"83593","007417dc":"83695",b225e9f7:"83787","18b7481c":"83819","025c3845":"83911","6ab254e3":"84084",e1b037a6:"84094","3603dc64":"84101",c9307803:"84109","67b9a9ed":"84275","016c99f5":"84342","2093a25c":"84533",ccbe36b5:"84589",d43711a2:"84609",e3bc6914:"84793",a1505666:"84816","9f063840":"84861","41da606f":"84890","720ef584":"84959","0e698270":"85054",e20e5b1b:"85198",b7a47829:"85235","6f230234":"85486",fb6fbcbc:"85510",f8817707:"85657",bb5adb3f:"85688","40500d46":"85731","9985b6b4":"85760","1e7bea2b":"86381","54b20349":"86407",d919af83:"86438","4c12bb41":"86461",a1d6df89:"86569","67e7a7a2":"86616",f6bb5feb:"86638","1ac80f48":"86706","32e1a604":"86842",bb1a22fe:"86845",e562837c:"86947","608605fe":"86965","537d16fa":"87311","77e0268b":"87399",a7de3171:"87401",b9583340:"87486","31fb3847":"87535","830d9274":"87631",def52b90:"87658","628f19ed":"87706","124cf492":"87762","3087f363":"87767","4f36b0ab":"88012","1800faa3":"88135",ba6c4f44:"88406","43bd0f3e":"88571",e7ffdf0e:"88733","7ea3161b":"88744","75bcd1ec":"88858",e86f1faf:"88877",b4cbc673:"88976","9f60fd43":"89183","533e4ee8":"89281","78be5594":"89343","17a3c4c7":"89563","179e41e0":"89608","4e42ba9b":"89633",a57c97e1:"89722",b511d978:"89744","59f94b0a":"89772","27ba56f5":"89780",d39426f1:"89781",e2c26865:"90032","3758fb0e":"90093",b7db8f42:"90318","686a27f5":"90353",a6c0c96a:"90551","3db4b834":"90645","92a67a5e":"90717",fa29f323:"90757","81617aef":"90758",e08af2f7:"90781",dcfeeef5:"90788","2b3d484b":"91002","6ef156d1":"91016","6faf837f":"91147","784cefee":"91170","57b3bd5a":"91234",c3b842f0:"91437",e14d3193:"91475",c3a56b2b:"91500","0c0856cf":"91645",a72e3859:"91667",de7187cd:"91692",cc1ec4e2:"91760",d82dae9c:"91819","78acccc5":"91889",dc306ea3:"91971",cc53792f:"92166","9aa8b2ce":"92192",e2f2321d:"92279","4493ef81":"92345","321507eb":"92463",a677fec3:"92541",c34595d4:"92580",e5331bbf:"92886","0b59f9d9":"92906","0fafb84a":"93093","95ae2e11":"93104",fec91b88:"93117","1a47e540":"93124","750bdf24":"93178",e35fe59d:"93387",d9db9575:"93564",ca92d177:"93658",d6c89a37:"93666",b5ae6a43:"93677","905d5f29":"94039","4bdf8047":"94242","485fd60f":"94445","7cb78d0e":"94808","56acf746":"95018","025c8e15":"95075","1b7953ef":"95111","5c00a2ae":"95170","8ba07a28":"95283","008d8ed8":"95422",b59ff28b:"95428",bd292e6b:"95480","9a1f0ffb":"95508",d6b34693:"95551",a4bba936:"95554",c7dee171:"95738",fa9f7ab7:"95808",b6607c60:"95827","579e796e":"95847","0a8b996c":"95885","39630c6f":"95901","2974c85a":"95961","063c6f4a":"96048",e9bd8d12:"96054","293b7ec8":"96074","3bfcb7ef":"96137","13052e62":"96168","731b568d":"96298","962c73d5":"96470",e6762b5d:"96550",d13d7913:"96766","463c6316":"96915",de3f1c9c:"96965","4eecffc4":"96994","7b44e488":"97077","06470666":"97221","64ca5894":"97466",d7d4ca84:"97603","2e5a906c":"97607","793d570b":"97878","1a4e3797":"97920",d941769a:"97955","88494be0":"97981","1b7f2ddb":"97982","3ee0fc6b":"97984","7b9635e1":"97987",fbc0a5af:"98004",f171655a:"98054","845352e9":"98181",ab40f74c:"98365","17c256d3":"98440","3708790d":"98476",be96c5c5:"98487",c2e1fe96:"98518","036bdd50":"98558","3bbd7fdc":"98698","5a9f8cc2":"98707",a10f0673:"98758","0120a125":"99023","5f623ea8":"99236","48d023ac":"99242",fb85aa06:"99252","2c72cb8a":"99256",a07ff668:"99369","6935d919":"99384","05b090b6":"99444",d4dc7dcd:"99481","4966510b":"99505","9f37195c":"99524",fd8bf6ff:"99537","0c1e2e5e":"99582","50f34778":"99776","1bc5c1c5":"99867"}[c]||c,r.p+r.u(c)},(()=>{var c={51303:0,40532:0};r.f.j=(e,b)=>{var a=r.o(c,e)?c[e]:void 0;if(0!==a)if(a)b.push(a[2]);else if(/^(40532|51303)$/.test(e))c[e]=0;else{var f=new Promise(((b,f)=>a=c[e]=[b,f]));b.push(a[2]=f);var d=r.p+r.u(e),t=new Error;r.l(d,(b=>{if(r.o(c,e)&&(0!==(a=c[e])&&(c[e]=void 0),a)){var f=b&&("load"===b.type?"missing":b.type),d=b&&b.target&&b.target.src;t.message="Loading chunk "+e+" failed.\n("+f+": "+d+")",t.name="ChunkLoadError",t.type=f,t.request=d,a[1](t)}}),"chunk-"+e,e)}},r.O.j=e=>0===c[e];var e=(e,b)=>{var a,f,d=b[0],t=b[1],o=b[2],n=0;if(d.some((e=>0!==c[e]))){for(a in t)r.o(t,a)&&(r.m[a]=t[a]);if(o)var i=o(r)}for(e&&e(b);n{"use strict";var c,e,b,a,f,d={},t={};function r(c){var e=t[c];if(void 0!==e)return e.exports;var b=t[c]={id:c,loaded:!1,exports:{}};return d[c].call(b.exports,b,b.exports,r),b.loaded=!0,b.exports}r.m=d,r.c=t,c=[],r.O=(e,b,a,f)=>{if(!b){var d=1/0;for(i=0;i=f)&&Object.keys(r.O).every((c=>r.O[c](b[o])))?b.splice(o--,1):(t=!1,f0&&c[i-1][2]>f;i--)c[i]=c[i-1];c[i]=[b,a,f]},r.n=c=>{var e=c&&c.__esModule?()=>c.default:()=>c;return r.d(e,{a:e}),e},b=Object.getPrototypeOf?c=>Object.getPrototypeOf(c):c=>c.__proto__,r.t=function(c,a){if(1&a&&(c=this(c)),8&a)return c;if("object"==typeof c&&c){if(4&a&&c.__esModule)return c;if(16&a&&"function"==typeof c.then)return c}var f=Object.create(null);r.r(f);var d={};e=e||[null,b({}),b([]),b(b)];for(var t=2&a&&c;"object"==typeof t&&!~e.indexOf(t);t=b(t))Object.getOwnPropertyNames(t).forEach((e=>d[e]=()=>c[e]));return d.default=()=>c,r.d(f,d),f},r.d=(c,e)=>{for(var b in e)r.o(e,b)&&!r.o(c,b)&&Object.defineProperty(c,b,{enumerable:!0,get:e[b]})},r.f={},r.e=c=>Promise.all(Object.keys(r.f).reduce(((e,b)=>(r.f[b](c,e),e)),[])),r.u=c=>"assets/js/"+({26:"3b1e8a04",188:"906be0f5",197:"537e891e",226:"ea98434a",338:"086f8d41",383:"7e4776c6",464:"7e418921",525:"0e645450",551:"b2c78190",563:"5d026d5b",598:"6ad82f9f",618:"c4a78fec",624:"99f09de0",819:"57afb12e",893:"cc624da4",1002:"13c60c15",1296:"46ea937d",1440:"4003e254",1554:"a13e61a2",1569:"97bdb81e",1725:"24abe6c9",1776:"0726a80a",1792:"1cf8363a",1969:"56cdcb55",1978:"95036120",2020:"f5fed7b4",2139:"1f2cae39",2203:"f180e4fd",2379:"aeec9328",2624:"083b5ee8",2641:"97cecdc7",2843:"aebc2649",2864:"1eaf0a35",2865:"d0afdb2d",2867:"f0009b6d",2933:"da0b5971",2972:"06598b01",2987:"3aacd70e",3046:"73eb95b3",3047:"39bec462",3291:"127d0327",3459:"933633e8",3600:"c5d1a363",3635:"22a8b3e5",3787:"61eb9ea3",4074:"98e30f2f",4121:"50c72a68",4202:"261a3c4c",4209:"5404c6be",4222:"47295864",4261:"db7e6e07",4277:"1d792ce4",4389:"0dadcc1e",4420:"6d4bff2e",4487:"d6eb8501",4488:"45c3a72d",4566:"e21395a6",4624:"37289545",4696:"2d92d3d5",4754:"4e5e925f",4801:"cf577441",4884:"9cc83235",4903:"9b1e992b",5007:"f991dec4",5028:"964e7fd1",5263:"cca24708",5375:"9d6f8c56",5405:"fd528e1c",5584:"b612009c",5600:"c883a7d2",5603:"15f51de4",5647:"685e914e",5728:"4f0ea51f",5810:"21124f8f",5826:"6ce587a7",6051:"8dc06929",6202:"6b962ab1",6267:"ba3d63bb",6584:"ff7950bf",6604:"dd8a41d8",6753:"1d4593ba",6801:"2b931e2a",6950:"82d44727",7059:"25c39f22",7096:"a3fb4be0",7173:"8850d7c4",7207:"7f6f7401",7285:"d42050ab",7314:"6119656b",7442:"23095ca6",7560:"fa7407c8",7685:"11f9c043",7755:"9c17e59b",7890:"dc1c2387",7956:"65aea855",8196:"065500c2",8489:"d6be9dd8",8557:"61358661",8619:"d785bf34",8707:"ea02488d",8719:"c0ae11fb",8757:"95a967db",8839:"e9b66c06",8850:"314c70b6",8884:"8ecee473",9060:"c3c45dd1",9126:"231e519f",9337:"d125fffa",9595:"bc3592ca",9624:"3dc458f1",9630:"a61a29c6",9643:"5a7373d1",9714:"6f89da90",9720:"f59a48f5",9730:"a03b08dd",9773:"6d9cd1c7",10230:"8f507c52",10278:"6c071a02",10388:"c97ea729",10483:"c4cd5cb0",10638:"e799bcae",10727:"a0089c72",10770:"a8cae02b",10800:"099be5df",10814:"62ad48cd",10882:"83f52709",10908:"c22afb16",10963:"d5ccaf8c",10973:"26b44581",11074:"a32c2e8f",11145:"a403b8e5",11153:"63fc0890",11224:"0984c047",11303:"b6981fe2",11353:"52a00ac0",11475:"9f135918",11544:"108d6373",11647:"a19c031b",11651:"efa62701",11664:"51b8fc83",11796:"f52c0eca",12067:"8a7333e7",12127:"d647beeb",12291:"44f979a3",12454:"9bc0fec8",12567:"6239da7f",12653:"ba291cc5",12658:"34a4c1ef",12707:"0a9480b9",12723:"bbad6248",12743:"4fb704a5",12760:"1f6e0f09",13511:"c48e9267",13592:"af5ff4a8",13629:"680a02ad",13650:"4ae49aac",14025:"85a71def",14050:"2bd866c9",14061:"32b53397",14167:"4c3162b5",14733:"cdd15c63",14840:"7aacce42",14842:"c3f4f527",14914:"cc3efc88",15013:"885af34c",15052:"847878ab",15180:"52e0ffdd",15283:"1861b089",15295:"1b5a6a39",15299:"2314758f",15378:"b30e2096",15579:"ad09e4f2",15592:"81fcdb1a",15707:"5303177b",15778:"67a4571f",15913:"e254b817",15971:"d1eaeaed",16077:"09bc9840",16317:"9c9cb554",16370:"f87dd7c3",16579:"d4ebab5c",16633:"8bdfcaf4",16672:"7a283c56",16756:"5d71ce26",16759:"6c105199",16762:"c79960d7",16774:"0ddd1b1b",16872:"8cb31f65",16901:"e2ab92e6",17054:"abb82bb2",17134:"f4d6c510",17155:"10a1121f",17177:"e2294cb2",17347:"288ff6dd",17421:"a0ffd745",17704:"a5251a71",17709:"40c0f930",17797:"916e7802",17951:"c8dcf605",18015:"5ac43825",18034:"9951ca2b",18208:"988fba77",18213:"ada2d469",18335:"56b21ce1",18443:"25c0dc6d",18514:"9af30fc0",18530:"a8272bf5",18545:"3027b40c",18563:"c59dc8af",18598:"8015a322",18681:"9e41ed88",18757:"1e436d1a",18803:"b807fc4f",18943:"a7d26b7e",18989:"6162d70a",18990:"e31d0546",18991:"45dc364c",19037:"1e9fbabd",19070:"963b198d",19088:"0d899299",19165:"2acac63a",19283:"049b698e",19334:"2c8652ef",19394:"2d013051",19517:"6a4c1420",19561:"baa6e992",19621:"a7cbd17c",19682:"c18b3dd3",19726:"0e555118",19981:"fa05e9a5",20057:"0a89b070",20078:"2a99c066",20092:"839ba15c",20372:"39d45e0f",20477:"6c80d7a1",20504:"6f1a1ca8",20534:"b77877a9",20535:"3e43a2b2",20592:"a5f653a7",20623:"17187cda",20656:"b2e3041d",20662:"b4defd80",20773:"7e044534",20930:"bd79b770",20969:"a6798804",21052:"37eacde6",21064:"df994e82",21092:"10d6e584",21117:"48867f70",21130:"fab27b4b",21141:"8ab7b0cd",21252:"94c15580",21290:"889bb296",21322:"e397a29c",21414:"f35c768e",21461:"a30ec1ba",21502:"797a29cf",21524:"d5bd3fe5",21661:"df4f48df",21748:"2d934cf3",21830:"1df635da",21911:"8157c2dd",21921:"e4bec3b4",21964:"e6bb218f",22010:"ccb7b808",22022:"f27f83f6",22294:"f823c609",22341:"717eed18",22495:"d252dd99",22638:"5011814c",22645:"7cbcba93",22852:"6a1fc806",22963:"7390d34f",22992:"7639e195",23022:"4e1c7b49",23054:"225e92a1",23128:"370ba5bb",23221:"0b34dda5",23327:"effbb39b",23418:"60c8650b",23442:"79dba252",23474:"3dae3655",23577:"801281af",23613:"9a5fc07a",23637:"bc521218",23737:"4b910cd9",23778:"0c5a975b",23798:"6b67672f",24079:"69c976eb",24082:"1dccb938",24083:"d452ad1f",24132:"864a1832",24369:"5e7874ef",24475:"cec929a1",24506:"5ab9c5bb",24564:"51e24d73",24617:"1d4a58b2",24722:"d521ca07",24748:"a1694c7f",24753:"be177392",24758:"d816822b",24881:"b472f62c",24884:"68d59462",24938:"8da44a2f",25056:"969f08fc",25118:"75cd7400",25197:"9f8006c1",25264:"12f84441",25290:"2c65fa8f",25332:"7f277d92",25398:"425e8d85",25453:"acf6d009",25562:"a14955b7",25588:"0abe0fe0",25781:"4343afaa",25942:"2b4f8af7",26094:"e38dcdaf",26101:"9a42e497",26282:"c2aa9606",26354:"267cf944",26381:"116e6c65",26698:"36eb0943",26871:"9d4344f6",26971:"e17a71f3",27006:"4356cfc6",27146:"033b8e71",27262:"f84941ff",27309:"e9f7d2c3",27363:"adb2bd7f",27501:"d5dc8cd0",27534:"23065245",27663:"e4eca706",27678:"761392cf",27850:"64b0b10e",27918:"17896441",28100:"9905859b",28290:"20126dcc",28407:"b22c8d77",28432:"872b574f",28505:"0839c2f2",28644:"c20f32fe",28678:"a37b42b8",28926:"65439e23",28970:"52c5d90f",29025:"292e8373",29043:"f6b07c9c",29242:"2272e4a0",29333:"506b7af1",29336:"f7448900",29473:"5fdd6e70",29497:"95f798c9",29514:"1be78505",29627:"935b2aef",29650:"6c8b5710",29654:"4ec98ed4",29685:"05747eec",29698:"38e0aa1b",29728:"6a6856d7",29751:"aa49738c",29899:"fc9c7bcb",29998:"e398b309",30010:"a14bba07",30058:"d7fd2129",30089:"a1720262",30115:"4b49353c",30147:"5c56d4eb",30326:"317022e7",30572:"92a099f2",30735:"2618151e",30801:"e2bb2cb5",31029:"1931bcc3",31074:"8a0d38f2",31189:"23bab739",31474:"0a67da07",31500:"bdd2828a",31636:"95fc7c58",31752:"4129c5c1",31885:"e53b72e5",31895:"39251080",31907:"3f2d9761",32028:"43ec88e9",32066:"54ac0390",32067:"8ddac3e7",32069:"f4664bca",32211:"71bd3347",32310:"890ce2a7",32408:"a68e5d78",32417:"4b1cfb23",32747:"c587f49b",32800:"fe68b5e4",32845:"c65e1a11",32900:"05619c3b",33005:"f78aacb3",33031:"090ef090",33035:"bdd9896c",33036:"b180c4b3",33064:"1931fdd9",33107:"db09fed0",33124:"4139b91a",33229:"f5008ea7",33273:"6b3ff6cc",33296:"aeaf9c67",33308:"b4d7d4ad",33392:"fa784e22",33617:"3704b249",33892:"ecc7bc3e",33898:"4bfd2db8",34071:"1aa8ceda",34173:"4edc808e",34204:"815a3dac",34236:"520f27a2",34288:"e8fc3664",34298:"b6c80156",34522:"565c7e7a",34548:"014fea84",34579:"ecb406fd",34607:"e8f88bc2",34641:"92cbc932",34698:"f9761c5e",34736:"d54c413d",34864:"f7c61839",34960:"9c9f4b72",34991:"9a2c7022",35022:"310d826d",35101:"00c5a843",35133:"7c9ab105",35377:"6b418b9d",35630:"ce85cb6e",35679:"1e8bd5b0",35708:"b967ba9e",35730:"b3d49b53",35775:"b167da58",35874:"96dae183",35978:"1370613c",35994:"9b399d10",36050:"2a9cb50e",36052:"a3657298",36125:"88cfda8b",36161:"401f64d8",36282:"3c881dfe",36299:"cfa4d47c",36344:"b182ba5a",36364:"29beb3fc",36389:"13f01a8a",36420:"d0b8f6f2",36516:"531d36a8",36557:"37f62d04",36569:"f2936bbd",36712:"e41b2273",36776:"be3a27c1",36797:"dc535e8b",36840:"a0e83a2e",37366:"e8f1b8cc",37419:"e3090d6c",37501:"57a52ec7",37581:"ec80f0f8",37644:"89a0769b",37775:"8fa063df",37897:"0222bab5",38073:"7dc96604",38266:"43fc11eb",38310:"b9099eab",38369:"6355eb0e",38468:"c2c9f624",38491:"b6ca6818",38537:"e9754802",38574:"f2cad8f8",38626:"c8867ead",38696:"137c07e2",38786:"9a86d8cc",38793:"34c58755",38908:"01a29863",39013:"c6756e66",39160:"952b6790",39182:"6a9ba154",39242:"d913284c",39260:"511dcd27",39515:"c64a672c",39586:"bd3a40d0",39607:"bc0dc214",39610:"64882008",39619:"e12a3758",39805:"2da5c4d8",39821:"553ac137",39894:"0eb675f4",39955:"e50f849d",39961:"75933c16",39978:"4bac9b1f",40049:"a3bb5839",40060:"c1e74a4c",40086:"9a89681b",40323:"bfc68003",40333:"16eb2325",40350:"8de80b01",40358:"75bfabaf",40543:"bb87ec56",40905:"0f6f90b2",41085:"18612f1d",41096:"bbeccb15",41103:"228df3ee",41104:"354a9724",41217:"4e658f9f",41335:"80159696",41348:"990c7218",41403:"3a50ac54",41408:"564774e4",41409:"34a00c10",41444:"1cecf61d",41476:"f5341953",41653:"4c412ed3",41735:"a6c97d01",41736:"88bdac60",41772:"0b34e84c",41832:"9625e3cf",41909:"b3dbcea3",42654:"cdac7eee",42689:"5fb625f6",42801:"59733b92",42827:"816e92e0",43055:"6dff6091",43092:"f9500687",43152:"b76fe286",43524:"aba58f6c",43557:"5acbe74d",43585:"e2a45f08",43638:"06e611a4",43688:"dc3d7fec",43696:"1632ccbd",43792:"7eb8af8a",43899:"b8583e9d",43989:"9cb826bf",44326:"cf96f01e",44339:"ac53eefd",44345:"ce76d2d2",44450:"b8eded90",44666:"09ab147a",44705:"6494d608",44909:"2c586235",45019:"bf268afd",45074:"473c41fb",45137:"6058e000",45230:"fb37a63f",45357:"8428dc8e",45384:"b183078b",45504:"fca10f8f",45661:"99dcad14",45784:"5e2ed9e0",45785:"9562f221",45860:"522ef36b",45879:"9ba75874",45910:"329d1cb3",45938:"d037a7a8",45954:"0d45fbb6",45960:"bf5b21c2",45997:"46f7fadb",46003:"d73d1478",46532:"0d97815c",46550:"ebb8b189",46694:"12d9b1bd",46784:"33ddb308",46808:"52d7d962",46908:"cb228c6f",47044:"3f613908",47104:"b615932b",47315:"4ad894f8",47357:"14b34cf0",47380:"63089e85",47457:"1ac3e25d",47497:"afe3715f",47675:"b9b4cc70",47682:"427b33e3",47706:"6f86928c",47730:"36121d87",47826:"10109baf",47844:"7c63c948",47901:"afa13d6c",48024:"b808e4e2",48173:"01def2f0",48216:"88087531",48243:"98ad38c6",48244:"2a49ba60",48304:"a175cf8b",48384:"b02f9910",48541:"2dedc8a4",48604:"a3e8cdfd",48745:"ff16d4d9",48783:"956b4570",48817:"5dfde814",49018:"1cc5ecbe",49020:"8750ec25",49058:"90f9c342",49070:"466913f7",49076:"4e721e97",49139:"adcc1d8e",49284:"3685cb1b",49450:"3a277a94",49473:"fb9b5d58",49547:"2bc58688",49581:"0891475e",49611:"3f5a9aec",49660:"7cf026eb",49701:"a671d179",49770:"86929204",49885:"fabd6154",49893:"042e442b",49998:"a06c4f73",50001:"fb2f18e8",50094:"dacd0a27",50103:"29c4964b",50154:"fe23e6b8",50472:"e02048e8",50598:"ce404f5b",50629:"644a76c8",50703:"2b52c7ce",50901:"121548f7",50931:"d0321f76",50996:"31b043b0",51201:"6f799ed7",51211:"99eee64d",51297:"e659bcf2",51301:"1fe18e32",51388:"63a20395",51427:"00deb6ac",51440:"18d02db7",51586:"fccf4da8",51623:"81cdb831",51637:"1ae90838",51760:"228e0e4a",51880:"3a558158",52060:"e820cfef",52137:"4d564705",52205:"ae9e0374",52289:"3b8c5879",52303:"e3716ac0",52351:"97b652a2",52412:"fbc04c9c",52467:"3eb0e82d",52645:"5d918b0d",52720:"17f8d39f",52947:"c52d395c",52969:"6e4ce4c4",53072:"e6e5635e",53118:"85f27db4",53124:"278ca12b",53172:"723df87b",53218:"83429edb",53378:"91c3c2b4",53418:"cfef71aa",53511:"8604e9d1",53622:"ad555afc",53698:"af646d81",53873:"daa78cd9",53896:"c2c02732",53897:"291af9ca",53946:"b3ffaa5d",53956:"c53da6e2",54068:"eea5c50e",54149:"4ee205e8",54157:"0bb30126",54174:"e3ae4459",54317:"2c48271a",54396:"f797c0d1",54543:"a5782e6c",54781:"4bd5222a",54895:"b6e1792b",54928:"e78fce63",54992:"88ce8468",55030:"7412879b",55126:"4d5fcd64",55133:"0bb5cb3b",55165:"a6ce14aa",55207:"2642e3b9",55239:"16756a68",55251:"a5d8d2c0",55362:"15e029d2",55417:"7113b392",55470:"cd9fcd8b",55474:"278c3025",55488:"c12755ef",55793:"e17f4cbd",55846:"0f276f47",55940:"ac7a7d4b",55968:"899eb281",56124:"404bc1a3",56192:"6162ad7c",56373:"9281c204",56469:"0d3ce22a",56584:"2b017db6",56640:"34ba053d",56976:"d541116e",57045:"75f7345d",57252:"54e35760",57291:"50d0703e",57316:"5c8f4dd6",57355:"fe1d7d76",57372:"f7dd5460",57411:"5e0eddb9",57477:"55ec9319",57511:"c14439a5",57596:"c2cc4b3d",57679:"3c721eea",57698:"55c9ddce",57855:"085530f7",57867:"b8e222b7",58148:"77ec448e",58188:"63f6e2ef",58228:"1bdd8362",58299:"19b24147",58300:"a55d2b67",58388:"c29d33ae",58504:"f09de917",58533:"faebfef1",58588:"01eff7bb",58671:"14e8926f",58703:"cc6e8ac5",58902:"8eeac047",58951:"2ae384d0",58954:"1441571f",59003:"dc75d149",59009:"e414dbe6",59020:"91a669f2",59032:"8f371e5f",59065:"2563e8e0",59148:"25185f0e",59219:"3bc32dbb",59260:"e85ac3d2",59293:"295bad4c",59320:"2dc1fad6",59334:"247783bb",59407:"07cc5864",59487:"88c4a046",59522:"042b05c7",59590:"033aa841",59700:"12a4832c",59782:"c651b04a",60019:"80f93b6a",60023:"71b18881",60070:"bd05747c",60344:"026d8b4a",60418:"19dd9055",60553:"0c7f2f7d",60722:"df9d2e0e",60746:"a6278bdf",60800:"e90bfa87",60829:"3466985c",60843:"cc0a4513",60899:"0a58537d",61022:"8f735039",61210:"fd6d72c8",61324:"d1bcbecc",61385:"b1843cea",61427:"89b93789",61683:"319e16c8",61691:"4e18715a",61749:"19b75377",61787:"bbd11534",62e3:"7fcaa117",62013:"6a4cfdc3",62080:"fde3b619",62171:"761c0fee",62257:"1070ce60",62530:"0ac661cd",62656:"88f0c610",62704:"6ed227de",62756:"5db048a0",62866:"6f9fe13d",62886:"c24ffec6",62910:"0163d222",62917:"b10334f9",63152:"487820d5",63274:"2c444a10",63424:"0a55acc3",63767:"de0b42a2",63860:"6d8d2f2d",64065:"f79e1d52",64129:"4f2a10e5",64172:"4d78e6a7",64231:"d2ad78df",64339:"63bf94b5",64441:"e5798c32",64509:"6c6a3c28",64633:"cb3894f2",64634:"5561a7b6",64701:"9c790e35",64955:"2b52cffa",64994:"2bb60e70",65134:"c519648a",65329:"d327bfa8",65350:"e5b99c64",65392:"c856918f",65546:"434eb2b3",65826:"c1d3d149",65952:"4fa7e8ec",66050:"1fb294c0",66053:"4e3c9c36",66198:"6324826a",66221:"3a5b218f",66235:"c6c4f55e",66288:"56bbc919",66385:"59b068d1",66560:"867ce6c5",66674:"125c6f18",66730:"9b326bb9",66865:"2ad15ba3",66975:"1ffbea02",66983:"4463978c",66995:"5cdd0279",66997:"f33ae72c",67141:"a3f20d95",67169:"a408a83e",67178:"59d9644b",67179:"2d35682d",67395:"5f6d7dc2",67461:"b179e805",67570:"82378c3d",67571:"d79eea0f",67630:"fb8b85c0",67715:"5bc7d28f",67759:"015f3359",67983:"af5b8f37",68005:"5e8bc7eb",68041:"a8546f28",68072:"554e0e92",68257:"7c81aff9",68317:"855cc29f",68428:"ff332aec",68532:"94bf1f11",68567:"4c7d984b",68623:"ec258617",68626:"b93ce049",68632:"2093545b",68872:"dabd12eb",68883:"975678f9",68917:"9467a3a7",69089:"6f265f1e",69125:"83c14c5b",69131:"86be6eb7",69301:"46994613",69376:"52c0afd0",69637:"08bfe654",69638:"a21e3f2b",69747:"4971b70e",69853:"85b33b51",69859:"e6963609",70049:"dec461d7",70247:"c99c2808",70254:"6e1b0d5d",70262:"8357b658",70283:"dbb4b0dd",70319:"2f679eca",70322:"e740f973",70361:"4eda58a2",70466:"3c2019bf",70517:"581c1936",70710:"66f7d59f",70735:"fbf8a582",70861:"58d70cba",70875:"23c8d0ec",71015:"a852c08e",71126:"464f51d8",71135:"9efc327a",71165:"592a270e",71181:"3424d603",71235:"2075c0e7",71292:"50ddb176",71370:"2763779d",71371:"532df885",71822:"0e0784f8",72051:"cc4926bd",72137:"d72358c5",72238:"05847173",72260:"ff3d1153",72321:"43c15dd6",72342:"160f3a79",72418:"2cc3cbd0",72626:"cc51bb94",72782:"cfe23f40",72846:"7f490342",73080:"cb2c479a",73181:"b3f9dbb3",73309:"eb134d49",73407:"fe669216",73481:"deeedaab",73495:"95f72fa5",73708:"d3337921",73714:"49d02f2b",73788:"16af972d",73855:"b8b08371",73907:"2ae6ee92",73953:"98fad2e1",74134:"3a9ce421",74181:"d3d63dbd",74192:"b0e2212e",74398:"759e8857",74404:"953bfb97",74455:"e342c8de",74459:"e0d18a7f",74498:"1bc96b4f",74799:"fbcf7722",74843:"b591fba7",74857:"3d32fb4a",74919:"fa8b7820",74986:"ce2e9252",75012:"586f596e",75093:"8b060552",75161:"2a7e9090",75223:"dce33e1f",75275:"4f49b4a6",75634:"bcf3c208",75719:"0d7e0438",75730:"4343594b",75746:"2a38130d",75786:"5ce80a97",75812:"3f3bc418",75857:"8e99cb43",75993:"4cb8fa66",76015:"62ff3f98",76042:"baa2ddd1",76233:"efc08881",76468:"ea7a23e5",76802:"0f573e36",77053:"97f09500",77102:"aa19dd49",77169:"54d368d0",77243:"b9f191e0",77286:"175ab1e6",77332:"04fe8bc7",77375:"dbb0c5ba",77445:"735d0569",77645:"a7434565",77669:"8021ccb9",77722:"afb57966",77792:"5be0fa3d",77943:"86fd3823",78107:"611d7e33",78112:"b4031aab",78197:"9f6eb29d",78222:"feb1c55f",78350:"5eeb66fc",78436:"8af6147a",78636:"00d30b51",78866:"78a121f7",79096:"448e9ff0",79104:"39109a85",79162:"d74be7d9",79260:"07e92a52",79265:"ef3ff2c2",79274:"e40db110",79286:"00a77e21",79388:"8c7c8eb3",79398:"24fa4cec",79418:"1a3d40eb",79512:"bbba91a4",79548:"8c7ba56e",79652:"45e2ccab",79783:"e6724f00",79792:"b3e24b6b",79916:"8a1a46cf",79994:"3ccf320e",80053:"935f2afb",80060:"43039bb0",80090:"526c94fd",80142:"925ec2c4",80169:"33152f28",80237:"4fbefc11",80309:"f30e2f4e",80322:"8285bf0a",80534:"3378914f",80589:"2368976d",80631:"9c105a4a",80706:"2cc9756f",80731:"bba534cb",80817:"2b66fdf3",80831:"9a4b7ed4",80872:"ffe0d0d7",80906:"a1c220e1",81093:"61d1e172",81177:"fc11e017",81208:"fd0a352e",81242:"29a89901",81269:"30fab45c",81476:"2550b685",81502:"d6f53db0",81617:"6a61db4c",81646:"e3a94193",81650:"582cf9cf",81701:"3f6ccc4d",81743:"a8a098e3",81884:"1d717d5f",82154:"5e72b495",82214:"87963f8e",82401:"b49dfbe6",82788:"2a054627",82833:"68e7302e",82913:"bdc9175c",82918:"eead291e",82941:"779a5035",83057:"b8fc97f5",83096:"0846aa9c",83105:"6606b81d",83153:"c22b7e4d",83157:"55f3c723",83337:"da59ca95",83435:"31f6e61c",83447:"beeaecb2",83576:"92a4540d",83593:"c01d5add",83695:"007417dc",83787:"b225e9f7",83819:"18b7481c",83911:"025c3845",84084:"6ab254e3",84094:"e1b037a6",84101:"3603dc64",84109:"c9307803",84275:"67b9a9ed",84342:"016c99f5",84533:"2093a25c",84589:"ccbe36b5",84609:"d43711a2",84793:"e3bc6914",84816:"a1505666",84861:"9f063840",84890:"41da606f",84959:"720ef584",85054:"0e698270",85198:"e20e5b1b",85235:"b7a47829",85486:"6f230234",85510:"fb6fbcbc",85642:"60667150",85657:"f8817707",85688:"bb5adb3f",85731:"40500d46",85760:"9985b6b4",85925:"93403402",86381:"1e7bea2b",86407:"54b20349",86438:"d919af83",86461:"4c12bb41",86569:"a1d6df89",86616:"67e7a7a2",86638:"f6bb5feb",86706:"1ac80f48",86842:"32e1a604",86845:"bb1a22fe",86947:"e562837c",86965:"608605fe",87311:"537d16fa",87399:"77e0268b",87401:"a7de3171",87486:"b9583340",87535:"31fb3847",87631:"830d9274",87658:"def52b90",87706:"628f19ed",87762:"124cf492",87767:"3087f363",88012:"4f36b0ab",88135:"1800faa3",88406:"ba6c4f44",88571:"43bd0f3e",88733:"e7ffdf0e",88744:"7ea3161b",88858:"75bcd1ec",88877:"e86f1faf",88976:"b4cbc673",89126:"16888267",89183:"9f60fd43",89281:"533e4ee8",89343:"78be5594",89525:"74842326",89563:"17a3c4c7",89608:"179e41e0",89633:"4e42ba9b",89722:"a57c97e1",89744:"b511d978",89772:"59f94b0a",89780:"27ba56f5",89781:"d39426f1",89955:"40357306",90032:"e2c26865",90093:"3758fb0e",90318:"b7db8f42",90353:"686a27f5",90551:"a6c0c96a",90645:"3db4b834",90717:"92a67a5e",90757:"fa29f323",90758:"81617aef",90781:"e08af2f7",90788:"dcfeeef5",91002:"2b3d484b",91016:"6ef156d1",91147:"6faf837f",91170:"784cefee",91234:"57b3bd5a",91437:"c3b842f0",91475:"e14d3193",91500:"c3a56b2b",91645:"0c0856cf",91667:"a72e3859",91692:"de7187cd",91760:"cc1ec4e2",91819:"d82dae9c",91889:"78acccc5",91971:"dc306ea3",92166:"cc53792f",92192:"9aa8b2ce",92279:"e2f2321d",92345:"4493ef81",92463:"321507eb",92541:"a677fec3",92580:"c34595d4",92886:"e5331bbf",92906:"0b59f9d9",92977:"11020189",93093:"0fafb84a",93104:"95ae2e11",93117:"fec91b88",93124:"1a47e540",93178:"750bdf24",93387:"e35fe59d",93564:"d9db9575",93658:"ca92d177",93666:"d6c89a37",93677:"b5ae6a43",94039:"905d5f29",94242:"4bdf8047",94445:"485fd60f",94808:"7cb78d0e",95018:"56acf746",95043:"54890881",95075:"025c8e15",95111:"1b7953ef",95170:"5c00a2ae",95283:"8ba07a28",95422:"008d8ed8",95428:"b59ff28b",95480:"bd292e6b",95508:"9a1f0ffb",95551:"d6b34693",95554:"a4bba936",95738:"c7dee171",95808:"fa9f7ab7",95827:"b6607c60",95847:"579e796e",95885:"0a8b996c",95901:"39630c6f",95961:"2974c85a",96048:"063c6f4a",96054:"e9bd8d12",96074:"293b7ec8",96137:"3bfcb7ef",96168:"13052e62",96298:"731b568d",96470:"962c73d5",96550:"e6762b5d",96636:"86369399",96766:"d13d7913",96915:"463c6316",96965:"de3f1c9c",96994:"4eecffc4",97077:"7b44e488",97221:"06470666",97466:"64ca5894",97603:"d7d4ca84",97607:"2e5a906c",97878:"793d570b",97920:"1a4e3797",97955:"d941769a",97981:"88494be0",97982:"1b7f2ddb",97984:"3ee0fc6b",97987:"7b9635e1",98004:"fbc0a5af",98054:"f171655a",98181:"845352e9",98365:"ab40f74c",98440:"17c256d3",98476:"3708790d",98487:"be96c5c5",98518:"c2e1fe96",98558:"036bdd50",98698:"3bbd7fdc",98707:"5a9f8cc2",98758:"a10f0673",99023:"0120a125",99236:"5f623ea8",99242:"48d023ac",99252:"fb85aa06",99256:"2c72cb8a",99369:"a07ff668",99384:"6935d919",99444:"05b090b6",99481:"d4dc7dcd",99505:"4966510b",99524:"9f37195c",99537:"fd8bf6ff",99582:"0c1e2e5e",99776:"50f34778",99867:"1bc5c1c5"}[c]||c)+"."+{26:"2e2e2d40",188:"f3fce124",197:"3fe28d52",226:"7d7506d1",338:"32b10e9f",383:"a30a3e5f",464:"bb4270b2",525:"6b684867",551:"7c033c3d",563:"29456321",598:"048e13c9",618:"895c2a01",624:"a0ede0df",724:"61cd8661",819:"fa96a5fc",893:"a1ec4917",1002:"435a77c5",1296:"95565614",1440:"ac028b2c",1554:"69ec5182",1569:"eb856577",1574:"f362b59d",1725:"99cc06e8",1776:"bd146d51",1792:"be424f4c",1969:"8405cd48",1978:"17c4b93f",2020:"e0131aed",2139:"ed585595",2203:"11e55646",2379:"4fcf0b82",2624:"a999a8ab",2641:"ccfebce7",2843:"0ce0017f",2864:"be8a9c87",2865:"acf2be21",2867:"8b2cc0b7",2933:"2113667d",2972:"3ce7b89c",2987:"356191be",3046:"5e94b212",3047:"d57ead06",3291:"3bb0f97b",3459:"9731eac8",3600:"0ac79a22",3635:"fd4e8746",3787:"af5b9608",4074:"813893e3",4121:"577939c4",4202:"d7a51594",4209:"83fd529a",4222:"9845b70b",4261:"7e1fe9a1",4277:"d780a055",4389:"056da692",4420:"d0613aa8",4487:"94cf1290",4488:"9b7ba1da",4566:"85ed7419",4624:"dd337e38",4696:"d31da03f",4754:"20976f37",4801:"f5963fb1",4884:"9399f7e8",4903:"aa5bec42",4972:"6f2a554b",5007:"53f09041",5028:"8a57ad8c",5263:"949d1a25",5375:"4765bd91",5405:"ee57a38e",5584:"5152778c",5600:"3989a907",5603:"f2df3478",5647:"4d6e541b",5728:"92605b66",5810:"372e3e87",5826:"79a9f373",6051:"32292e44",6202:"5168f6cd",6267:"2ff0e227",6584:"0180d5d7",6604:"27549a5c",6753:"0c2eac85",6801:"18847e46",6950:"f4322d13",7059:"7bee2cb5",7096:"51e350dc",7173:"930d8587",7207:"34557ee0",7285:"2c3bb157",7314:"bbabddd9",7442:"2a7ba622",7560:"4e38c118",7685:"b9b8d495",7755:"c749b63a",7890:"ef635735",7956:"cbf20299",8196:"36baac25",8489:"aca9aa62",8557:"2e82b18f",8619:"a275c20f",8707:"30ee84e3",8719:"4e111dfd",8757:"7479cab4",8839:"cb1650bb",8850:"efbc75c8",8884:"e25e0746",9060:"15ef201d",9126:"4471f2c8",9337:"d7d2c0c5",9595:"f45ee0d8",9624:"813eadcc",9630:"e73f1493",9643:"ebe148f7",9714:"cc61305d",9720:"434ae041",9730:"8bc3f4c5",9773:"03a055be",10230:"8fb633ff",10278:"d5deb0b6",10388:"c3ad0351",10483:"36a85800",10638:"a3d79a18",10727:"b553f187",10768:"9f9f442e",10770:"d17d5042",10800:"d1cd16df",10814:"882283a0",10882:"83012574",10908:"f025e8b4",10963:"31b8b53a",10973:"42498b90",11074:"5a9e55d2",11145:"b9127983",11153:"d502ee10",11224:"2f93eb11",11303:"f6110cbc",11353:"e0c01c31",11475:"08e699f7",11544:"e9eebbee",11647:"18a0859f",11651:"dc23dcd1",11664:"863d1432",11796:"9b57d5fc",12067:"e06e134d",12127:"a7bae4d0",12291:"60717462",12454:"80aa4000",12567:"0adf99f7",12653:"b5f07e99",12658:"8f6d73d9",12707:"c03a0ed3",12723:"4bd69950",12743:"cf277668",12760:"b931f7b9",13511:"aafc09b1",13571:"fd584bc7",13592:"0b7a0dd7",13629:"97c75437",13650:"008acde6",14025:"6c67f319",14050:"7dc0213d",14061:"fdd9a2d7",14167:"87c07323",14733:"77d4ea3e",14840:"b8f7f6e5",14842:"f948616f",14914:"5b0753a8",15013:"15e6a123",15052:"8334ac5e",15180:"9d1b499a",15283:"5e22886c",15295:"60209ff3",15299:"d7883dec",15378:"20e07c98",15579:"448500cb",15592:"3ba82556",15707:"789de38e",15778:"d44c182c",15913:"26cc528d",15971:"e4519a53",16077:"c006ba63",16317:"13a797b8",16370:"99002720",16579:"c72b0d10",16633:"a835bc18",16672:"38f751ad",16756:"e1677ee3",16759:"c1125db4",16762:"724ba98e",16774:"8d6550b8",16872:"0d8bdb32",16901:"cadbada8",17054:"2e4be7c7",17134:"8f42a6f1",17155:"6e840a67",17177:"4c2c9dc7",17347:"a8eff7ed",17421:"4b67d4d3",17481:"72657b20",17704:"3e5624ca",17709:"f816fa64",17797:"7a757662",17951:"284bb095",18015:"b6db7fe9",18034:"07ebe229",18208:"12617f08",18213:"e57e15a1",18335:"e7f49d1f",18443:"b2d7251a",18514:"4ce863ee",18530:"d2a80a73",18545:"665e455f",18563:"44cb1533",18598:"62cf62c1",18681:"27a77fe7",18757:"b4f109e3",18803:"d894a08b",18894:"ab503a98",18943:"8b739018",18989:"91c12b77",18990:"6dc98016",18991:"4e703d1c",19037:"b497f5e7",19070:"d21b9743",19088:"d5e6be91",19165:"24346565",19283:"97c719ce",19334:"5d81eae5",19394:"ba453488",19487:"61c58325",19517:"75f37528",19561:"3c5bc7e0",19621:"463608b5",19682:"52a92c16",19726:"5238454d",19744:"0b656cff",19981:"3bd71053",20057:"399b0262",20078:"d3422383",20092:"35588286",20372:"ffda2d2a",20477:"cd76695a",20504:"1773c1c8",20534:"091d5bec",20535:"2804a992",20592:"6d1385a9",20623:"973ca172",20656:"a36dd962",20662:"00eece41",20773:"52b968ce",20930:"41b715f5",20969:"f1ca434c",21052:"3bd01265",21064:"d0042643",21092:"47272528",21117:"961cb40c",21130:"b0126cb1",21141:"add6ef20",21252:"69128550",21290:"eeb323fa",21322:"5de4ec91",21414:"e8d7d56b",21461:"497f3df3",21502:"629e96cc",21524:"7960b767",21661:"db3677cd",21748:"8164ff18",21830:"3313f8f5",21911:"2580099b",21921:"e747285f",21964:"016bf5ee",22010:"22cb9d5e",22022:"b11cf23c",22294:"38fe9e4c",22341:"072da9f6",22495:"832cbde6",22638:"2a3035e8",22645:"4a08a6db",22852:"47109b45",22963:"335b4cbd",22992:"dee60447",23022:"aa116b7a",23054:"52b95b2c",23128:"e61e61ce",23221:"f320439d",23327:"8e05c3e3",23418:"adda618e",23442:"e84592d7",23474:"e969e733",23577:"e138d3f0",23613:"977a729f",23637:"d151d5c3",23737:"42312636",23778:"29665074",23798:"6c0aa906",24079:"22d15611",24082:"80ed9bb7",24083:"41ae870c",24132:"b3d37ee7",24178:"b9736b9c",24369:"57465c3e",24475:"39ce61ee",24506:"904c30d2",24564:"21134882",24617:"ed264594",24722:"2b0ecce0",24748:"44004b33",24753:"72b8f292",24758:"e88f4aed",24881:"94b280c1",24884:"067a13a9",24938:"b3296a8a",25056:"cb3c90d7",25118:"e31b1657",25197:"d0437979",25264:"05ad3ee4",25290:"07dab1f5",25332:"bd7328bd",25398:"31326937",25453:"c0a9505f",25562:"1c33aa14",25588:"86e02ae1",25781:"565d8e7a",25942:"ea05e1d5",26079:"7c4bb28f",26094:"5084e79e",26101:"455cba60",26105:"0028b786",26282:"c724df40",26354:"07033eb5",26381:"6477c89c",26698:"124a0216",26871:"ac28bf8b",26971:"2ba93431",27006:"65d10f33",27146:"8c048561",27262:"effc1ff1",27309:"12142dcc",27363:"ef8d7853",27501:"210cb4c5",27534:"05481b31",27588:"98e95b73",27663:"63e7b939",27678:"90bc39ee",27850:"7470a970",27918:"0cd27aec",28100:"c0bf7eb1",28290:"00626fd7",28407:"1114a95c",28432:"9026ffa0",28505:"286fe80c",28644:"4baee7dc",28678:"c57cd199",28926:"2be69459",28970:"9d1ce1c5",29025:"086abbbe",29043:"b4ee8020",29242:"611d512f",29333:"8c2f4719",29336:"22e0d3cb",29473:"0c93b429",29497:"3bd52d12",29514:"f68da1eb",29627:"c243283d",29650:"0c35bb1f",29654:"05c0b778",29685:"781ee0c1",29698:"53a0d6c3",29728:"023027ea",29751:"c5c5b16e",29899:"6077446d",29998:"73c5eab4",30010:"55557b5b",30058:"7f9d3018",30089:"c313a8cf",30115:"b12d0cdd",30147:"3bea2ca6",30326:"053950d9",30572:"173f9677",30735:"d9793191",30801:"d34153ca",31029:"921a2f17",31074:"c94afe8b",31189:"4d4b78df",31474:"039491e4",31500:"24ea237e",31636:"b1953863",31752:"8ce7e980",31885:"4ffa4f31",31895:"f19fff03",31907:"9c4ff058",32028:"547b5f33",32066:"26e66a48",32067:"91f0942a",32069:"9386a30a",32211:"653abf07",32310:"c64e3181",32408:"0adc48da",32417:"5fc0d5f2",32573:"ad1d44ac",32747:"5ccc4ae5",32800:"a0af3723",32845:"6f965de9",32900:"e4fa8564",33005:"dc156300",33031:"21801bd0",33035:"8e1f79cc",33036:"076f96c3",33064:"45ff6518",33107:"a7a7fecc",33124:"7ffa84c7",33229:"9f97d342",33273:"89486caa",33296:"a78db1b0",33308:"25d611aa",33392:"1064edd3",33617:"68b80e8a",33892:"aa3f541d",33898:"ae42d64f",34071:"b747c264",34173:"bc8a8105",34204:"61a2757a",34236:"5880be61",34288:"05c53a1d",34298:"897b239a",34522:"1f9c9eec",34548:"36ce9de8",34579:"e1d356c2",34607:"9b8445f0",34641:"9b856104",34698:"e1d70b6e",34736:"ef6f7f93",34864:"3a8b9a23",34960:"02433ab3",34991:"80316f24",35022:"b5d98990",35101:"d0e29181",35133:"afb50350",35377:"d4da0e5a",35630:"04b2ac27",35679:"a86cb65f",35708:"b9aba4f7",35730:"f8085cfc",35775:"eeb59660",35874:"25168567",35978:"32b18e07",35994:"46211b70",36050:"5917e79f",36052:"c088702e",36125:"807e34e2",36161:"4e52c673",36282:"86ef58a0",36299:"529d05b8",36344:"e0756ae4",36364:"fb10bdcf",36389:"704ac5b0",36420:"2ef0796b",36516:"6ed55d8d",36557:"1315d492",36569:"e346d380",36712:"29fcb16b",36776:"1ace43df",36797:"8c3d6f10",36840:"a6afa7a4",37366:"d945dec7",37419:"ca55ea81",37501:"9f98b1a0",37581:"de10e155",37644:"91083ab2",37775:"4a8894d0",37897:"8bcd22c2",38073:"51e27b82",38266:"0dcd989b",38310:"ba4baa9f",38369:"8f6feda6",38468:"f25b02c3",38491:"985d9095",38537:"1f909ad2",38574:"9779a16a",38626:"6f77d676",38696:"d15346b8",38786:"40a847d2",38793:"709a942a",38908:"fb6b36db",39013:"e4f7b1d8",39160:"ab03c6c5",39182:"d21bb929",39242:"b4fa28c9",39260:"898330e9",39515:"3132d067",39586:"2bc435c7",39607:"a4eb8b4a",39610:"257b15bb",39619:"0505a5d2",39805:"455cf824",39821:"001ca72e",39894:"bd6a0a56",39955:"12309cea",39961:"28348efd",39978:"6e8631c0",40049:"e90ede11",40060:"f717c2f8",40086:"bd112efa",40323:"f24941ea",40333:"030e1b66",40350:"977a24ee",40358:"bd637838",40543:"54575388",40905:"d9ac5e9d",41085:"718cd2eb",41096:"5139357c",41103:"739a4ed6",41104:"6414a86d",41217:"59d75392",41335:"42d9e08d",41348:"c32cd089",41403:"9b732a24",41408:"11e80298",41409:"4fc0264c",41444:"1b3165ee",41476:"80614a65",41653:"37e3a49b",41735:"075ed52b",41736:"83c70b4c",41772:"efcb8ca1",41832:"e55d8ce4",41909:"43d8ed23",42098:"df9c8b90",42654:"ba51b6c8",42689:"976384d9",42801:"08d8ce37",42827:"497cdb6d",43055:"345e9baf",43092:"84fc389f",43152:"162908b0",43524:"12d4ac62",43557:"0636d48a",43585:"ee223613",43638:"107bd1a6",43688:"9dcaf722",43696:"8be46aff",43792:"01f5082f",43899:"b0c24462",43989:"5b1db205",44326:"dc618ebf",44339:"666524af",44345:"8c2085c0",44450:"282f4c5d",44666:"374b7d82",44705:"0cb3dcd6",44909:"257ebcd1",45019:"130fd343",45074:"440bc37f",45092:"049ef51c",45137:"d9598802",45230:"067148e9",45357:"22f9f63b",45384:"f91bd69b",45504:"90dac8fd",45661:"3f0b34aa",45784:"ea60c27c",45785:"bdd0b355",45860:"a795a8c2",45879:"30c02d06",45910:"592a858b",45938:"0feca01f",45954:"a054ab75",45960:"a6829d39",45997:"3750752e",46003:"dbc18d33",46532:"2fd91201",46550:"e8940713",46694:"9954453d",46784:"63f0b3d2",46808:"494fe7ac",46908:"9141f5d1",46945:"b9c02393",47044:"f8cfd1e5",47104:"330c9459",47315:"44066121",47357:"3c7515ae",47380:"b39229ad",47457:"c018a1b8",47497:"d4a6d559",47675:"c4ad702c",47682:"c3801ed8",47706:"20fe8154",47724:"54acbd95",47730:"c7eba3b5",47826:"9ab41fcf",47844:"fc8eec02",47901:"7bc91270",48024:"4574cafb",48173:"4a541f8d",48216:"ed8ca11b",48243:"1d46d1e7",48244:"81a58839",48304:"61216a83",48384:"916bb925",48541:"cd45a01a",48604:"983a470f",48745:"531dbd5a",48783:"6b2deb5d",48817:"c866bde0",49018:"fee7ae00",49020:"0238475b",49058:"fa24aa81",49070:"6f3d06dd",49076:"b3835c00",49139:"40db9a2d",49284:"f33237d9",49450:"c986efa5",49473:"e3f735c1",49547:"507fb2c8",49581:"a25e05d1",49611:"de8db0e4",49660:"8c8b57f0",49701:"bcaa5d54",49770:"28e5e959",49885:"c82e8910",49893:"f1ec195b",49998:"1c1ad747",50001:"2d28229d",50094:"6b334c11",50103:"d8b62bd8",50154:"0ca71e93",50472:"0383414d",50598:"de3c8388",50629:"32bf5ad6",50703:"eef3e040",50901:"a4412671",50931:"1588b18b",50996:"22d306f6",51201:"fb3766af",51211:"2d1c4642",51297:"66fa8c75",51301:"931802f6",51388:"163d52d1",51427:"48e41f27",51440:"d310f38c",51586:"bc2603f2",51623:"7413074e",51637:"6f403746",51760:"3982291f",51880:"bfb1c458",52060:"f482c2a8",52137:"a4540e02",52198:"bfdb2ef1",52205:"e97dad6d",52289:"76042967",52303:"42bd8ee9",52351:"7b8f8fee",52412:"f1dcc897",52467:"8d606401",52645:"71c881d0",52720:"d29b15ae",52947:"f9496ea8",52969:"0feccd95",53072:"b5b0636d",53118:"9d408569",53124:"ab65cd6e",53172:"65eeac7d",53218:"1a1d9179",53378:"7beaf063",53418:"8a752056",53511:"77cd5cb1",53622:"c3d5716f",53698:"15195224",53873:"f816a2e2",53896:"18cc04e2",53897:"6df77872",53946:"5006e2d4",53956:"3d085682",54068:"e69dbe79",54149:"808c5341",54157:"b17f7850",54174:"5cecab18",54317:"f1bbd900",54396:"4587bdc6",54543:"569712ab",54781:"fcae3271",54895:"11a869e2",54928:"93ce8a0f",54980:"d1159c54",54992:"0c86496e",55030:"e9bea07e",55126:"8a086da5",55133:"dbb99ea0",55165:"49f59014",55207:"38033cb7",55239:"1f23ecf4",55251:"af42ee75",55362:"a4d33f0a",55417:"abb783a2",55470:"f835719f",55474:"3cb87607",55488:"e0b95d74",55739:"0f376ce5",55793:"3b3535ba",55846:"cd17497c",55940:"fe0b74d4",55968:"1ce13225",56124:"0dd8c0fb",56192:"a63ba040",56373:"6494837b",56469:"76a9317d",56584:"e95e569a",56640:"9f40a20d",56976:"8b1a03f0",57045:"02a7fe96",57252:"3fe11bdf",57291:"91538b9a",57316:"d8f1c6d8",57355:"2f0df212",57372:"ec080a45",57411:"cae223a1",57471:"c007c502",57477:"d6a4e3ff",57511:"c706cd40",57596:"22af1c99",57679:"e62b6088",57698:"4169bcd9",57855:"6199b352",57867:"c2cff559",58148:"21f32f66",58188:"ea733d8d",58228:"100c6abd",58299:"47d604d6",58300:"b1ed2148",58388:"d5609d26",58504:"750ef235",58533:"d596895a",58588:"666ae3c2",58671:"f4f2186f",58703:"81b8a279",58902:"cf71b301",58951:"341a2e39",58954:"b27bba36",59003:"60270ed4",59009:"b3fa3678",59020:"7f946067",59032:"c0657eaa",59065:"ed21197c",59148:"65d36ff4",59219:"ab899a1c",59260:"733d80a3",59293:"ab163170",59320:"77a16165",59334:"33dd5c2d",59407:"1ef8407c",59487:"a495dafa",59522:"8bd43a05",59590:"b090eb80",59700:"266c7656",59782:"5d99c00d",60019:"ed736a66",60023:"f4a0d19e",60070:"935ff3be",60344:"916817f1",60418:"e7c76945",60553:"7d0afea5",60722:"1f75d95d",60746:"e64a43ed",60800:"c6327bc7",60829:"36d85c88",60843:"ac3aa644",60845:"cd615554",60899:"5a602931",61022:"b1714da1",61210:"bd4b696c",61324:"daa91a6f",61385:"67b5cbce",61427:"7340f4b8",61683:"cde5e515",61691:"2e6468f0",61749:"947b3b80",61787:"ff0efb3f",62e3:"91083b1f",62013:"1c2ffc7b",62080:"3d1108ea",62171:"16a07297",62257:"95017957",62530:"0ded4c81",62656:"c0b09bcc",62704:"70249dc9",62756:"955fedde",62866:"c2df68ac",62886:"d13788ac",62910:"3776f168",62917:"9a575d8b",63152:"01caff99",63274:"7a3f1211",63424:"44cacaf9",63767:"df83cc55",63860:"a94e18b3",64065:"f2ec185b",64129:"afc5a8d1",64172:"65ac66b3",64231:"df9536cd",64339:"36fcc3c8",64441:"44962610",64509:"b80064d8",64633:"b55b93ba",64634:"79e5ddf0",64701:"87dc3184",64955:"6f3c676e",64994:"ba900224",65134:"491c2671",65329:"bd92b2bf",65350:"3643c5f1",65392:"8f52414a",65546:"8213fc31",65826:"419da6a0",65952:"a733aded",66050:"fa2d2397",66053:"dde992c5",66198:"7d6aee8d",66221:"9ed35e0d",66235:"488e03ce",66288:"92898ce1",66385:"c5f1debe",66560:"1c03c4c5",66674:"894a6122",66730:"0511956a",66865:"05bc7a2b",66975:"dfd27b97",66983:"1c0fd615",66995:"a293f4a4",66997:"6799955f",67141:"5ed8906d",67169:"b956140c",67178:"a019daa4",67179:"31b05dbf",67395:"fa4cda2a",67461:"1cb1bff0",67570:"6f122e55",67571:"257016bb",67630:"4187ab32",67662:"826c9574",67715:"52c50ad5",67759:"342c18b5",67983:"f85ad06f",68005:"379bcf87",68041:"45b13429",68072:"d33b70c4",68257:"a23a607e",68317:"3cd1ef02",68428:"7cb9d4af",68532:"90d8b43b",68567:"a34b36e9",68623:"e41347e4",68626:"42b9c223",68632:"50e84ffe",68872:"bce97a50",68883:"e55a04f9",68917:"1d40d5be",69089:"9763190d",69125:"6e971acf",69131:"42ce3521",69301:"0437b040",69376:"b3d17ad8",69637:"10c9ce26",69638:"38a992da",69747:"7a41843e",69853:"744f0ba5",69859:"662e143c",70049:"d888f4c6",70247:"461ab652",70254:"3d228f8b",70262:"95c01692",70283:"8ce19a4a",70319:"5bdb5319",70322:"eae06d3d",70361:"56499f7e",70466:"76a7988a",70517:"2e957c95",70710:"7e12b2b4",70735:"4b8beeb1",70861:"d47b9838",70875:"8dbd5b3f",71015:"923278c2",71126:"4c85dc9a",71135:"dee37ce3",71165:"9e1e0d0b",71181:"d3867df0",71235:"14443b71",71292:"dbd751cb",71370:"8da27144",71371:"16a6056d",71441:"d263260a",71822:"97098856",72051:"df6a68ff",72137:"e8ce8e40",72238:"d1f2dd7d",72260:"153cf8f9",72321:"611bc24f",72342:"4bd9e707",72418:"ff571cad",72626:"53757bf9",72782:"6fd1f5dc",72846:"b435c2cd",73080:"99f507fc",73181:"bf775a4a",73309:"55cd9daf",73407:"a99ef0e2",73481:"a1b51b50",73495:"15a55805",73708:"5fe394a2",73714:"d2296fd5",73788:"8e16fb46",73855:"b89f3fc6",73907:"bda65761",73953:"7e2445ad",74134:"c594c2d3",74181:"7510ad05",74192:"43fe083f",74398:"16fcb3cd",74404:"609b3a73",74455:"2a52634f",74459:"cc0015d5",74498:"c31a6f7d",74799:"bec67e70",74843:"664ca616",74857:"bfc94c68",74919:"cce0aba0",74986:"3f432d40",75012:"884354f7",75093:"07800c72",75161:"e9f7a0df",75223:"ad0ec433",75275:"9ade45d9",75634:"f529b656",75719:"7366813e",75730:"5899503c",75746:"208dffe6",75786:"9beff5e5",75812:"ec7a99a7",75857:"41300285",75993:"3c94b77d",76015:"33c5ff6b",76042:"9901c278",76233:"0f7e3122",76468:"c86cee85",76780:"a29f6a7f",76802:"7c172222",77053:"ade54cf2",77102:"a4f12bc5",77169:"17f42dfe",77243:"d34ef1d6",77286:"acc91c46",77332:"b6585406",77375:"486ee5e3",77445:"2e4b7bc7",77645:"8451ed4c",77669:"3af0089a",77722:"7300ae36",77792:"f2dfc908",77943:"e1a62755",78107:"49b43c59",78112:"1628a4f1",78197:"677905f0",78222:"f6442f46",78350:"28a654cb",78436:"aca1271a",78636:"f10bb308",78866:"ed8e8d1e",79096:"bb400c47",79104:"bb8fb37a",79162:"95c45a2d",79260:"be7affe9",79265:"c47ba125",79274:"7c42e26d",79286:"8a3aae79",79388:"dbe699a8",79398:"5bca3818",79418:"b54c31df",79512:"1ae01931",79548:"272c612d",79652:"ff0f02da",79783:"1c417b3c",79792:"05d178aa",79916:"afbfc56b",79994:"4faf3055",80053:"cb28f32f",80060:"5542aba6",80090:"5c5a2fc0",80142:"9a3293da",80169:"89e02059",80237:"57154231",80309:"e5d0903b",80322:"63d5e275",80534:"4b821f1d",80589:"858f143b",80631:"8f8b986a",80706:"fc32ce52",80731:"a2828737",80817:"66f9c07e",80831:"c52b651e",80872:"5b3fce72",80906:"9ec9c966",81093:"a102ed69",81177:"d1247bb6",81208:"c8504298",81242:"5f240a13",81269:"09ff435b",81476:"09c87795",81502:"56bc2541",81617:"a0d0ccfd",81646:"f3d1360f",81650:"e0d6f06e",81701:"84b41c91",81743:"206f9b84",81884:"89fc86bc",82154:"acbb84a3",82214:"884c6e0e",82401:"6002f9c6",82788:"578b6740",82833:"0f74871f",82913:"e47286ef",82918:"355f0317",82941:"959915e5",83057:"c117c8d2",83096:"4af965b2",83105:"d7da4467",83153:"72918dd3",83157:"3e0da6e7",83337:"3b87c8d3",83435:"4892a6a5",83447:"ae01566e",83576:"90786004",83593:"6d1e9976",83695:"2c914fc5",83787:"ae4a6231",83819:"de996987",83911:"f2dc03da",84084:"f7df0fcd",84094:"cbd359de",84101:"e427ae61",84109:"fcaeac01",84275:"960b3581",84342:"758d002f",84533:"a4827c7e",84589:"9823c36b",84609:"c4bcbdec",84793:"533d8ff2",84816:"20a008b5",84861:"2c8f4d7d",84890:"734390a6",84959:"9248b47d",85054:"ca4f51ec",85198:"0604ee53",85235:"0ff8a654",85486:"be163d29",85510:"e952a728",85642:"164c0642",85657:"b2360ac2",85688:"8e4e464c",85731:"73ff116d",85760:"e4732bd7",85925:"ed2cd121",85995:"9220d8bc",86381:"0cb7bff9",86407:"50ae68f7",86438:"477242fd",86461:"04ffcd52",86569:"25f866de",86616:"08592fba",86638:"e2d4813a",86706:"4c99b3b0",86842:"b4342c9e",86845:"af737499",86896:"1ea9e98b",86947:"4988d838",86965:"289a3c43",87311:"2e968ccf",87399:"e8a80265",87401:"3c1ff041",87486:"848e5906",87535:"77082ee9",87631:"c6d271a2",87658:"393140ed",87706:"f84f0971",87762:"08352b38",87767:"f8b4f552",88012:"0ae87b0a",88135:"3545a087",88406:"902119a2",88571:"60f8236f",88733:"50bdc2cd",88744:"ebf47ad1",88858:"3a77547f",88877:"5a61a6fb",88976:"3d17df73",89126:"f9e892f2",89183:"ea1266c9",89281:"29ceca9f",89343:"cf87bf8e",89525:"b0347e80",89563:"0afd93b0",89608:"441eb09d",89633:"7d968139",89722:"7dcbb2e8",89744:"f342b245",89772:"6c8b995f",89780:"39adb92f",89781:"7adbb575",89863:"a7edf75e",89955:"ec994b5f",90032:"0ad98c7b",90093:"d88acdf7",90318:"353057eb",90353:"82cc9870",90551:"52f4b046",90645:"f75c1d35",90717:"d82d7fb0",90757:"b0536ebf",90758:"783eeef1",90781:"858aca1f",90788:"185a0fb8",91002:"28e98dfb",91016:"2daf1c87",91147:"a19fecda",91170:"1fa4dc5a",91234:"ff0a1cc5",91437:"b895b9f1",91475:"b5ca1b6f",91500:"917c8aa4",91645:"e403d208",91667:"856e1195",91692:"7e46b438",91760:"27a1cfb7",91819:"55eca4fb",91889:"8a0c6ffc",91971:"e770d4cb",92166:"59820d37",92192:"baa1a5c8",92279:"53e45c4a",92345:"db3f4472",92463:"80f304e0",92541:"762b4b09",92580:"604c2721",92886:"dee151ec",92906:"dd640a64",92977:"20e68412",93093:"6ecc84f1",93104:"8cb458e3",93117:"bc03d886",93124:"35ab44c4",93178:"7a581169",93200:"c0df696f",93387:"84a8aaf0",93564:"1f3f43e6",93658:"333ad072",93666:"158df98d",93677:"df5e2524",94039:"e9ff9e42",94242:"eccb3d7b",94445:"e1030b17",94808:"2c7b16ac",95018:"b6495426",95043:"72489a78",95075:"44338c0c",95111:"a2299f5d",95170:"35e66818",95283:"27789056",95422:"227a34fc",95428:"2bd2023f",95480:"932559b0",95508:"b5a5a555",95551:"073885ef",95554:"7ef1ce2f",95738:"7cc6adf9",95808:"37f39392",95827:"8fa81f60",95847:"9bc46117",95885:"78346ac9",95901:"2274c648",95961:"41f6d804",96048:"e518c2a9",96054:"2e2223ba",96074:"a928bed9",96137:"d6a04eaf",96168:"484a5382",96298:"82b1a655",96316:"f236fce4",96470:"a21d11e8",96550:"b00b68e9",96636:"fdbf288b",96766:"1dee2add",96915:"53b3a491",96965:"9e8acb87",96994:"789d6a6d",97077:"30757c69",97221:"26ddd277",97466:"d5c4cef7",97480:"2d338cc2",97603:"b677e33e",97607:"44cf88f0",97878:"481b1f06",97920:"4c7533f0",97955:"65d2d330",97981:"119cfa67",97982:"291486e1",97984:"19e7d4ae",97987:"33cfc9f6",98004:"5ce25514",98054:"c7695051",98181:"af4daabe",98365:"c76820d1",98440:"23b7f55d",98476:"5714988c",98487:"ad9625fb",98518:"09d007b4",98558:"afc330a4",98698:"b91d74be",98707:"50a728f8",98758:"e0d77e2f",99023:"32e79cbb",99236:"4cdbecd4",99242:"a2ff24c8",99252:"eb0a3f89",99256:"156d1958",99369:"69fa0668",99384:"250f07b7",99444:"ea9bd2bf",99481:"fcd3ffac",99505:"4e489cbd",99524:"d74674cc",99537:"b63a4dc3",99582:"28b2a6f8",99776:"401719cb",99867:"8c1c78b7"}[c]+".js",r.miniCssF=c=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(c){if("object"==typeof window)return window}}(),r.o=(c,e)=>Object.prototype.hasOwnProperty.call(c,e),a={},f="@swan-io/docs:",r.l=(c,e,b,d)=>{if(a[c])a[c].push(e);else{var t,o;if(void 0!==b)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=a[c];if(delete a[c],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((c=>c(b))),e)return e(b)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=c=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(c,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(c,"__esModule",{value:!0})},r.p="/",r.gca=function(c){return c={11020189:"92977",16888267:"89126",17896441:"27918",23065245:"27534",37289545:"4624",39251080:"31895",40357306:"89955",46994613:"69301",47295864:"4222",54890881:"95043",60667150:"85642",61358661:"8557",64882008:"39610",74842326:"89525",80159696:"41335",86369399:"96636",86929204:"49770",88087531:"48216",93403402:"85925",95036120:"1978","3b1e8a04":"26","906be0f5":"188","537e891e":"197",ea98434a:"226","086f8d41":"338","7e4776c6":"383","7e418921":"464","0e645450":"525",b2c78190:"551","5d026d5b":"563","6ad82f9f":"598",c4a78fec:"618","99f09de0":"624","57afb12e":"819",cc624da4:"893","13c60c15":"1002","46ea937d":"1296","4003e254":"1440",a13e61a2:"1554","97bdb81e":"1569","24abe6c9":"1725","0726a80a":"1776","1cf8363a":"1792","56cdcb55":"1969",f5fed7b4:"2020","1f2cae39":"2139",f180e4fd:"2203",aeec9328:"2379","083b5ee8":"2624","97cecdc7":"2641",aebc2649:"2843","1eaf0a35":"2864",d0afdb2d:"2865",f0009b6d:"2867",da0b5971:"2933","06598b01":"2972","3aacd70e":"2987","73eb95b3":"3046","39bec462":"3047","127d0327":"3291","933633e8":"3459",c5d1a363:"3600","22a8b3e5":"3635","61eb9ea3":"3787","98e30f2f":"4074","50c72a68":"4121","261a3c4c":"4202","5404c6be":"4209",db7e6e07:"4261","1d792ce4":"4277","0dadcc1e":"4389","6d4bff2e":"4420",d6eb8501:"4487","45c3a72d":"4488",e21395a6:"4566","2d92d3d5":"4696","4e5e925f":"4754",cf577441:"4801","9cc83235":"4884","9b1e992b":"4903",f991dec4:"5007","964e7fd1":"5028",cca24708:"5263","9d6f8c56":"5375",fd528e1c:"5405",b612009c:"5584",c883a7d2:"5600","15f51de4":"5603","685e914e":"5647","4f0ea51f":"5728","21124f8f":"5810","6ce587a7":"5826","8dc06929":"6051","6b962ab1":"6202",ba3d63bb:"6267",ff7950bf:"6584",dd8a41d8:"6604","1d4593ba":"6753","2b931e2a":"6801","82d44727":"6950","25c39f22":"7059",a3fb4be0:"7096","8850d7c4":"7173","7f6f7401":"7207",d42050ab:"7285","6119656b":"7314","23095ca6":"7442",fa7407c8:"7560","11f9c043":"7685","9c17e59b":"7755",dc1c2387:"7890","65aea855":"7956","065500c2":"8196",d6be9dd8:"8489",d785bf34:"8619",ea02488d:"8707",c0ae11fb:"8719","95a967db":"8757",e9b66c06:"8839","314c70b6":"8850","8ecee473":"8884",c3c45dd1:"9060","231e519f":"9126",d125fffa:"9337",bc3592ca:"9595","3dc458f1":"9624",a61a29c6:"9630","5a7373d1":"9643","6f89da90":"9714",f59a48f5:"9720",a03b08dd:"9730","6d9cd1c7":"9773","8f507c52":"10230","6c071a02":"10278",c97ea729:"10388",c4cd5cb0:"10483",e799bcae:"10638",a0089c72:"10727",a8cae02b:"10770","099be5df":"10800","62ad48cd":"10814","83f52709":"10882",c22afb16:"10908",d5ccaf8c:"10963","26b44581":"10973",a32c2e8f:"11074",a403b8e5:"11145","63fc0890":"11153","0984c047":"11224",b6981fe2:"11303","52a00ac0":"11353","9f135918":"11475","108d6373":"11544",a19c031b:"11647",efa62701:"11651","51b8fc83":"11664",f52c0eca:"11796","8a7333e7":"12067",d647beeb:"12127","44f979a3":"12291","9bc0fec8":"12454","6239da7f":"12567",ba291cc5:"12653","34a4c1ef":"12658","0a9480b9":"12707",bbad6248:"12723","4fb704a5":"12743","1f6e0f09":"12760",c48e9267:"13511",af5ff4a8:"13592","680a02ad":"13629","4ae49aac":"13650","85a71def":"14025","2bd866c9":"14050","32b53397":"14061","4c3162b5":"14167",cdd15c63:"14733","7aacce42":"14840",c3f4f527:"14842",cc3efc88:"14914","885af34c":"15013","847878ab":"15052","52e0ffdd":"15180","1861b089":"15283","1b5a6a39":"15295","2314758f":"15299",b30e2096:"15378",ad09e4f2:"15579","81fcdb1a":"15592","5303177b":"15707","67a4571f":"15778",e254b817:"15913",d1eaeaed:"15971","09bc9840":"16077","9c9cb554":"16317",f87dd7c3:"16370",d4ebab5c:"16579","8bdfcaf4":"16633","7a283c56":"16672","5d71ce26":"16756","6c105199":"16759",c79960d7:"16762","0ddd1b1b":"16774","8cb31f65":"16872",e2ab92e6:"16901",abb82bb2:"17054",f4d6c510:"17134","10a1121f":"17155",e2294cb2:"17177","288ff6dd":"17347",a0ffd745:"17421",a5251a71:"17704","40c0f930":"17709","916e7802":"17797",c8dcf605:"17951","5ac43825":"18015","9951ca2b":"18034","988fba77":"18208",ada2d469:"18213","56b21ce1":"18335","25c0dc6d":"18443","9af30fc0":"18514",a8272bf5:"18530","3027b40c":"18545",c59dc8af:"18563","8015a322":"18598","9e41ed88":"18681","1e436d1a":"18757",b807fc4f:"18803",a7d26b7e:"18943","6162d70a":"18989",e31d0546:"18990","45dc364c":"18991","1e9fbabd":"19037","963b198d":"19070","0d899299":"19088","2acac63a":"19165","049b698e":"19283","2c8652ef":"19334","2d013051":"19394","6a4c1420":"19517",baa6e992:"19561",a7cbd17c:"19621",c18b3dd3:"19682","0e555118":"19726",fa05e9a5:"19981","0a89b070":"20057","2a99c066":"20078","839ba15c":"20092","39d45e0f":"20372","6c80d7a1":"20477","6f1a1ca8":"20504",b77877a9:"20534","3e43a2b2":"20535",a5f653a7:"20592","17187cda":"20623",b2e3041d:"20656",b4defd80:"20662","7e044534":"20773",bd79b770:"20930",a6798804:"20969","37eacde6":"21052",df994e82:"21064","10d6e584":"21092","48867f70":"21117",fab27b4b:"21130","8ab7b0cd":"21141","94c15580":"21252","889bb296":"21290",e397a29c:"21322",f35c768e:"21414",a30ec1ba:"21461","797a29cf":"21502",d5bd3fe5:"21524",df4f48df:"21661","2d934cf3":"21748","1df635da":"21830","8157c2dd":"21911",e4bec3b4:"21921",e6bb218f:"21964",ccb7b808:"22010",f27f83f6:"22022",f823c609:"22294","717eed18":"22341",d252dd99:"22495","5011814c":"22638","7cbcba93":"22645","6a1fc806":"22852","7390d34f":"22963","7639e195":"22992","4e1c7b49":"23022","225e92a1":"23054","370ba5bb":"23128","0b34dda5":"23221",effbb39b:"23327","60c8650b":"23418","79dba252":"23442","3dae3655":"23474","801281af":"23577","9a5fc07a":"23613",bc521218:"23637","4b910cd9":"23737","0c5a975b":"23778","6b67672f":"23798","69c976eb":"24079","1dccb938":"24082",d452ad1f:"24083","864a1832":"24132","5e7874ef":"24369",cec929a1:"24475","5ab9c5bb":"24506","51e24d73":"24564","1d4a58b2":"24617",d521ca07:"24722",a1694c7f:"24748",be177392:"24753",d816822b:"24758",b472f62c:"24881","68d59462":"24884","8da44a2f":"24938","969f08fc":"25056","75cd7400":"25118","9f8006c1":"25197","12f84441":"25264","2c65fa8f":"25290","7f277d92":"25332","425e8d85":"25398",acf6d009:"25453",a14955b7:"25562","0abe0fe0":"25588","4343afaa":"25781","2b4f8af7":"25942",e38dcdaf:"26094","9a42e497":"26101",c2aa9606:"26282","267cf944":"26354","116e6c65":"26381","36eb0943":"26698","9d4344f6":"26871",e17a71f3:"26971","4356cfc6":"27006","033b8e71":"27146",f84941ff:"27262",e9f7d2c3:"27309",adb2bd7f:"27363",d5dc8cd0:"27501",e4eca706:"27663","761392cf":"27678","64b0b10e":"27850","9905859b":"28100","20126dcc":"28290",b22c8d77:"28407","872b574f":"28432","0839c2f2":"28505",c20f32fe:"28644",a37b42b8:"28678","65439e23":"28926","52c5d90f":"28970","292e8373":"29025",f6b07c9c:"29043","2272e4a0":"29242","506b7af1":"29333",f7448900:"29336","5fdd6e70":"29473","95f798c9":"29497","1be78505":"29514","935b2aef":"29627","6c8b5710":"29650","4ec98ed4":"29654","05747eec":"29685","38e0aa1b":"29698","6a6856d7":"29728",aa49738c:"29751",fc9c7bcb:"29899",e398b309:"29998",a14bba07:"30010",d7fd2129:"30058",a1720262:"30089","4b49353c":"30115","5c56d4eb":"30147","317022e7":"30326","92a099f2":"30572","2618151e":"30735",e2bb2cb5:"30801","1931bcc3":"31029","8a0d38f2":"31074","23bab739":"31189","0a67da07":"31474",bdd2828a:"31500","95fc7c58":"31636","4129c5c1":"31752",e53b72e5:"31885","3f2d9761":"31907","43ec88e9":"32028","54ac0390":"32066","8ddac3e7":"32067",f4664bca:"32069","71bd3347":"32211","890ce2a7":"32310",a68e5d78:"32408","4b1cfb23":"32417",c587f49b:"32747",fe68b5e4:"32800",c65e1a11:"32845","05619c3b":"32900",f78aacb3:"33005","090ef090":"33031",bdd9896c:"33035",b180c4b3:"33036","1931fdd9":"33064",db09fed0:"33107","4139b91a":"33124",f5008ea7:"33229","6b3ff6cc":"33273",aeaf9c67:"33296",b4d7d4ad:"33308",fa784e22:"33392","3704b249":"33617",ecc7bc3e:"33892","4bfd2db8":"33898","1aa8ceda":"34071","4edc808e":"34173","815a3dac":"34204","520f27a2":"34236",e8fc3664:"34288",b6c80156:"34298","565c7e7a":"34522","014fea84":"34548",ecb406fd:"34579",e8f88bc2:"34607","92cbc932":"34641",f9761c5e:"34698",d54c413d:"34736",f7c61839:"34864","9c9f4b72":"34960","9a2c7022":"34991","310d826d":"35022","00c5a843":"35101","7c9ab105":"35133","6b418b9d":"35377",ce85cb6e:"35630","1e8bd5b0":"35679",b967ba9e:"35708",b3d49b53:"35730",b167da58:"35775","96dae183":"35874","1370613c":"35978","9b399d10":"35994","2a9cb50e":"36050",a3657298:"36052","88cfda8b":"36125","401f64d8":"36161","3c881dfe":"36282",cfa4d47c:"36299",b182ba5a:"36344","29beb3fc":"36364","13f01a8a":"36389",d0b8f6f2:"36420","531d36a8":"36516","37f62d04":"36557",f2936bbd:"36569",e41b2273:"36712",be3a27c1:"36776",dc535e8b:"36797",a0e83a2e:"36840",e8f1b8cc:"37366",e3090d6c:"37419","57a52ec7":"37501",ec80f0f8:"37581","89a0769b":"37644","8fa063df":"37775","0222bab5":"37897","7dc96604":"38073","43fc11eb":"38266",b9099eab:"38310","6355eb0e":"38369",c2c9f624:"38468",b6ca6818:"38491",e9754802:"38537",f2cad8f8:"38574",c8867ead:"38626","137c07e2":"38696","9a86d8cc":"38786","34c58755":"38793","01a29863":"38908",c6756e66:"39013","952b6790":"39160","6a9ba154":"39182",d913284c:"39242","511dcd27":"39260",c64a672c:"39515",bd3a40d0:"39586",bc0dc214:"39607",e12a3758:"39619","2da5c4d8":"39805","553ac137":"39821","0eb675f4":"39894",e50f849d:"39955","75933c16":"39961","4bac9b1f":"39978",a3bb5839:"40049",c1e74a4c:"40060","9a89681b":"40086",bfc68003:"40323","16eb2325":"40333","8de80b01":"40350","75bfabaf":"40358",bb87ec56:"40543","0f6f90b2":"40905","18612f1d":"41085",bbeccb15:"41096","228df3ee":"41103","354a9724":"41104","4e658f9f":"41217","990c7218":"41348","3a50ac54":"41403","564774e4":"41408","34a00c10":"41409","1cecf61d":"41444",f5341953:"41476","4c412ed3":"41653",a6c97d01:"41735","88bdac60":"41736","0b34e84c":"41772","9625e3cf":"41832",b3dbcea3:"41909",cdac7eee:"42654","5fb625f6":"42689","59733b92":"42801","816e92e0":"42827","6dff6091":"43055",f9500687:"43092",b76fe286:"43152",aba58f6c:"43524","5acbe74d":"43557",e2a45f08:"43585","06e611a4":"43638",dc3d7fec:"43688","1632ccbd":"43696","7eb8af8a":"43792",b8583e9d:"43899","9cb826bf":"43989",cf96f01e:"44326",ac53eefd:"44339",ce76d2d2:"44345",b8eded90:"44450","09ab147a":"44666","6494d608":"44705","2c586235":"44909",bf268afd:"45019","473c41fb":"45074","6058e000":"45137",fb37a63f:"45230","8428dc8e":"45357",b183078b:"45384",fca10f8f:"45504","99dcad14":"45661","5e2ed9e0":"45784","9562f221":"45785","522ef36b":"45860","9ba75874":"45879","329d1cb3":"45910",d037a7a8:"45938","0d45fbb6":"45954",bf5b21c2:"45960","46f7fadb":"45997",d73d1478:"46003","0d97815c":"46532",ebb8b189:"46550","12d9b1bd":"46694","33ddb308":"46784","52d7d962":"46808",cb228c6f:"46908","3f613908":"47044",b615932b:"47104","4ad894f8":"47315","14b34cf0":"47357","63089e85":"47380","1ac3e25d":"47457",afe3715f:"47497",b9b4cc70:"47675","427b33e3":"47682","6f86928c":"47706","36121d87":"47730","10109baf":"47826","7c63c948":"47844",afa13d6c:"47901",b808e4e2:"48024","01def2f0":"48173","98ad38c6":"48243","2a49ba60":"48244",a175cf8b:"48304",b02f9910:"48384","2dedc8a4":"48541",a3e8cdfd:"48604",ff16d4d9:"48745","956b4570":"48783","5dfde814":"48817","1cc5ecbe":"49018","8750ec25":"49020","90f9c342":"49058","466913f7":"49070","4e721e97":"49076",adcc1d8e:"49139","3685cb1b":"49284","3a277a94":"49450",fb9b5d58:"49473","2bc58688":"49547","0891475e":"49581","3f5a9aec":"49611","7cf026eb":"49660",a671d179:"49701",fabd6154:"49885","042e442b":"49893",a06c4f73:"49998",fb2f18e8:"50001",dacd0a27:"50094","29c4964b":"50103",fe23e6b8:"50154",e02048e8:"50472",ce404f5b:"50598","644a76c8":"50629","2b52c7ce":"50703","121548f7":"50901",d0321f76:"50931","31b043b0":"50996","6f799ed7":"51201","99eee64d":"51211",e659bcf2:"51297","1fe18e32":"51301","63a20395":"51388","00deb6ac":"51427","18d02db7":"51440",fccf4da8:"51586","81cdb831":"51623","1ae90838":"51637","228e0e4a":"51760","3a558158":"51880",e820cfef:"52060","4d564705":"52137",ae9e0374:"52205","3b8c5879":"52289",e3716ac0:"52303","97b652a2":"52351",fbc04c9c:"52412","3eb0e82d":"52467","5d918b0d":"52645","17f8d39f":"52720",c52d395c:"52947","6e4ce4c4":"52969",e6e5635e:"53072","85f27db4":"53118","278ca12b":"53124","723df87b":"53172","83429edb":"53218","91c3c2b4":"53378",cfef71aa:"53418","8604e9d1":"53511",ad555afc:"53622",af646d81:"53698",daa78cd9:"53873",c2c02732:"53896","291af9ca":"53897",b3ffaa5d:"53946",c53da6e2:"53956",eea5c50e:"54068","4ee205e8":"54149","0bb30126":"54157",e3ae4459:"54174","2c48271a":"54317",f797c0d1:"54396",a5782e6c:"54543","4bd5222a":"54781",b6e1792b:"54895",e78fce63:"54928","88ce8468":"54992","7412879b":"55030","4d5fcd64":"55126","0bb5cb3b":"55133",a6ce14aa:"55165","2642e3b9":"55207","16756a68":"55239",a5d8d2c0:"55251","15e029d2":"55362","7113b392":"55417",cd9fcd8b:"55470","278c3025":"55474",c12755ef:"55488",e17f4cbd:"55793","0f276f47":"55846",ac7a7d4b:"55940","899eb281":"55968","404bc1a3":"56124","6162ad7c":"56192","9281c204":"56373","0d3ce22a":"56469","2b017db6":"56584","34ba053d":"56640",d541116e:"56976","75f7345d":"57045","54e35760":"57252","50d0703e":"57291","5c8f4dd6":"57316",fe1d7d76:"57355",f7dd5460:"57372","5e0eddb9":"57411","55ec9319":"57477",c14439a5:"57511",c2cc4b3d:"57596","3c721eea":"57679","55c9ddce":"57698","085530f7":"57855",b8e222b7:"57867","77ec448e":"58148","63f6e2ef":"58188","1bdd8362":"58228","19b24147":"58299",a55d2b67:"58300",c29d33ae:"58388",f09de917:"58504",faebfef1:"58533","01eff7bb":"58588","14e8926f":"58671",cc6e8ac5:"58703","8eeac047":"58902","2ae384d0":"58951","1441571f":"58954",dc75d149:"59003",e414dbe6:"59009","91a669f2":"59020","8f371e5f":"59032","2563e8e0":"59065","25185f0e":"59148","3bc32dbb":"59219",e85ac3d2:"59260","295bad4c":"59293","2dc1fad6":"59320","247783bb":"59334","07cc5864":"59407","88c4a046":"59487","042b05c7":"59522","033aa841":"59590","12a4832c":"59700",c651b04a:"59782","80f93b6a":"60019","71b18881":"60023",bd05747c:"60070","026d8b4a":"60344","19dd9055":"60418","0c7f2f7d":"60553",df9d2e0e:"60722",a6278bdf:"60746",e90bfa87:"60800","3466985c":"60829",cc0a4513:"60843","0a58537d":"60899","8f735039":"61022",fd6d72c8:"61210",d1bcbecc:"61324",b1843cea:"61385","89b93789":"61427","319e16c8":"61683","4e18715a":"61691","19b75377":"61749",bbd11534:"61787","7fcaa117":"62000","6a4cfdc3":"62013",fde3b619:"62080","761c0fee":"62171","1070ce60":"62257","0ac661cd":"62530","88f0c610":"62656","6ed227de":"62704","5db048a0":"62756","6f9fe13d":"62866",c24ffec6:"62886","0163d222":"62910",b10334f9:"62917","487820d5":"63152","2c444a10":"63274","0a55acc3":"63424",de0b42a2:"63767","6d8d2f2d":"63860",f79e1d52:"64065","4f2a10e5":"64129","4d78e6a7":"64172",d2ad78df:"64231","63bf94b5":"64339",e5798c32:"64441","6c6a3c28":"64509",cb3894f2:"64633","5561a7b6":"64634","9c790e35":"64701","2b52cffa":"64955","2bb60e70":"64994",c519648a:"65134",d327bfa8:"65329",e5b99c64:"65350",c856918f:"65392","434eb2b3":"65546",c1d3d149:"65826","4fa7e8ec":"65952","1fb294c0":"66050","4e3c9c36":"66053","6324826a":"66198","3a5b218f":"66221",c6c4f55e:"66235","56bbc919":"66288","59b068d1":"66385","867ce6c5":"66560","125c6f18":"66674","9b326bb9":"66730","2ad15ba3":"66865","1ffbea02":"66975","4463978c":"66983","5cdd0279":"66995",f33ae72c:"66997",a3f20d95:"67141",a408a83e:"67169","59d9644b":"67178","2d35682d":"67179","5f6d7dc2":"67395",b179e805:"67461","82378c3d":"67570",d79eea0f:"67571",fb8b85c0:"67630","5bc7d28f":"67715","015f3359":"67759",af5b8f37:"67983","5e8bc7eb":"68005",a8546f28:"68041","554e0e92":"68072","7c81aff9":"68257","855cc29f":"68317",ff332aec:"68428","94bf1f11":"68532","4c7d984b":"68567",ec258617:"68623",b93ce049:"68626","2093545b":"68632",dabd12eb:"68872","975678f9":"68883","9467a3a7":"68917","6f265f1e":"69089","83c14c5b":"69125","86be6eb7":"69131","52c0afd0":"69376","08bfe654":"69637",a21e3f2b:"69638","4971b70e":"69747","85b33b51":"69853",e6963609:"69859",dec461d7:"70049",c99c2808:"70247","6e1b0d5d":"70254","8357b658":"70262",dbb4b0dd:"70283","2f679eca":"70319",e740f973:"70322","4eda58a2":"70361","3c2019bf":"70466","581c1936":"70517","66f7d59f":"70710",fbf8a582:"70735","58d70cba":"70861","23c8d0ec":"70875",a852c08e:"71015","464f51d8":"71126","9efc327a":"71135","592a270e":"71165","3424d603":"71181","2075c0e7":"71235","50ddb176":"71292","2763779d":"71370","532df885":"71371","0e0784f8":"71822",cc4926bd:"72051",d72358c5:"72137","05847173":"72238",ff3d1153:"72260","43c15dd6":"72321","160f3a79":"72342","2cc3cbd0":"72418",cc51bb94:"72626",cfe23f40:"72782","7f490342":"72846",cb2c479a:"73080",b3f9dbb3:"73181",eb134d49:"73309",fe669216:"73407",deeedaab:"73481","95f72fa5":"73495",d3337921:"73708","49d02f2b":"73714","16af972d":"73788",b8b08371:"73855","2ae6ee92":"73907","98fad2e1":"73953","3a9ce421":"74134",d3d63dbd:"74181",b0e2212e:"74192","759e8857":"74398","953bfb97":"74404",e342c8de:"74455",e0d18a7f:"74459","1bc96b4f":"74498",fbcf7722:"74799",b591fba7:"74843","3d32fb4a":"74857",fa8b7820:"74919",ce2e9252:"74986","586f596e":"75012","8b060552":"75093","2a7e9090":"75161",dce33e1f:"75223","4f49b4a6":"75275",bcf3c208:"75634","0d7e0438":"75719","4343594b":"75730","2a38130d":"75746","5ce80a97":"75786","3f3bc418":"75812","8e99cb43":"75857","4cb8fa66":"75993","62ff3f98":"76015",baa2ddd1:"76042",efc08881:"76233",ea7a23e5:"76468","0f573e36":"76802","97f09500":"77053",aa19dd49:"77102","54d368d0":"77169",b9f191e0:"77243","175ab1e6":"77286","04fe8bc7":"77332",dbb0c5ba:"77375","735d0569":"77445",a7434565:"77645","8021ccb9":"77669",afb57966:"77722","5be0fa3d":"77792","86fd3823":"77943","611d7e33":"78107",b4031aab:"78112","9f6eb29d":"78197",feb1c55f:"78222","5eeb66fc":"78350","8af6147a":"78436","00d30b51":"78636","78a121f7":"78866","448e9ff0":"79096","39109a85":"79104",d74be7d9:"79162","07e92a52":"79260",ef3ff2c2:"79265",e40db110:"79274","00a77e21":"79286","8c7c8eb3":"79388","24fa4cec":"79398","1a3d40eb":"79418",bbba91a4:"79512","8c7ba56e":"79548","45e2ccab":"79652",e6724f00:"79783",b3e24b6b:"79792","8a1a46cf":"79916","3ccf320e":"79994","935f2afb":"80053","43039bb0":"80060","526c94fd":"80090","925ec2c4":"80142","33152f28":"80169","4fbefc11":"80237",f30e2f4e:"80309","8285bf0a":"80322","3378914f":"80534","2368976d":"80589","9c105a4a":"80631","2cc9756f":"80706",bba534cb:"80731","2b66fdf3":"80817","9a4b7ed4":"80831",ffe0d0d7:"80872",a1c220e1:"80906","61d1e172":"81093",fc11e017:"81177",fd0a352e:"81208","29a89901":"81242","30fab45c":"81269","2550b685":"81476",d6f53db0:"81502","6a61db4c":"81617",e3a94193:"81646","582cf9cf":"81650","3f6ccc4d":"81701",a8a098e3:"81743","1d717d5f":"81884","5e72b495":"82154","87963f8e":"82214",b49dfbe6:"82401","2a054627":"82788","68e7302e":"82833",bdc9175c:"82913",eead291e:"82918","779a5035":"82941",b8fc97f5:"83057","0846aa9c":"83096","6606b81d":"83105",c22b7e4d:"83153","55f3c723":"83157",da59ca95:"83337","31f6e61c":"83435",beeaecb2:"83447","92a4540d":"83576",c01d5add:"83593","007417dc":"83695",b225e9f7:"83787","18b7481c":"83819","025c3845":"83911","6ab254e3":"84084",e1b037a6:"84094","3603dc64":"84101",c9307803:"84109","67b9a9ed":"84275","016c99f5":"84342","2093a25c":"84533",ccbe36b5:"84589",d43711a2:"84609",e3bc6914:"84793",a1505666:"84816","9f063840":"84861","41da606f":"84890","720ef584":"84959","0e698270":"85054",e20e5b1b:"85198",b7a47829:"85235","6f230234":"85486",fb6fbcbc:"85510",f8817707:"85657",bb5adb3f:"85688","40500d46":"85731","9985b6b4":"85760","1e7bea2b":"86381","54b20349":"86407",d919af83:"86438","4c12bb41":"86461",a1d6df89:"86569","67e7a7a2":"86616",f6bb5feb:"86638","1ac80f48":"86706","32e1a604":"86842",bb1a22fe:"86845",e562837c:"86947","608605fe":"86965","537d16fa":"87311","77e0268b":"87399",a7de3171:"87401",b9583340:"87486","31fb3847":"87535","830d9274":"87631",def52b90:"87658","628f19ed":"87706","124cf492":"87762","3087f363":"87767","4f36b0ab":"88012","1800faa3":"88135",ba6c4f44:"88406","43bd0f3e":"88571",e7ffdf0e:"88733","7ea3161b":"88744","75bcd1ec":"88858",e86f1faf:"88877",b4cbc673:"88976","9f60fd43":"89183","533e4ee8":"89281","78be5594":"89343","17a3c4c7":"89563","179e41e0":"89608","4e42ba9b":"89633",a57c97e1:"89722",b511d978:"89744","59f94b0a":"89772","27ba56f5":"89780",d39426f1:"89781",e2c26865:"90032","3758fb0e":"90093",b7db8f42:"90318","686a27f5":"90353",a6c0c96a:"90551","3db4b834":"90645","92a67a5e":"90717",fa29f323:"90757","81617aef":"90758",e08af2f7:"90781",dcfeeef5:"90788","2b3d484b":"91002","6ef156d1":"91016","6faf837f":"91147","784cefee":"91170","57b3bd5a":"91234",c3b842f0:"91437",e14d3193:"91475",c3a56b2b:"91500","0c0856cf":"91645",a72e3859:"91667",de7187cd:"91692",cc1ec4e2:"91760",d82dae9c:"91819","78acccc5":"91889",dc306ea3:"91971",cc53792f:"92166","9aa8b2ce":"92192",e2f2321d:"92279","4493ef81":"92345","321507eb":"92463",a677fec3:"92541",c34595d4:"92580",e5331bbf:"92886","0b59f9d9":"92906","0fafb84a":"93093","95ae2e11":"93104",fec91b88:"93117","1a47e540":"93124","750bdf24":"93178",e35fe59d:"93387",d9db9575:"93564",ca92d177:"93658",d6c89a37:"93666",b5ae6a43:"93677","905d5f29":"94039","4bdf8047":"94242","485fd60f":"94445","7cb78d0e":"94808","56acf746":"95018","025c8e15":"95075","1b7953ef":"95111","5c00a2ae":"95170","8ba07a28":"95283","008d8ed8":"95422",b59ff28b:"95428",bd292e6b:"95480","9a1f0ffb":"95508",d6b34693:"95551",a4bba936:"95554",c7dee171:"95738",fa9f7ab7:"95808",b6607c60:"95827","579e796e":"95847","0a8b996c":"95885","39630c6f":"95901","2974c85a":"95961","063c6f4a":"96048",e9bd8d12:"96054","293b7ec8":"96074","3bfcb7ef":"96137","13052e62":"96168","731b568d":"96298","962c73d5":"96470",e6762b5d:"96550",d13d7913:"96766","463c6316":"96915",de3f1c9c:"96965","4eecffc4":"96994","7b44e488":"97077","06470666":"97221","64ca5894":"97466",d7d4ca84:"97603","2e5a906c":"97607","793d570b":"97878","1a4e3797":"97920",d941769a:"97955","88494be0":"97981","1b7f2ddb":"97982","3ee0fc6b":"97984","7b9635e1":"97987",fbc0a5af:"98004",f171655a:"98054","845352e9":"98181",ab40f74c:"98365","17c256d3":"98440","3708790d":"98476",be96c5c5:"98487",c2e1fe96:"98518","036bdd50":"98558","3bbd7fdc":"98698","5a9f8cc2":"98707",a10f0673:"98758","0120a125":"99023","5f623ea8":"99236","48d023ac":"99242",fb85aa06:"99252","2c72cb8a":"99256",a07ff668:"99369","6935d919":"99384","05b090b6":"99444",d4dc7dcd:"99481","4966510b":"99505","9f37195c":"99524",fd8bf6ff:"99537","0c1e2e5e":"99582","50f34778":"99776","1bc5c1c5":"99867"}[c]||c,r.p+r.u(c)},(()=>{var c={51303:0,40532:0};r.f.j=(e,b)=>{var a=r.o(c,e)?c[e]:void 0;if(0!==a)if(a)b.push(a[2]);else if(/^(40532|51303)$/.test(e))c[e]=0;else{var f=new Promise(((b,f)=>a=c[e]=[b,f]));b.push(a[2]=f);var d=r.p+r.u(e),t=new Error;r.l(d,(b=>{if(r.o(c,e)&&(0!==(a=c[e])&&(c[e]=void 0),a)){var f=b&&("load"===b.type?"missing":b.type),d=b&&b.target&&b.target.src;t.message="Loading chunk "+e+" failed.\n("+f+": "+d+")",t.name="ChunkLoadError",t.type=f,t.request=d,a[1](t)}}),"chunk-"+e,e)}},r.O.j=e=>0===c[e];var e=(e,b)=>{var a,f,d=b[0],t=b[1],o=b[2],n=0;if(d.some((e=>0!==c[e]))){for(a in t)r.o(t,a)&&(r.m[a]=t[a]);if(o)var i=o(r)}for(e&&e(b);n - +
- + \ No newline at end of file diff --git a/developers/about/endpoints/index.html b/developers/about/endpoints/index.html index 523d3f8daad..c5b9356390c 100644 --- a/developers/about/endpoints/index.html +++ b/developers/about/endpoints/index.html @@ -7,13 +7,13 @@ - +
- + \ No newline at end of file diff --git a/developers/about/intro/index.html b/developers/about/intro/index.html index a182f6d52d2..e6b92041b89 100644 --- a/developers/about/intro/index.html +++ b/developers/about/intro/index.html @@ -7,13 +7,13 @@ - +

About the Swan API

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/about/webhooks/index.html b/developers/about/webhooks/index.html index 0078dd74d59..eec67af5959 100644 --- a/developers/about/webhooks/index.html +++ b/developers/about/webhooks/index.html @@ -7,13 +7,13 @@ - +

Webhooks

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/access-tokens/about/index.html b/developers/access-tokens/about/index.html index 62f416005e9..c226178b585 100644 --- a/developers/access-tokens/about/index.html +++ b/developers/access-tokens/about/index.html @@ -7,13 +7,13 @@ - +

Access tokens

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/access-tokens/get-token-project/index.html b/developers/access-tokens/get-token-project/index.html index 5f13d3c6bfa..b5f6ce5ed16 100644 --- a/developers/access-tokens/get-token-project/index.html +++ b/developers/access-tokens/get-token-project/index.html @@ -7,13 +7,13 @@ - +

Get a project access token

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/access-tokens/get-token-user/index.html b/developers/access-tokens/get-token-user/index.html index 8646ebe0d0d..cfda2889559 100644 --- a/developers/access-tokens/get-token-user/index.html +++ b/developers/access-tokens/get-token-user/index.html @@ -7,13 +7,13 @@ - +

Get a user access token

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/guides/access-tokens/index.html b/developers/guides/access-tokens/index.html index b7ce3b654a6..4004c6e875c 100644 --- a/developers/guides/access-tokens/index.html +++ b/developers/guides/access-tokens/index.html @@ -7,13 +7,13 @@ - +

Get access tokens

info

This section is purposefully empty right now.

Project access tokens​

User access tokens​

- + \ No newline at end of file diff --git a/developers/guides/rejections/index.html b/developers/guides/rejections/index.html index 6bae26dfcc2..6e604bed82f 100644 --- a/developers/guides/rejections/index.html +++ b/developers/guides/rejections/index.html @@ -7,13 +7,13 @@ - +

Use rejections

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/guides/webhooks/index.html b/developers/guides/webhooks/index.html index ce65f33db25..bd7bbedb3c2 100644 --- a/developers/guides/webhooks/index.html +++ b/developers/guides/webhooks/index.html @@ -7,13 +7,13 @@ - +

Using webhooks

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/intro/index.html b/developers/intro/index.html index 976226eacc9..afae087d9d9 100644 --- a/developers/intro/index.html +++ b/developers/intro/index.html @@ -7,13 +7,13 @@ - +

About the Swan API

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/rejections/about/index.html b/developers/rejections/about/index.html index d6376c6ef23..939e179a17a 100644 --- a/developers/rejections/about/index.html +++ b/developers/rejections/about/index.html @@ -7,13 +7,13 @@ - +

Errors and rejections

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/rejections/using-rejections/index.html b/developers/rejections/using-rejections/index.html index 1e70ba18d49..e89891c7aa6 100644 --- a/developers/rejections/using-rejections/index.html +++ b/developers/rejections/using-rejections/index.html @@ -7,13 +7,13 @@ - +

Using rejections

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/webhooks/about/index.html b/developers/webhooks/about/index.html index 5d125f170c5..b9a42b268a7 100644 --- a/developers/webhooks/about/index.html +++ b/developers/webhooks/about/index.html @@ -7,13 +7,13 @@ - +

Webhooks

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/developers/webhooks/using-webhooks/index.html b/developers/webhooks/using-webhooks/index.html index 51e78f9f51e..d6e73af54b2 100644 --- a/developers/webhooks/using-webhooks/index.html +++ b/developers/webhooks/using-webhooks/index.html @@ -7,13 +7,13 @@ - +

Using webhooks

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/explorer/index.html b/explorer/index.html index b61a5793e92..6a2da4d676f 100644 --- a/explorer/index.html +++ b/explorer/index.html @@ -7,13 +7,13 @@ - +
Loading...
- + \ No newline at end of file diff --git a/glossary/index.html b/glossary/index.html index 1ad04049532..64aa97abb3a 100644 --- a/glossary/index.html +++ b/glossary/index.html @@ -7,14 +7,14 @@ - +

Glossary

Account holder​

Individual (natural person) or legal entity (legal person) who owns and is responsible for the funds in a Swan account.

Account onboarding​

Company account onboarding

Process of creating a new company account holder, and opening a new Swan account for that account holder.

Individual account onboarding

Process of creating a new individual account holder, and opening a new Swan account for that account holder.

Capital deposit​

Initial funds invested to start operations for a new company, involving required documents, shareholder information, and legal processes.

Individual or entity authorized to act on behalf of another person or entity in legal and financial matters related to the Swan account.

Project​

Entity that contains all information for your Swan integration and users.

Supporting document collection​

A collection of documents (think of a folder) containing documents gathered for a specific reason, such as onboarding. Swan collects these documents according to local regulations.

- + \ No newline at end of file diff --git a/index.html b/index.html index 47cb6d91c21..4af59fe87e1 100644 --- a/index.html +++ b/index.html @@ -7,7 +7,7 @@ - + @@ -16,7 +16,7 @@ Use cases vary widely, from buy-now/pay-later setups to employee benefits cards to rental management.

About Swan documentation​

This primary section of Swan's documentation covers two main themes: concepts, or explanatory content, and guides, providing steps to complete a task.

More to come

Swan is in a full documentation migration. Over the coming weeks, you'll see more content in this main section. Developer and Partnership sections are coming soon.

Site anatomy​

The anatomy of the Swan documentation site has five main sections:

  1. Top navigation: Swan's different types of partner documentation, including the main docs (where you are now), information about partnerships with Swan (coming soon), and a section just for developers (also coming soon).
  2. Sidebar navigation: links to all content for this top navigation section.
  3. Changelog & Search: link to Swan's product changelog (coming soon), plus the invaluable global search that unifies all sections in the top navigation (powered by Algolia).
  4. Page navigation: table of contents for this page only, generated using the page's headings.
  5. Edit link: if you find errors or would like to contribute something you've discovered, follow this link to the Swan documentation GitHub repository and start a discussion or create a pull request.

callouts of homepage

- + \ No newline at end of file diff --git a/partnership/contact/index.html b/partnership/contact/index.html index b48d427d7cb..aa9a602127b 100644 --- a/partnership/contact/index.html +++ b/partnership/contact/index.html @@ -7,13 +7,13 @@ - +
- + \ No newline at end of file diff --git a/partnership/country-guides/france/index.html b/partnership/country-guides/france/index.html index 5551909734f..995697d734b 100644 --- a/partnership/country-guides/france/index.html +++ b/partnership/country-guides/france/index.html @@ -7,13 +7,13 @@ - +
- + \ No newline at end of file diff --git a/partnership/country-guides/index.html b/partnership/country-guides/index.html index b668233a817..8bc33d2f180 100644 --- a/partnership/country-guides/index.html +++ b/partnership/country-guides/index.html @@ -7,13 +7,13 @@ - +
- + \ No newline at end of file diff --git a/partnership/country-guides/spain/index.html b/partnership/country-guides/spain/index.html index c27069ce202..3e385be8e3e 100644 --- a/partnership/country-guides/spain/index.html +++ b/partnership/country-guides/spain/index.html @@ -7,13 +7,13 @@ - +
- + \ No newline at end of file diff --git a/partnership/intro/index.html b/partnership/intro/index.html index b815791b811..2aece1f8efd 100644 --- a/partnership/intro/index.html +++ b/partnership/intro/index.html @@ -7,13 +7,13 @@ - +

Partnership with Swan

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/partnership/rules/index.html b/partnership/rules/index.html index d851474552d..adc36b3cfaa 100644 --- a/partnership/rules/index.html +++ b/partnership/rules/index.html @@ -7,13 +7,13 @@ - +

Rules and regulations

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/search/index.html b/search/index.html index 84f7b077f96..2e10c864700 100644 --- a/search/index.html +++ b/search/index.html @@ -7,13 +7,13 @@ - +

Search the documentation

- + \ No newline at end of file diff --git a/starter-guides/activate/index.html b/starter-guides/activate/index.html index ff6e15ba28e..7c48a93c367 100644 --- a/starter-guides/activate/index.html +++ b/starter-guides/activate/index.html @@ -7,13 +7,13 @@ - +

Activate your project

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/starter-guides/intro/index.html b/starter-guides/intro/index.html index 80cd51a44df..1e3f421e663 100644 --- a/starter-guides/intro/index.html +++ b/starter-guides/intro/index.html @@ -7,13 +7,13 @@ - +

Swan starter guides

info

This section is purposefully empty right now.

- + \ No newline at end of file diff --git a/topics/capital-deposits/france/guide-create-case/index.html b/topics/capital-deposits/france/guide-create-case/index.html index 89d7030c97e..1054cc8f666 100644 --- a/topics/capital-deposits/france/guide-create-case/index.html +++ b/topics/capital-deposits/france/guide-create-case/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@

Create your capital deposit case

Use the createCapitalDepositCase mutation to create your capital deposit case.

Multi-step process

This page explains step 1 of a multi-step process. Refer to the France guide for the whole process.

Guide​

  1. Add the createCapitalDepositCase mutation.
    • By default, objects are added to the API Explorer in the following order:
      1. companyName
      2. companyShareholders
      3. individualShareholders
      4. totalCapitalDepositAmount
      5. onboardingCapitalDepositCompany
  2. companyName: Enter the name of the future company (line 4).
  3. companyShareholders: Add required information about company shareholders (starts on line 5).
    1. Add the onboardingInfo object to prefill onboarding information for individualUltimateBeneficialOwners (starts on line 8).
    2. You can also prefill information about the company (starts on line 33).
  4. individualShareholders: Add required information about individual shareholders (starts on line 50).
  5. totalCapitalDepositAmount: Add the combined capital deposit amount from all company and individual shareholders (line 69).
  6. onboardingCapitalDepositCompany: Add the company onboarding object to start creating the future company account (starts on line 70).
    • Note that individualUltimateBeneficialOwners and company information should match the information entered in step 3.
  7. Add the CreateCapitalDepositCaseSuccessPayload (starts on line 107). Consider adding several pieces of important information, such as:
    1. companyOnboarding > id.
    2. documents > type, status, and id.
    3. shareholders information, including onboarding > id.
  8. Add rejections in case the mutation doesn't succeed (starts on line 154).
  9. ▶ Run your mutation.

API mutation​

🔎 Open the mutation in API Explorer

mutation createCase {
  createCapitalDepositCase(
    input: {
      companyName: "MyBrand"
      companyShareholders: {
        capitalDepositAmount: { value: "10000", currency: "EUR" }
        name: "Company shareholder"
        onboardingInfo: {
          individualUltimateBeneficialOwners: [
            {
              type: LegalRepresentative
              birthCity: "Paris"
              birthCityPostalCode: "75000"
              birthCountryCode: "FRA"
              birthDate: "02/02/1988"
              direct: false
              firstName: "Jules"
              lastName: "Fleury"
              totalCapitalPercentage: 51
            }
            {
              type: HasCapital
              birthCity: "Paris"
              birthCityPostalCode: "75000"
              birthCountryCode: "FRA"
              birthDate: "09/01/1989"
              direct: false
              firstName: "Malika"
              lastName: "Ngoma"
              totalCapitalPercentage: 26
            }
          ]
          accountName: "MyBrand company account"
          businessActivity: Arts
          businessActivityDescription: "Description required"
          companyType: Company
          email: "bonjour@mybrand.fr"
          isRegistered: false
          language: "fr"
          monthlyPaymentVolume: Between50000And100000
          name: "Company shareholder"
          residencyAddress: {
            addressLine1: "123 avenue de Paris"
            city: "Paris"
            country: "FRA"
            postalCode: "75000"
          }
        }
      }
      individualShareholders: {
        firstName: "Henri"
        lastName: "Dupont"
        birthDate: "01/11/1992"
        nationality: "FRA"
        capitalDepositAmount: { value: "500", currency: "EUR" }
        onboardingInfo: {
          email: "henri.dupont@mybrand.fr"
          language: "fr"
          employmentStatus: Employee
          monthlyIncome: Between1500And3000
          residencyAddress: {
            addressLine1: "1 rue de la Paix"
            city: "Paris"
            country: "FRA"
            postalCode: "75000"
          }
        }
      }
      totalCapitalDepositAmount: { value: "10500", currency: "EUR" }
      onboardingCapitalDepositCompany: {
        individualUltimateBeneficialOwners: [
          {
            type: LegalRepresentative
            birthCity: "Paris"
            birthCityPostalCode: "75000"
            birthCountryCode: "FRA"
            birthDate: "02/02/1988"
            direct: false
            firstName: "Jules"
            lastName: "Fleury"
            totalCapitalPercentage: 51
          }
          {
            type: HasCapital
            birthCity: "Paris"
            birthCityPostalCode: "75000"
            birthCountryCode: "FRA"
            birthDate: "09/01/1989"
            direct: false
            firstName: "Malika"
            lastName: "Ngoma"
            totalCapitalPercentage: 26
          }
        ]
        accountName: "MyBrand company account"
        accountCountry: FRA
        businessActivity: Arts
        businessActivityDescription: "Description required"
        companyType: Company
        email: "bonjour@mybrand.fr"
        isRegistered: false
        language: "fr"
        monthlyPaymentVolume: Between10000And50000
      }
    }
  ) {
    ... on CreateCapitalDepositCaseSuccessPayload {
      capitalDepositCase {
        companyName
        id
        companyOnboarding {
          id
          createdAt
          info {
            type
          }
        }
        documents {
          type
          status
          id
        }
        shareholders {
          info {
            ... on IndividualShareholder {
              __typename
              firstName
              lastName
            }
            ... on CompanyShareholder {
              __typename
              name
            }
          }
          status
          id
          onboarding {
            id
          }
          documents {
            type
            status
            id
          }
        }
        status
        totalCapitalDepositAmount {
          currency
          value
        }
        updatedAt
      }
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on BadRequestRejection {
      __typename
      message
    }
    ... on InternalErrorRejection {
      __typename
      message
    }
  }
}

Payload​

The options selected in the mutation example produce the following success payload. Note several pieces of key information:

  1. Your capital deposit case id (line 6).
  2. Your company onboarding id (line 8).
  3. Information about required documents, including the type, status, and id (starts on line 14).
  4. Information about all shareholders (starts on line 41), including:
    • Onboarding id (example line 51)
    • Document id (example line 57)
  5. Status of the entire capital deposit case (line 100).
Queries

This information will help you complete your capital deposit.

If needed, use the capitalDepositCase query to get information about an individual case, or the capitalDepositCases query for information about all ongoing capital deposit cases.

{
  "data": {
    "createCapitalDepositCase": {
      "capitalDepositCase": {
        "companyName": "MyBrand",
        "id": "4ca1be36-1760-4966-8303-6f1fcaa3fc6c",
        "companyOnboarding": {
          "id": "e29fcd1b-8a94-48d5-93fb-fb58ed667a60",
          "createdAt": "2023-11-02T10:15:42.093Z",
          "info": {
            "type": "Company"
          }
        },
        "documents": [
          {
            "type": "ArticlesOfIncorporation",
            "status": "Pending",
            "id": "9390583f-f63d-43eb-b1ad-95aa786a76f4"
          },
          {
            "type": "CompanyLeaseAgreement",
            "status": "Pending",
            "id": "97c71862-48d2-4f77-b3f7-3f1461cb8bb2"
          },
          {
            "type": "PowerOfAttorney",
            "status": "Pending",
            "id": "d75b910b-21c2-45d6-ade6-2fc9af00a0a2"
          },
          {
            "type": "CapitalShareDepositCertificate",
            "status": "Pending",
            "id": "3e7c08dd-7d3e-484a-ab93-416bd5337fde"
          },
          {
            "type": "RegisterExtract",
            "status": "Pending",
            "id": "f8be85b9-23b6-4722-a179-c23bf3c28842"
          }
        ],
        "shareholders": [
          {
            "info": {
              "__typename": "IndividualShareholder",
              "firstName": "Henri",
              "lastName": "Dupont"
            },
            "status": "PendingOnboarding",
            "id": "ba874dca-0c09-482b-beba-ceea3e3fa39d",
            "onboarding": {
              "id": "0a5349ba-709d-4e6e-84eb-be19eca2cd0b"
            },
            "documents": [
              {
                "type": "ProofOfIndividualAddress",
                "status": "Pending",
                "id": "4e2581ae-5a31-4499-8f20-fd5ecd5c75f0"
              },
              {
                "type": "ProofOfIdentity",
                "status": "Pending",
                "id": "7ceb8a22-8912-4486-9797-f253f9e0ff28"
              }
            ]
          },
          {
            "info": {
              "__typename": "CompanyShareholder",
              "name": "Company shareholder"
            },
            "status": "PendingOnboarding",
            "id": "ca588da0-bc7a-481d-857f-c3f537a16cf4",
            "onboarding": {
              "id": "3737eed1-ba78-484c-8126-3ccb1042730f"
            },
            "documents": [
              {
                "type": "RegisterExtract",
                "status": "Pending",
                "id": "91517975-65dc-4f00-ac0b-9fe601d38ede"
              },
              {
                "type": "ArticlesOfIncorporation",
                "status": "Pending",
                "id": "4617c161-b33b-42fc-ac77-4f40d12da7ff"
              },
              {
                "type": "CorporateIncomeTaxReturn",
                "status": "Pending",
                "id": "06bfa933-ac8c-4e00-8b3e-492a620807b1"
              },
              {
                "type": "ProofOfIdentity",
                "status": "Pending",
                "id": "50b665be-5ff7-43ac-a8a0-451759f5b261"
              }
            ]
          }
        ],
        "status": "WaitingForRequirements",
        "totalCapitalDepositAmount": {
          "currency": "EUR",
          "value": "10500"
        },
        "updatedAt": "2023-11-02T10:15:42.159Z"
      }
    }
  }
}
- + \ No newline at end of file diff --git a/topics/capital-deposits/france/guide-upload-documents/index.html b/topics/capital-deposits/france/guide-upload-documents/index.html index 371433dc3a9..3852f02db11 100644 --- a/topics/capital-deposits/france/guide-upload-documents/index.html +++ b/topics/capital-deposits/france/guide-upload-documents/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@

Upload required documents

Multi-step process

This page explains how to upload documents for steps 4 and 8 of a multi-step process. Refer to the France guide for the whole process.

Step 1: Generate upload URL​

Use the generateCapitalDepositDocumentUploadUrl mutation to generate an upload URL.

  1. Add the generateCapitalDepositDocumentUploadUrl mutation.
  2. Enter all required information: documentId,capitalDepositCaseId, and filename.
  3. Add the GenerateSupportingDocumentUploadUrlSuccessPayload with the uploadUrl.
  4. Add other optional messages to the payload, either for validation or in case of rejection.
  5. ▶ Run your mutation.

🔎 Open the mutation in API Explorer

mutation MyMutation {
  generateCapitalDepositDocumentUploadUrl(
    input: {
      documentId: "$YOUR_DOCUMENT_ID"
      capitalDepositCaseId: "$YOUR_CAPITALDEPOSITCASE_ID"
      filename: "$FILE_NAME"
    }
  ) {
    ... on GenerateCapitalDepositDocumentUploadUrlSuccessPayload {
      uploadUrl
    }
  }
}

Step 2: Retrieve generated URL from payload​

Retrieve the generated uploadUrl in the payload.

Upload URL expires

The uploadUrl is only valid for seven days, after which you'd need to generate a new URL.

{
  "data": {
    "generateCapitalDepositDocumentUploadUrl": {
      "uploadUrl": "$YOUR_UPLOAD_URL"
    }
  }
}

Step 3: Send HTTP PUT request​

Send an HTTP PUT request to the uploadUrl with a Content-Type: multipart/form-data header.

Supported formats: .pdf, .png, .jpg

curl --upload-file $YOUR_FILE https://$UPLOAD_URL

Step 4: Repeat​

Repeat steps 1-3 to upload additional documents, as needed. You can also change the documents you already uploaded as long as the document status remains Uploaded.

- + \ No newline at end of file diff --git a/topics/capital-deposits/france/guide/index.html b/topics/capital-deposits/france/guide/index.html index aa389f3adea..20d166e1bca 100644 --- a/topics/capital-deposits/france/guide/index.html +++ b/topics/capital-deposits/france/guide/index.html @@ -7,7 +7,7 @@ - + @@ -24,7 +24,7 @@ Be sure to add documents > downloadUrl in the explorer.

Step 8: Upload the register extract (KBIS)​

Upload your KBIS using the same document upload process as in step 4. Choose document type RegisterExtract.

→ Follow the detailed guide to generate an upload URL and upload your KBIS, which includes full API mutation examples.

Step 9: Transfer funds to company account​

After the notary validates the register extract, they'll transfer your capital deposit funds to the company account you created at the beginning of this process. This process usually takes up to two business days.

Congratulations

As soon as the capital funds arrive in your company's Swan account, the capital deposit process is complete.

Best of luck with your endeavor!

- + \ No newline at end of file diff --git a/topics/capital-deposits/index.html b/topics/capital-deposits/index.html index 2a920a5dae3..f1cde179ed6 100644 --- a/topics/capital-deposits/index.html +++ b/topics/capital-deposits/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ Documents must meet Swan's requirements; otherwise, the document will be assigned the status Refused and you'll need to upload the document again.

List of required documents​

All documents are mandatory unless marked if requested.

Stakeholder DocumentAPI document type
Individual shareholdersProof of addressProofOfIndividualAddress
See proof of address section
Identity document proving the shareholder's identity (collected during identity verification)ProofOfIdentity
Company shareholdersDocument available only after the notary validates the case, uploaded during at a specific time during the capital deposit processRegisterExtract
Draft of the articles of incorporationArticlesOfIncorporation
Company's most recent tax statement (if requested)CorporateIncomeTaxReturn
Identity document proving the shareholder's identity (collected during identity verification)ProofOfIdentity
Future companyDraft of the articles of incorporationArticlesOfIncorporation
Lease agreement for official company addressCompanyLeaseAgreement
Lease Mandate from legal representativePowerOfAttorney
Template available in French

Document statuses​

StatusExplanation
PendingPlace for the document is created, but the document isn't uploaded yet
UploadedDocument successfully uploaded; you can change and re-upload the document as long it retains the status Uploaded

Next step: Swan reviews the document and either validates or refuses it
ValidatedSwan validated the document
RefusedSwan refused the document

Shareholders​

A shareholder is a physical or legal person who deposits funds in exchange for ownership of the future company.

In order to deposit funds, the shareholder opens a temporary Swan payment account, which is then assigned an IBAN. This also means that each shareholder must go through the onboarding and verification processes.

Proof of address​

Shareholders must provide proof of their residence address. Only official documents will be validated.

Acceptable documents:

  1. Include the shareholder's full name and residence address.
  2. Are officially issued from the utility company, tax authority, or rental agency.
  3. Are less than three months old.
    1. Exception: Tax documents must be from the most recent year.
  4. Are one of the following document types:
    1. Utility or internet bill (water, gas, electricity, internet).
    2. Tax document mailed to you by an income or housing tax authority.
    3. Professional rent receipt.
document support

If you aren't sure a document complies with these requirements, please send an email to kyc@swan.io.

Shareholder statuses​

StatusExplanation
PendingOnboardingDefault status after the shareholder is created; shareholder must complete their onboarding and their account must be created to continue
WaitingForVerificationPossible status if the account holder verification isn't complete at the moment the shareholder's account is created

Status bypassed if the account holder status is already Verified
WaitingForTransferWaiting for the shareholder to deposit the full share capital in their Swan account created during onboarding, which must be transferred from an account belonging to the shareholder
CapitalTransferredWaiting for the rest of the capital deposit case to be ready and the funds to be transferred to the notary
CapitalFundsWiredToNotaryStill waiting for the rest of the capital deposit case to be ready, but now the funds are with the notary

Sequence diagram​

- + \ No newline at end of file diff --git a/topics/capital-deposits/support/index.html b/topics/capital-deposits/support/index.html index 9c8062e7d01..fe6aa7e80b9 100644 --- a/topics/capital-deposits/support/index.html +++ b/topics/capital-deposits/support/index.html @@ -7,14 +7,14 @@ - +

Support for projects

New support pages

Support pages are the start of improved resources for your operations and support teams.
Please email docs@swan.io with any requests for these new support sections.

- + \ No newline at end of file diff --git a/topics/contact/index.html b/topics/contact/index.html index ecdb0e83698..9129c040e4b 100644 --- a/topics/contact/index.html +++ b/topics/contact/index.html @@ -7,13 +7,13 @@ - +
- + \ No newline at end of file diff --git a/topics/onboarding/account-holders/guide-add-additional-account/index.html b/topics/onboarding/account-holders/guide-add-additional-account/index.html index 6cbe9279c70..fa776318d0c 100644 --- a/topics/onboarding/account-holders/guide-add-additional-account/index.html +++ b/topics/onboarding/account-holders/guide-add-additional-account/index.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@ Since Swan already knows the account holder, verification is quicker than for a new account holder.

Individual account holder​

  1. Run the OnboardIndividualAccountHolder mutation, using the same information as the account holder's existing Swan account.
  2. Finalize the onboarding with the new onboarding ID and the user access token. The account holder doesn't need to do anything.
  3. You'll get new accountId immediately with the status Pending.
  4. Swan will verify the account. Since Swan already knows the account holder, verification is quicker than for a new account holder.
- + \ No newline at end of file diff --git a/topics/onboarding/account-holders/index.html b/topics/onboarding/account-holders/index.html index ca4eb332577..78b9639f567 100644 --- a/topics/onboarding/account-holders/index.html +++ b/topics/onboarding/account-holders/index.html @@ -7,7 +7,7 @@ - + @@ -23,7 +23,7 @@ Learn more in IBAN issuing.

Components​

  1. Onboarding: Process is finalized for either an individual or a company, which creates an account holder, an account, and a user.
  2. Identity verification: Newly-created individual or company account holder completes identity verification with an ID document and a picture or video.
  3. Document collection: Swan collects required documents.
  4. Review: Swan reviews onboarding, identity verification, and collected documents.

After Swan validates the review, the account holder is verified and the restrictions on their account are lifted, meaning they're no longer limited to 150€ in outgoing payments. Their account will also receive its primary IBAN.

User flow diagram

To understand more about your user's verification experience, refer to the user flow diagram for identity verification.

Account holder verification statuses​

Verification statusExplanation
NotStartedVerification process hasn't started yet
WaitingForInformationSwan is waiting for information from the account holder, such as a document or for the account holder to complete identity verification
PendingSwan has begun their review
VerifiedSwan verified the account holder and the process is complete
RefusedSwan won't onboard this account holder

Sequence diagram​

This diagram details a common flow of how Swan, the account holder, and you interact during verification. Your integration might flow differently.

Guides​

- + \ No newline at end of file diff --git a/topics/onboarding/account-holders/sandbox/index.html b/topics/onboarding/account-holders/sandbox/index.html index b7b14f992c7..431e19c069d 100644 --- a/topics/onboarding/account-holders/sandbox/index.html +++ b/topics/onboarding/account-holders/sandbox/index.html @@ -7,14 +7,14 @@ - +

Sandbox: Account holders

Simulate updating an account holder’s verification status​

Step 1: Get the account holder ID​

Use the Dashboard to get the account holder ID.

You could also use the accountHolders query. However, since you can only simulate updating one account holder status at a time, and from your Dashboard, it's simpler to get the ID from the Dashboard.

  1. On your Dashboard, go to Data > Account holders.
  2. Locate the account holder you need.
  3. Click to copy their account holder ID.

Screenshot of Swan Dashboard account holders page with a callout of the account holder ID

Step 2: Update the status​

With the account holder ID, use the Event Simulator to change the account holder verification status to any available status.

  1. On your Dashboard, go to Developers > Event Simulator.
  2. Open Account holders, then go to the Update verification status tab.
  3. Enter the account holder ID into the Account holder ID field.
  4. From the dropdown, choose the status you'd like to simulate.
  5. Click Simulate.

Simulate changing an account holder&#39;s verification status with the Event Simulator

- + \ No newline at end of file diff --git a/topics/onboarding/company/guide-create-onboarding/index.html b/topics/onboarding/company/guide-create-onboarding/index.html index 9ef403ca544..1e11028e3d0 100644 --- a/topics/onboarding/company/guide-create-onboarding/index.html +++ b/topics/onboarding/company/guide-create-onboarding/index.html @@ -7,13 +7,13 @@ - +

Create a company onboarding link

There are two methods you can use to create company onboarding links.

  • Run an API mutation to create a unique onboarding link for each future company account holder.
  • Use a public URL from your Dashboard to share the same company onboarding link with all of your users.

Unique links using the API​

Create a unique company onboarding link for each user with the API.

  1. Add the onboardCompanyAccountHolder mutation.
  2. Enter information for all required API fields for the account country, as noted in country requirements for company accounts.
    1. Start with general company information (lines 4-21).
    2. Next, add details about your UBO.
    3. Finally, add details about your legal representative (if needed; not shown).
  3. Include optional fields as needed for your use case (such as accountName or redirectUrl).
  4. Add optional messages to the success payload, either for validation or in case of rejection.
  5. ▶ Run your mutation.

Mutation​

🔎 Open the mutation in API Explorer

mutation CreateCompanyOnboarding {
  onboardCompanyAccountHolder(
    input: {
      accountCountry: ESP
      businessActivity: Construction
      businessActivityDescription: "Historical restoration"
      companyType: Company
      email: "alberto.moreno@mimarca.io"
      isRegistered: true
      language: "es"
      monthlyPaymentVolume: Between10000And50000
      name: "MiMarca"
      registrationNumber: "123456789"
      residencyAddress: {
        addressLine1: "21 Barrio de San Roque"
        city: "Barcelona"
        country: "ESP"
        postalCode: "08005"
      }
      taxIdentificationNumber: "Y1234567Z"
      typeOfRepresentation: LegalRepresentative
      individualUltimateBeneficialOwners: {
        birthCity: "Madrid"
        birthCountryCode: "ESP"
        birthDate: "1990-03-03"
        direct: true
        indirect: false
        firstName: "Sofia"
        lastName: "Ramos"
        residencyAddress: {
          addressLine1: "1 Camino del Océano"
          city: "Barcelona"
          country: "ESP"
          postalCode: "08005"
        }
        totalCapitalPercentage: 1.5
        type: LegalRepresentative
      }
    }
  ) {
    ... on OnboardCompanyAccountHolderSuccessPayload {
      __typename
      onboarding {
        id
        onboardingState
        statusInfo {
          status
        }
      }
    }
    ... on BadRequestRejection {
      __typename
      message
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on ValidationRejection {
      __typename
      message
      fields {
        message
      }
    }
  }
}

Payload​

If you added validation or rejection messages, you'll see information such as the onboardingId as well as the current status Valid in the success payload.

{
  "data": {
    "onboardCompanyAccountHolder": {
      "__typename": "OnboardCompanyAccountHolderSuccessPayload",
      "onboarding": {
        "id": "eda0ceec-0e20-4d1b-bbee-b3e3a4227c99",
        "onboardingState": "Ongoing",
        "statusInfo": {
          "status": "Valid"
        }
      }
    }
  }
}

Public link using the Dashboard​

  1. On your Swan Dashboard, go to Settings > Onboarding.
  2. In the onboarding URLs section, toggle Public URLs to on.
  3. Notice the URLs that appear for individuals and companies for each account country.
Public URL availability

Anyone could create an account using the public URL, and all accounts created are charged to your project.


Screenshot of Swan Dashboard onboarding page with a callout of the onboarding ID

- + \ No newline at end of file diff --git a/topics/onboarding/company/guide-update-onboarding/index.html b/topics/onboarding/company/guide-update-onboarding/index.html index bfd2d0750d8..40c3d1bead8 100644 --- a/topics/onboarding/company/guide-update-onboarding/index.html +++ b/topics/onboarding/company/guide-update-onboarding/index.html @@ -7,14 +7,14 @@ - +

Update a company onboarding

Update company onboardings using the API.

Updating UBO fields

Fields about an ultimate beneficial owner (UBO) cannot be updated incrementally. If you need to update UBO information, you must submit all of the fields again.

Prerequisites

To update an onboarding:

Guide​

To test updating a company onboarding, change the language.

  1. First, retrieve the ID for the onboarding you need to update.
  2. Add the updateCompanyOnboarding mutation.
  3. Enter the onboarding ID retrieved in step 1.
  4. Check the box for language, then enter the language code of your choosing (example: fr or es).
  5. Add desired messages to the success payload, either for validation or in case of rejection.
    • Recommendation: Inside the UpdateCompanyOnboardingSuccessPayload option, add onboardingState and statusInfo > status to confirm the onboarding is still ongoing and valid after making the update.
  6. ▶ Run your mutation.

API mutation​

🔎 Open the mutation in API Explorer

mutation UpdateCompanyOnboarding {
  updateCompanyOnboarding(
    input: {
      onboardingId: "$ONBOARDING_ID"
      language: "fr"
    }
  ) {
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on InternalErrorRejection {
      __typename
      message
    }
    ... on UpdateCompanyOnboardingSuccessPayload {
      __typename
      onboarding {
        languageonboardingState
        statusInfo {
          status
      }
    }
    ... on ValidationRejection {
      __typename
      message
      fields {
        message
      }
    }
  }
}

Payload​

{
  "data": {
    "updateCompanyOnboarding": {
      "__typename": "UpdateCompanyOnboardingSuccessPayload",
      "onboarding": {
        "language": "fr",
        "onboardingState": "Ongoing",
        "statusInfo": {
          "status": "Valid"
      }
    }
  }
}
- + \ No newline at end of file diff --git a/topics/onboarding/company/index.html b/topics/onboarding/company/index.html index dfbac3c547e..166adb2c13c 100644 --- a/topics/onboarding/company/index.html +++ b/topics/onboarding/company/index.html @@ -7,7 +7,7 @@ - + @@ -21,7 +21,7 @@ Please refer to the section on identity verification for more information on identification levels.

Account countryRecommended level for companiesOther supported levels
🇫🇷 France✓ ExpertQES
PVID
🇩🇪 Germany✓ ExpertQES
🇳🇱 Netherlands✓ ExpertQES
PVID
🇪🇸 Spain✓ ExpertQES
PVID
Self-employed account holders
  • France unregistered self-employed: PVID, or Expert and a first transfer to your Swan account
  • France registered self-employed: Expert
  • Germany self-employed: QES and a first transfer to your Swan account

Country requirements for company accounts​

Requirements vary country to country when opening any type of Swan account. Requirements for company accounts are different than for individual accounts, and there is also a different mutation.

For company accounts, use the onboardCompanyAccountHolder mutation to collect the following information according to your desired account country.

Note that this section is broken up into company and account holder information, information about the UBO, and information about the legal representative.

All have required fields. If the cell is empty, the field is optional.

Company and account holder information​

API field🇫🇷
France		🇩🇪
Germany		🇳🇱
Netherlands		🇪🇸
Spain
accountCountry✓ Required (FRA)✓ Required (DEU)✓ Required (NLD)✓ Required (ESP)
accountName
businessActivity✓ Required✓ Required✓ Required✓ Required
businessActivityDescription✓ Required✓ Required✓ Required✓ Required
companyType✓ Required✓ Required✓ Required✓ Required
email✓ Required✓ Required✓ Required✓ Required
isRegistered✓ Required✓ Required✓ Required✓ Required
language✓ Required✓ Required✓ Required✓ Required
monthlyPaymentVolume✓ Required✓ Required✓ Required✓ Required
name (company name)✓ Required✓ Required✓ Required✓ Required
redirectUrl
registrationNumber
(if registered)		✓ Required✓ Required✓ Required✓ Required
residencyAddress.addressLine1✓ Required✓ Required✓ Required✓ Required
residencyAddress.addressLine2
residencyAddress.city✓ Required✓ Required✓ Required✓ Required
residencyAddress.country✓ Required✓ Required✓ Required✓ Required
residencyAddress.postalCode✓ Required✓ Required✓ Required✓ Required
residencyAddress.state
taxIdentificationNumber∗ 90 days﹖ Conditional
typeOfRepresentation✓ Required✓ Required✓ Required✓ Required
vatNumber

﹖ Required if both the accountCountry and residencyAddress.country are Spain.

∗ If the accountCountry is Germany, the account holder has 90 days to provide their Tax ID Number when opening an account. Otherwise, the account will be suspended.

Ultimate beneficial owner (UBO) information​

Abbreviation

UBO stands for a portion of the API field: individualUltimateBeneficialOwners.

API field🇫🇷
France		🇩🇪
Germany		🇳🇱
Netherlands		🇪🇸
Spain
UBO.birthCity✓ Required✓ Required✓ Required
UBO.birthCityPostalCode✓ Required✓ Required
UBO.birthCountryCode✓ Required✓ Required✓ Required✓ Required
UBO.birthDate✓ Required✓ Required✓ Required
UBO.direct✓ Required✓ Required✓ Required✓ Required
UBO.indirect✓ Required✓ Required✓ Required✓ Required
UBO.firstName✓ Required✓ Required✓ Required✓ Required
UBO.lastName✓ Required✓ Required✓ Required✓ Required
UBO.residencyAddress.addressLine1✓ Required✓ Required
UBO.residencyAddress.addressLine2
UBO.residencyAddress.city✓ Required✓ Required
UBO.residencyAddress.country✓ Required✓ Required
UBO.residencyAddress.postalCode✓ Required✓ Required
UBO.residencyAddress.state
UBO.taxIdentificationNumber﹖ Conditional
UBO.totalCapitalPercentage✓ Required✓ Required✓ Required✓ Required
UBO.type✓ Required✓ Required✓ Required✓ Required

﹖ Required if both the accountCountry and the UBO's residencyAddress.country are Germany.

Abbreviation

lr stands for a portion of the API field: legalRepresentative.

API field🇫🇷
France		🇩🇪
Germany		🇳🇱
Netherlands		🇪🇸
Spain
lrPersonalAddress.addressLine1✓ Required✓ Required
lrPersonalAddress.addressLine2
lrPersonalAddress.city✓ Required✓ Required
lrPersonalAddress.country✓ Required✓ Required
lrPersonalAddress.postalCode✓ Required✓ Required
lrPersonalAddress.state

Guides​

Use the following guides to start and complete the company onboarding process.

- + \ No newline at end of file diff --git a/topics/onboarding/documents/guide-add-document-webhooks/index.html b/topics/onboarding/documents/guide-add-document-webhooks/index.html index 25045db21a3..1baa5615452 100644 --- a/topics/onboarding/documents/guide-add-document-webhooks/index.html +++ b/topics/onboarding/documents/guide-add-document-webhooks/index.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@ Consider testing the endpoint URL before saving the webhook.
  • Use the dropdown to choose the event types you'd like to follow with this webhook. For this use case, choose both SupportingDocumentCollection events.
  • Enter an optional secret key. Alternatively, you can generate one.
  • Click Save.

    • Add a new webhook on the Dashboard

    - + \ No newline at end of file diff --git a/topics/onboarding/documents/guide-delete-document/index.html b/topics/onboarding/documents/guide-delete-document/index.html index 3962280f1be..7f553de03a1 100644 --- a/topics/onboarding/documents/guide-delete-document/index.html +++ b/topics/onboarding/documents/guide-delete-document/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ Note that your end users can delete documents through their banking interface.

    1. Run an API mutation to delete the document.
    2. Delete it directly from your Dashboard.
    Prerequisites

    If you're using the API, you'll need either a project access token, or a user access token for the associated user. Also, the document must have the status Uploaded.

    API guide​

    1. First, retrieve the document ID.
    2. Add the deleteSupportingDocument mutation.
    3. Enter the document ID retrieved in step 1.
    4. Add optional messages to the success payload, either for validation or in case of rejection.
    5. ▶ Run your mutation.

    Mutation​

    🔎 Open the mutation in API Explorer

    mutation DeleteDocument {
      deleteSupportingDocument(input: { id: "$DOCUMENT_ID" }) {
        ... on DeleteSupportingDocumentSuccessPayload {
          id
        }
      }
    }

    Payload​

    If the deletion is successful, the API Explorer returns the document ID. You can confirm that the document no longer exists by checking your Dashboard.

    {
      "data": {
        "deleteSupportingDocument": {
          "id": "f193d0f6-fe7e-4592-9b5f-bce46a968553"
        }
      }
    }

    Dashboard​

    Use the Dashboard to delete a document.

    1. Go to Data > Onboardings > Supporting documents.
    2. Click the trash icon for any document on your list.

    Delete a supporting document from the Dashboard

    - + \ No newline at end of file diff --git a/topics/onboarding/documents/guide-list-documents/index.html b/topics/onboarding/documents/guide-list-documents/index.html index 584c0c83b15..f9f2f2b516d 100644 --- a/topics/onboarding/documents/guide-list-documents/index.html +++ b/topics/onboarding/documents/guide-list-documents/index.html @@ -7,7 +7,7 @@ - + @@ -15,7 +15,7 @@

    Get a list of required documents

    Get a list of required documents for your onboarding using the API by adding information about collecting supporting documents to the success payload when creating an onboarding link.

    Guide​

    1. Create your onboarding link for an individual or a company.
    2. Add the supportingDocumentCollection field and the requiredSupportingDocumentPurposes subfield to the success payload. You might also choose to add collection status info.
    3. ▶ Run your mutation.

    API mutation​

    Partial mutation

    Add this information to the full mutation when creating an individual or company onboarding link. Note that the example features company onboarding.

    mutation ListRequiredDocuments {
      onboardCompanyAccountHolder {
      {...}
        ... on OnboardCompanyAccountHolderSuccessPayload {
          __typename
          onboarding {
            id
            onboardingState
            statusInfo {
              status
            }
            supportingDocumentCollection {
              requiredSupportingDocumentPurposes {
                acceptableSupportingDocumentTypes
                name
              }
              statusInfo {
                status
              }
            }
          }
        }
      {...}
      }
    }

    Payload​

    Review this full success payload for a company account holder onboarding.

    Notice the documents listed (lines 11-23), as well as the collection status WaitingForDocument (line 27).

    {
      "data": {
        "onboardCompanyAccountHolder": {
          "__typename": "OnboardCompanyAccountHolderSuccessPayload",
          "onboarding": {
            "id": "$ONBOARDING_ID",
            "onboardingState": "Ongoing",
            "statusInfo": {
              "status": "Valid"
            },
            "supportingDocumentCollection": {
              "requiredSupportingDocumentPurposes": [
                {
                  "acceptableSupportingDocumentTypes": [
                    "UBODeclaration"
                  ],
                  "name": "UBODeclaration"
                },
                {
                  "acceptableSupportingDocumentTypes": [
                    "SwornStatement"
                  ],
                  "name": "SwornStatement"
                }
              ],
              "statusInfo": {
                "status": "WaitingForDocument"
              }
            }
          }
        }
      }
    }
    - + \ No newline at end of file diff --git a/topics/onboarding/documents/guide-request-collection-review/index.html b/topics/onboarding/documents/guide-request-collection-review/index.html index a7d45381d59..220a959d334 100644 --- a/topics/onboarding/documents/guide-request-collection-review/index.html +++ b/topics/onboarding/documents/guide-request-collection-review/index.html @@ -7,14 +7,14 @@ - +

    Request a collection review

    After all required supporting documents are uploaded, you can ask Swan to review your collection using the API or on your Dashboard.

    Prerequisites

    The collection must have the status Waiting for document, and there must be at least one document in the collection with the status Uploaded.

    API guide​

    1. First, retrieve the collection ID (supportingDocumentCollectionId).
    2. Add the requestSupportingDocumentCollectionReview mutation.
    3. Enter the collection ID retrieved in step 1.
    4. Add optional messages to the payload, either for validation or in case of rejection.
    5. ▶ Run your mutation.

    Mutation​

    🔎 Open the mutation in API Explorer

    mutation RequestCollectionReview {
      requestSupportingDocumentCollectionReview(
        input: { supportingDocumentCollectionId: "$COLLECTION_ID" }
      ) {
        ... on RequestSupportingDocumentCollectionReviewSuccessPayload {
          __typename
          supportingDocumentCollection {
            id
            statusInfo {
              status
            }
          }
        }
        ... on ForbiddenRejection {
          __typename
          message
        }
        ... on SupportingDocumentCollectionNotFoundRejection {
          id
          message
        }
        ... on SupportingDocumentCollectionStatusNotAllowedRejection {
          __typename
          message
          newStatus
          oldStatus
        }
      }
    }

    Payload​

    Notice the status PendingReview. You can also confirm this on your Dashboard—there should be an infobox in the supporting documents tab for this onboarding.

    {
      "data": {
        "requestSupportingDocumentCollectionReview": {
          "__typename": "RequestSupportingDocumentCollectionReviewSuccessPayload",
          "supportingDocumentCollection": {
            "id": "b52c51b4-8a23-45a2-b77a-e6d691f4578c",
            "statusInfo": {
              "status": "PendingReview"
            }
          }
        }
      }
    }

    Dashboard​

    Use the Dashboard to request a review of your supporting document collection.

    1. On your Dashboard, go to Data > Onboardings.
    2. Open the onboarding for which you'd like to request a collection review.
    3. Open the Supporting documents tab.
    4. Click Request document review to begin the review process.
    5. A confirmation modal will appear. Click Confirm to finalize your request.

    Request a collection review from the Dashboard

    No updates while pending review

    As soon as you click Confirm, you can no longer upload additional documents or change uploaded documents until the review is complete.

    - + \ No newline at end of file diff --git a/topics/onboarding/documents/guide-retrieve-info/index.html b/topics/onboarding/documents/guide-retrieve-info/index.html index dfcc6e8cbb4..88f34b51215 100644 --- a/topics/onboarding/documents/guide-retrieve-info/index.html +++ b/topics/onboarding/documents/guide-retrieve-info/index.html @@ -7,14 +7,14 @@ - +

    Retrieve information about a collection or document

    There are two methods you can use to get information about a collection or a document.

    1. Run an API query to get information about collections and documents.
    2. Get information about individual documents from your Dashboard.

    API guide​

    You can use either the user's onboarding ID or, if their onboarding is Finalized, their account holder ID, to get information about a supporting document collection or an individual document.

    Onboarding or account holder ID

    This guide uses the onboarding ID. If the onboarding is Finalized, use the accountHolder query with the account holder ID instead.

    1. First, retrieve the required onboarding ID.
    2. Add the onboarding query.
    3. Enter the onboarding ID retrieved in step 1.
    4. Choose to query either collection (line 3) or document (line 5) information, or keep both.
    5. ▶ Run your query.

    Query​

    🔎 Open the query in API Explorer

    query DocumentCollectionInfo {
      onboarding(id: "$USER_ONBOARDING_ID") {
        supportingDocumentCollection {
          id
          supportingDocuments {
            id
            supportingDocumentPurpose
            supportingDocumentType
          }
        }
      }
    }

    Payload​

    The API Explorer returns the collection or document ID.

    {
      "data": {
        "onboarding": {
          "supportingDocumentCollection": {
            "id": "b52c51b4-8a23-45a2-b77a-e6d691f4578c",
            "supportingDocuments": [
              {
                "id": "03a5601d-f9cc-448d-ad26-02aa04e5688a",
                "supportingDocumentPurpose": "ProofOfIndividualAddress",
                "supportingDocumentType": "HomeInsurance"
              }
            ]
          }
        }
      }
    }

    Dashboard​

    Use the Dashboard to get a document ID.

    1. Go to Data > Onboardings > Supporting documents.
    2. Scroll horizontally to locate the document ID, then click to copy.

    Get a document ID from the Dashboard

    - + \ No newline at end of file diff --git a/topics/onboarding/documents/guide-upload-document/index.html b/topics/onboarding/documents/guide-upload-document/index.html index 735eabbe0f3..22454d0a1a5 100644 --- a/topics/onboarding/documents/guide-upload-document/index.html +++ b/topics/onboarding/documents/guide-upload-document/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ Supported formats are .pdf, .png, and .jpg.

    curl --location --request POST '$UPLOAD_URL' \
    --form 'Key="INPUT/$ID"' \
    --form 'X-Amz-Algorithm="AWS4-HMAC-SHA256"' \
    --form 'X-Amz-Credential="$CREDENTIAL"' \
    --form 'X-Amz-Date="20220705T135458Z"' \
    --form 'X-Amz-Security-Token="$TOKEN"' \
    --form 'Policy="$POLICY"' \
    --form 'X-Amz-Signature="$SIGNATURE"' \
    --form 'X-Amz-Meta-X-Swan-Supporting-Document-Id="$DOCUMENT_ID"' \
    --form 'file=@"$FILE_PATH"'

    Replace all $VARIABLES with your values from step 2.

    Upload successful

    When you upload a document with the HTTP POST cURL command, Amazon sends a 204: No content error, but the document was successfully uploaded.

    Dashboard​

    Use the Dashboard to upload required documents.

    1. On your Dashboard, go to Data > Onboardings.
    2. Open the onboarding for which you'd like to upload documents. The onboarding status must be Ongoing (Valid).
    3. Open the Supporting documents tab.
    4. Click + New to add a new supporting document.
    5. Attach your document file. Supported formats are .pdf, .png, and .jpg.
    6. The name field fills automatically with the name of your file. Feel free to change it.
    7. Choose your document type and purpose from the dropdown options.
    8. Click Upload to upload your supporting document.

    Upload a supporting document from the Dashboard

    - + \ No newline at end of file diff --git a/topics/onboarding/documents/index.html b/topics/onboarding/documents/index.html index 8fb5b9b700a..5f303ed21f4 100644 --- a/topics/onboarding/documents/index.html +++ b/topics/onboarding/documents/index.html @@ -7,7 +7,7 @@ - + @@ -20,7 +20,7 @@ You need to add documents to these collections as requested. For each required document, you'll create a document within the collection.

    Each document added to a collection runs through the following statuses.

    Document statusExplanation
    Waiting for uploadURL to upload the document has been generated

    Next step:
    • If the document is uploaded → Uploaded
    • If onboarding is finalized before the document is uploaded → Not uploaded
    UploadedDocument is uploaded

    Next step:
    • If a review is completed on the uploaded document → Status moves to Validated, Refused, or Deleted depending on Partner actions and Swan decisions
    • If onboarding is finalized before the uploaded document is reviewed → Not uploaded
    ValidatedSwan approved the document
    RefusedSwan refused the document
    DeletedSwan or the partner deleted the document
    Not uploadedURL was generated but collection was closed before a document was uploaded

    Document purposes and types​

    For all supporting documents, there is a high-level purpose and a more specific type (supportingDocumentPurpose and supportingDocumentType). Both purpose and type can be exposed in the onboarding success payload.

    Common purposes (not exhaustive):

    • CompanyRegistration
    • SignedStatus
    • ProofOfAddress
    • ProofOfIncome
    • Other

    Webhooks​

    There are two webhooks associated with supporting documents:

    • SupportingDocumentCollection.Created
    • SupportingDocumentCollection.Updated

    Guides​

    Use the following guides to manage required documents for the onboarding process.

    - + \ No newline at end of file diff --git a/topics/onboarding/documents/sandbox/index.html b/topics/onboarding/documents/sandbox/index.html index 5507ea649de..86831c31434 100644 --- a/topics/onboarding/documents/sandbox/index.html +++ b/topics/onboarding/documents/sandbox/index.html @@ -7,13 +7,13 @@ - +

    Sandbox: Supporting document collection

    Simulate updating the status of a document​

    Step 1: Get the supporting document collection ID​

    Get the ID for the supporting document collection using either the user's onboarding ID or, if their onboarding is Finalized, their account holder ID.

    🔎 Open the query in API Explorer

    query getCollectionId {
      onboarding(id: "$USER_ONBOARDING_ID") {
        supportingDocumentCollection {
          id
          requiredSupportingDocumentPurposes {
            name
          }
          statusInfo {
            status
          }
        }
      }
    }

    Step 2: Update the status​

    With the supporting document collection ID, use the Event Simulator to change the supporting document collection status to any available status.

    1. On your Dashboard, go to Developers > Event Simulator.
    2. Open Account holders, then go to the Update Supporting Document Collection status tab.
    3. Copy the document ID from the success payload you received during step 1, then paste it into the Supporting Document Collection ID field in the Event Simulator.
    4. From the dropdown, choose the status you'd like to simulate.
    5. Click Simulate.

    Simulate changing the status of a supporting document collection with the Event Simulator

    note

    At this time, it's only possible to simulate status changes for collections, not individual documents.

    - + \ No newline at end of file diff --git a/topics/onboarding/index.html b/topics/onboarding/index.html index 6cfbcb04c2d..5c30016fe57 100644 --- a/topics/onboarding/index.html +++ b/topics/onboarding/index.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@ However, they're split in the documentation to prevent mixing up small but important details.

    Swan Banking Frontend

    If you'd like to customize the onboarding experience for your users (while respecting local regulations), check out the open source Swan Banking Frontend.

    Purpose of onboarding​

    Completing the onboarding process serves several purposes.

    1. Account holder is created with the status Enabled.
    2. Account holder's account is created.
    3. If the person who performed the onboarding process is the legal representative of the account, they have the first account membership with full permissions. This isn't true if the person who performed the onboarding did so with power of attorney.
    4. Your relationship with the account holder is stored in the partnershipStatusInfofield of the account object.

    Onboarding statuses​

    StatusExplanation
    Ongoing (Invalid)
    • This is the first status assigned to an onboarding when using the frontend.
    • If using the API, this is the first status if not all required information is included with your mutation.
    • Status might change to Invalid if required information is removed or if some information is incorrect.
    Next step: Submit or update required information to advance to Ongoing (Valid) (both you and the end user can submit or update information)
    Ongoing (Valid)
    • This is the first status assigned to an onboarding if using the API and you included all required information with your mutation.
    • Status changes to Valid when missing required information is submitted or if incorrect information is updated.
    Next step: User completes form, clicks "Finalize," and provides consent to complete the onboarding process
    FinalizedOnboarding completed

    Country requirements​

    Onboarding is a highly localized experience. Everything from what to include in your API request to how to ask users to verify their identity to whether Swan requires certain ID numbers or documents depends on the account country.

    Account onboarding country requirements are described in the individual and company onboarding sections. Please follow the requirements for your target countries closely.

    Sequence diagram: API onboarding flow​

    Guides​

    The following guides are common to the individual and company onboarding processes.

    - + \ No newline at end of file diff --git a/topics/onboarding/individual/guide-create-onboarding/index.html b/topics/onboarding/individual/guide-create-onboarding/index.html index e24cb603953..a9a3c788e7a 100644 --- a/topics/onboarding/individual/guide-create-onboarding/index.html +++ b/topics/onboarding/individual/guide-create-onboarding/index.html @@ -7,13 +7,13 @@ - +

    Create an individual onboarding link

    There are two methods you can use to create individual onboarding links.

    • Run an API mutation to create a unique onboarding link for each future individual account holder.
    • Use a public URL from your Dashboard to share the same individual onboarding link with all of your users.

    Unique links using the API​

    Create a unique individual onboarding link for each user with the API.

    1. Add the onboardIndividualAccountHolder mutation.
    2. Enter information for all required API fields for the account country, as noted in country requirements for individual accounts.
    3. Include optional fields as needed for your use case (such as accountName or redirectUrl).
    4. Add optional messages to the success payload, either for validation or in case of rejection.
    5. ▶ Run your mutation.

    Mutation​

    🔎 Open the mutation in API Explorer

    mutation CreateIndividualOnboarding {
      onboardIndividualAccountHolder(
        input: {
          accountCountry: FRA
          email: "malika.ngomao@mybrand.io"
          employmentStatus: Employee
          language: "FR"
          monthlyIncome: Between3000And4500
          residencyAddress: {
            addressLine1: "123 avenue de Paris"
            city: "Paris"
            country: "FRA"
            postalCode: "75000"
          }
        }
      ) {
        ... on OnboardIndividualAccountHolderSuccessPayload {
          __typename
          onboarding {
            id
            statusInfo {
              status
            }
          }
        }
        ... on ForbiddenRejection {
          __typename
          message
        }
        ... on ValidationRejection {
          __typename
          message
        }
      }
    }

    Payload​

    If you added validation or rejection messages, you'll see information such as the onboardingId as well as the current status Ongoing (Valid) in the success payload.

    {
      "data": {
        "onboardIndividualAccountHolder": {
          "__typename": "OnboardIndividualAccountHolderSuccessPayload",
          "onboarding": {
            "id": "ae06faf6-13b2-4e9e-891b-e78ecd5ca0e4",
            "onboardingState": "Ongoing",
            "statusInfo": {
              "status": "Valid"
            }
          }
        }
      }
    }

    Public link using the Dashboard​

    1. On your Swan Dashboard, go to Settings > Onboarding.
    2. In the onboarding URLs section, toggle Public URLs to on.
    3. Notice the URLs that appear for individuals and companies for each account country.
    Public URL availability

    Anyone could create an account using the public URL, and all accounts created are charged to your project.


    Screenshot of Swan Dashboard onboarding page with a callout of the onboarding ID

    - + \ No newline at end of file diff --git a/topics/onboarding/individual/guide-update-onboarding/index.html b/topics/onboarding/individual/guide-update-onboarding/index.html index f4a8f2874b7..abbbb4c342f 100644 --- a/topics/onboarding/individual/guide-update-onboarding/index.html +++ b/topics/onboarding/individual/guide-update-onboarding/index.html @@ -7,13 +7,13 @@ - +

    Update an individual onboarding

    Update individual onboardings using the API.

    Prerequisites

    To update an onboarding:

    Guide​

    To test updating an individual onboarding, add an account name.

    1. First, retrieve the ID for the onboarding you need to update.
    2. Add the updateIndividualOnboarding mutation.
    3. Enter the onboarding ID retrieved in step 1.
    4. Check the box for accountName, then add an account name (example: MyBrand).
    5. Add desired messages to the success payload, either for validation or in case of rejection.
      • Recommendation: Inside the UpdateIndividualOnboardingSuccessPayload option, add onboardingState and statusInfo > status to confirm the onboarding is still ongoing and valid after making the update.
    6. ▶ Run your mutation.

    API mutation​

    🔎 Open the mutation in API Explorer

    mutation UpdateIndividualOnboarding {
      updateIndividualOnboarding(
        input: {
          onboardingId: "$ONBOARDING_ID"
          accountName: "Personal account"
        }
      ) {
        ... on ForbiddenRejection {
          __typename
          message
        }
        ... on InternalErrorRejection {
          __typename
          message
        }
        ... on UpdateIndividualOnboardingSuccessPayload {
          __typename
          onboarding {
            accountName
            onboardingState
            statusInfo {
              status
            }
          }
        }
        ... on ValidationRejection {
          __typename
          message
          fields {
            message
          }
        }
      }
    }

    Payload​

    {
      "data": {
        "updateIndividualOnboarding": {
          "__typename": "UpdateIndividualOnboardingSuccessPayload",
          "onboarding": {
            "accountName": "MyBrand",
            "onboardingState": "Ongoing",
            "statusInfo": {
              "status": "Valid"
          }
        }
      }
    }
    - + \ No newline at end of file diff --git a/topics/onboarding/individual/index.html b/topics/onboarding/individual/index.html index 9e34566e813..89369e36f54 100644 --- a/topics/onboarding/individual/index.html +++ b/topics/onboarding/individual/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ Please refer to the section on identity verification for more information on identification levels.

    Account countryRecommended level
    for individuals    		Other supported levels
    🇫🇷 France✓ PVIDExpert + first transfer
    QES
    🇩🇪 Germany✓ QES + first transfernone
    🇳🇱 Netherlands✓ ExpertQES
    PVID
    🇪🇸 Spain✓ ExpertQES
    PVID

    Country requirements for individual accounts​

    Requirements vary country to country when opening any type of Swan account. Requirements for individual accounts are different than for company accounts, and there is also a different mutation.

    For individual accounts, use the onboardIndividualAccountHolder mutation to collect the following information according to your desired account country. If the cell is empty, the field is optional.

    API field🇫🇷
    France    		🇩🇪
    Germany    		🇳🇱
    Netherlands    		🇪🇸
    Spain
    accountCountry✓ Required (FRA)✓ Required (DEU)✓ Required (NLD)✓ Required (ESP)
    accountName
    email✓ Required✓ Required✓ Required✓ Required
    employmentStatus✓ Required✓ Required✓ Required✓ Required
    language✓ Required✓ Required✓ Required✓ Required
    monthlyIncome✓ Required✓ Required✓ Required✓ Required
    redirectUrl
    residencyAddress.addressLine1✓ Required✓ Required✓ Required✓ Required
    residencyAddress.addressLine2
    residencyAddress.city✓ Required✓ Required✓ Required✓ Required
    residencyAddress.country✓ Required✓ Required✓ Required✓ Required
    residencyAddress.postalCode✓ Required✓ Required✓ Required✓ Required
    residencyAddress.state
    taxIdentificationNumber∗ 90 days

    ∗ If the accountCountry is Germany, the account holder has 90 days to provide their Tax ID Number when opening an account. Otherwise, the account will be suspended.

    Guides​

    Use the following guides to start and complete the individual onboarding process.

    - + \ No newline at end of file diff --git a/topics/onboarding/overview/guide-finalize-onboarding/index.html b/topics/onboarding/overview/guide-finalize-onboarding/index.html index 06a4157eb4c..826b004efe1 100644 --- a/topics/onboarding/overview/guide-finalize-onboarding/index.html +++ b/topics/onboarding/overview/guide-finalize-onboarding/index.html @@ -7,13 +7,13 @@ - +

    Finalize an onboarding

    You can finalize onboardings using the API.

    Your end users can also finalize their own onboardings using the onboarding URLs you create for individuals or companies.

    Prerequisites

    To finalize an onboarding using the API:

    • You must have a user access token for the user whose onboarding you're finalizing, and the user must have accessed their onboarding URL at least one time.
    • The onboarding status must be Ongoing (Valid).

    If you need to update an onboarding before finalizing it, follow the guides for updating an individual or company onboarding.

    Guide​

    Finalize an onboarding using the API.

    1. First, retrieve the ID for the onboarding you're finalizing.
    2. Add the finalizeOnboarding mutation.
    3. Enter the onboarding ID retrieved in step 1.
    4. Add optional messages to the success payload, either for validation or in case of rejection.
    5. Confirm you're using the user access token to run the mutation.
    6. ▶ Run your mutation.

    Mutation​

    🔎 Open the mutation in API Explorer

    Notice the request to include the account ID and account holder ID, as well as the onboarding status, in the success payload.

    mutation finalizeOnboarding {
      finalizeOnboarding(input: { onboardingId: "$ONBOARDING_ID" }) {
        ... on FinalizeOnboardingSuccessPayload {
          __typename
          onboarding {
            account {
              id
              holder {
                id
              }
            }
            statusInfo {
              status
            }
          }
        }
        ... on OnboardingNotCompletedRejection {
          __typename
        }
        ... on ValidationRejection {
          __typename
          message
        }
      }
    }

    Payload​

    Notice the ID for the newly-created account and account holder, as well as the onboarding status Finalized.

    {
      "data": {
        "finalizeOnboarding": {
          "__typename": "FinalizeOnboardingSuccessPayload",
          "onboarding": {
            "account": {
              "id": "$NEW_ACCOUNT_ID",
              "holder": {
                "id": "$NEW_ACCOUNT_HOLDER_ID"
              }
            },
            "statusInfo": {
              "status": "Finalized"
            }
          }
        }
      }
    }
    - + \ No newline at end of file diff --git a/topics/onboarding/overview/guide-get-onboarding-info/index.html b/topics/onboarding/overview/guide-get-onboarding-info/index.html index d32b731c5cc..76f1b7c2dc2 100644 --- a/topics/onboarding/overview/guide-get-onboarding-info/index.html +++ b/topics/onboarding/overview/guide-get-onboarding-info/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ Refer to the guides to update an individual or company onboarding.

    Prerequisites

    To monitor onboarding progress, you must have at least one existing onboarding, either individual or company. The onboarding can have any status.

    Guide​

    1. Add the onboardings query.
    2. Add all the query options you'd like to monitor.
      • For this exercise, add: createdAt, email, info > type, onboardingUrl, onboardingState, statusInfo > status, id, and totalCount.
      • To statusInfo > status, add a rejection as well: OnboardingInvalidStatusInfo with errors, field, and status.
    3. ▶ Run your query.
    Note about onboarding count

    Running the onboardings query returns a list of all onboardings for your project, including completed onboardings and ongoing onboardings that are valid or invalid. The totalCount could be high.

    Limit how many onboardings are returned by adding the first query option, then indicating the number of onboardings you'd like to review.

    Query​

    🔎 Open the query in API Explorer

    query MonitorOnboarding {
      onboardings {
        edges {
          node {
            createdAt
            email
            info {
              type
            }
            onboardingUrl
            onboardingState
            statusInfo {
              status
              ... on OnboardingInvalidStatusInfo {
                __typename
                errors {
                  field
                  errors
                }
                status
              }
            }
            id
          }
        }
        totalCount
      }
    }

    Payload​

    Review the sample payload with two Ongoing onboardings, one Invalid and one Valid, as well as one Completed onboarding with the status Finalized.

    {
      "data": {
        "onboardings": {
          "edges": [
            {
              "node": {
                "createdAt": "2023-06-20T14:10:39.286Z",
                "email": "alberto.moreno@mimarca.io",
                "info": {
                  "type": "Company"
                },
                "onboardingUrl": "https://api.banking.swan.io/projects/$PROJECT_ID/onboardings/$ONBOARDING_ID?lang=es",
                "onboardingState": "Ongoing",
                "statusInfo": {
                  "status": "Invalid",
                  "__typename": "OnboardingInvalidStatusInfo",
                  "errors": [
                    {
                      "field": "individualUltimateBeneficialOwners[0].birthDate",
                      "errors": [
                        "Missing"
                      ]
                    }
                  ]
                },
                "id": "$ONBOARDING_ID"
              }
            },
            {
              "node": {
                "createdAt": "2023-06-20T14:00:20.207Z",
                "email": "sofia.ramos@mybrand.io",
                "info": {
                  "type": "Individual"
                },
                "onboardingUrl": "https://api.banking.swan.io/projects/$PROJECT_ID/onboardings/$ONBOARDING_ID?lang=en",
                "onboardingState": "Ongoing",
                "statusInfo": {
                  "status": "Valid"
                },
                "id": "$ONBOARDING_ID",
              }
            },
            {
              "node": {
                "createdAt": "2023-08-01T09:01:17.050Z",
                "email": "malika.ngomao@mybrand.io",
                "info": {
                  "type": "Individual"
                },
                "onboardingUrl": "https://api.banking.swan.io/projects/$PROJECT_ID/onboardings/$ONBOARDING_ID?lang=fr",
                "onboardingState": "Completed",
                "statusInfo": {
                  "status": "Finalized"
                },
                "id": "$ONBOARDING_ID",
              }
            },
          ],
          "totalCount": 3
        }
      }
    }
    - + \ No newline at end of file diff --git a/topics/onboarding/support/index.html b/topics/onboarding/support/index.html index c92571e1549..500e634e7f8 100644 --- a/topics/onboarding/support/index.html +++ b/topics/onboarding/support/index.html @@ -7,14 +7,14 @@ - +

    Support for account onboarding

    New support pages

    Support pages are the start of improved resources for your operations and support teams.
    Please email docs@swan.io with any requests for these new support sections.

    User flow diagrams​

    Individual​

    Individual account onboarding
    Individual onboarding documents

    Company​

    Company account onboarding
    Company onboarding documents

    Account holder identity verification​

    Identity verification
    - + \ No newline at end of file diff --git a/topics/projects/guide-activate-project/index.html b/topics/projects/guide-activate-project/index.html index 573aff4646c..6bdf1d80b62 100644 --- a/topics/projects/guide-activate-project/index.html +++ b/topics/projects/guide-activate-project/index.html @@ -7,7 +7,7 @@ - + @@ -26,7 +26,7 @@ As soon as your branding is approved, you'll see it in your Live project environment.

    Step 9: Get your final integration review​

    Every integration must pass a final technical review. Swan also reviews all materials that mention Swan and Swan features.

    Please send the following materials to compliance@swan.io to start your final review:

    1. Explanation of how you present your offer and where you market Swan features. Please make sure to review Swan's guidelines when creating these materials.
    2. Link your clients will use to open their Swan accounts.
    3. Access to your userflow (in your staging environment).
    4. Your terms and conditions.
    5. Your privacy policy.

    The final review can take time (usually about one week). You can send these materials to Swan as soon as they're ready, even if you are early in the activation process.

    - + \ No newline at end of file diff --git a/topics/projects/index.html b/topics/projects/index.html index 5234de2919b..acd57659ce4 100644 --- a/topics/projects/index.html +++ b/topics/projects/index.html @@ -7,7 +7,7 @@ - + @@ -19,7 +19,7 @@ Projects can remain Sandbox-only if you're goal for the project is to test various implementations.

    After a project passes to the status LimitedLiveAccess, the project owner can begin testing the Live implementation. From there, more and more Live access is granted (assuming the project passes reviews).

    After a project is Live, you can switch between Sandbox and Live. Use Sandbox to test new features before releasing them to your Live users.

    Can't move between projects

    You can't migrate work between projects. If you have a Live project and you'd like to test an implementation in Sandbox before launching, use that Live project's Sandbox mode.

    Project statuses​

    StatusExplanationLive availableOnboarding available
    InitiatedPartner creates a project

    Next: Partner schedules meeting with Swan    		☒ No☒ No
    MeetingScheduledPartner schedules a meeting

    Next: Partner schedules meeting with Swan    		☒ No☒ No
    PendingComplianceSwan performs a review of the project for risk and compliance reasons

    Next: Partner starts investigative development of their implementation while Swan performs the review    		☒ No
    ✅ Yes for project owner only

    ☒ No for users and companies
    LimitedLiveAccessReview accepted; Partner can use Swan for their own account only

    Next: Partner continues testing their development, then requests a review    		✅ Yes☒ No
    PendingLiveReviewPartner asks Swan to review; Swan performs a technical review of the Live implementation

    Next: Partner stays responsive to questions as Swan performs Live review    		✅ Yes☒ No
    BetaLiveAccessSwan approves implementation for a limited number of Live accounts

    Next: Partner begins onboarding a limited number of accounts    		✅ Yes✅ Yes (limited)
    FullLiveAccessSwan approves implementation for full Live access

    Next: Partner uses their Swan implementation    		✅ Yes✅ Yes (unlimited)
    DisabledProject is not longer active (could be due to Partner request, Swan's choice, or a mutual decision)

    Next: No next steps    		☒ No☒ No
    SuspendedProject is suspended, either pending a review by Swan or at the Partner's request

    Next: If due to Swan review, Partner stays responsive to questions as Swan performs the review; if due to Partner request, the Partner should communicate with Swan about reactivating the project    		☒ No☒ No
    RejectedSwan rejects the project (reasons vary and are communicated to the Partner or main point of contact)

    Next: No next steps    		☒ No☒ No

    Guides​

    - + \ No newline at end of file diff --git a/topics/projects/support/index.html b/topics/projects/support/index.html index 1f110b3ad44..495b66a988c 100644 --- a/topics/projects/support/index.html +++ b/topics/projects/support/index.html @@ -7,14 +7,14 @@ - +
    - + \ No newline at end of file diff --git a/use-cases/bnpl/index.html b/use-cases/bnpl/index.html index d387be04b14..6f455bab94b 100644 --- a/use-cases/bnpl/index.html +++ b/use-cases/bnpl/index.html @@ -7,13 +7,13 @@ - +
    - + \ No newline at end of file diff --git a/use-cases/expense/index.html b/use-cases/expense/index.html index 4fec1812f09..e1e7a7ae498 100644 --- a/use-cases/expense/index.html +++ b/use-cases/expense/index.html @@ -7,13 +7,13 @@ - +

    Expense management

    info

    This section is purposefully empty right now.

    - + \ No newline at end of file diff --git a/use-cases/financial/index.html b/use-cases/financial/index.html index 3ec27777cfb..450429e78c7 100644 --- a/use-cases/financial/index.html +++ b/use-cases/financial/index.html @@ -7,13 +7,13 @@ - +

    Financial management

    info

    This section is purposefully empty right now.

    - + \ No newline at end of file diff --git a/use-cases/intro/index.html b/use-cases/intro/index.html index 7fa5365092b..19e8ea3c507 100644 --- a/use-cases/intro/index.html +++ b/use-cases/intro/index.html @@ -7,13 +7,13 @@ - +

    Swan use cases

    info

    This section is purposefully empty right now.

    - + \ No newline at end of file diff --git a/use-cases/rental/index.html b/use-cases/rental/index.html index 2d7f0c8024d..e0ef915e3f7 100644 --- a/use-cases/rental/index.html +++ b/use-cases/rental/index.html @@ -7,13 +7,13 @@ - +

    Rental management

    info

    This section is purposefully empty right now.

    - + \ No newline at end of file diff --git a/use-cases/swan-solo/index.html b/use-cases/swan-solo/index.html index 3e6336eab4e..bbc9f6c9187 100644 --- a/use-cases/swan-solo/index.html +++ b/use-cases/swan-solo/index.html @@ -7,13 +7,13 @@ - +

    Swan Solo

    info

    This section is purposefully empty right now.

    - + \ No newline at end of file diff --git a/use-cases/vertical/index.html b/use-cases/vertical/index.html index d625e57c492..46ebe2b3790 100644 --- a/use-cases/vertical/index.html +++ b/use-cases/vertical/index.html @@ -7,13 +7,13 @@ - +

    Vertical SaaS

    info

    This section is purposefully empty right now.

    - + \ No newline at end of file