Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Wallet

Add AutoPayout rule

This POST endpoint is used to add an autopayout rule that will initiate a payout whenever the provided wallet token is loaded. <br> You can use this endpoint to create an autopayout rule that automatically sends a percentage of incoming load to a specific destination. <br> To use this endpoint, you need to provide the user_token and wallet_token as required parameters in the URL Path, and the destination_token and percentage of incoming load that should be autopaid to the destination_token in the request Body. <br> The response will include a JSON object containing the details of the created autopayout rule, including the token, destination_token and percentage.

post/payout/wallet/{user_token}/{wallet_token}/autopayout

Request body

destination_tokenstring required

The destination_token to autopay (send payout to)

percentagenumber float required

The percent of incoming load that should be autopaid to the destination_token

attr_set_tokenstring

The token that represents a set of attributes for a specific payer. Optional, specify the value if you''re trying to update a value of a specific attributes set.

Example request

{
  "destination_token": "dest_d2138fd0-00be-45a8-985f-4f5bde500962",
  "percentage": 50
}

Response

Succesfully created.

tokenstring required

Autopayout token

destination_tokenstring required

The destination_token to autopayout (send payout to)

percentagenumber float required

The percent of incoming load that should be autopaid to the destination_token

attr_set_tokenstring

The token that represents a set of attributes for a specific payer. Optional, specify the value if you''re trying to update a value of a specific attributes set.

Example response

{
  "token": "autopayout_3684cc43-fe3b-4994-8ca1-7dc0db94430f",
  "destination_token": "dest_d2138fd0-00be-45a8-985f-4f5bde500962",
  "percentage": 50
}