Skip to content
API Reference
/
/
Trigger a mock settlement

Trigger a mock settlement

Request

This API is only available in sandbox mode. Queues a settlement run for your account so you can exercise settlements without a wait for the daily settlement schedule.

Security
JWT
POST
/settlements/mock-trigger
curl -i -X POST \
  https://api.glomopay.com/api/v1/settlements/mock-trigger \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Settlement run accepted

Bodyapplication/json
statusstring

Confirms that the settlement run was queued.

Value:"accepted"
withdrawal_account_idstring

The settlement account that the run pays into.

Example:"accwith_E602dMzgjpDC"
Response
{
  "status": "accepted",
  "withdrawal_account_id": "accwith_E602dMzgjpDC"
}