Xsolla-logo

Request to change customer account balance

post/api/v1/merchants/customer/balance

Requests data from a merchant system to change customer account balance.

SecurityBasicAuth
Request
Request Body schema: application/json

Request body

amount
required
number >= 0.01

Amount to be changed in a customer account balance. The amount is transferred in the currency of a merchant account.

email
required
string <email> <= 255 characters

Customer email whose balance is changing.

id
required
string <= 255 characters

Transaction ID in the merchant system.

details
string <= 255 characters

Description of the reason for changing customer balance. For transactions with positive amounts, this description will be used when sending a receipt to a customer via email.

Responses
204
400

Bad request.

401

Merchant is unauthorized.

422

Request to change customer balance with specified ID already exists.

500

Internal error.

Request samples
application/json
{
  • "amount": 0.01,
  • "details": "string",
  • "email": "user@example.com",
  • "id": "string"
}
Response samples
application/json
{
  • "invalidParams": [
    ]
}