Care MCP

POST /api/client/deposits

Starts a deposit with the payment provider and answers the page to pay on, with the tax added for the client's country. The pot is credited the net amount when the provider confirms; the receipt goes by mail.

Surface: client. Who may call: client. Key: client.deposit.start.

Example request

curl -X POST https://caremcp.com/api/client/deposits \
  -H "Authorization: Bearer <session or access token>" \
  -H "Content-Type: application/json" \
  -d '{"amountCents":5000,"returnUrl":"https://agent.example/back"}'

Example input

{
  "amountCents": 5000,
  "returnUrl": "https://agent.example/back"
}

Input schema

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "properties": {
  "amountCents": {
   "type": "integer",
   "minimum": 1000,
   "maximum": 500000,
   "description": "Cents in the client's currency, net of tax; 10 to 5000 dollars or euro."
  },
  "returnUrl": {
   "description": "Where the provider sends the client afterwards.",
   "$ref": "#/$defs/__schema0"
  }
 },
 "required": [
  "amountCents"
 ],
 "$defs": {
  "__schema0": {
   "type": "string",
   "format": "uri"
  }
 }
}

Output schema

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "properties": {
  "url": {
   "type": "string"
  },
  "ref": {
   "type": "string"
  },
  "currency": {
   "type": "string",
   "enum": [
    "USD",
    "EUR"
   ]
  },
  "amountCents": {
   "$ref": "#/$defs/__schema0"
  },
  "taxPercent": {
   "type": "integer",
   "minimum": -9007199254740991,
   "maximum": 9007199254740991
  },
  "taxCents": {
   "$ref": "#/$defs/__schema0"
  },
  "totalCents": {
   "$ref": "#/$defs/__schema0"
  }
 },
 "required": [
  "url",
  "ref",
  "currency",
  "amountCents",
  "taxPercent",
  "taxCents",
  "totalCents"
 ],
 "additionalProperties": false,
 "$defs": {
  "__schema0": {
   "type": "integer",
   "minimum": -9007199254740991,
   "maximum": 9007199254740991
  }
 }
}