Endpoints for creating an account
- name: Update an account description:Endpoints for updating an account
- name: Get account information description: Endpoints for fetching an account paths: /v4/{id}: get: tags: - Get account information summary: Get account description: This operation will respond with an account given account id operationId: getAccountV4UsingGET parameters: - name: auditUser in: query description: The audit user to log the request required: true schema: type: string - name: id in: path description: The account id for given account required: true schema: type: string format: biginteger responses: '200': description: Successful lookup of the account content: application/json: schema: discriminator: propertyName: template mapping: CREDIT: $ref: '#/components/schemas/creditAccountResponse' DEBIT: $ref: '#/components/schemas/debitAccountResponse' PREPAID: $ref: '#/components/schemas/prepaidAccountResponse' FLEET: $ref: '#/components/schemas/fleetAccountResponse' MULTICURR_EUR_DE: $ref: '#/components/schemas/multiCurrAccountResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorResponse' '404': description: Account does not exist content: application/json: schema: $ref: '#/components/schemas/errorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorResponse' deprecated: false components: schemas: creditAccountResponse: allOf: - $ref: '#/components/schemas/standardAccountResponse' - properties: address: $ref: '#/components/schemas/address' description: >- Address connected to an account that will override the address set on customer level. This is for example used when sending out statements creditLimit: $ref: '#/components/schemas/creditLimit' delinquencyDate: $ref: '#/components/schemas/delinquencyDate' dueDate: $ref: '#/components/schemas/dueDate' eInvoice: $ref: '#/components/schemas/eInvoice' interestPostingEnabled: $ref: '#/components/schemas/interestPostingEnabled' invoiceDayOfMonth: $ref: '#/components/schemas/invoiceDayOfMonth' invoiceDeliveryMethod: $ref: '#/components/schemas/invoiceDeliveryMethod' invoicedBalance: $ref: '#/components/schemas/invoicedBalance' statementBalance: $ref: '#/components/schemas/statementBalance' minimumToPay: $ref: '#/components/schemas/minimumToPay' minimumToPayBalance: $ref: '#/components/schemas/minimumToPayBalance' due: $ref: '#/components/schemas/due' totalDue: $ref: '#/components/schemas/totalDue' overdueBalance: $ref: '#/components/schemas/overdueBalance' reason: $ref: '#/components/schemas/reason' description: Reason for account status change usageLimits: type: array items: $ref: '#/components/schemas/getUsageLimit' paymentTerms: $ref: '#/components/schemas/creditPaymentTerms' InvoicePaymentMethod: $ref: '#/components/schemas/invoicePaymentMethod' interestRates: $ref: '#/components/schemas/interestRates' underInvestigation: $ref: '#/components/schemas/underInvestigation' accountsCardStatuses: $ref: '#/components/schemas/accountCardsStatus' accountCardBlocks: $ref: '#/components/schemas/accountCardBlocks' reminders: $ref: '#/components/schemas/reminders' title: Credit response debitAccountResponse: allOf: - $ref: '#/components/schemas/standardAccountResponse' - properties: address: $ref: '#/components/schemas/address' description: >- Address connected to an account that will override the address set on customer level. This is for example used when sending out statements reason: $ref: '#/components/schemas/reason' description: Reason for account status change iban: $ref: '#/components/schemas/iban' usageLimits: type: array items: $ref: '#/components/schemas/getUsageLimit' title: Debit response prepaidAccountResponse: allOf: - $ref: '#/components/schemas/standardAccountResponse' - properties: address: $ref: '#/components/schemas/address' description: >- Address connected to an account that will override the address set on customer level. This is for example used when sending out statements reason: $ref: '#/components/schemas/reason' description: Reason for account status change iban: $ref: '#/components/schemas/iban' usageLimits: type: array items: $ref: '#/components/schemas/getUsageLimit' title: Prepaid response fleetAccountResponse: allOf: - $ref: '#/components/schemas/standardAccountResponse' - properties: additionalInvoiceDaysOfMonth: $ref: '#/components/schemas/fleetAdditionalInvoiceDaysOfMonth' address: $ref: '#/components/schemas/address' description: >- Address connected to an account that will override the address set on customer level. This is for example used when sending out statements creditLimit: $ref: '#/components/schemas/creditLimit' interestRates: $ref: '#/components/schemas/interestRates' eInvoice: $ref: '#/components/schemas/eInvoice' externalCustomerReference: $ref: '#/components/schemas/externalCustomerReference' invoiceDayOfMonth: $ref: '#/components/schemas/invoiceDayOfMonth' invoiceDeliveryMethod: $ref: '#/components/schemas/invoiceDeliveryMethod' minimumToPay: $ref: '#/components/schemas/minimumToPay' paymentTerms: $ref: '#/components/schemas/fleetPaymentTerms' reason: $ref: '#/components/schemas/reason' description: Reason for account status change usageLimits: type: array items: $ref: '#/components/schemas/getUsageLimit' InvoicePaymentMethod: $ref: '#/components/schemas/invoicePaymentMethod' accountsCardStatuses: $ref: '#/components/schemas/accountCardsStatus' accountCardBlocks: $ref: '#/components/schemas/accountCardBlocks' directDebitMandate: $ref: '#/components/schemas/directDebitMandate' balances: $ref: '#/components/schemas/balances' title: Fleet response multiCurrAccountResponse: allOf: - $ref: '#/components/schemas/standardAccountResponse' - properties: address: $ref: '#/components/schemas/address' description: >- Address connected to an account that will override the address set on customer level. This is for example used when sending out statements creditLimit: $ref: '#/components/schemas/creditLimit' externalBalanceCheck: $ref: '#/components/schemas/externalBalanceCheck' interestPostingEnabled: $ref: '#/components/schemas/interestPostingEnabled' underInvestigation: $ref: '#/components/schemas/underInvestigation' reason: $ref: '#/components/schemas/reason' description: Reason for account status change usageLimits: type: array items: $ref: '#/components/schemas/getUsageLimit' title: Multi-currency response errorResponse: type: object properties: code: type: string description: An error code indicating what kind of error. I.e. HTTP error code message: type: string description: Error message in human-readable format id: type: string format: uuid description: Unique error identifier errorCode: type: string description: Enfuce code for a specific error type errorType: type: string description: Error type enum: - STATIC_VALIDATION_ERROR - DYNAMIC_VALIDATION_ERROR - INTEGRATION_ERROR - SECURITY_ERROR - UNEXPECTED_ERROR errorReason: type: string description: Free-form text explaining the error reason timestamp: type: string format: date-time description: Datetime when error occurred standardAccountResponse: allOf: - $ref: '#/components/schemas/baseAccountResponse' - properties: additionalValues: $ref: '#/components/schemas/additionalValues' segment: $ref: '#/components/schemas/segment' closureReason: $ref: '#/components/schemas/closureReason' address: type: object required: - address1 - city - country - zipCode properties: address1: type: string minLength: 1 maxLength: 255 example: Kings street 12 address2: type: string maxLength: 255 address3: type: string maxLength: 255 address4: type: string maxLength: 255 city: type: string minLength: 1 maxLength: 255 example: Mariehamn country: $ref: '#/components/schemas/country' region: type: string maxLength: 32 example: Åland Islands zipCode: type: string minLength: 1 maxLength: 32 example: 22100 title: address creditLimit: type: number description: Credit limit of the account example: 10000 delinquencyDate: type: string format: date description: >- Delinquence date for the latest invoice which is due date including any potentialy configured grace days. example: '2024-04-18' dueDate: type: string format: date description: Due date for the latest invoice example: '2024-04-14' eInvoice: type: object deprecated: true properties: address: maxLength: 32 type: string example: FI7165429021331431 operator: maxLength: 32 type: string example: NDEAFIHH paymentInstruction: maxLength: 2 type: string example: AA interestPostingEnabled: type: boolean description: >- Indicates if interest posting enabled or disabled. With a boolean type of False, interest accrual is blocked, and with a boolean type of True, interest accrual will continue example: true invoiceDayOfMonth: type: integer maximum: 31 minimum: 1 description: >- This indicates the last day of the billing period. An invoice is created and sent on the next day. If the scheduled day exceeds the total number of days in a month, then the invoice is generated on last day of the month. example: 21 invoiceDeliveryMethod: type: string enum: - REGULAR_MAIL - EMAIL - E_INVOICE - CUSTOM_1 - CUSTOM_2 - CUSTOM_3 - CUSTOM_4 - CUSTOM_5 - BETALINGSSERVICE invoicedBalance: type: number description: >- This amount represents the due payment expected from the customer. Please use `totalDue` instead. example: 200.5 deprecated: true statementBalance: type: number description: >- The statement balance is the amount that includes the minimum payment, any outstanding balances, and unpaid invoiced instalment portions. If the product offers interest-free terms, paying this full balance will prevent revolving interest from being charged. example: 250.5 minimumToPay: type: object properties: amount: type: number percentage: type: number maximum: 100 minimum: 0 minimumToPayBalance: type: number description: Invoiced minimum payment balance. Please use `due` instead. example: 25 deprecated: true due: type: number description: Invoiced minimum payment balance. example: 25 totalDue: type: number description: Total due (Due + Past Due) including open/overdue instalment portions example: 20 overdueBalance: type: number description: >- Overdue MTP of the credit balances (Past Due). Overdue instalment portions are not included. example: 300.5 reason: type: string description: Reason for contract status change maxLength: 32 title: reason getUsageLimit: type: object allOf: - $ref: '#/components/schemas/baseUsageLimit' - properties: values: type: array items: $ref: '#/components/schemas/getLimitValues' title: getUsageLimit creditPaymentTerms: type: integer maximum: 30 minimum: 1 description: > Number of days to allow for invoice to be paid before it goes overdue. Use of this field as well as the values of the field, is dependent on institution setup and should be aligned with Enfuce before taking into use. example: 10 invoicePaymentMethod: type: string description: > Use of this field as well as the values of the field, is dependent on institution setup and should be aligned with Enfuce prior to use. Also, it is only a value, there is no functionality behind it. enum: - DIRECT_DEBIT - PLUS_GIROT - BANK_GIROT - BANK_TRANSFER - IBAN interestRates: type: array items: $ref: '#/components/schemas/interestRate' description: >- Revolving or overdue Interest rate percentages that is effective for the account. underInvestigation: type: boolean description: If account is under investigation example: true accountCardsStatus: type: string description: >- Indicates the current value for card statuses. Should not be used, use accountCardBlocks value instead. Will be deprecated enum: - OK - SOFT_BLOCK - HARD_BLOCK accountCardBlocks: type: object description: >- Indicates which blocks are set for the account cards. Current values are SoftBlock and HardBlock true / false. In case either of the softblock or hardblock is true the account card usage is blocked, so to enable card usage both of the blocks must be set to false. To block the accounts card usage setting either value (sofblock or hardblock to true) is enough to block account card usage. properties: softblock: type: boolean hardblock: type: boolean reminders: type: object description: Reminder details properties: reminderStatus: type: string enum: - WAIT - REMINDER1_SENT - CARD_BLOCKED - REMINDER2_SENT - REMINDER3_SENT - REMINDER4_SENT - REMINDER5_SENT - REMINDER6_SENT - REMINDER7_SENT - SENT_TO_COLLECTION - STOPPED - DONE disableReminderProcess: type: boolean reminder1TriggerDate: description: Date when reminder 1 is triggered type: string format: date example: '2019-11-27' reminder2TriggerDate: description: Date when reminder 2 is triggered type: string format: date example: '2019-11-27' reminder3TriggerDate: description: Date when reminder 3 is triggered type: string format: date example: '2019-11-27' reminder4TriggerDate: description: Date when reminder 4 is triggered type: string format: date example: '2019-11-27' reminder5TriggerDate: description: Date when reminder 5 is triggered type: string format: date example: '2019-11-27' reminder6TriggerDate: description: Date when reminder 6 is triggered type: string format: date example: '2019-11-27' reminder7TriggerDate: description: Date when reminder 7 is triggered type: string format: date example: '2019-11-27' collectionTriggerDate: description: Date when statement is sent to collection type: string format: date example: '2019-11-27' title: reminders iban: type: object properties: iban: type: string description: An IBAN number example: FI7165429021331431 fleetAdditionalInvoiceDaysOfMonth: type: array items: $ref: '#/components/schemas/invoiceDayOfMonth' description: Additional days in a month when an invoice could be created. example: - 5 - 18 - 25 externalCustomerReference: type: string maxLength: 30 description: >- To be printed on invoice in order for customer to handle invoice properly example: Example customer ref fleetPaymentTerms: type: integer description: > Number of days to allow for invoice to be paid before it goes overdue. The valid values for the parameter are integers between 1 and 31 (inclusive) and the specific value 45. Use of this field as well as the values of the field, is dependent on institution setup and should be aligned with Enfuce before taking into use. example: 10 directDebitMandate: type: object properties: mandateId: maxLength: 36 type: string description: Direct debit mandate identifier example: 1234567890 dateOfSignature: maxLength: 32 type: string format: date-time description: Date and time when direct debit mandate was created example: '2024-06-01T12:34:56Z' balances: type: array description: List of balances for the account items: $ref: '#/components/schemas/balanceItem' externalBalanceCheck: type: boolean description: > The external balance check parameter enables the issuer to determine per account, whether the available balance during authorisation process should be checked by Enfuce or issuer (utilising Authorisation Control service). When set to “true”, Enfuce will not check the available balance of the account rather the issuer is expected to do it. As the parameter is set on account level, it will automatically apply to all cards linked to account in question. Please note that utilisation of this parameter requires implementation of the Authorisation Control service. baseAccountResponse: type: object properties: available: $ref: '#/components/schemas/available' balance: $ref: '#/components/schemas/balance' currency: $ref: '#/components/schemas/currency' customerId: $ref: '#/components/schemas/customerId' id: $ref: '#/components/schemas/id' name: $ref: '#/components/schemas/name' number: $ref: '#/components/schemas/accountNumber' parentId: $ref: '#/components/schemas/parentId' status: $ref: '#/components/schemas/accountStatusGet' paymentReference: $ref: '#/components/schemas/paymentReference' productCode: $ref: '#/components/schemas/productCodeInResponse' example: DEBIT_EUR_FI template: type: string description: Template name for which the account is connected to additionalValues: type: array maxItems: 4 description: > List of additional key-value pairs that can be associated with the account. Known keys: - BALC: Balance check configuration. Possible values: true (Shadow Balancing Disabled) or false (Shadow Balancing Enabled) items: $ref: '#/components/schemas/keyValuePair' segment: type: string description: >- Field enables to group an entity into a segment. This field will be exported but no logic is applied to this in Enfuce API enum: - SEGMENT_A - SEGMENT_B - SEGMENT_C - SEGMENT_D - SEGMENT_E - SEGMENT_F title: segment closureReason: type: string description: >- Field enables to define entity's closure reason. This field will be exported but no logic is applied to this in Enfuce API enum: - CLOSED1 - CLOSED2 - CLOSED3 - CLOSED4 - CLOSED5 title: closureReason country: type: string description: >- A valid ISO 3166-1 alpha-3 country code, except for QZZ (UNMIK in Kosovo) and ROM for Romania. pattern: '[A-Z]{3}' example: FIN baseUsageLimit: type: object properties: code: type: string enum: - 24H - DAILY - MONTHLY - WEEKLY - ANNUAL_YEARLY - ROLLING_YEARLY description: | Usage Limiter Time Periods Available usage limiters include: * __24H__ - A sliding window limiter covering the last 24 hours. * __WEEKLY__ - Limits usage for the current week, starting on Monday. * __MONTHLY__ - Limits usage for the current month, starting on the 1st. __Note:__ The following usage limiters are not part of the standard usage limiter setup. The use of these fields and their values depends on the institution's configuration and must be coordinated with Enfuce before use. * __DAILY__ - Limits usage for the current day, starting at 00:00. * __ANNUAL_YEARLY__ - Limits usage for the current year, starting on 1st January. * __ROLLING_YEARLY__ - A sliding window limiter covering the year until now. (DAILY, WEEKLY, MONTHLY and ANNUAL_YEARLY are reset at midnight UTC) title: baseUsageLimit getLimitValues: type: object allOf: - $ref: '#/components/schemas/limitValues' - properties: availableAmount: type: number description: >- Available amount for specific usage limit. Note this is not present if sumAmount is not set. example: 1200 availableCount: type: integer description: >- Available count for specific usage limit. Note this is not present if count is not set. example: 1200 usedAmount: type: number description: Used amount for specific usage limit example: 1200 usedCount: type: integer description: Used count for specific usage limit example: 1200 title: getLimitValues interestRate: type: object properties: interestRate: type: number interestType: type: string balanceItem: type: object properties: type: $ref: '#/components/schemas/fleetBalanceType' amount: type: number description: Balance amount example: 300.78 currency: type: string description: ISO 4217 currency code example: SEK required: - type - amount - currency available: type: number description: Accounts's available amount example: 1000 balance: type: number description: Account's balance example: 1000 currency: type: string description: A valid ISO 4217 currency code pattern: '[A-Z]{3}' example: EUR customerId: type: string description: Customer id for account owner example: 55667788990 id: type: string description: Unique account id for given account example: 1234567890 name: type: string maxLength: 64 description: Human readable name of an account example: My example account name accountNumber: type: string description: >- Unique account number for given account. Must be numeric if paymentRefence.type defined as MOD10 or FINNISH_7_3_1! Note that selected account numbers might be reserved by Enfuce for internal usage. maxLength: 64 example: 123456789 parentId: type: string description: Account id of parent account. If empty then this is parent contract. example: 9876543210 accountStatusGet: type: string enum: - ACCOUNT_BLOCKED - ACCOUNT_COLLECTION - ACCOUNT_OK - ACCOUNT_TO_CLOSE - ACCOUNT_CLOSED - ACCOUNT_AUTO_CLOSED title: accountStatusGet paymentReference: type: object description: >- Number connected to account that will be used to map incoming payments to required: - type properties: number: type: string description: Payment reference number example: 1234567897 type: type: string enum: - MOD10 - FINNISH_7_3_1 - CUSTOMER_SPECIFIC productCodeInResponse: type: string description: | The productCode is used to determine the specific account product. Values of the field are dependent on institution setup. example: CARD_EUR_FI keyValuePair: type: object properties: key: type: string minLength: 1 maxLength: 8 pattern: ^[a-zA-Z0-9\-\_ ]*$ value: type: string minLength: 1 maxLength: 50 pattern: >- ^[a-zA-Z0-9|\-_ +.éàèùçâêîôûëïü'ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿĀāĂ㥹ĆćĈĉĊċČčĎďĐđĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıIJijĴĵĶķĸĹĺĻļĽľĿŀŁłŃńŅņŇňʼnŊŋŌōŎŏŐőŒœŔŕŖŗŘřŚśŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŹźŻżŽžſǪǫȘșȚțȪȫȮȯȲȳḐḑṢṣẞỌọ]*$ limitValues: type: object properties: code: type: string enum: - ATM - RETAIL - ALL description: > Note that all values must be present when set. Usage limiter values are: * __ATM__ - ATM max withdrawal limit * __RETAIL__ - Retail max purchase limit * __ALL__ - All usage max limit reset: type: boolean description: > If set to true this specific usage limit will be reset to product default and any other values sent in to the request will be ignored. Example: If __usageLimits.values.reset__ = true then all values below will be ignored and the default configuration will apply. usageLimits.values.singleAmount = 1000 usageLimits.values.sumAmount = 1200 usageLimits.values.count = 5 example: true singleAmount: type: number description: | The max allowed amount of a single transaction. Example: Maximum allowed spend per transaction is 1000 usageLimits.values.singleAmount = 1000 usageLimits.values.sumAmount = 0 usageLimits.values.count = 0 example: 1000 count: type: integer description: | The max number of transactions allowed under a time period. Example: Maximum number of allowed transactions under a certain period of time is 5 usageLimits.values.singleAmount = 0 usageLimits.values.sumAmount = 0 usageLimits.values.count = 5 example: 5 sumAmount: type: number description: | The max allowed amount under a time period. Example: Maximum allowed spend under a certain period of time is 1200. usageLimits.values.singleAmount = 0 usageLimits.values.sumAmount = 1200 usageLimits.values.count = 0 example: 1200 title: limitValue fleetBalanceType: type: string description: > Type of fleet balance. - RETAIL_CURRENT_CYCLE: How much retail transactions are in current cycle, will be invoiced on next invoice run - CURRENT_CREDITS: Overpayments enum: - RETAIL_CURRENT_CYCLE - CURRENT_CREDITS ````