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.

نظرة سريعة

المصادقة: رمز موظّف أو جلسة
تتطلب صلاحية: prm_users_deposit Deposit to user wallet
حد المعدل: t_mutate
مفتاح عدم التكرار: request_id

المعاملات

المعامل	الوصف
`id`مطلوب path · integer	Subscriber id.
`amount`مطلوب body · number	Major units, a bare JSON number. 150.50, not "150.50" and not 15050.
`request_id`مطلوب body · string	Idempotency key.
`issue_invoice` body · boolean	Also record an invoice document. Skipped on a replay.

الأخطاء

الرمز	متى تُرجَع
`ERR_VALIDATION`400	request_id missing, too long or reserved
`ERR_CONFLICT`409	the request_id is already held by a different ledger line

الطلب

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

الاستجابة 200 OK

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

‏BASE هو عنوان مؤسستك: نفس العنوان الذي تسجّل الدخول منه.

جرّبه على شبكتك.

50 مشترك لمدة 7 أيام، من غير ما تدفع حاجة.

جرّب ببلاش كلّمنا