Remit premium
API Refs
- Staging: Remit premium
This endpoint moves the premium portion of a paid invoice from your trust account to your operational account.
URI Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| invoiceId | number | The ID of the invoice to remit premium for | yes |
Request
This endpoint takes no request body. The premium amount is taken from the invoice identified by invoiceId.
POST /api/public/invoices/{invoiceId}/remit-premiumResponse
A successful request returns a 201 Created status code with no response body.
RequirementsThe invoice must belong to your account and must be in the
payout_paidstatus. Requests for an invoice that has not been paid out, or that belongs to another account, return a403 Forbiddenerror.
Updated 2 days ago