AlliancePay

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• Merchant ID
• Service Code (optional)
• API Type
• Payment Key
• Private Key (optional)
• KID (optional)
• JWS Private Key (optional)
• Device ID (optional)
• API URL (optional)
• Test Mode -> (enable if you are using sandbox credentials)

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. Card, Apple Pay, and Google Pay are all supported on this same connection. AlliancePay may return a 3D Secure challenge redirect depending on the card.

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "1a2b3c4d-5e6f-4a7b-8c91-2d3e4f5a6b7c",
      "service": "payment_card_uah_hpp",
      "currency": "UAH",
      "amount": 10
    }
  }
}

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "2b3c4d5e-6f7a-4b8c-8d02-3e4f5a6b7c8d",
      "service": "payment_card_uah_hpp",
      "currency": "UAH",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "Ivanov Ivan Ivanovych",
        "individual_tax_id": "1234567890"
      },
      "metadata": {
        "order_purpose": "Order #123"
      }
    }
  }
}

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

• customer_name_format -> optional, enum (LAST, FIRST, MIDDLE, FIRST, MIDDLE, LAST, LAST, MIDDLE, FIRST, LAST, FIRST, FIRST, LAST) - how to split customer.name into first/last/middle name parts; defaults to LAST, FIRST, MIDDLE.
• forced_rejection_delay -> optional, number - card payments only; delays reporting a rejection by this many seconds.
• payment_purpose -> optional, string - the name of a metadata key; whatever value you send under that key in metadata is forwarded to AlliancePay as the payment purpose. For example, setting this to order_purpose and sending metadata.order_purpose in your request forwards that value.
• final_reconcile_callback_only -> optional, boolean - relies only on the asynchronous callback to finalize the payment, instead of also allowing an active status request to do so.
• send_prid_in_comment -> optional, boolean - sends your own payment reference ID as the transaction comment, instead of your merchant company details.

Refunds

AlliancePay supports partial refunds, but only one refund per payment (no multiple partial refunds against the same payment).

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• Merchant ID
• Payment Key
• Private Key (optional, legacy authorization only)
• Service Code (optional, legacy authorization only)
• KID (optional)
• JWS Private Key (optional)
• API URL (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": "3c4d5e6f-7a8b-4c9d-8e02-3f4a5b6c7d8e",
      "service": "payment_card_uah",
      "currency": "UAH",
      "amount": 10,
      "fields": {
        "card_number": "4111111111111111"
      }
    }
  }
}

Payout - MAX

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "4d5e6f7a-8b9c-4d0e-8f13-4a5b6c7d8e9f",
      "service": "payment_card_uah",
      "currency": "UAH",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "Ivanov Ivan Ivanovych",
        "individual_tax_id": "1234567890",
        "address": {
          "country": "UA",
          "city": "Kyiv",
          "street": "Main street 1"
        }
      },
      "fields": {
        "card_number": "4111111111111111"
      }
    }
  }
}

customer.name is parsed the same way as on the H2H Merchant account, per the Customer Name Format option.

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

• customer_name_format -> optional, enum - same values and default as on the H2H Merchant account.
• payout_purpose -> optional, string - same metadata key-lookup mechanism as payment_purpose above, for the payout purpose.
• send_recipient_passport -> optional, boolean - additionally sends the recipient's passport series+number (from customer.passport_series+customer.passport_number, or the passport Constant) - required by AlliancePay for some payout amounts/profiles.
• send_prid_in_comment -> optional, boolean - sends your own payout reference ID as the transaction comment, instead of your merchant company details.
• final_reconcile_callback_only -> optional, boolean - relies only on the asynchronous callback to finalize the payout.
• finalize_on_invalid_itn -> optional, boolean - treats an invalid recipient tax ID (ITN) response from AlliancePay as a final failure immediately, instead of leaving it pending.

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, per the name format option)
• last_name -> customer.name (second part)
• middle_name -> customer.name (third part)
• country -> customer.address.country
• city -> customer.address.city
• street -> customer.address.street
• reference_id -> customer.reference_id
• individual_tax_id -> customer.individual_tax_id
• passport -> fallback for customer.passport_series+customer.passport_number, used only when send_recipient_passport is enabled