Ecommpay

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• Project ID
• Secret Key
• API URL (optional)
• Test Mode -> (enable if you are using sandbox credentials)
• Send Merchant URL -> (enable to send your website URL to Ecommpay with every request)
• Send Payment Extra Param -> (enable to forward a custom payment_extra_param value from your request's metadata)

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

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_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": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567",
        "address": {
          "country": "DE",
          "city": "Berlin",
          "street": "1 Main street",
          "post_code": "10115"
        }
      },
      "metadata": {
        "payment_extra_param": "custom-value"
      }
    }
  }
}

All of customer's fields are optional - anything you don't send falls back to the Constants below (or is simply omitted) instead of failing the request. metadata.payment_extra_param is only forwarded when Send Payment Extra Param is enabled. This connector also supports USD and RUB (use payment_card_usd_hpp/payment_card_rub_hpp as the service code).

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

• ignore_callback - tells Corefy to disregard Ecommpay's own callback notifications entirely.
• async_acs_data_extraction - actively polls for 3D Secure (ACS) challenge data instead of waiting once for the callback.
• enable_visa_aft_refund_rules - skips the normal 24-hour refund delay for Visa cards.
• enable_mastercard_aft_refund_rules - skips the normal 24-hour refund delay for Mastercard cards.

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)

• CUSTOMER_NAME -> customer.name
• CUSTOMER_EMAIL -> customer.email
• PHONE -> customer.phone
• COUNTRY -> customer.address.country
• CITY -> customer.address.city
• STREET -> customer.address.street
• ZIP -> customer.address.post_code
• FULL_ADDRESS -> customer.address.full_address

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• Project ID
• Secret Key
• Token / Token Key (optional)
• Test Mode -> (enable if you are using sandbox credentials)

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_eur",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123"
      },
      "fields": {
        "card_number": "4111111111111111",
        "card_exp_month": "12",
        "card_exp_year": "27"
      }
    }
  }
}

Payout - MAX

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "7976b4ce-fadd-4585-baa0-6b02c65351dc",
      "service": "payment_card_eur",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "address": {
          "country": "US",
          "region": "California",
          "city": "Los Angeles",
          "full_address": "1 Main street",
          "post_code": "90001"
        }
      },
      "fields": {
        "card_number": "4111111111111111",
        "card_exp_month": "12",
        "card_exp_year": "27"
      }
    }
  }
}

fields.card_number/card_exp_month/card_exp_year are required; the cardholder's name is derived from customer.name. This connector also supports PLN, USD, and KRW (use payment_card_pln/payment_card_usd/payment_card_krw as the service code).

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)

• send_recipient_and_sender - sends detailed recipient (cardholder) and sender (your customer) information with the payout.