Skip to content

Logo

YeloPay

Easy payments for merchants, supporting worldwide currencies and different processing types. Open your account in a flash

Supports in this guide: Payments

Provider website: yelopay.io


What you need to do for start processing transactions (brief summary)

  1. Get your credentials (from YeloPay)
  2. Connect in Dashboard
  3. Send an API request

Prerequisites: get from YeloPay

Contact your YeloPay account manager to get your account verified and receive the following credentials.

  • Client key -> Corefy field client_key.
  • Client pass -> Corefy field client_pass.
  • API URL (optional) -> Corefy field api_url -> leave as default unless your account manager tells you otherwise.

EUR, USD, GBP.


Payments processing (connect H2H Merchant account, create payment-invoice)

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Client key
  • Client pass
  • API URL (optional)
  • Currency / Features -> choose values available for your account (EUR, USD, GBP)

Success

You have connected YeloPay H2H Merchant 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. YeloPay may return a 3D Secure challenge redirect depending on the card.

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "bc99aca6-6438-4676-b5be-51865e993b07",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 100
    }
  }
}

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "d0e1022c-721c-4b8f-a89d-9e2f6d0dbda7",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 100,
      "customer": {
        "reference_id": "38967ac7-81f7-43ca-afeb-ea56290a3211",
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+32434324324",
        "date_of_birth": "2008-02-06",
        "address": {
          "full_address": "London street",
          "country": "GB",
          "region": "London",
          "city": "London",
          "post_code": "54567"
        }
      }
    }
  }
}

Important

  • customer.name is split into first/last/middle name parts and transliterated to Latin before being sent to YeloPay.
  • If a field under customer is missing, Corefy falls back to the matching Constant (below); if neither is set, that field is simply 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


Options

  • auth -> optional, boolean - sends the payment to YeloPay as an authorization only (no automatic capture) instead of a sale.
  • ignore_callback -> optional, boolean - ignores YeloPay's asynchronous callback and relies only on an active status request to finalize the payment.
  • allow_ipv6 -> optional, boolean - allows sending the customer's real IPv6 address to YeloPay; when disabled (default) and the customer's IP is IPv6, the ip Constant (or a default placeholder) is sent instead.

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)

  • PAYER_FIRST_NAME -> customer.name (first part)
  • PAYER_LAST_NAME -> customer.name (second part)
  • PAYER_MIDDLE_NAME -> customer.name (third part)
  • PAYER_EMAIL -> customer.email
  • PAYER_PHONE -> customer.phone
  • PAYER_BIRTH_DATE -> customer.date_of_birth
  • PAYER_ADDRESS -> customer.address.full_address
  • PAYER_COUNTRY -> customer.address.country
  • PAYER_STATE -> customer.address.region
  • PAYER_CITY -> customer.address.city
  • PAYER_ZIP -> customer.address.post_code
  • IP -> client IP address (used only when the customer's real IP is IPv6 and allow_ipv6 is not enabled)
  • TERM_URL_TARGET -> target window for the 3D Secure redirect (default _self)

Refunds

YeloPay supports refunds for the full amount only (no partial or multiple refunds).

Recurring

YeloPay supports saving and charging a card token through Corefy (standard tokenize/token-charge flow).


Additional info

  1. Active reconciliation is available - an active status request can finalize the payment in addition to the asynchronous callback, unless ignore_callback is enabled (in which case only the callback is used).

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify client_key/client_pass and the api_url setting
  • Currency or service is not supported -> confirm allowed currencies/features in your YeloPay account and in Corefy - only EUR, USD, GBP are available
  • Refund fails with multiple attempts -> only one, full-amount refund per payment is allowed
  • Unexpected IP sent to YeloPay -> if the customer's IP is IPv6, enable allow_ipv6 or set the IP Constant, otherwise a fallback IP is sent

Question

Still looking for help connecting your YeloPay account? Please contact our support team!