### MiFinity Developer Hub Guides

Source: https://mifinity.readme.io/index

This section provides links to various guides available on the MiFinity Developer Hub. These guides cover specific integration topics such as Contact, iFRAME, PayAnyBank, and PayAnyCard/PayMyCard.

```APIDOC
Documentation Guide: Contact
  URL: https://mifinity.readme.io/docs/contact
```

```APIDOC
Documentation Guide: iFRAME Integration
  URL: https://mifinity.readme.io/docs/init-iframe-1
```

```APIDOC
Documentation Guide: PayAnyBank (PAB)
  URL: https://mifinity.readme.io/docs/payanybank-pab
```

```APIDOC
Documentation Guide: PayAnyCard (PAC) / PayMyCard (PMC)
  URL: https://mifinity.readme.io/docs/payanycardpac-paymycardpmc
```

```APIDOC
View All Guides
  URL: https://mifinity.readme.io/docs
```

--------------------------------

### iFrame Initialization and Usage

Source: https://mifinity.readme.io/docs/test-page

Guides for integrating the Mifinity iFrame, including initialization, JavaScript widget, and handling payment statuses.

```APIDOC
iFrame Initialization:
  - Description: Details on how to initialize the Mifinity iFrame in your application.
  - Parameters:
    - apiKey: Your Mifinity API key.
    - amount: The transaction amount.
    - currency: The transaction currency.
    - orderId: A unique identifier for the transaction.
    - callbackUrl: URL to redirect after payment.
  - Usage: Provides code examples for embedding the iFrame.

iFrame JavaScript(widget):
  - Description: Information about the JavaScript widget used for iFrame integration.
  - Functionality: Enables dynamic interaction with the iFrame.

Payment Status Callback:
  - Endpoint: /payment/status
  - Method: POST
  - Description: Receives payment status updates from Mifinity.
  - Request Body: Contains transaction details and status.
  - Response: Acknowledgment of receipt.
```

--------------------------------

### Mifinity iFrame Integration

Source: https://mifinity.readme.io/docs/logo-brand-guideline-1

Guides for integrating Mifinity's iFrame for payment processing, including initialization and JavaScript widgets.

```APIDOC
iFrame Initialization:
  Description: Provides parameters and methods for initializing the Mifinity iFrame.
  Parameters:
    - api_key: Your Mifinity API key.
    - account_holder_id: The ID of the account holder.
    - currency: The transaction currency.
    - amount: The transaction amount.
    - language: The preferred language for the iFrame.
  Returns:
    - iframe_url: The URL to load the iFrame.

iFrame JavaScript (widget):
  Description: Details on using the Mifinity JavaScript widget for iFrame integration.
  Usage:
    - Include the Mifinity JS library.
    - Call the Mifinity.init() function with configuration options.
  Configuration Options:
    - apiKey: Your Mifinity API key.
    - elementId: The ID of the HTML element where the iFrame will be rendered.
    - onSuccess: Callback function for successful transactions.
    - onError: Callback function for transaction errors.

E-mail validation:
  Description: API endpoints or methods for validating email addresses within the iFrame flow.

Payment Status Callback:
  Description: Defines the structure and parameters for callbacks received from Mifinity regarding payment status updates.
  Parameters:
    - transaction_id: Unique identifier for the transaction.
    - status: The current status of the payment (e.g., SUCCESS, FAILED, PENDING).
    - reference: Optional reference number.

Account to Account Transfer:
  Description: API endpoints for facilitating account-to-account transfers.
  Parameters:
    - source_account_id: The ID of the account to transfer from.
    - destination_account_id: The ID of the account to transfer to.
    - amount: The amount to transfer.
    - currency: The currency of the transfer.
  Returns:
    - transfer_id: The ID of the initiated transfer.

Notification callbacks for withdrawals:
  Description: Specifies the callback mechanism for withdrawal status notifications.

Language Selection:
  Description: How to specify the language for the iFrame interface.
  Parameter:
    - lang: ISO 639-1 language code (e.g., 'en', 'es').

iFrame-size:
  Description: Options for controlling the dimensions of the iFrame.
  Parameters:
    - width: The desired width of the iFrame.
    - height: The desired height of the iFrame.
```

--------------------------------

### iFrame Integration

Source: https://mifinity.readme.io/docs/payanybank-pab

Guides for integrating the Mifinity iFrame for payment flows, including initialization, JavaScript widget, and callbacks.

