Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIFinanceCommission

Commission routes: pay

The Commission Verbs pay as api.sb routes, with inputs, result, refusals and an example.

Reference for Commission, one group of Commission routes.

Commission.pay

Pay transfers a Commission’s earned, unpaid amount to the Partner’s connected account through Stripe. Verb page.

Text
POST /{namespace}/commissions/{commission}/pay

Path: commission. Emits Commission.paid.

Inputs

InputTypeRequiredDescription
commissionCommissionrequiredThe Commission with an amount past its clawback window.

Returns

OutputTypeRequiredDescription
commissionCommissionrequiredThe Commission, its paid raised by the transfer.
transactionTransactionrequiredThe transfer as the rail reports it.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/commissions/commission_oYhMioUeCH/pay \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "commission": {
    "$id": "https://api.sb/leaseline.app/commissions/commission_oYhMioUeCH",
    "$type": "Commission",
    "rate": 1,
    "term": 1,
    "clawbackDays": 1
  },
  "transaction": {
    "$id": "https://api.sb/leaseline.app/transactions/txn_XoxtZe3CQI",
    "$type": "Transaction",
    "kind": "charge",
    "amount": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Commission.pay",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update

Previous

Cost

Next