Care MCP

POST /api/org/deposits

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

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

Example request

curl -X POST https://caremcp.com/api/org/deposits \
  -H "Authorization: Bearer <session or access token>" \
  -H "Content-Type: application/json" \
  -d '{"amountCents":100000}'

Example input

{
  "amountCents": 100000
}

Input schema

{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "properties": {
  "amountCents": {
   "type": "integer",
   "minimum": 10000,
   "maximum": 10000000,
   "description": "Cents in the organisation's currency, net of tax; 100 to 100 000 dollars or euro."
  },
  "returnUrl": {
   "type": "string",
   "format": "uri"
  }
 },
 "required": [
  "amountCents"
 ]
}

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
  }
 }
}