```APIDOC
iFrame Initialization:
  - Method: POST
  - Endpoint: /api/iframe/initialize
  - Description: Initializes the iFrame for a payment transaction.
  - Request Body: { "amount": 100, "currency": "EUR", "orderId": "ORD123" }
  - Response: { "iframeUrl": "https://mifinity.com/pay?token=..." }

Payment Status Callback:
  - Method: POST
  - Endpoint: /api/callback/payment-status
  - Description: Receives payment status updates from Mifinity.
  - Request Body: { "orderId": "ORD123", "status": "PAID" }

E-mail validation:
  - Method: POST
  - Endpoint: /api/validate/email
  - Description: Validates an email address.
  - Request Body: { "email": "test@example.com" }
  - Response: { "isValid": true }
```

--------------------------------

### iFrame Integration

Source: https://mifinity.readme.io/docs/monochrome-versions

Guides and methods for integrating Mifinity's iFrame for payment processing and related functionalities.

```APIDOC
iFrame Initialization:
  - Description: Provides instructions on how to initialize the Mifinity iFrame.
  - Parameters: Configuration options for the iFrame.
  - Returns: Initialized iFrame instance.

iFrame JavaScript (widget):
  - Description: Details the JavaScript methods and properties available for interacting with the iFrame widget.
  - Parameters: Various widget control parameters.
  - Returns: Widget status or results of operations.

E-mail validation:
  - Description: Describes the process and API endpoints for email validation within the iFrame flow.
  - Parameters: Email address, potentially other user data.
  - Returns: Validation status.

Payment Status Callback:
  - Description: Information on how the iFrame communicates payment status updates back to the merchant.
  - Parameters: Payment identifiers, status codes.
  - Returns: Callback confirmation.

Account to Account Transfer:
  - Description: Details the process for initiating account-to-account transfers via the iFrame.
  - Parameters: Source and destination account details, amount.
  - Returns: Transfer initiation status.

Notification callbacks for withdrawals:
  - Description: Explains how withdrawal status notifications are handled via callbacks.
  - Parameters: Withdrawal identifiers, status updates.
  - Returns: Notification acknowledgment.

Split Gateway:
  - Description: Information on using split gateway functionality within the iFrame.
  - Parameters: Gateway configuration details.
  - Returns: Split gateway status.

Split Gateway List:
  - Description: Provides details on retrieving a list of available split gateways.
  - Parameters: None specified.
  - Returns: List of split gateways.

Language Selection:
  - Description: How to manage language preferences within the iFrame.
  - Parameters: Language code.
  - Returns: Language setting confirmation.

iFrame-size:
  - Description: Information on adjusting the size and dimensions of the iFrame.
  - Parameters: Width, height values.
  - Returns: iFrame size update status.
```

--------------------------------

### Authentication Management

Source: https://mifinity.readme.io/docs/notification-callbacks-1

Guides on managing API keys, including creation and disabling, as well as retrieving the AccountHolderId.

```APIDOC
Create API key
[https://mifinity.readme.io/docs/create-api-key](https://mifinity.readme.io/docs/create-api-key)

Disable API key
[https://mifinity.readme.io/docs/disable-api-key](https://mifinity.readme.io/docs/disable-api-key)

Retrieving the AccountHolderId
[https://mifinity.readme.io/docs/retrieving-the-accountholderid](https://mifinity.readme.io/docs/retrieving-the-accountholderid)
```

--------------------------------

### Get Transaction Status cURL Request

Source: https://mifinity.readme.io/reference/get-transactions-status-history

Example cURL request to get the status of a transaction. This demonstrates how to call the Get Transaction Status API.

```curl
curl --request GET \
     --url https://demo.mifinity.com/api/account-holders/accountHolderId/transactions/history \
     --header 'accept: application/json' \
     --header 'api-version: 1'
```

--------------------------------

### Get Bank Field Descriptions cURL Example

Source: https://mifinity.readme.io/reference/get-bank-field-descriptions

Example cURL request to fetch bank detail field descriptions from the Mifinity API.

```curl
curl --request GET \
     --url https://demo.mifinity.com/api/dictionaries/bank-details-fields \
     --header 'accept: application/json' \
     --header 'api-version: 1'
```

--------------------------------

### Get Transaction Status API Endpoint

Source: https://mifinity.readme.io/docs/get-transaction-status

This section describes the GET request to retrieve the status of a transaction. It specifies the endpoint, the required path variable `transactionReference`, and provides examples of successful (200) and unsuccessful responses (404, 403).

