> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # Create the organization Flutterwave subaccount > Creates a provider subaccount and, on provider success, stores its subaccount/account IDs and a default Flutterwave gateway for the authenticated organization. The server supplies split_value=0.05 and split_type=percentage; callers cannot override these fields. Returns the updated organization model. A provider rejection or transport exception is a local500 failure. Requires permission: one of access_payment_gateways. ## OpenAPI ````yaml post /flutterwave/subaccount openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity commitment relationships, lifecycle transitions, and commitment-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Events description: >- Event setup, invitations, registration, ticketing, attendance and event reporting. - name: Journeys description: >- Journey graphs, activation, enrollment, message templates and event follow-up automations. - name: Tasks description: Workspace tasks, assignments, saved task views and record collaboration. - name: Fundraising description: >- Fundraising portfolios, stewardship plans, giving anniversaries and personal donor follow-up. - name: Impact Stories description: Story intake, review, assets, consent and publication workflows. - name: Integrations description: Workspace integration connections, mappings, synchronization and recovery. - name: Email Calendar description: Connected email/calendar accounts and donor interactions. - name: Spaces description: Workspace Spaces and collaborative Pages. - name: Library description: Workspace documents, source connections, files and analysis. - name: Intelligence description: Donor intelligence and Tali workspace workflows. - name: Automation description: >- V3 automation primitive discovery, input validation, invocation and Zapier contracts. - name: Schema description: V3 model, enum, capability and scope discovery. - name: Zapier description: Zapier automation connections, polling feeds and actions. - name: Files description: Files - name: Client description: Client - name: Payment Gateways description: Payment Gateways - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Recipients description: Recipients - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Settings description: Settings - name: Notifications description: Notifications - name: Participation description: Participation - name: Users description: Users - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User - name: Workspace description: Workspace paths: /flutterwave/subaccount: post: tags: - Payments summary: Create the organization Flutterwave subaccount description: >- Creates a provider subaccount and, on provider success, stores its subaccount/account IDs and a default Flutterwave gateway for the authenticated organization. The server supplies split_value=0.05 and split_type=percentage; callers cannot override these fields. Returns the updated organization model. A provider rejection or transport exception is a local500 failure. Requires permission: one of access_payment_gateways. operationId: reference_FlutterwaveController_createSubaccount requestBody: description: Validated request fields for this operation. required: true content: application/json: schema: required: - account_bank - account_number - business_name - business_mobile - business_email - country properties: account_bank: description: Provider bank code. type: string example: '044' account_number: description: >- Required bank account identifier; this controller imposes no further type rule. example: EXAMPLE-ACCOUNT business_name: description: Required organization/business name. example: Example Nonprofit business_mobile: description: Required business contact phone. example: '+2348000000000' business_email: description: Business contact mailbox. type: string format: email example: finance@example.org country: description: Provider setup country. type: string example: NG type: object responses: '200': description: Operation result. content: application/json: schema: $ref: '#/components/schemas/Client' '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The authenticated user lacks access to this workflow or its related records. '404': description: The authenticated organization is missing. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '422': description: Request validation failed. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' '500': description: Provider subaccount creation failed. security: - bearerAuth: [] - apiKeyAuth: [] servers: - url: https://api.gratona.com/v1 description: Gratona API components: schemas: Client: title: Client description: >- A Gratona client — the tenant of the multi-tenant system. Owns donors, entities, programs, users, and integrations. The `client_id` on every other resource scopes data to this row. Stripe Connect onboarding state, account-level settings, and the client's display name all live here. required: - id - organization properties: id: description: Internal client ID — referenced by every multi-tenant resource. type: integer format: int64 example: 207 organization: description: Display name of the organization. type: string example: Gratona Demo Org website: description: Organization website. type: string example: https://demo.gratona.com nullable: true email: description: Primary contact email for the organization. type: string format: email example: hello@demo.gratona.com nullable: true stripe_connect_id: description: >- Stripe Connect account id once onboarding completes; null until the org has finished Stripe onboarding. type: string example: acct_1OqXXXXX nullable: true previous_stripe_connect_id: description: >- Prior Stripe Connect account id, kept around when the client migrates between Connect accounts. type: string example: null nullable: true completed_stripe_onboarding: description: >- Whether the org has finished the Stripe Connect onboarding flow and can accept Stripe payments. type: boolean example: true date_format: description: >- Stored organization date-format setting token. API and admin surfaces resolve this token to the corresponding display pattern. type: string enum: - m-d-Y - d-m-Y - Y-m-d example: Y-m-d timezone: description: 'Computed accessor: client timezone derived from settings.' type: string example: America/Chicago nullable: true custom: description: >- Legacy free-form JSON column for arbitrary client-level configuration. type: object nullable: true additionalProperties: true frequency: description: Legacy frequency configuration for billing / payment plans (JSON). type: object nullable: true additionalProperties: true custom_start_date: description: Legacy billing custom start date marker. type: string example: null nullable: true custom_amount: description: Legacy billing custom amount marker. type: number format: float example: null nullable: true created_at: type: string format: date-time example: '2024-06-01T12:00:00Z' updated_at: type: string format: date-time example: '2026-01-01T00:00:00Z' type: object UnauthorizedResponse: title: UnauthorizedResponse description: >- Returned with HTTP 401 when the request lacks a valid Passport bearer token, a valid `X-HYS-API-Key`, or a valid session. The body is the simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`. required: - message - status properties: message: description: >- Always the literal string `Unauthorized` from the `auth.api_or_key` middleware. Login endpoints return `Invalid Credentials` instead. type: string example: Unauthorized status: type: string example: error type: object NotFoundResponse: title: NotFoundResponse description: >- Returned with HTTP 404 when a resource lookup misses (typically because the id doesn't exist OR is scoped to a different `client_id`). Note: many endpoints intentionally collapse 'not found' and 'forbidden' into a single 404 to avoid leaking which records exist in another tenant. required: - message properties: message: description: >- Human-readable message. Often a more specific string like `Donor not found` or `Trip not found`. type: string example: Not Found status: type: string example: error type: object RequestRejection: description: >- Request or workflow rejection. Framework field-validation failures contain errors; semantic rejections may contain message without errors; legacy/provider failures may use error and error_code. The operation description identifies the rejected condition. Domain responses may add current revision, limits or other conflict context. anyOf: - $ref: '#/components/schemas/ValidationErrorResponse' - $ref: '#/components/schemas/ErrorResponse' - required: - error properties: error: description: Legacy or provider-facing error message. type: string example: The request could not be completed. error_code: description: Stable domain error code, when provided. type: string example: WORKFLOW_UNAVAILABLE type: object ValidationErrorResponse: title: ValidationErrorResponse description: >- Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The `errors` map is keyed by the failing field name; each value is an array of human-readable error messages for that field. Most controllers also include a top-level `status: error`. required: - errors properties: errors: description: >- Map of field name to array of validator error messages. Example: `{email: [The email field is required.], amount: [The amount must be a number.]}`. type: object additionalProperties: type: array items: type: string status: description: Always the literal string `error`. type: string example: error message: description: >- Optional summary message — present on some endpoints, absent on others. type: string example: The given data was invalid. nullable: true type: object ErrorResponse: title: ErrorResponse description: >- Generic error envelope used by most controllers. Most error responses pair a human-readable `message` with `status: error`. Some endpoints additionally include `errors` (validator errors), `error` (legacy single-error string), `code`, or domain-specific context fields. required: - message properties: message: description: Human-readable error message. type: string example: Something went wrong. Please try again. status: description: >- Always the literal string `error` for failures. Some endpoints omit this field. type: string example: error error: description: Legacy single error code/string used by older endpoints. type: string example: invalid_request nullable: true code: description: >- Optional application-level error code (not all endpoints populate this). type: string example: DONOR_NOT_FOUND nullable: true type: object securitySchemes: bearerAuth: type: http description: Passport bearer token authentication for legacy admin sessions. scheme: bearer bearerFormat: JWT apiKeyAuth: type: apiKey description: Gratona API key sent with the compatibility header X-HYS-API-Key. name: X-HYS-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.