API Reference

Transfer credits

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/credits/actions/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.

Related: GET /credit-history, GET /customers

⚠️ 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

string
required

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

float
required

Number of the transferred credits.

string
required

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

string

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

string

Note for the credit transfer.

Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses
204

No Content

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago