/accounts/income-sourcesCreates a new income source account for receiving payroll or other inflows.
AuthorizationClick to expand
ApiKeyAuth Format: ApiKey <key>. Keys are scoped to an organization and carry explicit permissions.
Each key holds a list of permission entries. An entry specifies a scope and a resources
constraint. A request returns 403 if the key lacks the required scope, or if the requested
resource is outside the key's allowed list.
| Scope | Resources | Grants access to |
|---|---|---|
LIST_ACCOUNTS | none | List all accounts in the organization |
READ_ACCOUNTS | account IDs or * | Full account details and balance for a specific account |
LIST_RULES | none | List all rules in the organization |
READ_RULES | rule IDs or * | Full rule details (steps, conditions, actions) for a specific rule |
TRIGGER_RULES | rule IDs or * | Triggering rule executions |
READ_RULE_EXECUTIONS | rule IDs or * | Rule execution history - rule_id filter required |
READ_TRANSFERS | account IDs or * | Transfer history - account_id filter required |
MANUAL_TRANSFER | list of { source, target, max_amount? } sets | Creating manual transfers |
READ_CARDS | account IDs or * | Cards and card transactions - account_id filter required |
In: header
Header Parameters
Idempotency-Key?stringA client-generated unique key to ensure idempotent processing. Requests with the same key within 24 hours return the original response without re-executing the operation. Recommended format: UUID v4.
X-Request-ID?stringA client-provided request identifier echoed back in the response `X-Request-ID` header and `request_id` body field. If omitted, the server generates one.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
| Field | Type | Description |
|---|---|---|
nickname* | string | Display name for the income source. |
icon? | string | Icon identifier for the income source. |
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.getsequence.io/api/v1/accounts/income-sources" \ -H "Content-Type: application/json" \ -d '{ "nickname": "Main Payroll", "icon": "briefcase" }'{
"request_id": "req_01HABC7002",
"data": {
"id": "acc_01HABC4567",
"name": "Main Payroll",
"type": "income_source",
"description": null,
"external_account_type": null,
"beneficiary_name": "John Smith",
"institution_name": null,
"can_be_source": true,
"can_be_destination": false,
"routing_number": "••••0021",
"bank_account_number": "••••7731",
"balance": {
"balance_in_cents": 0,
"available_balance_in_cents": 0,
"last_statement_balance_in_cents": null,
"next_payment_minimum_in_cents": null,
"next_payment_due_date": null,
"balance_last_updated_at": "2024-04-23T10:00:00Z"
},
"created_at": "2024-04-23T10:00:00Z",
"updated_at": "2024-04-23T10:00:00Z"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key does not have the required permission."
}
}