```APIDOC
GET https://demo.mifinity.com/api/transactions/{transactionReference}/status

Parameters:
  transactionReference (Path Variable): Unique transaction ID identifier.

Responses:
  200 OK:
    Description: Transaction status retrieved successfully.
    Example:
      {
          "payload": [
              {
                  "transactionReference": "2500ebc5-8345-4595-8b06-3200797e2b8e",
                  "transactionStatus": 5,
                  "transactionStatusDescription": "Processed by acquirer",
                  "arn": "85271954003400337846992",
                  "transactionLastUpdated": "2024-01-04T09:30:23.767Z",
                  "traceId": "76152654-82f2-468b-aca8-4305938f0629"
              }
          ]
      }
      or
      {
          "payload": [
              {
                  "transactionReference": "ad52d870-da3a-4429-9bab-22a59f416ab4",
                  "transactionStatus": 6,
                  "transactionStatusDescription": "Rejected",
                  "transactionLastUpdated": "2023-12-14T15:21:55.631Z",
                  "traceId": "17acb228-7608-4c15-a511-60768efb316d",
                  "errorMessage": "Transaction failed"
              }
          ]
      }
  404 Not Found:
    Description: Transaction not found.
    Example:
      {
          "errors": [
              {
                  "type": "FATAL",
                  "errorCode": "ELEMENT_NOT_FOUND",
                  "message": "No transaction found for transaction reference: ad52d870-da3a-4429-9bab-22a59f416ab3."
              }
          ]
      }
  403 Forbidden:
    Description: Access denied.
    Example:
      {
          "errors": [
              {
                  "type": "FATAL",
                  "errorCode": "ACCESS_DENIED",
                  "message": "Cannot perform this action. Access denied"
              }
          ]
      }

Note: Ensure the status is obtained from a valid API response (200). If the response is invalid, retry the request or contact the integration team.
```

--------------------------------

### iFrame Initialization and Payment Flow

Source: https://mifinity.readme.io/docs/text-logo-version

Details on initializing the Mifinity iFrame, handling payment flows, and managing callbacks.

```APIDOC
iFrame Initialization:
  - Method: `Mifinity.init(options)`
  - Description: Initializes the Mifinity iFrame with specified options.
  - Parameters:
    - `options`: object (required)
      - `apiKey`: string (required) - Your Mifinity API key.
      - `environment`: string (required) - The environment to use ('sandbox' or 'production').
      - `elementId`: string (required) - The ID of the HTML element where the iFrame will be mounted.
      - `locale`: string (optional) - The language for the iFrame.

IFrame Deposit Flow:
  - Method: `Mifinity.openDeposit(details)`
  - Description: Opens the deposit flow within the iFrame.
  - Parameters:
    - `details`: object (required)
      - `amount`: number (required) - The deposit amount.
      - `currency`: string (required) - The currency code (e.g., 'EUR').
      - `reference`: string (optional) - A unique reference for the transaction.

Payment Status Callback:
  - Endpoint: /api/payment/status
  - Method: POST
  - Description: Callback endpoint to receive payment status updates.
  - Request Body:
    - `transactionId`: string - The ID of the transaction.
    - `status`: string - The status of the payment (e.g., 'SUCCESS', 'FAILED').
    - `reference`: string - The reference provided during the transaction.
  - Response:
    - Acknowledgment of receipt.
```

--------------------------------

### Mifinity API Reference - B2B Transaction

Source: https://mifinity.readme.io/reference/1-for-b2c-transaction

Provides details on how to perform B2B transactions. Includes an example GET request for retrieving bank details fields for a given currency and country.

```APIDOC
get https://demo.mifinity.com/api/payees/bank-details-fields?currency={currency}&country={country}&personal=false

Parameters:
- currency: The currency code (e.g., USD, EUR).
- country: The country code (e.g., US, GB).
- personal: Boolean flag, typically false for B2B transactions.
```

--------------------------------

### Pay My Card Example

Source: https://mifinity.readme.io/docs/difference-between-pac-pmc

Demonstrates a scenario where a merchant sends GBP 85 to a customer, and the equivalent EUR amount is debited from the merchant's account, illustrating the PMC process.

```APIDOC
Scenario:
  1. Merchant wishes to send exactly GBP 85 to a customer.
  2. MiFinity sends an instruction to pay the cardholder GBP 85 and debits the EUR equivalent from the Merchant's EUR source account balance.
```

--------------------------------

### Transaction Status Examples

Source: https://mifinity.readme.io/docs/transaction-status

Examples of JSON responses for a processed and a rejected transaction.

```JSON
{
  "payload": [
    {
      "transactionReference": "64ec6629-5a4e-436f-9eca-62c270406d4b",
      "transactionStatus": 5,
      "transactionStatusDescription": "Processed by acquirer",
      "transactionLastUpdated": "2024-02-12T10:32:53.456Z",
      "traceId": "dff73372-d6a1-45df-9938-7081c510fec1"
    }
  ]
}
```

