Skip to content

Logo

Katarun

Tailored to you

Supports in this guide: Payments, Payouts

Provider website: katarun.com


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

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

Choose account type

Katarun 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 local payment methods (MB WAY, Multibanco, Payshop, Bizum, BLIK, SEPA transfer, bank transfer, MyBank, ePay, RapidTransfer) or payouts -> choose Provider account

If you're not sure which one to use, confirm with your Corefy account manager.


Prerequisites: get from Katarun

Submit a connection request via katarun.com or contact your Katarun account manager directly to get your account verified and receive the following credentials:

For H2H Merchant account:

  • API Key -> Corefy field api_key.
  • API Type -> Corefy field api_type -> choose Server-to-Server or Direct Post - see Additional info for what each one means for your PCI scope.
  • S2S Token (required only if API Type is Server-to-Server) -> Corefy field s2s_token.
  • Brand ID -> Corefy field brand_id.
  • Webhook Public Key (optional) -> Corefy field webhook_public_key -> used to verify callback notifications signed by Katarun, if your account requires it.
  • API URL (optional) -> Corefy field api_url -> leave as default unless your account manager tells you otherwise.

For Provider account:

  • Brand ID -> Corefy field brand_id.
  • API Key -> Corefy field api_key.
  • Webhook Public Key (optional) -> Corefy field webhook_public_key.
  • S2S Token (optional) -> Corefy field s2s_token.

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

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • API Key
  • API Type -> Server-to-Server or Direct Post
  • S2S Token (required only for Server-to-Server)
  • Brand ID
  • Webhook Public Key (optional)
  • API URL (optional)

Choose Currency and Features. USD, EUR, and AZN are confirmed; check with your Corefy account manager which are enabled for your account.

Success

You have connected Katarun 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.

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

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",
          "full_address": "1 Main street",
          "post_code": "10001"
        }
      }
    }
  }
}

Important

There are no Constants configured for this flow - unlike most other connectors, nothing you omit from customer falls back to a Dashboard-configured default here. Send whatever customer data your use case needs directly in the request.


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 either.


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

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Brand ID
  • API Key
  • Webhook Public Key (optional)
  • S2S Token (optional)
  • Currency -> single-select, choose from the currencies enabled for your account

Success

You have connected Katarun Provider account!


First request to Corefy API (MIN)

What it does: creates a payment-invoice. Most local methods redirect to Katarun's hosted page; a few (MB WAY, Multibanco, Payshop) are also available as a "requisites" variant that returns payment details directly instead of a redirect - see Additional info.

Payment - MIN

POST /api/payment-invoices

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

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6795502c-e27d-4d07-85e0-93245aab9a3f",
      "service": "sepa_transfer_eur_hpp",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "email": "johnsmith@gmail.com"
      }
    }
  }
}

customer requirements differ a lot by local method - some need nothing at all, others need a full address - see Additional info for the breakdown per method.


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


Options

Options are configured on the Corefy side and affect how Corefy builds provider requests or processes responses.

Currently available options (1)

  • finalize_by_protocol - switches which internal status map Corefy uses to finalize transactions.
finalize_by_protocol

What it does: when enabled, Corefy finalizes transactions using a stricter status map; when disabled, a softer one is used instead.

When to use: enable only if instructed by Katarun or your Corefy account manager.

Default: false

Allowed values: true / false


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. These only apply to the five specific Payment services listed below - every other local method on this flow has no Constants fallback at all.

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), by service

  • sepa_transfer_eur_hpp: EMAIL -> customer.email
  • bank_transfer_jpy_hpp: EMAIL -> customer.email
  • mybank2_eur_hpp, epay_eur_hpp, rapidtransfer_eur_hpp: EMAIL -> customer.email, COUNTRY -> customer.address.country

Payouts processing (connect Provider account, create payout-invoice)

Connect Provider account in Corefy Dashboard

Uses the same Provider account connection as Payments above - one connection covers both directions, there's nothing extra to fill in for payouts specifically.


First request to Corefy API (MIN)

