Skip to content

Logo

Klyme

Real-time Payments with Klyme: Your Payments Taking Center Stage.

Supports in this guide: Payments

Provider website: klyme.io

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

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

Prerequisites: get from Klyme

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

  • Merchant UUID -> Corefy field merchant_uuid.
  • API key -> Corefy field api_key.
  • Secret key -> Corefy field secret_key.
  • Webhook secret -> Corefy field webhook_secret.

EUR, USD, GBP.

Payments processing (connect Provider account, create payment-invoice)

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Merchant UUID
  • API key
  • Secret key
  • Webhook secret
  • Currency / Features -> choose values available for your account (EUR, USD, GBP)
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected Klyme Provider account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice and redirects the customer to Klyme's hosted consent flow (an open banking payment).

Payment - MIN

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6be05631-8710-4b14-a369-1928a2b70eda",
      "service": "klyme_gbp_hpp",
      "currency": "GBP",
      "amount": 10
    }
  }
}

Payment - MAX

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "199be985-c243-478a-86a8-4b8c902e5bb6",
      "service": "klyme_gbp_hpp",
      "currency": "GBP",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Doe",
        "email": "name@example.com",
        "phone": "+380680786663",
        "address": {
          "full_address": "Main street 1",
          "country": "GB",
          "city": "London",
          "post_code": "W1J 5AX"
        }
      }
    }
  }
}

Important

No customer field is required - if a field is missing, it's simply not sent, unless the corresponding Constant below is set.

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)

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)

  • EMAIL -> customer.email
  • PHONE -> customer.phone
  • FIRST_NAME -> customer.name (first name)
  • LAST_NAME -> customer.name (last name)
  • COUNTRY -> customer.address.country
  • CITY -> customer.address.city
  • ADDRESS -> customer.address.full_address
  • POST_CODE -> customer.address.post_code

Refunds

Klyme does not support refunds.

Additional info

  1. No active reconciliation after a redirect - Corefy always completes the payment itself. After the customer finishes Klyme's hosted consent flow, Klyme redirects back to Corefy, which then calls Klyme's own completion endpoint to resolve the final status. Corefy can also poll Klyme's status endpoint directly for reconciliation.
  2. Webhook secret is technically optional, but required for callbacks to work. If webhook_secret is left empty, Klyme's asynchronous callbacks can never be decrypted and are always rejected - finalization then depends entirely on the redirect-return step above.
  3. No recurring - this connector does not support saving/charging a token through Corefy.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify the API key and Secret key
  • Callbacks always fail / payment stuck pending -> make sure webhook_secret is set; without it, Klyme's callbacks can't be decrypted
  • Currency or service is not supported -> confirm allowed currencies/features in your Klyme account and in Corefy - only EUR, USD, and GBP are available
  • Refund fails -> Klyme does not support refunds through Corefy

Question

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