Skip to content

WhiteBIT

Supports in this guide: Payments, Payouts

Provider website: whitebit.com


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

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

Choose account type

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

  • If you do direct card payments -> choose H2H Merchant account
  • If you do hosted/redirect card payments or card payouts -> choose Provider account

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


Prerequisites: get from WhiteBIT

Log in to your WhiteBIT merchant dashboard to get the following credentials. H2H Merchant account and Provider account are separate connections with independent credentials, but both use the same type of values.

For H2H Merchant account:

  • Account ID -> Corefy field com_acc.
  • API key -> Corefy field api_key.
  • Private key (optional) -> Corefy field key_for_callback -> used to verify incoming callbacks.
  • API URL -> Corefy field api_url.

For Provider account:

  • Account ID -> Corefy field commerce_id.
  • API key -> Corefy field api_key.
  • Private key (optional) -> Corefy field secret_key_callback -> used to verify incoming callbacks.
  • API URL (optional) -> Corefy field api_url.

Important

If you require to whitelist IPs on WhiteBIT's side, ask your account manager and provide Corefy's IP list from the integration docs.

UAH, RUB, EUR, and USD are available on the H2H Merchant account. Available currencies on the Provider account depend on the services configured for your WhiteBIT account - Corefy reads them live from WhiteBIT.


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

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Account ID
  • API key
  • Private key (optional)
  • API URL
  • Send metadata -> (optional): enable to forward your own metadata to WhiteBIT
  • Currency / Features -> choose values available for your account (UAH, RUB, EUR, USD)
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected WhiteBIT 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. WhiteBIT may return a 3D Secure challenge redirect, or an OTP confirmation step, depending on the card.

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6f7a8b9c-0d1e-4f2a-8b13-6c7d8e9f0a1b",
      "service": "payment_card_uah_hpp",
      "currency": "UAH",
      "amount": 10
    }
  }
}

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "7a8b9c0d-1e2f-4a3b-8c24-7d8e9f0a1b2c",
      "service": "payment_card_uah_hpp",
      "currency": "UAH",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "email": "customer@example.com",
        "phone": "+380991234567",
        "address": {
          "country": "UA",
          "city": "Kyiv",
          "post_code": "01001",
          "street": "Main street 1"
        }
      },
      "metadata": {
        "order_id": "order_123"
      }
    }
  }
}

Important

  • customer.email, customer.phone, and customer.address are all optional - WhiteBIT doesn't require them, but sending them can help with 3DS/fraud checks.
  • metadata is only forwarded to WhiteBIT when the Send metadata option is enabled on your account.

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

  • ignore_callback -> optional, boolean - relies only on an active status request to finalize the payment, instead of also accepting WhiteBIT's asynchronous callback.
  • save_provider_instant_token -> optional, boolean - saves a token after a successful payment so it can be charged again later (recurring).
  • generate_random_customer_data -> optional, boolean - generates random customer data on Corefy's side when your request doesn't include it, for providers that require some customer fields to be present.
  • transliterate_customer_data -> optional, boolean - transliterates customer data to Latin characters before sending it to WhiteBIT.
  • transliterate_card_holder -> optional, boolean - transliterates the cardholder name to Latin characters before sending it to WhiteBIT.
  • set_description -> optional, boolean - sends your payment's description to WhiteBIT.
  • duplicate_original_resolution -> optional, boolean - reuses the original payment's decline reason for a related operation instead of requesting a new one.

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)

  • address -> customer.address.street
  • city -> customer.address.city
  • country -> customer.address.country
  • post_code -> customer.address.post_code
  • phone -> customer.phone
  • email -> customer.email
  • metadata_key / metadata_value -> fallback for metadata when Send metadata is enabled but the request doesn't include it
  • browser_tz, browser_screen_width, browser_screen_height, browser_color_depth, browser_language, browser_java_enabled, browser_accept_header, browser_user_agent, browser_ip -> browser fingerprint fields used for 3D Secure, normally collected automatically by Corefy's checkout/SDK layer

Refunds

WhiteBIT does not support refunds through Corefy on the H2H Merchant account.


Recurring

WhiteBIT supports saving a card token on a successful payment (enable save_provider_instant_token) and charging it again later through Corefy's standard recurring flow.


Payments and Payouts processing (connect Provider account)

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Account ID
  • API key
  • Private key (optional)
  • API URL (optional)
  • Send metadata -> (optional)
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected WhiteBIT Provider account!


First request to Corefy API (MIN)

What it does: creates a payment-invoice (hosted/redirect payment) or a payout-invoice (card payout). Available currencies and services are read live from your WhiteBIT account - whatever WhiteBIT exposes for your account becomes available in Corefy for the matching currency.

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "8b9c0d1e-2f3a-4b4c-8d35-8e9f0a1b2c3d",
      "service": "payment_card_uah_hpp",
      "currency": "UAH",
      "amount": 10
    }
  }
}

Payout - MIN

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "9c0d1e2f-3a4b-4c5d-8e46-9f0a1b2c3d4e",
      "service": "payment_card_uah",
      "currency": "UAH",
      "amount": 10,
      "fields": {
        "card_number": "4111111111111111"
      }
    }
  }
}

Important

fields.card_number is required for payouts.


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

  • allow_conversion -> optional, boolean - allows a payment or payout to go through on a WhiteBIT service whose settlement currency differs from the one you requested.
  • send_description -> optional, boolean - Payouts only; sends your payout's description to WhiteBIT.

Refunds

WhiteBIT does not support refunds through Corefy on the Provider account.


Additional info

  1. Refunds are not available on either account type - despite WhiteBIT's own API having refund-capable infrastructure on Corefy's side, refunds are not enabled for this connector; always double-check with your account manager before relying on refund capability.
  2. Provider account routes are discovered automatically - Corefy reads the currencies/services available on your WhiteBIT account directly from WhiteBIT, rather than using a fixed list.
  3. OTP confirmation - some H2H card payments may require the customer to confirm an OTP code as part of the flow.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify the credentials for the selected account type and environment - H2H Merchant account and Provider account use separate credentials
  • Refund request fails -> WhiteBIT does not support refunds through Corefy on either account type
  • Currency or service is not supported -> confirm allowed currencies/features in your WhiteBIT account and in Corefy
  • Not sure which account type to use? -> H2H Merchant account is for direct card payments; Provider account is for hosted/redirect payments and payouts

Question

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