---
title: "Send doc group invite with payment request"
method: POST
path: "/documentgroup/{group_id}/groupinvite"
---

# Send doc group invite with payment request

`POST /documentgroup/{group_id}/groupinvite`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/documentgroup/{group_id}/groupinvite`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/documentgroup/:group_id/groupinvite/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows API users to send a document group invite with a payment request. Recipients will be redirected to the payment page after completing the documents.

For more information, see the [Request payments guide](/docs/request-payments-guide).

> [!NOTE]
> To request a payment, users must either connect to the payment service individually or accept an invitation to an organization already connected to the payment service.

- To connect your organization to the payment service, see [Connect to merchant account](/docs/request-payments/operations/post-organizations-org-id-merchantaccount).

- To connect a personal SignNow account to the payment service, see [Connect to personal merchant account](/docs/request-payments/operations/post-v2-merchant-accounts).

A payment request can be linked to a specific field (`calculated` type) or set as a fixed amount (`fixed`type).

This article lists only the parameters required for a payment request. For other document group invite parameters, see [Invite to sign doc group](/docs/doc-group-field-invite/operations/invite-to-sign-document-group).


<details>
<summary>Use additional attributes to customize the request</summary>

| Parameter | Description | Example |
| --- | --- | --- |
| `field_type` | Type of the field that sets the payment amount. Required if the request `type` is `calculated`. For a payment request invite, `filed_type` is `text_fields`. |<img src="/reference-assets/images/Request_payments/payment_request_field_name_type.png" alt="Field type"> |
| `field_name` | Name of the field that sets the payment amount. Used if the `type` is `calculated`. Can be found in the [Get document response](/docs/document/operations/get-document) (fields.name). | See the screenshot above.  |
| `type` | Defines how the payment amount is set. Allowed values: `fixed` (the amount is set in the amount field) and `calculated` (set using a document field).<br><br> Learn how to [add a payment request field](/docs/request-payments/operations/put-document-document-id). |<img src="/reference-assets/images/Request_payments/payment_request_type.png" alt="Payment type"> |
| `currency` | Payment currency in ISO format. |<img src="/reference-assets/images/Request_payments/payment_request_amount_currency.png" alt="Currency"> |
| `amount` | Amount of payment. Required if `type` is 'fixed'. | See the screenshot above. |

</details>

## Request body

- object
  - `invite_steps` object[], required: Steps of the document group invite. Every step contains the `order` number, `invite_emails` and `invite_actions` within this step.
    - `order` integer, required: Signing order step. All signers assigned to a specific order step (e.g., order: 1) receive the invite email simultaneously. Emails for the next order step (e.g., order: 2) are sent only after all actions in the previous order step are completed.
    - `invite_emails` object[]: An array of recipient emails within this step.
      - `email` string, required: Recipient email address.
    - `invite_actions` object[], required: An array of objects, where each object defines a recipient, their role, and the corresponding action for a document.
      - `email` string: Recipient email address.
      - `action` string: The action required from the recipient in the document. Allowed values: `sign`, `view`, `approve`.
      - `role_name` string: Recipient role name.
      - `document_id` string: ID of the document on which the action is required.
      - `payment_request` object: An object with the payment request configuration.
        - `type` string, required: The type of the payment request. Allowed values: `fixed`, `calculated`.
        - `amount` string, required: Payment amount. Required for the `fixed` payment type.
        - `currency` string, required: Payment currency in ISO format.
        - `field_id` string, required: The ID of the field that defines the payment amount. Required for the `calculated` payment type. Can be found in the [Get document](/docs/document/operations/get-document) response.
        - `merchants` string[], required: IDs of connected payment service accounts. Can be found in the [Get merchant account](/docs/request-payments/operations/get-organizations-org-id-merchantaccount-merchant-account-id) response.
        - `field_name` string: The name of the field that defines the payment amount. Used for the `calculated` payment type. Can be found in the [Get document](/docs/document/operations/get-document) response.
        - `field_type` string, required: The field type that defines the payment amount. Required for the `calculated` payment type. Allowed value is `text_fields`.

## Response `200`

Successful response.

- object
  - `id` string: ID of the document group invite.
  - `pending_invite_link` unknown

## Other responses

- `400`: - `field_id` is empty or missing. - `field_type` is missing or incorrect. - `amount` is empty or missing. - `currency` is missing. - `type` is missing. - `merchants` is empty. - Merchant ID is incorrect.

---

[API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)