Skip to main content
Skip table of contents

Create a One Time Payout via API

Examples of creating One Time Payouts:

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.

CODE
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

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

One Time Payout that is 80% of available balance

CODE
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

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

Payout Schedules

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.