Cardiful New

Welcome to Cardiful New

Set up Account

Step 1: Create merchant account

To create an account, contact your Cardiful New manager and submit the required documents to verify your account and gain access.

Step 2: Get required credentials

Credentials that have to be issued:

• cardifulnew__api_key → API key
• cardifulnew__signing_key → Signing key
• cardifulnew__test_mode → Test Mode
• cardifulnew__currency → Currency

If your Cardiful New setup uses a dedicated endpoint, you can also specify cardifulnew__api_url.

Connect H2H Merchant Account

Step 1. Connect H2H account at the Corefy Dashboard

Press Connect at Cardiful New Provider Overview page in 'New connection' section and choose H2H Merchant account option to open Connection form.

Enter credentials:

• API key → API key
• Signing key → Signing key
• Test Mode → True/False
• Currency → choose currency (Set this parameter according to available currencies for your Cardiful New account and agreed service configuration.)

If your provider shared a custom API endpoint, fill in cardifulnew__api_url as well.

API examples:

Minimum data set to create a transaction

SALE

POST /api/payment-invoices HTTP/1.1

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 5,
      "customer": {
        "reference_id": "85af8385-d00e-4f58-ab1f-3a527fdf2d3b"
      },
      "test_mode": false
    }
  }
}

Maximum data set to create a transaction

SALE

POST /api/payment-invoices HTTP/1.1

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "1f2aa3ca-abd8-4741-980d-4017ed30cb8c",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 5,
      "customer": {
        "reference_id": "85af8385-d00e-4f58-ab1f-3a527fdf2d3b",
        "name": "John Doe",
        "email": "johndoe@email.com",
        "phone": "+2134234234523",
        "address": {
          "full_address": "123 Baker street",
          "country": "US",
          "state": "CA",
          "city": "Los Angeles",
          "post_code": "12345"
        }
      },
      "test_mode": false
    }
  }
}

Additional information

Constants

If some parameters are not sent in the transaction creation request, they will take the values from the set constants.

Here is a list of constants with their corresponding parameters:

• FIRST_NAME → customer [first_name]
• LAST_NAME → customer [last_name]
• EMAIL → customer [email]
• PHONE → customer [phone]
• DATE_OF_BIRTH → customer [date_of_birth]
• CITIZENSHIP_COUNTRY_CODE → customer [address] [country]
• FULL_ADDRESS → customer [address] [fullAddress]
• CITY → customer [address] [city]
• COUNTRY_CODE → customer [address] [country]
• POSTAL_CODE → customer[address][post_code]
• STATE → customer [address] [region]
• ROUTING_GROUP → is passed in the request to create transaction in body['customer']['routingGroup'] parameter
• PAYMENT_METHOD → is passed in the request to create transaction in body['paymentMethod'] parameter

Provider Options

• finalize_by_protocol
  • The provider does not guarantee the finality of the fail status because in their system it can later change to success. If the merchant does not agree with this logic, enable this option.
  • Then Corefy will stop failing payments by callback flow and the merchant will not receive transaction status discrepancies caused by late provider updates.
• ignore_callback
  • For cascading to work correctly, exclude the possibility of finalizing payments using asynchronous callbacks. Ignore the callback and rely only on the status request for finalization (reconciliation).
• save_provider_instant_token
  • Enable this option if you plan to use the account for instant payments.
• send_additional_data
  • Includes additional customer-related data in the request sent to Cardiful New when this is required by the provider configuration.

Please contact our support team!