What it does: creates a payout-invoice and sends funds to a bank account or a card.

Payout - MIN (bank transfer)

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "0dde9e79-2c64-4703-adaf-93d710633401",
      "service": "bank_transfer_eur",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123"
      },
      "fields": {
        "account_number": "DE89370400440532013000",
        "beneficiary_full_name": "John Smith"
      }
    }
  }
}

Payout - MAX (bank transfer)

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "7976b4ce-fadd-4585-baa0-6b02c65351dc",
      "service": "bank_transfer_eur",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567"
      },
      "fields": {
        "account_number": "DE89370400440532013000",
        "beneficiary_full_name": "John Smith"
      }
    }
  }
}

fields.account_number (IBAN) and fields.beneficiary_full_name are required. This connector also supports card payouts in EUR/USD (use payment_card_eur/payment_card_usd as the service, with fields.card_number required and fields.card_holder optional - falls back to customer.name).


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


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.

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), by service

  • bank_transfer_eur: EMAIL -> customer.email, PHONE -> customer.phone
  • payment_card_eur, payment_card_usd: EMAIL -> customer.email, PHONE -> customer.phone, COUNTRY -> customer.address.country, CITY -> customer.address.city, FULL_ADDRESS -> customer.address.full_address, POST_CODE -> customer.address.post_code

Additional info

  1. API Type (H2H Merchant account only). Server-to-Server means Corefy submits card data to Katarun on your behalf via API (requires the S2S Token). Direct Post means the customer's browser posts card data directly to Katarun, bypassing Corefy's servers - ask your account manager which one fits your PCI scope.
  2. Callback routing. For H2H Merchant account, register your webhook with Katarun and provide the Webhook Public Key so Corefy can verify incoming callback signatures. For Provider account (Payments and Payouts), callback routing is handled automatically - Corefy generates the callback URL per transaction.
  3. HPP vs "requisites" (Invoice) variant. MB WAY, Multibanco, and Payshop are each available as two separate service codes: the _hpp version redirects the customer to Katarun's hosted page, while the _invoice version instead returns payment requisites directly in the response for the customer to complete elsewhere (a reference and phone number for MB WAY, a reference and entity code for Multibanco, a reference for Payshop) - choose the service code that matches which experience you want to build.
  4. Local payment methods available on the Payments (Provider account) flow (actual availability depends on what's enabled for your account):

    Method Currency Service code customer requirement
    SEPA transfer EUR sepa_transfer_eur_hpp none (email optional, falls back to Constant)
    Card EGP payment_card_egp_hpp none
    MB WAY EUR mb_way_eur_hpp / mb_way_eur_invoice customer object required; its individual fields are optional
    Multibanco EUR multibanco_eur_hpp / multibanco_eur_invoice customer object required; its individual fields are optional
    Payshop EUR payshop_eur_hpp / payshop_eur_invoice customer object required; its individual fields are optional
    Bank transfer JPY bank_transfer_jpy_hpp customer.name, customer.phone, and full customer.address required (email optional, falls back to Constant)
    Bizum EUR bizum_eur_hpp customer.name and customer.phone required
    BLIK PLN blik_pln_hpp none
    MyBank EUR mybank2_eur_hpp none (country optional, falls back to Constant)
    ePay EUR epay_eur_hpp none (country optional, falls back to Constant)
    RapidTransfer EUR rapidtransfer_eur_hpp none (country optional, falls back to Constant)
  5. Local payout methods available on the Payouts (Provider account) flow (actual availability depends on what's enabled for your account): bank transfer in EUR and card payouts in EUR/USD - see the Payouts MIN/MAX above.


FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify credentials for the selected environment and account type
  • H2H payment rejected for missing customer data -> there are no Constants on the H2H flow; send the customer fields your use case needs directly in the request
  • Local payment method rejected for missing customer data -> requirements vary a lot by method on the Payments (Provider account) flow - check the method table in Additional info
  • Currency or service is not supported -> confirm allowed currencies/features in your Katarun account and in Corefy
  • Not sure which account type to use? -> ask your Corefy account manager

Question

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