Balances correction API

The balance correction resource allows you to modify account balance by applying **correction**. Correction may be negative or positive

update values

PUT /api/rest/admin/accounts/:id/balance-correction

Parameters

Name	Description
data[type]	Resource type (balance-correction)
data[id]	Account ID
data[attributes][correction]	Correction

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQ2LCJhdWQiOlsiYWRtaW4iXSwiZXhwIjoxNzc2MzY1NzMzfQ.LzT3V_dw1-pUC9OcklyUip8Q-RvMNddvNiEGPQtOxaw
Host: example.org
Cookie:

Route

PUT /api/rest/admin/accounts/28/balance-correction

Body

{"data":{"type":"balance-correction","id":28,"attributes":{"correction":"21"}}}

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
vary: Accept
etag: W/"df88cddafd5a2b6c050c8ce456906f0d"
cache-control: max-age=0, private, must-revalidate
x-request-id: 4d8a00c1-3bd9-4038-bd4c-8bc3f4c65751
x-runtime: 0.015234
content-length: 171

Status

200 OK

Body

{
  "data": {
    "id": "28",
    "type": "balance-correction",
    "links": {
      "self": "http://example.org/api/rest/admin/balance-correction"
    },
    "attributes": {
      "name": "account8",
      "balance": "121.0"
    }
  }
}