```JSON
{
  "payload": [
    {
      "transactionReference": "5bbcbb4c-a657-4009-997c-fef9624c7405",
      "transactionStatus": 6,
      "transactionStatusDescription": "Rejected",
      "transactionLastUpdated": "2024-02-12T11:17:04.381Z",
      "traceId": "12e1d8f8-0b50-40bc-b0d2-b9337b37a231"
    }
  ]
}
```

--------------------------------

### API Documentation Overview

Source: https://mifinity.readme.io/docs/difference-between-pac-pmc

Provides links to various sections of the Mifinity API documentation, including the main API reference, currency lists, transaction lifecycle, status retrieval, callbacks, error codes, and test cards.

```APIDOC
The API: https://mifinity.readme.io/docs/the-api
List of Currencies: https://mifinity.readme.io/docs/list-of-currencies
Transaction Lifecycle and Status: https://mifinity.readme.io/docs/transaction-status-1
Get Transaction Status: https://mifinity.readme.io/docs/get-transaction-status
Notification Callbacks: https://mifinity.readme.io/docs/notification-callbacks-1
Error Codes: https://mifinity.readme.io/docs/error-codes
Test Cards: https://mifinity.readme.io/docs/test-cards
UnionPay International (China UnionPay): https://mifinity.readme.io/docs/unionpay-international-china-unionpay
```

--------------------------------

### Get Bank Name API

Source: https://mifinity.readme.io/reference/account-to-account-transfer

Retrieves the name of a bank.

```APIDOC
GET https://mifinity.readme.io/reference/get-bank-name
```

--------------------------------

### Mifinity API Endpoints Overview

Source: https://mifinity.readme.io/reference/pay-my-card

A list of available Mifinity API endpoints categorized by functionality, including Init iFrame, Lookup APIs, Payment Status, Account to Account transfers, PAY ANY BANK, and PAY MY CARD.

```APIDOC
init-iframe
  init-iFramepost

Lookup API calls
  Currency Lookupget
  Get Bank Field Descriptionsget
  Validate IBAN Numberget
  Get Pay My Card Currenciesget

Payment Status
  Payment Statusget

Account to Account
  Account to Account Transferpost
  Get Account Listing by Account Holder Idget
  Get Account Detailsget

PAY ANY BANK (PAB)
  PayAnyBankpost
  Currencies are supported for the specific country
  Bank detail fields needed for each country and currency
  For B2B Transaction
  Get bank nameget

Transaction Information
  Get Transaction Statusget
  Get Transactions Status Historyget

PAY ANY CARD (PAC)
  PayAnyCardpost

PAY MY CARD (PMC)
  PayMyCardpost
```

--------------------------------

### Mifinity Environments and Back Office Access

Source: https://mifinity.readme.io/docs/environment

Details the available environments for Mifinity services, including demo and production URLs for both the main platform and the back office. This is crucial for developers integrating with Mifinity's systems.

```APIDOC
Environments:
  Demo Environment: https://demo.mifinity.com
  Production Environment: https://secure.mifinity.com

Back Office Access:
  Demo Back Office: https://businessdemo.mifinity.com
  Production Back Office: https://business.mifinity.com
```

--------------------------------

### Get Transaction Status API

Source: https://mifinity.readme.io/reference/pay-any-card

Retrieves the status of a specific transaction.

```APIDOC
GET https://demo.mifinity.com/api/transactions/status/{transactionId}
```

--------------------------------

### Get Transaction Status API

Source: https://mifinity.readme.io/reference/currency-lookup

Retrieves the status of a specific transaction.

```APIDOC
Get Transaction Status (GET)

URL: /reference/get-transaction-status1

Description: Checks the status of a transaction.
```

--------------------------------

### Logo Branding Guidelines

Source: https://mifinity.readme.io/docs/iframe-initialization

Guidelines for using Mifinity logos, including different versions and usage on various backgrounds.

```APIDOC
Logo Brand Guideline:
  - General guidelines for logo usage.

Logo:
  - Standard logo assets and usage.

Text logo version:
  - Guidelines for the text-based logo.

Different Background:
  - How to use the logo on different background colors.

Monochrome versions:
  - Information on monochrome logo variations.

Logo Mark:
  - Usage guidelines for the logo mark or icon.
```

--------------------------------

### Get Transaction Status API

Source: https://mifinity.readme.io/reference/account-to-account-transfer

Retrieves the status of a specific transaction.

```APIDOC
GET https://mifinity.readme.io/reference/get-transaction-status1
```

--------------------------------

### init-iFrame API

Source: https://mifinity.readme.io/reference

Initiates an iframe payment process. Requires return URLs, a validation key, client and money details, destination account, brand ID, and a client reference.

