CaresPay¶

Website: carespay.com

Set up Account¶

Step 1: Create Merchant Account¶

To create an account send connection request at the carespay.com/service.html#cpContack or contact manager directly. Submit the required documents to verify your account and gain access.

Step 2: Get required credentials¶

Credentials that have to be issued:

• carespay_merchant_number → Carespay Merchant Number
• carespay_md5key - Carespay md5key
• currency → choose currency (You can set these parameters according to available currencies and features for your CaresPay wallets and services, but it's necessary to check details of the connection with your Corefy account manager.)

Connect Merchant Account¶

Step 1. Connect H2H account at the Corefy Dashboard¶

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

Enter credentials:

• Carespay Merchant Number
• Carespay md5key

API examples:¶

Minimum data set to create a transaction¶

SALE

POST /api/commerce/payment-invoices HTTP/1.0
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"payment_card_eur_hpp",
      "commerce_account":"Hello_World",
      "currency":"EUR",
      "amount":12.65,
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "test_mode":true,
      "options":{
        "allow_partially":false
      },
      "reference_id":"2087a982-06e3-404f-b0f3-ce3da5c22948",
      "service_fields":[
      ]
    }
  }
}

Request with minimal parameters will work if you fill in the customer data in your commerce account

Maximum data set to create a transaction¶

SALE

POST /api/commerce/payment-invoices HTTP/1.0
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"payment_card_eur_hpp",
      "commerce_account":"Hello_World",
      "currency":"EUR",
      "amount":13.17,
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"b4e3f8fe-9f3b-4c81-af76-5ec9e70f5fce",
        "name":"Roman Savchak",
        "email":"[email protected]",
        "phone":"380951234567",
        "address":{
          "full_address":"Savchakova st 18",
          "country":"AR",
          "region":"Bueno ",
          "city":"Buenos aires",
          "street":"Savchakova",
          "post_code":"123456"
        }
      },
      "test_mode":true,
      "options":{
        "allow_partially":false
      },
      "reference_id":"d99e9a31-bfac-4fbd-a2e9-99dec201e4c7",
      "service_fields":[
      ]
    }
  }
}

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]
• COUNTRY → customer [address] [country]
• STATE → customer [address] [region]
• CITY → customer [address] [city]
• ADDRESS → customer [address] [address]
• POST_CODE → customer[address][post_code]
• EMAIL → customer [email]
• PHONE → customer [phone]

Provider Options¶

• ignore_callback
  • for cascading to work correctly, we exclude the possibility of finalizing payments using asynchronous callbacks, ignore the callback, do not change the status of the transaction on it in any way and rely only on the status request for finalization (Reconciliation)