API Reference

Deposit of credits

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/credits/actions/deposit-credits

Creates a new credit record with the corresponding value.

A deposit adds a positive credit record to the customer account, increasing the wallet balance. The response returns the ID of the newly created credit record.

If credit_type_id is not provided, the project-default credit type is assigned. If currency_id is not provided, the project-default currency is used. The note field is optional and is recorded in the credit history audit log, visible via GET /credit-history.

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

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

The number of deposit credits.

string
required

The unique ID of the customer. GET /customers

string
required

The unique ID of the partner. GET /partners

string

The unique ID of the credit type. If the parameter is not set, a default credit type is set. 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 new credit deposit.

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

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

Responses

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