```APIDOC
POST https://demo.mifinity.com/pegasus-ci/api/gateway/init-iframe

Parameters:
- returnUrl (string, required): URL to send callback after successful transfer.
- errorUrl (string, required): URL to send callback after failed transfer.
- validationKey (string, required): Secret key to validate payment response and get status of payment. Minimum 48 characters, maximum 255 characters.
- client (object, required):
  - address (object, required):
    - traceId (string, required): Merchant's identifier for the call. Maximum 48 characters.
- money (object, required):
  - description (string, required): Description of transfer. Sofort/Klarna deposits limited to 27 characters. Maximum 255 characters.
- destinationAccountNumber (string, required): Merchant’s account number to collect payment.
- brandId (string, required): A 3-digit ID provided by MiFinity indicating the brand.
- clientReference (string, required): Id of client in merchant’s system. Maximum 48 characters.

Headers:
- api-version (string, required): Defaults to 1.

Responses:
- Response body (json)
```

--------------------------------

### Get Account Details API

Source: https://mifinity.readme.io/reference/account-to-account-transfer

Retrieves detailed information about an account.

```APIDOC
GET https://mifinity.readme.io/reference/get-account-details
```

--------------------------------

### Mifinity API Documentation Links

Source: https://mifinity.readme.io/docs/environment

Provides a list of key documentation sections for the Mifinity API, covering core functionalities, differences between services, transaction management, and error handling.

```APIDOC
API Documentation:
  - PayAnyCard(PAC) / PayMyCard(PMC): https://mifinity.readme.io/docs/payanycardpac-paymycardpmc
  - Difference between PAC & PMC ?: https://mifinity.readme.io/docs/difference-between-pac-pmc
  - The API: https://mifinity.readme.io/docs/the-api
  - List of Currencies: https://mifinity.readme.io/docs/list-of-currencies
  - Transaction Lifecycle and Status: https://mifinity.readme.io/docs/transaction-status-1
  - Get Transaction Status: https://mifinity.readme.io/docs/get-transaction-status
  - Notification Callbacks: https://mifinity.readme.io/docs/notification-callbacks-1
  - Error Codes: https://mifinity.readme.io/docs/error-codes
  - Test Cards: https://mifinity.readme.io/docs/test-cards
  - UnionPay International (China UnionPay): https://mifinity.readme.io/docs/unionpay-international-china-unionpay
```

--------------------------------

### Get Transactions Status History API

Source: https://mifinity.readme.io/reference/pay-any-card

Retrieves the history of transaction statuses.

```APIDOC
GET https://demo.mifinity.com/api/transactions/history
```

--------------------------------

### Authentication and Security

Source: https://mifinity.readme.io/docs/iframe-initialization

This section covers managing API keys, understanding security requirements, and retrieving account holder information.

```APIDOC
Create API key:
  - Instructions on how to generate new API keys.

Disable API key:
  - Procedures for disabling existing API keys.

Retrieving the AccountHolderId:
  - Methods for obtaining the AccountHolderId.

Security Requirements:
  - General security guidelines and requirements for using the API.
```

--------------------------------

### Get Bank Name API

Source: https://mifinity.readme.io/reference/pay-any-card

Retrieves the name of a bank based on its identifier.

```APIDOC
GET https://demo.mifinity.com/api/lookup/bank-name/{bankIdentifier}
```

--------------------------------

### Get Account Details API

Source: https://mifinity.readme.io/reference/pay-any-card

Retrieves detailed information for a specific account.

```APIDOC
GET https://demo.mifinity.com/api/accounts/{accountId}/details
```

--------------------------------

### Mifinity API - Initialization and Deposits

Source: https://mifinity.readme.io/reference/pay-any-bank

Provides information on initializing Mifinity's iframe and related deposit functionalities.

```APIDOC
init-iframe
  init-iFramepost
```

--------------------------------

### Get Transactions Status History API

Source: https://mifinity.readme.io/reference/get-transaction-status1

Retrieves the historical status of transactions.

```APIDOC
Get Transactions Status History
get
```

--------------------------------

### Mifinity API Reference - iFrame Integration

Source: https://mifinity.readme.io/docs/business-to-business-b2b

Provides documentation for integrating the Mifinity iFrame into applications. This includes initialization, JavaScript widget usage, handling payment status callbacks, and managing various payment-related functionalities within the iFrame.

