Credit a subscriber wallet

POST /api/v1/users/{id}/deposit prm_users_deposit

Moves money into the subscriber's wallet and writes the matching ledger line. Idempotent on request_id through a unique constraint on the ledger itself, so the charge and the record of it cannot disagree.

replay true means this exact request already happened and nothing moved this time. It is a success, and the balance shown is the one from the original operation.

At a glance

Authentication: Staff token or session
Requires permission: prm_users_deposit Deposit to user wallet
Rate limit: t_mutate
Idempotency key: request_id

Parameters

Parameter	Description
`id`required path · integer	Subscriber id.
`amount`required body · number	Major units, a bare JSON number. 150.50, not "150.50" and not 15050.
`request_id`required body · string	Idempotency key.
`issue_invoice` body · boolean	Also record an invoice document. Skipped on a replay.

Errors

Code	When it is returned
`ERR_VALIDATION`400	request_id missing, too long or reserved
`ERR_CONFLICT`409	the request_id is already held by a different ledger line

Request

curl -X POST "$BASE/api/v1/users/{id}/deposit" \
  -H "Authorization: Bearer $XR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 250.00,
  "request_id": "b41cf0a2-33de-4b57-8a7a-9e3c5d1f0c77"
}'

Response 200 OK

{
  "data": {
    "journal_id": 90412,
    "balance": 250.00,
    "debt": 0.00,
    "replay": false
  }
}

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us