Pinwheel · Schema
Allocation
PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data
Properties
| Name | Type | Description |
|---|---|---|
| type | object | Type of allocation. |
| value | number | Value of allocation. If type is amount, you must include a value. If type is null, the end-user will be able to select the allocation type and value. If min_amount is also specified for the allocation |
| min_amount | number | Minimum amount for the allocation. |
| targets | array | List of allowed target accounts for an allocation. |
JSON Schema
{
"properties": {
"type": {
"allOf": [
{
"type": "string",
"enum": [
"amount"
]
}
],
"description": "Type of allocation."
},
"value": {
"type": "number",
"title": "value",
"description": "Value of allocation. If type is amount, you must include a value. If type is null, the end-user will be able to select the allocation type and value. If min_amount is also specified for the allocation, must be greater than or equal to min_amount."
},
"min_amount": {
"type": "number",
"title": "min_amount",
"description": "Minimum amount for the allocation."
},
"targets": {
"items": {
"$ref": "#/components/schemas/BankAccountDetails"
},
"type": "array",
"title": "targets",
"description": "List of allowed target accounts for an allocation.",
"default": []
}
},
"type": "object",
"title": "Allocation",
"x-tags": [
"Schemas"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://schema.pinwheelapi.com/Allocation.json"
}