---
title: "Send doc group invite with payment request"
url: "https://docs.signnow.com/docs/request-payments/operations/post"
type: "endpoint"
section: "request-payments"
slug: "request-payments/operations/post"
method: "POST"
path: "/documentgroup/{group_id}/groupinvite"
operation_id: "post"
authorization: "bearer"
---

# Send doc group invite with payment request

`POST /documentgroup/{group_id}/groupinvite`

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

> 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>

## Authorization

bearer

## Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `group_id` | string | Yes | ID of the document group |

## Request Body

**Schema**

```json
{
  "type": "object",
  "required": [
    "invite_steps"
  ],
  "properties": {
    "invite_steps": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "order",
          "invite_actions"
        ],
        "properties": {
          "order": {
            "type": "integer",
            "example": 1,
            "description": "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": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "email"
              ],
              "properties": {
                "email": {
                  "type": "string",
                  "example": "signer@email.com",
                  "description": "Recipient email address."
                }
              }
            },
            "description": "An array of recipient emails within this step."
          },
          "invite_actions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "example": "signer@email.com",
                  "description": "Recipient email address."
                },
                "action": {
                  "type": "string",
                  "example": "sign",
                  "description": "The action required from the recipient in the document. Allowed values: `sign`, `view`, `approve`."
                },
                "role_name": {
                  "type": "string",
                  "example": "Signer",
                  "description": "Recipient role name."
                },
                "document_id": {
                  "type": "string",
                  "example": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye",
                  "description": "ID of the document on which the action is required."
                },
                "payment_request": {
                  "type": "object",
                  "required": [
                    "type",
                    "currency",
                    "merchants",
                    "field_type",
                    "field_id",
                    "amount"
                  ],
                  "properties": {
                    "type": {
                      "type": "string",
                      "example": "fixed",
                      "description": "The type of the payment request. Allowed values: `fixed`, `calculated`."
                    },
                    "amount": {
                      "type": "string",
                      "example": "1000",
                      "description": "Payment amount. Required for the `fixed` payment type."
                    },
                    "currency": {
                      "type": "string",
                      "example": "USD",
                      "description": "Payment currency in ISO format."
                    },
                    "field_id": {
                      "type": "string",
                      "example": "eb1dc1e1946f47cd87fa4a63664803bddbazzzz",
                      "description": "The ID of the field that defines the payment amount. Required for the `calculated` payment type. Can be found in the\u00a0[Get document](/docs/document/operations/get-document)\u00a0response."
                    },
                    "merchants": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "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)\u00a0response."
                    },
                    "field_name": {
                      "type": "string",
                      "example": "payment_field",
                      "description": "The name of the field that defines the payment amount. Used for the `calculated` payment type. Can be found in the\u00a0[Get document](/docs/document/operations/get-document)\u00a0response."
                    },
                    "field_type": {
                      "type": "string",
                      "example": "text_fields",
                      "description": "The field type that defines the payment amount. Required for the `calculated` payment type. Allowed value is\u00a0`text_fields`."
                    }
                  },
                  "description": "An object with the payment request configuration."
                }
              }
            },
            "description": "An array of objects, where each object defines a recipient, their role, and the corresponding action for a document."
          }
        }
      },
      "description": "Steps of the document group invite. Every step contains the `order` number, `invite_emails` and `invite_actions` within this step."
    }
  },
  "x-examples": {
    "Example 1": {
      "invite_steps": [
        {
          "order": 1,
          "invite_emails": [
            {
              "email": "seller@email.com"
            }
          ],
          "invite_actions": [
            {
              "email": "seller@email.com",
              "action": "sign",
              "role_name": "Seller",
              "document_id": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye",
              "payment_request": {
                "type": "calculated",
                "currency": "USD",
                "field_id": "eb1dc1e1946f47cd87fa4a63664803bddbazzzz",
                "merchants": [
                  "5ef7e3853f4a4624a037d90d20513a195937dxxx"
                ],
                "field_name": "payment_buyer",
                "field_type": "text_fields"
              }
            }
          ]
        },
        {
          "order": 2,
          "invite_emails": [
            {
              "email": "buyer@email.com"
            }
          ],
          "invite_actions": [
            {
              "email": "buyer@email.com",
              "action": "sign",
              "role_name": "Buyer",
              "document_id": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye",
              "payment_request": {
                "type": "fixed",
                "amount": "1000",
                "currency": "USD",
                "merchants": [
                  "yyyye3853f4a4624a037d90d20513a195937dxxx"
                ]
              }
            }
          ]
        }
      ]
    }
  }
}
```

