> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dueflow.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Request payments

> > **Requires scope** `payments:write` · **Minimum role** editor

Requests one payment batch from a group, members, or members of a group. Requires an `Idempotency-Key` header. Amounts are in dollars; date fields accept ISO date or date-time strings.

[Scopes and roles](https://docs.dueflow.co/api-reference/scopes)



## OpenAPI

````yaml /openapi.json post /v1/payment-requests
openapi: 3.1.0
info:
  title: Dueflow API
  version: 1.0.0
  description: >-
    Read and write your organization's Dueflow data. Authenticate with a
    personal access token or an organization service token as a bearer
    credential; cookies are ignored. Every endpoint is also a tool on the
    Dueflow MCP server at https://api.dueflow.co/mcp, which accepts the same
    bearer tokens or an OAuth connection from ChatGPT and Claude.
  termsOfService: https://dueflow.co/terms
  contact:
    name: Dueflow support
    email: support@dueflow.co
    url: https://docs.dueflow.co
servers:
  - url: https://api.dueflow.co
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/payment-requests:
    post:
      tags:
        - Payments
      summary: Request payments
      description: >-
        > **Requires scope** `payments:write` · **Minimum role** editor


        Requests one payment batch from a group, members, or members of a group.
        Requires an `Idempotency-Key` header. Amounts are in dollars; date
        fields accept ISO date or date-time strings.


        [Scopes and roles](https://docs.dueflow.co/api-reference/scopes)
      operationId: postPayment-requests
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            A unique key per logical operation, e.g. a UUID. Retrying with the
            same key replays the original response instead of repeating the
            write; reusing it with different parameters is a 409.
          schema:
            type: string
            maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                groupId:
                  type: string
                  minLength: 1
                memberIds:
                  minItems: 1
                  maxItems: 2000
                  type: array
                  items:
                    type: string
                    minLength: 1
                excludeMemberIds:
                  default: []
                  type: array
                  items:
                    type: string
                amount:
                  type: number
                  minimum: 0.01
                currency:
                  type: string
                amountOverrides:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    type: number
                    minimum: 0.01
                description:
                  type: string
                  minLength: 1
                  maxLength: 2000
                dueDate:
                  type: string
                earlyDiscount:
                  type: number
                  minimum: 0.01
                earlyDeadline:
                  type: string
                lateFee:
                  type: number
                  minimum: 0.01
                lateDeadline:
                  type: string
                autoRemindersEnabled:
                  default: true
                  type: boolean
                reminderIntervalHours:
                  type: integer
                  exclusiveMinimum: 0
                  maximum: 9007199254740991
                isRecurring:
                  default: false
                  type: boolean
                intervalUnit:
                  type: string
                  enum:
                    - weekly
                    - monthly
                    - quarterly
                    - yearly
                totalCycles:
                  type: integer
                  minimum: 2
                  maximum: 120
                startDate:
                  type: string
                installmentMonths:
                  type: integer
                  minimum: 2
                  maximum: 12
                installmentInterval:
                  type: string
                  enum:
                    - monthly
                    - quarterly
                sendAt:
                  type: string
                deadlineTimeZone:
                  type: string
              required:
                - amount
                - description
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  batchId:
                    type: string
                  shows:
                    type: object
                    properties:
                      label:
                        type: string
                      href:
                        type: string
                    required:
                      - label
                      - href
                    additionalProperties: false
                  members:
                    type: array
                    items:
                      type: object
                      properties:
                        memberId:
                          type: string
                        memberName:
                          type: string
                        status:
                          type: string
                          enum:
                            - created
                            - skipped
                            - failed
                        reason:
                          type: string
                        paymentId:
                          type: string
                      required:
                        - memberId
                        - memberName
                        - status
                      additionalProperties: false
                required:
                  - batchId
                  - shows
                  - members
                additionalProperties: false
        '401':
          description: Missing, malformed, expired or revoked token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks a required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource, or the token's organization can't see it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The write conflicts with existing state, or an `Idempotency-Key` was
            reused with different parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited; see the `Retry-After` header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - payments:write
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            param:
              type: string
            requiredScopes:
              type: array
              items:
                type: string
            requestId:
              type: string
            docsUrl:
              type: string
          required:
            - code
            - message
            - requestId
            - docsUrl
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Dueflow access token: `dfp_` (personal) or `dfs_` (service).
        Permissions are the token's scopes intersected with the role ceiling,
        re-evaluated per request.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.