Skip to content

Logo

Impaya

E-commerce Solutions that Fit Your Business

Supports in this guide: Payments

Provider website: impaya.com

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

  1. Choose account type
  2. Get your credentials (from Impaya)
  3. Connect in Dashboard
  4. Send an API request

Choose account type

Impaya can be connected in different ways (depending on your needs):

  • If you do H2H card payments (card data sent directly) -> choose H2H Merchant account
  • If you do card, MB WAY, Pay ID, Multibanco, Open Banking, Revolut Pay, Apple Pay, or Google Pay payments via a hosted page -> choose Provider account

Impaya does not currently support payouts through Corefy. If you're not sure which one to use, confirm with your Corefy account manager.

Important

On both account types, customer data is functionally required, not optional - a sale is rejected upfront if key fields are missing, even though the general Corefy API treats customer as optional. The exact required fields differ slightly per account type - see the important notes under each flow below. Always send full customer data for this connector.

Prerequisites: get from Impaya

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

For H2H Merchant account:

  • Merchant ID -> Corefy field merchant_id.
  • Merchant Key -> Corefy field merchant_key.
  • Finalize Pending to Failed (optional) -> Corefy field finalize_pending_to_failed -> see the important note under Refunds/Reconciliation below.

Note

There is no Test Mode toggle for the H2H Merchant account - ask your account manager whether a separate sandbox is available.

For Provider account:

  • Merchant ID -> Corefy field merchant_id.
  • Merchant Key -> Corefy field merchant_key.
Payments processing (connect H2H Merchant account, create payment-invoice)

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Merchant ID
  • Merchant Key
  • Finalize Pending to Failed (optional)

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

Success

You have connected Impaya 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. Impaya may return a 3D Secure challenge redirect depending on the card. CVV is always required - non-CVV sales aren't supported.

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,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567",
        "address": {
          "country": "US",
          "city": "New York"
        }
      }
    }
  }
}

This connector also supports EUR, AUD, BRL, CAD, CZK, DKK, HUF, NZD, NOK, PLN, RUB, CHF.

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"
        }
      }
    }
  }
}

Important

customer.name (first name), customer.email, customer.phone, and customer.address.country are required - the sale is rejected before it even reaches Impaya if any of these is missing. customer.name (last name) and customer.address.city are sent if present but aren't strictly required.

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 - since customer is already functionally required, there's no fallback data to configure.

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.

Refunds

This connector does not support refunds on the H2H Merchant account.

Important

By default, a transaction that Impaya rejects is reported to you as pending, not failed, and Corefy keeps checking its status. Enable Finalize Pending to Failed on the connection if you'd rather see rejected transactions finalized as failed right away.

Payments processing (connect Provider account, create payment-invoice)

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Merchant ID
  • Merchant Key
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected Impaya Provider account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice and redirects the customer to an Impaya-hosted page to complete the payment. The exact payment methods available depend on what's enabled for your specific Impaya account - check with your account manager which of card, MB WAY, Pay ID, Multibanco, Open Banking, Revolut Pay, Apple Pay, and Google Pay are available to you.

Payment - MIN

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "8e3dbbb0-17af-4c9a-bedb-93bdac6900a2",
      "service": "pay_id_aud_hpp",
      "currency": "AUD",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "address": {
          "country": "AU",
          "city": "Sydney"
        }
      }
    }
  }
}

Payment - MAX

POST /api/payment-invoices 

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

Important

customer.name, customer.email, customer.address.country, and customer.address.city are required for every service on this flow - the sale is rejected before it reaches Impaya if any of these is missing. customer.phone is sent if present but isn't strictly required.

Note

Apple Pay and Google Pay use a separate flow on Impaya's side that additionally expects customer.address.region, customer.address.street, and customer.address.post_code - send a full address when using these methods.

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 Options are configured for this flow.

Constants (fallback fields)

Constants are static values that Corefy can send to the provider instead of dynamic data from your API request, when those fields are missing in the request. Currently configured only for the pay_id_aud_hpp and mb_way_eur_hpp services.

Priority (predictable rule): 1. If a value is present in the request -> Corefy uses the request value 2. Else if the constant is set -> Corefy uses the constant 3. Else -> provider may reject the request or apply its defaults (depends on provider)

Currently available constants (constant -> Corefy API field)

  • HPP_LANGUAGE -> controls the language of Impaya's hosted page; defaults to English if not set

Refunds

This connector does not support refunds on the Provider account.

Additional info

  1. Callback routing is automatic on the Provider account - Corefy generates the callback/return URLs per transaction, nothing to configure in Impaya's own back-office.
  2. The H2H Merchant account uses a single fixed callback endpoint rather than a per-transaction URL; it's already set up on Corefy's side, nothing to configure in Impaya's own back-office either.
  3. No payouts - this connector does not support payouts through Corefy.

FAQ / Troubleshooting

  • Sale rejected with "Customer data is required" -> send customer.name, customer.email, and customer.address.country/customer.address.city - they're required for both account types on this connector
  • Invalid credentials / auth error -> verify the credentials for the selected account type - H2H Merchant account and Provider account use entirely different credential sets
  • Rejected transaction stays pending -> this is expected by default; enable Finalize Pending to Failed on the H2H Merchant account if you'd rather see it finalized as failed
  • Refund request fails -> this connector doesn't support refunds on either account type
  • Currency or service is not supported -> confirm allowed currencies/features in your Impaya account and in Corefy

Question

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