**Example** (`Request with `fixed` payment type`)

```json
{
  "invite_steps": [
    {
      "order": 1,
      "invite_emails": [
        {
          "email": "seller@email.com"
        }
      ],
      "invite_actions": [
        {
          "email": "seller@email.com",
          "action": "sign",
          "role_name": "Seller",
          "document_id": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye"
        }
      ]
    },
    {
      "order": 2,
      "invite_emails": [
        {
          "email": "buyer@email.com"
        }
      ],
      "invite_actions": [
        {
          "email": "buyer@email.com",
          "action": "sign",
          "role_name": "Buyer",
          "document_id": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye",
          "payment_request": {
            "type": "fixed",
            "amount": "1000",
            "currency": "USD",
            "merchants": [
              "5ef7e3853f4a4624a037d90d20513a195937dxxx"
            ]
          }
        }
      ]
    }
  ]
}
```

**Example** (`Request with `calculated` payment type`)

```json
{
  "invite_steps": [
    {
      "order": 1,
      "invite_emails": [
        {
          "email": "seller@email.com"
        }
      ],
      "invite_actions": [
        {
          "email": "seller@email.com",
          "action": "sign",
          "role_name": "Seller",
          "document_id": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye"
        }
      ]
    },
    {
      "order": 2,
      "invite_emails": [
        {
          "email": "buyer@email.com"
        }
      ],
      "invite_actions": [
        {
          "email": "buyer@email.com",
          "action": "sign",
          "role_name": "Buyer",
          "document_id": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye",
          "payment_request": {
            "type": "calculated",
            "currency": "USD",
            "field_id": "eb1dc1e1946f47cd87fa4a63664803bddba6fff",
            "merchants": [
              "5ef7e3853f4a4624a037d90d20513a195937dxxx"
            ],
            "field_name": "payment_buyer",
            "field_type": "text_fields"
          }
        }
      ]
    }
  ]
}
```

## Responses

### 200

Success

**Example** (`Example 1`)

```json
{
  "id": "XXXXe0ea656944f3b833d0baeb1067f02490YYYY",
  "pending_invite_link": null
}
```

### 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.

**Example** (`Example 1`)

```json
{
  "errors": [
    {
      "code": 65536,
      "message": "Invalid field type, valid types are: text_fields"
    }
  ]
}
```

**Example** (`Merchants empty`)

```json
{
  "errors": [
    {
      "code": 65536,
      "message": "Required at least one merchant account in payment request"
    }
  ]
}
```

**Example** (`currency missing`)

```json
{
  "errors": [
    {
      "code": 65536,
      "message": "Must provide currency type for payments"
    }
  ]
}
```

**Example** (`Merchant ID incorrect`)

```json
{
  "errors": [
    {
      "code": 65536,
      "message": "Invalid merchant_id in payment_field_request"
    }
  ]
}
```

**Example** (`amount empty or missing`)

```json
{
  "errors": [
    {
      "code": 65536,
      "message": "For fixed payment types, please enter non zero amount"
    }
  ]
}
```

**Example** (`field_id empty or missing`)

```json
{
  "errors": [
    {
      "code": 65536,
      "message": "Invalid field id provided"
    }
  ]
}
```

**Example** (`field_type missing or incorrect`)

```json
{
  "errors": [
    {
      "code": 65536,
      "message": "Invalid field type, valid types are: text_fields"
    }
  ]
}
```

## Code Examples

> Replace `$SIGNNOW_ACCESS_TOKEN` and any `{placeholder}` values before running.

### cURL

```bash
curl -X POST \
  "https://api.signnow.com/documentgroup/{group_id}/groupinvite" \
  -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"invite_steps": [{"order": 1, "invite_emails": [{"email": "seller@email.com"}], "invite_actions": [{"email": "seller@email.com", "action": "sign", "role_name": "Seller", "document_id": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye"}]}, {"order": 2, "invite_emails": [{"email": "buyer@email.com"}], "invite_actions": [{"email": "buyer@email.com", "action": "sign", "role_name": "Buyer", "document_id": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye", "payment_request": {"type": "fixed", "amount": "1000", "currency": "USD", "merchants": ["5ef7e3853f4a4624a037d90d20513a195937dxxx"]}}]}]}'
```

---
*Full reference: https://docs.signnow.com/docs/request-payments/operations/post*