Paymentz

Supports in this guide: Payments

Provider website: paymentz.co.uk

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

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

Prerequisites: get from Paymentz

To create an account, send a connection request via the Paymentz partner page or contact your Paymentz account manager directly. Submit the required documents to verify your account, then get the following credentials.

• Product name -> Corefy field product_name.
• Merchant private key -> Corefy field merchant_private_key -> used both to authenticate every request to Paymentz and to identify your account; check with your Corefy account manager which currencies and features are enabled for it.

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "e9745af4-4b0b-4adb-ae8e-63cef6e07b2d",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "address": {
          "full_address": "1 Main street"
        }
      }
    }
  }
}

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "e9745af4-4b0b-4adb-ae8e-63cef6e07b2d",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "8ce9c51c-6a72-4f73-aa60-380967ef9645",
        "name": "Test Test",
        "email": "test@test.com",
        "phone": "+15551234567",
        "date_of_birth": "2000-01-01",
        "address": {
          "full_address": "1 Main street",
          "country": "GB",
          "region": "London",
          "city": "London",
          "street": "1 Main street",
          "post_code": "000357"
        }
      }
    }
  }
}

Additional info

1. Hardcoded email fallback - if customer.email is not sent in the request and the EMAIL constant is not set on the Dashboard, Corefy sends the fixed placeholder jonhdoe@example.com to Paymentz instead of a real customer email.
2. Always include a customer.address field - Paymentz's request builder reads customer.address as part of every sale request regardless of what you send; if customer or customer.address is omitted entirely, this can trigger an internal warning. Sending at least one address field (e.g. full_address) avoids this - it's not required by Paymentz itself, but is good practice for every request.
3. Active reconciliation is supported - Corefy can request Paymentz's transaction status directly using the original provider transaction ID, rather than relying only on the asynchronous callback. This is what the ignore_callback option above switches on.
4. No recurring - this connector does not support saving/charging a token through Corefy.
5. Single currency - only EUR is available for this connector.

FAQ / Troubleshooting

• Invalid credentials / auth error -> verify the Product name and Merchant private key, and that Test Mode matches the credential environment
• Sale fails immediately with no attempt reaching Paymentz -> check that a CVV was provided and that the transaction does not require 3-D Secure (not supported by this connector)
• Currency is not supported -> only EUR is available for this connector
• Refund fails -> only one refund is allowed per payment; a second refund attempt against the same payment is rejected
• Customer received an unexpected placeholder email -> customer.email was missing and no EMAIL constant was set; set the constant or always send a real email