Payouts

Learn how to make scheduled and one-off payouts to sub-merchants.


After an account holder starts receiving funds to their account, these funds can be paid out according to the current payout tier of the account holder. For more information on possible tiers and Know Your Customer (KYC) checks required for payouts, refer to Verification checks.

Scheduled payouts

By default, your marketplace account is configured to send payouts daily to all account holders eligible. If necessary, you can ask Support Team to change the default schedule for your marketplace.

In addition, you can manually set a new payout schedule for a particular account holder. To do this, make an /updateAccount call and pass a new schedule in the payoutSchedule parameter.

Request

{
    "accountCode": "198360329",
    "payoutSchedule": {
        "schedule": "WEEKLY",
        "action": "CLOSE"
    }
}

Response

{
   "pspReference": "9914860311410009",
   "submittedAsync": "false",
   "accountCode": "198360329",
   "payoutSchedule": {
      "nextScheduledPayout": "2017-02-06T11:32:26+01:00",
      "schedule": "WEEKLY"
   }
}

One-off payouts

To enable one-off payouts, first disable scheduled payouts for your marketplace. For this, contact the Support Team.

Then you can manually trigger payouts by making the /payoutAccountHolder request.

Request

{
   "accountCode":"118731451",
   "amount":{
      "currency":"EUR",
      "value":99792
   },
   "accountHolderCode":"TestAccountHolder877209",
   "description":"12345 – Test",
   "bankAccountUUID":"000b81aa-ae7e-4492-aa7e-72b2129dce0c"
}

Response

{
   "pspReference":"9914719437810080",
   "bankAccountUUID":"000b81aa-ae7e-4492-aa7e-72b2129dce0c"
}

Response in case of an error

{
   "status":422,
   "errorCode":"10_066",
   "message":"There is not enough balance available for account 104327556. Available balance: EUR 0.00; Payout amount: EUR 50.00",
   "errorType":"validation"
}

For detailed information on possible error codes, refer to General error codes.

Refund last transactions

With the /refundNotPaidOutTransfers call, you can schedule a refund for all of the transactions that have occurred since the last payout and have not been paid out yet.

Request

{
   "accountHolderCode":"TestAccountHolder502924",
   "accountCode":"189184578"
}

Response

{
   "pspReference":"9914764308750114",
   "resultCode":"Success"
}

Additionally, a SCHEDULED_REFUNDS notification is sent out. This indicates the transactions that have been scheduled for a refund.

See also