Skip to content
/
Update payout method

Update payout method

Request

Create or update the user's preferred payout method. The request must always include receiver_wallet. For PAYPAL and VENMO the client must also supply receiver (an email or phone respectively). For BILL_CREDITS the receiver must not be supplied — it is derived server-side from the user's linked billing account.

Security
oauth2(Required scopes: payout_method:write)
Path
user_idstring^(user[A-Z\d]{26})$required

The ID of the specific user to retrieve.

Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
Bodyapplication/jsonrequired
receiverstring or null, <= 254 characters

Email when receiver_wallet is PAYPAL, phone when VENMO. Must not be supplied when receiver_wallet is BILL_CREDITS.

Example:"alice@example.com"
receiver_walletstringrequired
Enum:"PAYPAL""VENMO""BILL_CREDITS"
curl -i -X PATCH \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/users/{user_id}/payout_method' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'EvEnergy-Version: 2' \
  -d '{
    "receiver": "alice@example.com",
    "receiver_wallet": "PAYPAL"
  }'

Responses

Payout method updated successfully.

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
Bodyapplication/json
urlstring, (uri)read-onlyrequired
Example:"https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735/payout_method"
receiverstring or nullrequired

The destination identifier for the payout (email for PAYPAL, phone for VENMO, billing account number for BILL_CREDITS). Null when no payout method has been set up.

Example:"alice@example.com"
receiver_typestring or nullread-onlyrequired

The semantic type of the receiver field. Server-derived.

Enum:"EMAIL""PHONE""ACCOUNT_NUMBER"null
receiver_walletstring or nullrequired

Which payout wallet the user has selected. Null when none is set.

Enum:"PAYPAL""VENMO""BILL_CREDITS"null
Response
{
  "url": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735/payout_method",
  "receiver": "alice@example.com",
  "receiver_type": "EMAIL",
  "receiver_wallet": "PAYPAL"
}