PayMaxis

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

• API Key
• Signing Key
• Test mode -> toggle on for sandbox, off for production
• API URL (optional) -> override the default PayMaxis endpoint only if instructed by your PayMaxis/Corefy account manager

Additionally, choose Currency and Features according to what is enabled for your PayMaxis account.

Payment - MIN

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "dad88b67-e331-4986-a2db-85f69033f105",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10,
      "customer": {
        "reference_id": "88d2d919-08f9-4cd4-8fae-4c0c63534a2b",
        "email": "test@example.com",
        "address": {
          "country": "US"
        }
      }
    }
  }
}

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "b877ced8-da9a-4dc0-aa64-15951828c4d0",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 123.45,
      "test_mode": false,
      "customer": {
        "reference_id": "60e865e1-9aa8-4074-ae21-f603fba6c2ee",
        "name": "Test Test",
        "email": "test@example.com",
        "phone": "380987452365",
        "date_of_birth": "1990-12-04",
        "address": {
          "full_address": "7 Sunny street",
          "country": "US",
          "region": "NY",
          "city": "New York",
          "post_code": "10001"
        }
      }
    }
  }
}

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

Options

Options are configured on the Corefy side and affect how Corefy builds PayMaxis requests or processes responses.

Currently available options (4):

• finalize_by_protocol - changes how Corefy treats a fail status that PayMaxis does not guarantee is final.
• save_provider_instant_token - enables saving a token for Recurring / one-click charges.
• send_additional_data - sends free-form additional parameters from your request metadata to PayMaxis.
• ignore_callback - skips signature verification on incoming PayMaxis callbacks.

Constants (fallback fields)

Constants are static values that Corefy can send to PayMaxis instead of dynamic data from your API request, when those fields are missing in the request.

So, if a field is missing in the API request, Corefy can take the value from the configured Constants.

After the successful connection, fill in constants for the necessary route in the editing menu.

Priority (predictable rule):

1. If a value is present in the request -> Corefy uses the request value
2. Else if the constant is set and the value isn't present in the request -> Corefy uses the constant
3. Else -> PayMaxis may reject the request or apply its own defaults

Currently available constants (constant -> Corefy API field)

• FIRST_NAME -> customer.name (first part)
• LAST_NAME -> customer.name (last part)
• EMAIL -> customer.email
• PHONE -> customer.phone
• DATE_OF_BIRTH -> customer.date_of_birth
• CITIZENSHIP_COUNTRY_CODE -> customer.address.country
• FULL_ADDRESS -> customer.address.full_address
• CITY -> customer.address.city
• COUNTRY_CODE -> customer.address.country
• POSTAL_CODE -> customer.address.post_code
• STATE -> customer.address.region

Refunds

• Partial and multiple refunds are supported.
• Every refund requires the original PayMaxis transaction id, which Corefy supplies automatically from the original payment.
• No card data is required to process a refund.

Recurring

• Supported via the save_provider_instant_token option (see Options above): enable it on the initial transaction so PayMaxis returns a reusable token, which Corefy can then use to charge follow-up transactions without new card data.

Reconciliation

• PayMaxis supports active reconciliation (status pull) in addition to callback processing, including reconciling refunds by their own original id.

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields

• API Key
• Signing Key
• Test mode -> toggle on for sandbox, off for production

Payout - MIN

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "306e6a37-f33c-4f8f-8da1-ebe5e1dac53c",
      "service": "payment_card_usd",
      "currency": "USD",
      "amount": 10,
      "fields": {
        "card_number": "400000******0002"
      },
      "context": {
        "card": {
          "card_holder": "John Smith",
          "exp_month": "01",
          "exp_year": "30"
        }
      }
    }
  }
}

Payout - MAX

POST /api/payout-invoices

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "6813c1ec-faa1-47d7-848d-d9b445d7be98",
      "service": "payment_card_usd",
      "currency": "USD",
      "amount": 213,
      "test_mode": true,
      "customer": {
        "reference_id": "5f90a4f1-6f4d-4979-b31d-e6858d497f22",
        "name": "John Smith",
        "email": "john.smith@example.com",
        "phone": "357111111111",
        "date_of_birth": "1990-12-03",
        "address": {
          "full_address": "7 Sunny street",
          "city": "Limassol",
          "country": "CY",
          "post_code": "4141",
          "region": "CA"
        }
      },
      "fields": {
        "card_number": "400000******0002"
      },
      "context": {
        "card": {
          "card_holder": "John Smith",
          "exp_month": "01",
          "exp_year": "30"
        }
      }
    }
  }
}

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

Options

Currently available options (1):

• finalize_by_protocol - changes how Corefy treats a fail status that PayMaxis does not guarantee is final (same behavior as the Payments option above, applied to payouts).

Constants (fallback fields)

Same mechanism as for Payments: if a field is missing from your payout request, Corefy can fall back to a configured constant.

Currently available constants (constant -> Corefy API field)

• FIRST_NAME -> customer.name (first part)
• LAST_NAME -> customer.name (last part)
• EMAIL -> customer.email
• PHONE -> customer.phone
• DATE_OF_BIRTH -> customer.date_of_birth
• CITIZENSHIP_COUNTRY_CODE -> customer.address.country
• FULL_ADDRESS -> customer.address.full_address
• CITY -> customer.address.city
• COUNTRY_CODE -> customer.address.country
• POSTAL_CODE -> customer.address.post_code
• STATE -> customer.address.region

Reconciliation

• PayMaxis supports both active reconciliation (status pull) and callback processing for payouts.