Xpate

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• API Key
• Save Instant Token -> (enable to have Xpate create a reusable token on every successful sale, for later recurring/merchant-initiated charges)
• Test Mode -> (enable if you are using sandbox credentials)

Choose Currency / Features; check with your Corefy account manager which are enabled for your 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_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": "FR",
          "city": "Paris",
          "full_address": "1 Main street",
          "post_code": "75000"
        }
      }
    }
  }
}

customer is entirely optional - anything you don't send falls back to the Constants below, or is simply left blank on Xpate's 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

Options

Configured per service (payment_card_<ccy>_hpp):

• dont_send_receiver_account_number -> optional, boolean - stops Corefy from sending receiver_account_number on every sale (see the note above).
• void_on_reconcile_available -> optional, boolean - advanced setting for card-validation (no-charge) requests: automatically voids a successful validation once confirmed, so no funds are captured.
• zero_amount_verify -> optional, boolean - also for card-validation requests: submits a literal zero-amount authorization instead of a capturable-then-voided 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)

• FIRSTNAME -> customer.name (first part)
• LAST_NAME -> customer.name (second part)
• EMAIL -> customer.email
• PHONE_NUMBER -> customer.phone
• COUNTRY -> customer.address.country
• CITY -> customer.address.city
• ADDRESS -> customer.address.full_address
• POST_CODE -> customer.address.post_code
• ADDRESS_TYPE -> billing address type sent to Xpate (defaults to billing if neither sent nor set)
• LOCALE -> checkout locale
• IP -> customer's IP address (falls back to the IP Corefy detects if neither sent nor set)
• MERCHANT_CUSTOMER_ID -> customer.reference_id

Refunds

Xpate supports partial and multiple refunds against the same payment.

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• Login
• Control Key
• Private Key
• Endpoint ID
• API URL (optional)
• Multi Currency (optional)
• Disable Balance (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 directly 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,
      "fields": {
        "card_number": "4111111111111111"
      }
    }
  }
}

Payout - MAX

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "3c6d2f8e-8a2a-4e7a-9b1a-2f6a7b9c0d1e",
      "service": "payment_card_eur",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith"
      },
      "fields": {
        "card_number": "4111111111111111",
        "card_holder": "JOHN SMITH"
      }
    }
  }
}

fields.card_holder is optional and falls back to customer.name (or the operation's own user name) if not sent.

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 or Constants are configured for this flow.