Skip to content

Logo

CircoFlows

Payments that power your business

Supports in this guide: Payments

Provider website: gateway.circoflows.com


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

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

Prerequisites: get from CircoFlows

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

  • API Key -> Corefy field api_key -> used as a bearer token to authenticate every request.
  • Webhook Secret -> Corefy field webhook_secret -> used to verify callback notifications from CircoFlows.

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

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • API Key
  • Webhook Secret
  • Test Mode -> (enable if you are using sandbox credentials)

Choose Currency / Features; check with your Corefy account manager which are enabled for your account.

Success

You have connected CircoFlows 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.

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "8e3dbbb0-17af-4c9a-bedb-93bdac6900a2",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10
    }
  }
}

This connector also supports EUR, GBP.

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6795502c-e27d-4d07-85e0-93245aab9a3f",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567",
        "address": {
          "country": "US",
          "region": "NY",
          "city": "New York",
          "full_address": "1 Main street",
          "post_code": "10001"
        }
      }
    }
  }
}

customer is entirely optional - anything you don't send falls back to the Constants below. The card's own embossed holder name is always used for first/last name - customer.name isn't used for this connector.


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
  • address -> customer.address.full_address
  • city -> customer.address.city
  • state -> customer.address.region (2-letter state/region code)
  • postal_code -> customer.address.post_code
  • country -> customer.address.country

Additional info

  1. Callback routing is automatic - Corefy generates the callback/return URLs per transaction, nothing to configure in CircoFlows's own back-office.
  2. No refunds and no payouts - this connector does not support refunds or payouts through Corefy.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify API Key for the selected environment
  • Callback signature fails -> verify the Webhook Secret matches what's configured on your CircoFlows account
  • Refund requested -> not supported by this connector
  • Currency or service is not supported -> confirm allowed currencies/features in your CircoFlows account and in Corefy

Question

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