```APIDOC
iFrame Initialization:
  - Description: Details on how to initialize the Mifinity iFrame for payment processing.
  - Related: iFrame JavaScript(widget), iFrame-size

iFrame JavaScript(widget):
  - Description: Information on using the provided JavaScript for iFrame widget functionalities.
  - Related: iFrame Initialization, iFrame-size

Payment Status Callback:
  - Description: Documentation for handling asynchronous notifications regarding payment status.
  - Related: Payment Status API, Notification callbacks for withdrawals

Payment Status API:
  - Description: API endpoints for retrieving the status of payments.
  - Related: Payment Status Callback, Notification callbacks for withdrawals

Account to Account Transfer:
  - Description: Information on performing account-to-account transfers via the iFrame.
  - Related: Notification callbacks for withdrawals, Split Gateway

Notification callbacks for withdrawals:
  - Description: Handling callbacks related to withdrawal notifications.
  - Related: Account to Account Transfer, Payment Status Callback

Split Gateway:
  - Description: Information on utilizing the split gateway functionality.
  - Related: Split Gateway List, Account to Account Transfer

Split Gateway List:
  - Description: Details on retrieving a list of available split gateways.
  - Related: Split Gateway, Account to Account Transfer

Language Selection:
  - Description: How to manage language preferences within the iFrame.
  - Related: iFrame Initialization

iFrame-size:
  - Description: Guidelines for configuring the dimensions of the iFrame.
  - Related: iFrame Initialization, iFrame JavaScript(widget)

E-wallet Supported Currencies:
  - Description: Lists the currencies supported by the e-wallet functionality within the iFrame.
```

--------------------------------

### MiFinity API Documentation Overview

Source: https://mifinity.readme.io/docs/batch-upload

Provides links to various sections of the MiFinity API documentation, covering topics such as PayAnyCard/PayMyCard, currency lists, transaction lifecycle, status retrieval, callbacks, error codes, test cards, and UnionPay International.

```APIDOC
MiFinity API Documentation:

- PayAnyCard (PAC) / PayMyCard (PMC): https://mifinity.readme.io/docs/payanycardpac-paymycardpmc
- Difference between PAC & PMC: https://mifinity.readme.io/docs/difference-between-pac-pmc
- The API: https://mifinity.readme.io/docs/the-api
- List of Currencies: https://mifinity.readme.io/docs/list-of-currencies
- Transaction Lifecycle and Status: https://mifinity.readme.io/docs/transaction-status-1
- Get Transaction Status: https://mifinity.readme.io/docs/get-transaction-status
- Notification Callbacks: https://mifinity.readme.io/docs/notification-callbacks-1
- Error Codes: https://mifinity.readme.io/docs/error-codes
- Test Cards: https://mifinity.readme.io/docs/test-cards
- UnionPay International (China UnionPay): https://mifinity.readme.io/docs/unionpay-international-china-unionpay
- Business to Business (B2B): https://mifinity.readme.io/docs/business-to-business-b2b
```

--------------------------------

### Get Account Details API

Source: https://mifinity.readme.io/reference/get-transaction-status1

Fetches detailed information for a specific account.

```APIDOC
Get Account Details
get
```

--------------------------------

### Get Transactions Status History API

Source: https://mifinity.readme.io/reference/account-to-account-transfer

Retrieves the history of transaction statuses.

```APIDOC
GET https://mifinity.readme.io/reference/get-transactions-status-history
```

--------------------------------

### Pay Any Card Example

Source: https://mifinity.readme.io/docs/difference-between-pac-pmc

Illustrates a scenario where a merchant sends EUR 100 to a customer whose card currency is also EUR, demonstrating the PAC process.

```APIDOC
Scenario:
  1. Merchant wishes to send EUR 100 to a customer in the preferred currency of the cardholder's card (EUR = Source Currency).
  2. MiFinity debits the merchant's account with EUR 100 and sends an instruction to pay the cardholder in the FX equivalent currency of the cardholder's card.
```

--------------------------------

### Authentication Management - Create API Key

Source: https://mifinity.readme.io/docs/e-mail-verification

Instructions for creating new API keys for accessing Mifinity services.

```APIDOC
Create API Key:
  Endpoint: /api-keys
  Method: POST
  Description: Generates a new API key for your account.
  Request Body:
    name: string (A descriptive name for the API key)
    permissions: array (Optional: Specify permissions for the key)
  Response:
    apiKey: string (The newly generated API key)
    keyId: string (Unique identifier for the key)
```

--------------------------------

### Get Account Details API

Source: https://mifinity.readme.io/reference/currency-lookup

Retrieves detailed information about a specific account.

```APIDOC
Get Account Details (GET)

URL: /reference/get-account-details

Description: Provides detailed information for a given account.
```

--------------------------------

### iFrame Initialization and Usage

Source: https://mifinity.readme.io/docs/iframe-initialization

This section details how to initialize and use the Mifinity iFrame, including JavaScript widget integration, deposit flows, and size configurations.

