> ## 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. # Start a batch payment import ## OpenAPI ````yaml post /admin/import/payments/batch 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 sponsorship relationships, lifecycle transitions, and sponsorship-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: Client description: Client - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Files description: Files - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User paths: /admin/import/payments/batch: post: tags: - Files summary: Start a batch payment import operationId: 118d830f435b32acbbbf2088c82695f2 requestBody: required: true content: application/json: schema: properties: filename: description: S3 filename of the CSV type: string original_filename: description: Original uploaded filename type: string csv_entity_field: description: CSV header name for entity identifier type: string entity_field: description: Gratona entity field key used for matching type: string csv_donor_field: description: CSV header name for donor identifier type: string donor_field: description: Gratona donor field key used for matching type: string csv_amount_field: description: CSV header name for amount column type: string csv_date_field: description: CSV header name for payment date column type: string csv_method_field: description: CSV header name for payment method column type: string method_default: description: Default payment method if not specified in CSV type: integer csv_type_field: description: CSV header name for payment type column type: string type_default: description: Default payment type if not specified in CSV type: integer csv_result_field: description: CSV header name for result column type: string source_system: description: External source system label used with source object ID type: string source_object_type: description: External source object type, defaults to donation type: string duplicate_policy: description: >- How to handle source object IDs, including link-only provenance adoption for an existing Gratona donation type: string enum: - create_only - skip_existing - fail_on_conflict - link_existing csv_source_object_id_field: description: CSV header name for durable source record ID type: string csv_source_modified_at_field: description: CSV header name for source-system modified timestamp type: string csv_existing_donation_id_field: description: >- CSV header name for an existing Gratona donation ID used by link_existing type: string csv_transaction_id_field: description: CSV header name for gateway/source transaction ID type: string csv_transaction_status_field: description: CSV header name for transaction status type: string csv_currency_field: description: CSV header name for ISO currency code type: string currency_default: description: Default ISO currency code type: string csv_actual_charged_amount_field: description: CSV header name for actual charged amount type: string csv_receipt_sent_at_field: description: CSV header name for imported receipt sent date type: string csv_tax_deductible_field: description: CSV header name for tax deductible flag type: string tax_deductible_default: description: Default tax deductible value when CSV column is not mapped type: boolean csv_in_kind_category_field: description: CSV header name for in-kind category type: string include_refunds: description: Whether refund columns should update existing donations type: boolean csv_refund_amount_field: description: CSV header name for imported refund amount type: string csv_refund_date_field: description: CSV header name for imported refund date type: string csv_refund_id_field: description: CSV header name for external refund ID type: string csv_refund_reason_field: description: CSV header name for imported refund reason type: string include_soft_credits: description: >- Whether soft credit columns should create soft credit records type: boolean csv_soft_credit_donor_field: description: CSV header name for soft credit donor identifier type: string soft_credit_donor_field: description: Gratona donor field key used for soft credit donor matching type: string csv_soft_credit_amount_field: description: CSV header name for soft credit amount type: string csv_soft_credit_type_field: description: CSV header name for soft credit type name or ID type: string soft_credit_type_default: description: Default active soft credit type name or ID type: string csv_soft_credit_note_field: description: CSV header name for soft credit note type: string csv_soft_credit_source_object_id_field: description: CSV header name for durable soft credit source ID type: string program_id: description: Program ID type: integer type: object responses: '200': description: Batch import started successfully content: application/json: schema: properties: message: type: string example: Payment import batch has been started. batch_id: type: integer example: 123 type: object '422': description: Validation error '500': description: Server error security: - bearerAuth: [] - apiKeyAuth: [] components: 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.