SettlePay

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• Account ID
• Point ID
• Wallet ID
• API Token
• Send Merchant Data
• Service ID (optional)
• Test Mode -> (enable if you are using sandbox credentials)

This connector supports CAD, AUD, GBP, USD, UAH, EUR, KZT.

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. SettlePay may return a 3D Secure challenge redirect depending on the card.

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "1e2f3a40-5b6c-4d7e-8f91-2a3b4c5d6e7f",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10
    }
  }
}

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "2f3a4b51-6c7d-4e8f-8a02-3b4c5d6e7f8a",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567",
        "date_of_birth": "1990-05-20",
        "address": {
          "country": "FR",
          "region": "IDF",
          "city": "Paris",
          "full_address": "1 Main street",
          "post_code": "75000"
        }
      }
    }
  }
}

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 - 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.
• random_generation_customer_data -> optional, boolean - if enabled and real customer/address data is missing from your request, Corefy fills it in with generated placeholder data instead of sending nothing.
• add_state -> optional, boolean - forces a state field to be sent for any country, not just US/Canada.

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)

• first_name -> customer.name (first part)
• last_name -> customer.name (second part)
• email -> customer.email
• phone -> customer.phone
• country -> customer.address.country (see the BIN-country priority note above)
• city -> customer.address.city
• zip_code -> customer.address.post_code
• address -> customer.address.full_address
• region -> customer.address.region
• date_of_birth -> customer.date_of_birth (EUR only)

Refunds

SettlePay supports refunds, but only one full refund per payment (no partial, no multiple).

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• Point ID
• Account ID
• API Key
• API URL (optional)
• Use V2 (optional)
• Currencies
• Test Mode -> (enable if you are using sandbox credentials)

First request to Corefy API (MIN)

What it does: creates a payment-invoice. Most methods redirect the customer to a SettlePay-hosted page; a few (Pix, bank transfer, Nequi) instead return payment instructions (a QR code, bank details, or similar) directly in the response, without a redirect. Available methods and currencies depend on what's enabled for your account - broadly: card/Apple Pay/Google Pay (UAH/RUB/KZT/USD/EUR), SettlePay Wallet (UAH), Pix (BRL/ARS), Binance Pay (wide currency list including USD/EUR/UAH/INR/KZT/PLN/BRL/TRY/CAD/AUD and more), GatePay (USD), Bybit Pay (USDT/USDC), bank transfer (ARS), MB WAY (EUR), Nequi/Nequi QR (COP).

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "3a4b5c62-7d8e-4f9a-8b13-4c5d6e7f8a9b",
      "service": "binancepay_usd_hpp",
      "currency": "USD",
      "amount": 10
    }
  }
}

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "4b5c6d73-8e9f-4a0b-8c24-5d6e7f8a9b0c",
      "service": "binancepay_usd_hpp",
      "currency": "USD",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567"
      },
      "metadata": {
        "product_name": "Order #123",
        "product_type": "Goods"
      }
    }
  }
}

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

• locale -> optional, enum - configured on the gatepay_usd_hpp service only - language used for GatePay's own hosted page.

Constants (fallback fields)

• customer_first_name, customer_last_name -> fallback for the first/last name on bank transfer (ARS) and Nequi services.
• client_ip -> fallback for the customer's IP address, used by the Nequi invoice flow.
• productName, productType -> fallback for Binance Pay's metadata.product_name/metadata.product_type.

Refunds

This connector does not support refunds on the Provider account - use the H2H Merchant account if you need refunds.

Connect Provider account in Corefy Dashboard

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

First request to Corefy API (MIN)

What it does: creates a payout-invoice and sends funds via card, SettlePay Wallet, UPI, or Pix, depending on what's enabled for your account. Required fields vary by method - the Dashboard shows the exact field list once a method is selected.

Payout - MIN

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "5c6d7e84-9f0a-4b1c-8d35-6e7f8a9b0c1d",
      "service": "payment_card_uah",
      "currency": "UAH",
      "amount": 10,
      "fields": {
        "card_number": "4111111111111111"
      }
    }
  }
}

This connector also supports payment_card_rub, payment_card_kzt, settlepay_wallet_uah, upi_inr, pix_brl, pix_ars.

Payout - MAX

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "6d7e8f95-0a1b-4c2d-8e46-7f8a9b0c1d2e",
      "service": "payment_card_uah",
      "currency": "UAH",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123"
      },
      "fields": {
        "card_number": "4111111111111111"
      }
    }
  }
}

customer is entirely optional. For Pix payouts, UPI payouts automatically include SettlePay's own required transaction-mode fields; neither needs extra configuration on your side.

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)

• country -> Pix only -> Corefy already sets this automatically per currency (Brazil for BRL, Argentina for ARS) - only override if your account manager tells you to.