```APIDOC
iFrame Initialization:
  - Provides methods for initializing the Mifinity iFrame.
  - Includes parameters for configuration and integration.

iFrame JavaScript (widget):
  - Details on using the provided JavaScript widget for iFrame integration.
  - Covers event handling and customization.

iFrame Deposit Flow:
  - Describes the end-to-end deposit process using the iFrame.

iFrame-size:
  - Documentation on how to configure the dimensions of the iFrame.

E-mail validation:
  - Information on email validation processes within the iFrame.

Language Selection:
  - How to manage language preferences within the iFrame.
```

--------------------------------

### Get Bank Field Descriptions API

Source: https://mifinity.readme.io/reference/account-to-account-transfer

Retrieves descriptions for bank fields.

```APIDOC
GET https://mifinity.readme.io/reference/get-bank-field-descriptions
```

--------------------------------

### MiFinity API Integration Prerequisites

Source: https://mifinity.readme.io/docs/test-page

Details the essential requirements for interacting with the MiFinity API, including authentication credentials, test account balance, and IP whitelisting procedures for both development and production environments.

```APIDOC
Prerequisites:
  - MiFinity Credentials (username and password)
  - Positive balance in a test account
  - Whitelisted IPs for Demo and Prod environments (both yours and MiFinity's)
```

--------------------------------

### Get Bank Name API

Source: https://mifinity.readme.io/reference/get-transaction-status1

Retrieves the name of a bank based on provided details.

```APIDOC
Get bank name
get
```

--------------------------------

### Get Transactions Status History API

Source: https://mifinity.readme.io/reference/currency-lookup

Retrieves the historical status updates for transactions.

```APIDOC
Get Transactions Status History (GET)

URL: /reference/get-transactions-status-history

Description: Fetches the history of transaction status changes.
```

--------------------------------

### Mifinity API Reference

Source: https://mifinity.readme.io/docs/init-iframe-1

This section outlines the Mifinity API, including authentication, iFrame integration, and payment processing. It details various endpoints and functionalities for managing transactions, user accounts, and notifications.

```APIDOC
API Reference:
  v1.0

Authentication Management:
  - Create API key
  - Disable API key
  - Retrieving the AccountHolderId

Transactional Limits:
  - Transaction Limits for Deposits
  - Transaction Limits for Withdrawals
  - PayAnyBank Limits

Notification Management:
  - Notification Management

iFRAME:
  - iFrame Deposit Flow
  - iFrame Initialization
  - iFrame JavaScript(widget)
  - E-mail validation
  - Payment Status Callback
  - Payment Status API
  - Account to Account Transfer
  - Notification callbacks for withdrawals
  - Split Gateway
  - Split Gateway List
  - Language Selection
  - iFrame-size
  - E-wallet Supported Currencies

PayAnyBank(PAB):
  - PayAnyBank Flow
  - PayAnyBank API
  - Bank Detail Fields
  - Bank name/Payer Name
  - Transaction Lifecycle
  - Notification Callbacks
  - Transaction Status
  - Business to Client (B2C)
  - Business to Business (B2B)
  - Batch Upload
```

--------------------------------

### Get Bank Name API

Source: https://mifinity.readme.io/reference/currency-lookup

Retrieves the name of a bank based on provided details.

```APIDOC
Get Bank Name (GET)

URL: /reference/get-bank-name

Description: Fetches a bank's name.
```

--------------------------------

### Other API functionalities

Source: https://mifinity.readme.io/docs/iframe-initialization

Covers miscellaneous API functionalities such as response codes, environments, and supported currencies.

```APIDOC
Response Codes:
  - A list of HTTP response codes and their meanings.

Environments:
  - Information on different API environments (e.g., sandbox, production).

E-wallet Supported Currencies:
  - A list of currencies supported by the e-wallet.
```

--------------------------------

### MiFinity API Documentation Overview

Source: https://mifinity.readme.io/docs/test-page

Provides a structured overview of the MiFinity API documentation, guiding users to relevant sections based on their integration needs. It includes links to specific topics such as payment methods, transaction lifecycles, and error handling.

```APIDOC
API Documentation Sections:
  - PayAnyCard(PAC) / PayMyCard(PMC)
  - Difference between PAC & PMC
  - The API
  - List of Currencies
  - Transaction Lifecycle and Status
  - Get Transaction Status
  - Notification Callbacks
  - Error Codes
  - Test Cards
  - UnionPay International (China UnionPay)
  - HTTP Response Status Codes
  - iFrame Integration
```

--------------------------------

### Get Pay My Card Currencies API

Source: https://mifinity.readme.io/reference/account-to-account-transfer

Retrieves supported currencies for Pay My Card.

