Skip to content

Logo

CaresPAY

Welcome To CaresPAY

Supports in this guide: Payments

Provider website: carespay.com


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

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

Choose account type

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

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

CaresPAY does not currently support payouts through Corefy. If you're not sure which one to use, confirm with your Corefy account manager.


Prerequisites: get from CaresPAY

Submit a connection request at carespay.com or contact your CaresPAY account manager directly, and submit the required documents to get your account verified.

  • Merchant ID -> Corefy field merchant_number
  • Secret Key -> Corefy field md5key

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

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Merchant ID -> merchant_number
  • Secret Key -> md5key
  • 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 CaresPAY 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": "2087a982-06e3-404f-b0f3-ce3da5c22948",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10
    }
  }
}

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "d99e9a31-bfac-4fbd-a2e9-99dec201e4c7",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "b4e3f8fe-9f3b-4c81-af76-5ec9e70f5fce",
        "name": "Roman Savchak",
        "email": "name@example.com",
        "phone": "380951234567",
        "address": {
          "full_address": "Savchakova st 18",
          "country": "AR",
          "region": "Buenos Aires",
          "city": "Buenos Aires",
          "street": "Savchakova",
          "post_code": "123456"
        }
      }
    }
  }
}

Note

customer is entirely optional - everything you don't send falls back to the Constants below. There is no hardcoded fallback value on CaresPAY's side: if a field is missing from both the request and the Constants, CaresPAY itself will reject the request as missing a required parameter.


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

  • ignore_callback -> optional, boolean - for cascading to work correctly, excludes finalizing the payment from the asynchronous callback; Corefy then relies only on an active status request (reconciliation) to finalize it.

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)

  • FIRST_NAME -> customer.first_name
  • LAST_NAME -> customer.last_name
  • COUNTRY -> customer.address.country
  • STATE -> customer.address.region
  • CITY -> customer.address.city
  • ADDRESS -> customer.address.full_address
  • POST_CODE -> customer.address.post_code
  • EMAIL -> customer.email
  • PHONE -> customer.phone

Refunds

This connector does not support refunds.


Additional info

  1. Only EUR is currently configured - CaresPAY is set up for the EUR currency only; confirm with your Corefy account manager if you need another currency enabled.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify your Merchant ID / Secret Key for the selected environment
  • Currency or service is not supported -> confirm allowed currencies/features in your CaresPAY account and in Corefy
  • Missing required fields -> provide missing request fields or configure Constants above
  • Not sure which account type to use? -> ask your Corefy account manager

Question

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