How do you get paid playing video games?

If I understand the question correctly, then usually yes.

A game company might have a contest in which the prize is appearing in their next video game, in which case the "payment" for appearing in the game would be appearing in the game.

However, celebrities who allow Video Games to use their name and likeness, and voice actors who provide the voices for the characters, would normally be paid.