Cirxus Pay

Supports in this guide: Payments

Provider website: cirxus-pay.com

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

1. Choose account type
2. Get your credentials (from Cirxus Pay)
3. Connect in Dashboard
4. Send an API request

Choose account type

Cirxus Pay can be connected in different ways (depending on your needs):

• If you do H2H card payments (card data sent directly) -> choose H2H Merchant account

If you're not sure which one to use, confirm with your Corefy account manager.

Prerequisites: get from Cirxus Pay

Submit a connection request via cirxus-pay.com or contact your Cirxus Pay account manager directly to get your account verified and receive the following credentials:

• API Key -> Corefy field api_key -> your Cirxus Pay API key, used to authenticate every request -> where to find: Cirxus Pay backoffice / issued by Cirxus Pay manager
• API Type -> Corefy field api_type -> choose Server-to-Server or Direct Post - see Additional info for what each one means for your PCI scope -> where to find: Cirxus Pay backoffice / issued by Cirxus Pay manager
• S2S Token (required only if API Type is Server-to-Server) -> Corefy field s2s_token -> authenticates the card-data submission step when using Server-to-Server -> where to find: Cirxus Pay backoffice / issued by Cirxus Pay manager
• Brand ID -> Corefy field brand_id -> identifies your brand/storefront on Cirxus Pay's side -> where to find: Cirxus Pay backoffice / issued by Cirxus Pay manager
• Webhook Public Key (optional) -> Corefy field webhook_public_key -> used to verify the signature on incoming callback notifications; if left blank, Corefy automatically requests/creates one from Cirxus Pay the first time the connection is tested -> where to find: Cirxus Pay backoffice / issued by Cirxus Pay manager
• Strict customer data validation (optional) -> Corefy field strict_customer_data_validation -> select which customer fields (Phone, Name, Street, Country, Individual Tax ID, City, Postcode, Region) Corefy should require locally before sending a request to Cirxus Pay -> where to find: Cirxus Pay backoffice / issued by Cirxus Pay manager

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "e2e594d7-eff2-41e9-9273-610670646111",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10,
      "customer": {
        "reference_id": "6164d44c-10de-48cd-91a4-735fc7c64f58",
        "email": "johnsmith@gmail.com"
      }
    }
  }
}

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "287e6567-3625-43f3-aac4-ff3002c6742d",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567",
        "individual_tax_id": "82189212198",
        "address": {
          "country": "US",
          "city": "New York",
          "region": "NY",
          "full_address": "1 Main street",
          "post_code": "10001"
        }
      }
    }
  }
}

Additional info

1. API Type. Server-to-Server means Corefy submits card data to Cirxus Pay on your behalf via API (requires the S2S Token). Direct Post means the customer's browser posts card data directly to Cirxus Pay, bypassing Corefy's servers - ask your account manager which one fits your PCI scope.

2. Callback routing. Callbacks use a dedicated endpoint, /cirxuspay/callback. Provide the Webhook Public Key (or leave it blank to have Corefy request/create one automatically on the first connection test) so Corefy can verify the signature on incoming callbacks.

3. No hardcoded fallback values. If a customer field is missing from both the request and from Constants, Corefy simply omits it from the request to Cirxus Pay - it never substitutes a placeholder email, address, or phone number on your behalf. The one exception is customer.email, which cannot be omitted at all (see above).

4. Refunds. Partial refunds are supported, but only one refund can be issued per transaction - a second refund attempt on the same transaction is not supported.

FAQ / Troubleshooting

• Invalid credentials / auth error -> verify you used the correct API Key / S2S Token for your account
• Currency not supported -> Cirxus Pay currently supports USD only; confirm this matches your needs
• Missing customer data fields -> set Constants (see "Constants") or provide the fields directly in the API request; customer.email must always be sent, Constants cannot cover it
• "Customer email is required" error -> customer.email is mandatory on every request to Cirxus Pay and has no fallback
• Not sure which account type to use? -> ask your Corefy account manager