Overpay

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• Shop ID
• Public key
• Secret key
• Test Mode -> (enable if you are using sandbox credentials)
• 3DS Mode -> Simple or Advanced
• Provider URL -> fixed value, pre-filled
• Currency / Features -> choose values available 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. CVV is always required, unless the currency is UZS, where it is optional.

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "50eb03f2-de01-474f-907a-53bbb2a30af3",
      "service": "payment_card_kzt_hpp",
      "currency": "KZT",
      "amount": 600
    }
  }
}

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "50eb03f2-de01-474f-907a-53bbb2a30af3",
      "service": "payment_card_kzt_hpp",
      "currency": "KZT",
      "amount": 600,
      "customer": {
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567",
        "name": "John Smith",
        "address": {
          "country": "KZ",
          "region": "Almaty",
          "city": "Almaty",
          "post_code": "050000",
          "full_address": "1st Street 1"
        }
      }
    }
  }
}

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, ignores Overpay's asynchronous callback and relies only on an active status request to finalize the payment.
• send_customer_data -> optional, boolean - when enabled, sends the customer's billing address (name, phone, country, city, state, zip, address) to Overpay; when disabled (default), only customer.email and the IP address are sent.

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 -> a built-in code default is sent (see the note above) rather than the field being omitted

Currently available constants (constant -> Corefy API field)

• EMAIL -> customer.email
• DESCRIPTION -> transaction description
• LANG -> transaction language
• REASON -> refund reason
• COUNTRY -> customer.address.country
• CITY -> customer.address.city
• STATE -> customer.address.region
• ZIP -> customer.address.post_code
• ADDRESS -> customer.address.full_address

Refunds

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