Commission methods: pay
The Commission Verbs pay as typed SDK methods, with inputs, result, refusals and an example.
Reference for Commission, one group of Commission methods.
Commission.pay
Pay transfers a Commission’s earned, unpaid amount to the Partner’s connected account through Stripe. Verb page.
interface CommissionVerbs {
pay(input: CommissionPayInput, options?: SB.CallOptions): SB.Call<CommissionPayOutput>
}Emits Commission.paid.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
commission | Commission | required | The Commission with an amount past its clawback window. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
commission | Commission | required | The Commission, its paid raised by the transfer. |
transaction | Transaction | required | The transfer as the rail reports it. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const { commission, transaction } = await $.Commission.pay({ commission: 'commission_oYhMioUeCH' })