# Finverse API

## Docs

- [Get account number](https://docs2.finverse.com/api-reference/accounts/get-account-number.md): Retrieve account number information for a specific account (using a specific `account_id`).
- [List accounts](https://docs2.finverse.com/api-reference/accounts/list-accounts.md): Retrieve all Accounts under a Login Identity (using a specific `login_identity_token`).
- [Get account](https://docs2.finverse.com/api-reference/accounts/get-account.md): Retrieve a specific Account under a Login Identity (using a specific `account_id`).
- [Get balance history](https://docs2.finverse.com/api-reference/accounts/get-balance-history.md): Retrieve Balance History information for a specific Account (using a specific `account_id`).
- [List card details](https://docs2.finverse.com/api-reference/accounts/list-card-details.md): Retrieve all Card Details under a Login Identity (using a specific `login_identity_token`).
- [Generate customer_token](https://docs2.finverse.com/api-reference/public/generate-customer_token.md): Generate a new customer access_token (`customer_token`).
- [Get cred submit jwks](https://docs2.finverse.com/api-reference/public/get-cred-submit-jwks.md): get jwks
- [Get payments jwks](https://docs2.finverse.com/api-reference/public/get-payments-jwks.md): get payment jwks
- [Exchange Link Code for login_identity_token and login_identity_id](https://docs2.finverse.com/api-reference/link/exchange-link-code-for-login_identity_token-and-login_identity_id.md): Exchange the one-time auth `code` (from a successful Finverse linking redirect) for a `login_identity_token` and its associated `login_identity_refresh_token`.
- [Create link](https://docs2.finverse.com/api-reference/link/create-link.md): Create a new link and submit credentials
- [Retrieve link/refresh status - for user-present refresh only](https://docs2.finverse.com/api-reference/link/retrieve-linkrefresh-status--for-user-present-refresh-only.md): Submit login action inputs for a specific `login_identity_id`. Use webhooks (recommended) or `GET /link/status` to monitor linking status, including whether any additional login actions are needed..
- [Relink v2](https://docs2.finverse.com/api-reference/link/relink-v2.md): Create a new link using an existing LIID
- [Link status](https://docs2.finverse.com/api-reference/link/link-status.md): Check the status of a given loginIdentity
- [Generate link_url](https://docs2.finverse.com/api-reference/link/generate-link_url.md): Generate a short-lived Finverse Link access_token (referred to as `link_token`) and URL (link_url) to open Finverse Link UI in a browser window. The link_token is associated with a specific Customer App (client_id) and End-User (user_id), and expires after 5 minutes (resend request to renew).
- [Refresh login_identity_token](https://docs2.finverse.com/api-reference/customer/refresh-login_identity_token.md): Generate a new `login_identity_token` and `login_identity_refresh_token` using a valid `login_identity_refresh_token`.
- [Retrieve Institutions list](https://docs2.finverse.com/api-reference/customer/retrieve-institutions-list.md): Retrieve list of all Institutions.
- [Get institutions for customer](https://docs2.finverse.com/api-reference/customer/get-institutions-for-customer.md): Get a customer-specific list of institutions for Finverse Link
- [Get institution](https://docs2.finverse.com/api-reference/customer/get-institution.md): Get a specific institution by institutionId
- [List bills](https://docs2.finverse.com/api-reference/bills/list-bills.md): List bills
- [Get bill](https://docs2.finverse.com/api-reference/bills/get-bill.md): Get a bill by ID
- [Get composite statement](https://docs2.finverse.com/api-reference/statements/get-composite-statement.md): Retrieve the Composite Statement in .zip format. By default, this request returns a redirect (HTTP 307 code) to a temporary Composite Statement URL (valid for 15min).
- [Get statements](https://docs2.finverse.com/api-reference/statements/get-statements.md): Retrieve a list of all Statements under a Login Identity (using a specific login_identity_token).
- [Get statement](https://docs2.finverse.com/api-reference/statements/get-statement.md): Retrieve an individual statement URL, based on the statement's id. By default, this request returns a redirect (HTTP 307 code) to a temporary statement URL (valid for 15min).
- [List Disputes](https://docs2.finverse.com/api-reference/disputes/list-disputes.md): List Disputes associated with a Customer App.
- [Get identity](https://docs2.finverse.com/api-reference/identity_income/get-identity.md): Retrieve all Identity information for a Login Identity (using a specific `login_identity_token`).
- [Get income estimate by login identity id](https://docs2.finverse.com/api-reference/identity_income/get-income-estimate-by-login-identity-id.md): Retrieve all Accounts under a Login Identity (using a specific login_identity_token). Authorization: login_identity_token
- [Generate Finverse statement CSV](https://docs2.finverse.com/api-reference/ledger/generate-finverse-statement-csv.md): Fetch a customer statement (in csv format) for all ledger transactions associated with a Customer App. The statement is returned as a short-lived URL link to the csv file.
- [Get login identity](https://docs2.finverse.com/api-reference/login_identity/get-login-identity.md): Retrieve information about a Login Identity, including its authentication and data retrieval status. Does not contain any sensitive user data.
- [Unlink Login Identity](https://docs2.finverse.com/api-reference/login_identity/unlink-login-identity.md): Unlink a Login Identity (using a specific login_identity_token). This deletes the associated login_identity_token, login_identity_refresh_token and all associated bank data (e.g. Accounts, Transactions). Authorization: login_identity_token
- [login_identity/refresh (User-present data refresh)](https://docs2.finverse.com/api-reference/login_identity/login_identityrefresh-user-present-data-refresh.md): Trigger a data refresh request for a Login Identity, requesting Finverse to start authenticating with the institution (using stored credentials), and if authentication succeeds, to fetch new data for the Login Identity.
- [Get login identity by ID](https://docs2.finverse.com/api-reference/login_identity/get-login-identity-by-id.md): Retrieve a Login Identity (using a specific `login_identity_id`). Does not contain any sensitive user data.
- [Get login identity history](https://docs2.finverse.com/api-reference/login_identity/get-login-identity-history.md): Retrieve status history for a Login Identity (using a specific `login_identity_id`).
- [List Mandates](https://docs2.finverse.com/api-reference/mandates/list-mandates.md): List Mandates associated with a Customer App.
- [Create Mandate](https://docs2.finverse.com/api-reference/mandates/create-mandate.md): Create a Mandate (i.e. pre-authorization) that will be used to make payments, without any existing/known sender account details (the end-user will be requested to input these in the mandate authorization UI).
- [Get mandate auth](https://docs2.finverse.com/api-reference/mandates/get-mandate-auth.md): Get Mandate Authorization by mandate id
- [Submit auth checklist](https://docs2.finverse.com/api-reference/mandates/submit-auth-checklist.md): Submit authorization checklist items
- [List Mandates including plaintext sensitive account data](https://docs2.finverse.com/api-reference/mandates/list-mandates-including-plaintext-sensitive-account-data.md): List Mandates associated with a Customer App, including sensitive account details of the Sender Account (such as plaintext account number and accountholder name).
- [Set mandate institution](https://docs2.finverse.com/api-reference/mandates/set-mandate-institution.md): Update InstitutionID and SenderType for Mandate
- [Generate link_url](https://docs2.finverse.com/api-reference/mandates/generate-link_url.md): Generate a short-lived Finverse Link URL (link_url) and access_token (referred to as `link_token`) to open the Finverse Link UI (in Mandate mode) in a browser window to allow an End-User to authorize the Mandate. The link_token is associated with a specific Customer App (client_id) and End-User (use…
- [Create Mandate with existing Sender Account](https://docs2.finverse.com/api-reference/mandates/create-mandate-with-existing-sender-account.md): Create a Mandate (i.e. pre-authorization) that will be used to make payments, from an existing sender account (created via `POST /payment_accounts`).
- [Get mandate](https://docs2.finverse.com/api-reference/mandates/get-mandate.md): Retrieve a Mandate object (using a specific `mandate_id`).
- [Authorize Mandate](https://docs2.finverse.com/api-reference/mandates/authorize-mandate.md): Mark the Mandate as authorized after obtaining end-user consent outside of the Finverse Link UI.
- [List Payment Accounts for Customer App, with payment method overview](https://docs2.finverse.com/api-reference/payment_accounts/list-payment-accounts-for-customer-app-with-payment-method-overview.md): Retrieve all Payment Accounts for a Customer App, including for any `SETTLEMENT_ACCOUNT` the details on the account's payment method configurations (`payment_method_overview`).
- [Create Payment Account](https://docs2.finverse.com/api-reference/payment_accounts/create-payment-account.md): Create a new Payment Account for Mandates, Payments or Payouts.
- [Delete Payment Account](https://docs2.finverse.com/api-reference/payment_accounts/delete-payment-account.md): Delete a `Payment Account` object (using a specific `account_id`).
- [Get adyen card setup payment methods](https://docs2.finverse.com/api-reference/payment_links/get-adyen-card-setup-payment-methods.md): Get available Adyen payment methods for Advanced card setup (proxy to Adyen /paymentMethods)
- [Submit adyen card setup payment](https://docs2.finverse.com/api-reference/payment_links/submit-adyen-card-setup-payment.md): Submit Adyen card setup payment (proxy to Adyen /payments with Drop-in state.data from onSubmit)
- [Submit adyen card setup payment details](https://docs2.finverse.com/api-reference/payment_links/submit-adyen-card-setup-payment-details.md): Submit Adyen card setup payment details (proxy to Adyen /payments/details with Drop-in state.data from onAdditionalDetails)
- [Create Payment Link](https://docs2.finverse.com/api-reference/payment_links/create-payment-link.md): Create new Payment Link.
- [Complete kcp payment](https://docs2.finverse.com/api-reference/payment_links/complete-kcp-payment.md): Complete a KCP payment
- [Get Payment Link](https://docs2.finverse.com/api-reference/payment_links/get-payment-link.md): Retrieve a Payment Link object (using a specific `payment_link_id`).
- [Cancel Payment Link](https://docs2.finverse.com/api-reference/payment_links/cancel-payment-link.md): Cancel a Payment Link (using a specific `payment_link_id`). This sets the Payment Link `status` to `CANCELLED` and Finverse will no longer process any user inputs or payments for the Payment Link.
- [Get Payment Method](https://docs2.finverse.com/api-reference/payment_methods/get-payment-method.md): Retrieve a single Payment Method (using a specific `payment_method_id`).
- [Cancel Payment Method](https://docs2.finverse.com/api-reference/payment_methods/cancel-payment-method.md): Cancel a Payment Method (using a specific `payment_method_id`). This sets the Payment Method `status` to `CANCELLED` and Finverse will no longer process any payments for the Payment Method.
- [Create Payment User](https://docs2.finverse.com/api-reference/payment_users/create-payment-user.md): Create a new Payment User to setup mandates or collect payments.
- [Get Payment User](https://docs2.finverse.com/api-reference/payment_users/get-payment-user.md): Retrieve a Payment User object (using a specific `user_id`).
- [Update Payment User](https://docs2.finverse.com/api-reference/payment_users/update-payment-user.md): Update (PATCH) an existing Payment User, identified by the user's Finverse `user_id`.
- [List Payment Accounts for a Payment User](https://docs2.finverse.com/api-reference/payment_users/list-payment-accounts-for-a-payment-user.md): Retrieve Payment Accounts for a user (using a specific `user_id`).
- [Get Payment Methods by User](https://docs2.finverse.com/api-reference/payment_users/get-payment-methods-by-user.md): Retrieve a list of Payment Methods for a user (using a specific `user_id`).
- [Create Payment Method: direct debit mandate](https://docs2.finverse.com/api-reference/payment_users/create-payment-method:-direct-debit-mandate.md): _Note: this endpoint is primarily intended for migrating payment methods from other payment gateways into Finverse._
- [List Payments](https://docs2.finverse.com/api-reference/payments/list-payments.md): List Payments associated with a Customer App.
- [Create Payment](https://docs2.finverse.com/api-reference/payments/create-payment.md): Create new Payment (off-session) for an existing `payment_method_id`.
- [Get payment](https://docs2.finverse.com/api-reference/payments/get-payment.md): Retrieve a Payment object (using a specific `payment_id`).
- [Update Payment metadata](https://docs2.finverse.com/api-reference/payments/update-payment-metadata.md): Update (PATCH) an existing Payment's `metadata`, identified by the payment's `payment_id`.
- [Update Manual Payment status](https://docs2.finverse.com/api-reference/payments/update-manual-payment-status.md): Update a test manual payment (e.g. FPS, PayNow) to status = `EXECUTED`, by simulating manually transferring the specified payment to the Finverse Testbank.
- [List Payouts](https://docs2.finverse.com/api-reference/payouts/list-payouts.md): Retrieve a Payout object (using a specific `payout_id`).
- [Get payout by ID](https://docs2.finverse.com/api-reference/payouts/get-payout-by-id.md): Get payout by payout_id
- [Cancel payout](https://docs2.finverse.com/api-reference/payouts/cancel-payout.md): Cancel Payout by payout_id
- [Create a payout](https://docs2.finverse.com/api-reference/payment/create-a-payout.md): Create a payout
- [Confirm a payout that was created with confirm = false, submitting it for processing](https://docs2.finverse.com/api-reference/payment/confirm-a-payout-that-was-created-with-confirm-=-false-submitting-it-for-processing.md): Confirm a payout that was created with confirm = false, submitting it for processing
- [List transactions by login identity id](https://docs2.finverse.com/api-reference/transactions/list-transactions-by-login-identity-id.md): Retrieve all Transactions under a Login Identity (using a specific `login_identity_token`).
- [List transactions by account id](https://docs2.finverse.com/api-reference/transactions/list-transactions-by-account-id.md): Retrieve all Transactions under an Account (using a specific `account_id`).
- [Trigger delayed error (during bank processing)](https://docs2.finverse.com/api-reference/trigger-delayed-error-during-bank-processing.md): Configure a test direct debit mandate to return status = `FAILED` with a set delay, after being submitted to the bank for authorization.

## OpenAPI Specs

- [openapi](https://docs2.finverse.com/api-reference/openapi.json)