```APIDOC
GET https://mifinity.readme.io/reference/get-pay-my-card-currencies
```

--------------------------------

### Get Pay My Card Currencies API

Source: https://mifinity.readme.io/reference/currency-lookup

Retrieves the currencies supported for the 'Pay My Card' service.

```APIDOC
Get Pay My Card Currencies (GET)

URL: /reference/get-pay-my-card-currencies

Description: Lists currencies supported by the Pay My Card service.
```

--------------------------------

### init-iframe API

Source: https://mifinity.readme.io/reference/to-determine-which-currencies-are-supported-for-the-specific-country

Initiates an iframe for a deposit operation.

```APIDOC
init-iframe
  post https://demo.mifinity.com/api/deposit
```

--------------------------------

### init-iFrame API

Source: https://mifinity.readme.io/reference/deposit-api

Initiates an iframe payment process. Requires return URLs, a validation key, client and money details, destination account, brand ID, and a client reference.

```APIDOC
POST https://demo.mifinity.com/pegasus-ci/api/gateway/init-iframe

Parameters:
- returnUrl (string, required): URL to send callback after successful transfer.
- errorUrl (string, required): URL to send callback after failed transfer.
- validationKey (string, required): Secret key to validate payment response and get status of payment. Minimum 48 characters, maximum 255 characters.
- client (object, required):
  - address (object, required):
    - traceId (string, required): Merchant's identifier for the call. Maximum 48 characters.
- money (object, required):
  - description (string, required): Description of transfer. Sofort/Klarna deposits limited to 27 characters. Maximum 255 characters.
- destinationAccountNumber (string, required): Merchant’s account number to collect payment.
- brandId (string, required): A 3-digit ID provided by MiFinity indicating the brand.
- clientReference (string, required): Id of client in merchant’s system. Maximum 48 characters.

Headers:
- api-version (string, required): Defaults to 1.

Responses:
- Response body (json)
```

--------------------------------

### Get Pay My Card Currencies API

Source: https://mifinity.readme.io/reference/get-transaction-status1

Retrieves a list of currencies supported for the Pay My Card service.

```APIDOC
Get Pay My Card Currencies
get
```

--------------------------------

### Get Bank Name (PayAnyBank)

Source: https://mifinity.readme.io/reference/get-account-details

Retrieves the bank name based on provided details for the PayAnyBank service.

```APIDOC
GET /reference/get-bank-name
```

--------------------------------

### iFrame Initialization and Usage

Source: https://mifinity.readme.io/docs/e-mail-verification

Details on how to initialize and use the Mifinity iFrame for seamless payment integration. Includes JavaScript widget information.

```APIDOC
iFrame Initialization:
  Method: POST
  Endpoint: /init-iframe
  Description: Initializes the iFrame for payment processing.
  Request Body:
    apiKey: string (Your Mifinity API key)
    transactionId: string (Unique identifier for the transaction)
    amount: number (The transaction amount)
    currency: string (The currency code, e.g., 'EUR')
    returnUrl: string (URL to redirect after payment completion)
  Response:
    iframeUrl: string (The URL to load in the iFrame)

iFrame JavaScript (widget):
  Description: Provides JavaScript functions to interact with the iFrame, such as handling callbacks and resizing.
  Example Usage:
    Mifinity.on('paymentSuccess', function(data) {
      console.log('Payment successful:', data);
    });
    Mifinity.resize(newWidth, newHeight);
```

--------------------------------

### init-iframe API

Source: https://mifinity.readme.io/reference/pay-my-card

Initializes an iframe for payment processing.

```APIDOC
POST https://demo.mifinity.com/api/init-iframe
Description: Initializes an iframe for payment.
```

--------------------------------

### Get Transaction Status

Source: https://mifinity.readme.io/reference/get-account-details

Retrieves the status of a specific transaction. Part of the Transaction Information API calls.

```APIDOC
GET /reference/get-transaction-status1
```

--------------------------------

### Logo Brand Guideline

Source: https://mifinity.readme.io/docs/monochrome-versions

Guidelines for using Mifinity logos, including different versions and background considerations.

```APIDOC
Logo Brand Guideline:
  - Description: Rules and assets for using Mifinity's branding.
  - Versions:
    - Logo: Standard logo usage.
    - Text logo version: Guidelines for the text-based logo.
    - Different Background: How to use the logo on various backgrounds.
    - Monochrome versions: Usage of single-color logo variants.
    - Logo Mark: Guidelines for the standalone logo symbol.
```

--------------------------------

### init-iframe

Source: https://mifinity.readme.io/reference/get-account-details

Initializes an iframe for a Mifinity service. Part of the init-iframe API calls.

```APIDOC
POST /reference/init-iframe
```