Skip to content

Logo

Omnikeea

The technical layer enabling connectivity with licensed financial service providers

Supports in this guide: Payments

Provider website: omnikeea.com


What you need to do for start processing transactions (brief summary)

  1. Get your credentials (from Omnikeea)
  2. Connect in Dashboard
  3. Send an API request

Prerequisites: get from Omnikeea

Contact your Omnikeea account manager to get your account verified and receive the following credentials.

  • Commerce Account -> Corefy field com_acc.
  • API Key -> Corefy field api_key.
  • Key for Callback (optional) -> Corefy field key_for_callback -> used to verify callback notifications from Omnikeea, if your account requires it.
  • API URL -> Corefy field api_url -> your account-specific endpoint, given by Omnikeea.
  • Send Metadata (optional) -> Corefy field send_metadata.

Payments processing (connect H2H Merchant account, create payment-invoice)

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

Open Omnikeea in the provider directory and press Connect at Omnikeea Provider Overview page in the New connection section. Choose H2H Merchant account.

Step 2 - Fill in fields and select settings

  • Commerce Account
  • API Key
  • Key for Callback (optional)
  • API URL
  • Send Metadata (optional)
  • Test Mode -> (enable if you are using sandbox credentials)

Choose Currency / Features; check with your Corefy account manager which are enabled for your account.

Success

You have connected Omnikeea H2H Merchant account!


First request to Corefy API (MIN)

What it does: creates a payment-invoice; card data itself is collected and submitted separately by Corefy's checkout/SDK layer, not as part of this request. Omnikeea may return a 3D Secure challenge redirect depending on the card.

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "8e3dbbb0-17af-4c9a-bedb-93bdac6900a2",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10
    }
  }
}

This connector also supports EUR.

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6795502c-e27d-4d07-85e0-93245aab9a3f",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567",
        "address": {
          "country": "US",
          "city": "New York"
        }
      }
    }
  }
}

customer is entirely optional and is only used to enrich the sale.


Extended request (MAX)

Why add extra fields (typical reasons): - Provide additional customer details for compliance/reconciliation - Positively influence conversion rate - Include optional fields required by your specific flow

No Constants are configured for this connector.


Options

  • ignore_callback -> optional, boolean - for cascading to work correctly, excludes finalizing the payment from the asynchronous callback; Corefy then relies only on an active status request (reconciliation) to finalize it.
  • save_provider_instant_token -> optional, boolean - if Omnikeea's response includes an instant token, Corefy stores it; confirm with your account manager whether a follow-up charge using this token is available for your account.
  • generate_random_customer_data -> optional, boolean - if enabled and customer is missing from your request, Corefy automatically fills it in with generated placeholder data instead of sending nothing.
  • transliterate_customer_data -> optional, boolean - transliterates customer fields to Latin before sending them to Omnikeea.
  • transliterate_card_holder -> optional, boolean - transliterates the card's embossed holder name to Latin before sending it to Omnikeea (independent of the customer transliteration above).
  • set_description -> optional, boolean - sends your transaction descriptor as the payment's description, instead of leaving it blank.
  • duplicate_original_resolution -> optional, boolean - if Corefy's own resolution mapping can't classify Omnikeea's response, falls back to reporting Omnikeea's original resolution code instead of leaving it blank.

Refunds

Omnikeea supports partial refunds, but only one refund per payment (no multiple partial refunds against the same payment).


Additional info

  1. Callback routing is automatic - Corefy generates the callback/return URLs per transaction, nothing to configure in Omnikeea's own back-office.
  2. No payouts - this connector does not support payouts through Corefy.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify Commerce Account/API Key for the selected environment
  • Refund fails on a second attempt -> only one refund per payment is supported
  • Currency or service is not supported -> confirm allowed currencies/features in your Omnikeea account and in Corefy

Question

Still looking for help connecting your Omnikeea account? Please contact our support team!