Skip to content

Logo

BlackRabbit

Supports in this guide: Payments, Payouts

Provider website: br-pay.io


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

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

Choose account type

BlackRabbit 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 payouts -> choose Provider account

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


Prerequisites: get from BlackRabbit

For H2H Merchant account:

  • ID -> Corefy field id -> where to find: BlackRabbit backoffice / issued by BlackRabbit manager.
  • Secret Key -> Corefy field secret_key -> used to sign every request.
  • Secret Key (return URL) -> Corefy field secret_key_return_url -> a separate key used specifically to sign the success/failure return URLs - BlackRabbit may issue the same value as Secret Key, or a distinct one; confirm with your account manager.
  • Payment System (optional) -> Corefy field sp_payment_system -> selects which underlying payment system BlackRabbit routes this connection through -> leave as default (CARD) unless your account manager tells you otherwise.

For Provider account:

  • ID -> Corefy field id -> where to find: BlackRabbit backoffice / issued by BlackRabbit manager.
  • Secret Key -> Corefy field secret_key -> used to sign every request.
  • Secret Key (return URL) -> Corefy field secret_key_return_url -> same as above.

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

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • ID
  • Secret Key
  • Secret Key (return URL)
  • Payment System (optional, leave default)
  • Test Mode -> (enable if you are using sandbox credentials)
  • Send Merchant URL -> (enable to send your own website URL to BlackRabbit with every request)
  • Save Instant Token -> (enable if you plan to use instant/recurring payments)

Choose Currency and Features. You can set these parameters according to available currencies and features for your BlackRabbit account (RUB, USD, EUR, KZT, UAH, UZS confirmed), but it is necessary to check details of the connection with your Corefy account manager.

Success

You have connected BlackRabbit 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_rub_hpp",
      "currency": "RUB",
      "amount": 100
    }
  }
}

Payment - MAX

POST /api/payment-invoices

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

None of customer's fields are strictly required - if you omit email/phone, BlackRabbit still receives a generic placeholder value for each rather than a blank one; send the real values if you want BlackRabbit to see your actual customer's details. This connector also supports USD, EUR, KZT, UAH, and UZS (use payment_card_<currency>_hpp as the service code) - UZS sales can skip sending a real CVV.


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)

  • ignore_callback - tells Corefy to disregard BlackRabbit's own callback notifications entirely.
ignore_callback

What it does: when enabled, Corefy ignores callback notifications sent by BlackRabbit for this connection, relying on status checks/reconciliation instead.

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

Default: false

Allowed values: true / false


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

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

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

Success

You have connected BlackRabbit Provider account!


First request to Corefy API (MIN)

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

Payout - MIN

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "0dde9e79-2c64-4703-adaf-93d710633401",
      "service": "payment_card_rub",
      "currency": "RUB",
      "amount": 100,
      "customer": {
        "reference_id": "cus_123"
      },
      "fields": {
        "card_number": "4111111111111111"
      }
    }
  }
}

Payout - MAX

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "7976b4ce-fadd-4585-baa0-6b02c65351dc",
      "service": "payment_card_rub",
      "currency": "RUB",
      "amount": 100,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567"
      },
      "fields": {
        "card_number": "4111111111111111",
        "card_exp_month": "12",
        "card_exp_year": "27"
      }
    }
  }
}

fields.card_number is required. This connector also supports payouts in AZN and EUR (use payment_card_azn/payment_card_eur as the service code). For EUR payouts to a Visa/Mastercard card specifically, enabling the strict_payout_request_validation option below makes customer.email, customer.phone, and the card's expiry (fields.card_exp_month/card_exp_year) mandatory - include them if you've enabled it.


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 (2)

  • strict_payout_request_validation - requires extra customer/card details on EUR Visa/Mastercard payouts.
  • api_url - overrides the payout endpoint for this connection.
strict_payout_request_validation

What it does: for EUR payouts to a Visa or Mastercard card, requires customer.email, customer.phone, and the card's expiry month/year to be present - the payout is rejected before reaching BlackRabbit if any are missing.

When to use: enable it if BlackRabbit or your account manager asked you to enforce this extra data on EUR card payouts.

Default: false

Allowed values: true / false

api_url

What it does: overrides the default payout API endpoint for this connection.

When to use: only if BlackRabbit issues you a different payout endpoint than the default.

Default: not set (uses BlackRabbit's default endpoint)

Allowed values: any valid URL


Additional info

  1. Callback routing. For H2H Merchant account, the callback endpoint is /blackrabbit/callback - register it in BlackRabbit's own back-office. For Provider account payouts, callback routing is handled automatically - Corefy generates the callback URL per transaction.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify credentials for the selected environment and account type
  • Payout rejected for missing email/phone/expiry (EUR) -> strict_payout_request_validation is enabled for this connection - include customer.email, customer.phone, and the card's expiry
  • Currency or service is not supported -> confirm allowed currencies/features in your BlackRabbit account and in Corefy
  • Not sure which account type to use? -> ask your Corefy account manager

Question

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