Create a One Time Payout via API

Owned by Jason Key (Deactivated)

Last updated: Aug 03, 2023 by Miles Graves

1 min read

Examples of creating One Time Payouts:

1 One Time 100% Payout with Float
2 Release a float on a scheduled Payout
3 One Time Payout that is 80% of available balance
4 One Time Payout of 100%
5 Payout Schedules

One Time 100% Payout with Float

Where a merchant is required to keep a fixed amount in the available balance. In this example a float of $10.00.

POST /payout
{
	"entity": "{{Entity_ID_Merchant4}}",
	"account": "{{Account_ID_Merchant4}}",
	"name": "One-Time Payout",
	"amount": "10000",
	"schedule": "5",
	"float" : "1000",
	"start" : "20201223",
	"um": 1
}

Release a float on a scheduled Payout

PUT /payout/t1_pay_asdsdasdasdasd
{
  "float" : "0"
}

One Time Payout that is 80% of available balance

POST /payout
{
	"entity": "{{Entity_ID_Merchant4}}",
	"account": "{{Account_ID_Merchant4}}",
	"name": "One-Time Payout",
	"amount": "8000",
	"schedule": "5",
	"start" : "20201223",
	"um": 1
}

One Time Payout of 100%

For example at the end of a monthly cycle

Payout Schedules