API explorer
HomeFAQSupportSDK

Payout the balance of a user

post
https://demo-smartcharging.jedlix.com/api/v2/users//payouts

This endpoint allows users to request a payout of their accumulated reward balance. After a successful payout, the balance is reset to zero.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

A string value formatted as a Globally Unique Identifier (GUID) that identifies the user whose balance should be paid out.

Body Params

A model that contain bank account details and payout type

string | null

A string representing the bank account of the user in IBAN format.

string | null

A string representing the name of the bank account holder.

string | null
enum

Indicates whether Jedlix or the external partner will handle the payout. When selecting NoPayment, Jedlix will only reset the reward balance to 0 and set the payout status to successfull. If you select PaidByJedlix, Jedlix will trigger a SEPA bank transfers which are performed in batches on a daily basis to the bank details provided and update the payout status accordingly. A minimum balance can be set for these transfers.

Allowed:
Headers
string

Name of the client (or system) calling the api, this is helpful for tracing requests. This is optional.

string

Version of the client (or system) calling the api, this is helpful for tracing requests. This is optional.

Responses

401

Unauthorized

403

Forbidden

504

Internal api timeout

Updated 7 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago