v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Credits

Transfer credits

Transfers credits from one customer to another.

A credit transfer moves a specified amount from one customer's wallet to another. This is typically used when merging duplicate customer accounts or redistributing loyalty balances. Both the deduction from the original customer and the addition to the new customer are recorded in the credit history.

The credit_type_id parameter is required. If currency_id is not provided, the project-default currency is used. Returns HTTP 204 on success.

⚠️ This action method is disabled by default. Please contact the CareCloud administrator to allow usage of this method. ⚠️ Action methods are available only in the Enterprise interface.

post/credits/actions/transfer-credits

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Request body

original_customer_idstring required

The unique ID of the original credit holder. GET /customers

new_customer_idstring required

The unique ID of the new credit holder. GET /customers

amountnumber float required

Number of the transferred credits.

credit_type_idstring required

The unique ID of the credit type for the transferred credits. GET /credit-types

currency_idstring

The unique ID of the currency. If not set, the default currency of the project is used. GET /currencies

notestring

Note for the credit transfer.

Example request

{
  "original_customer_id": "8ea2591121e636086a4a9c0992",
  "new_customer_id": "84b9167cc2f01ff007d98e1633",
  "amount": 100,
  "credit_type_id": "8adcb83164fa7e12668035d43e",
  "currency_id": "8bed991c68a470e7aaeffbf048",
  "note": "Merging customer account"
}

Response

No Content