SIsignnow

Send doc group invite with payment request

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.

[!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.

  • To connect a personal SignNow account to the payment service, see Connect to personal merchant account.

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

This article lists only the parameters required for a payment request. For other document group invite parameters, see Invite to sign doc group.

<details> <summary>Use additional attributes to customize the request</summary>
ParameterDescriptionExample
field_typeType 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_nameName of the field that sets the payment amount. Used if the type is calculated. Can be found in the Get document response (fields.name).See the screenshot above.
typeDefines 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.<img src="/reference-assets/images/Request_payments/payment_request_type.png" alt="Payment type">
currencyPayment currency in ISO format.<img src="/reference-assets/images/Request_payments/payment_request_amount_currency.png" alt="Currency">
amountAmount of payment. Required if type is 'fixed'.See the screenshot above.
</details>
post/documentgroup/{group_id}/groupinvite

Request

Path parameters

ID of the document group

Request body

Example request

{
  "invite_steps": [
    {
      "order": 1,
      "invite_emails": [
        {
          "email": "signer@email.com"
        }
      ],
      "invite_actions": [
        {
          "email": "signer@email.com",
          "action": "sign",
          "role_name": "Signer",
          "document_id": "d31bb646ccca47aa9ab91eeb04c27458aeyyyyye",
          "payment_request": {
            "type": "fixed",
            "amount": "1000",
            "currency": "USD",
            "field_id": "eb1dc1e1946f47cd87fa4a63664803bddbazzzz",
            "field_name": "payment_field",
            "field_type": "text_fields"
          }
        }
      ]
    }
  ]
}

Response

Successful response.

idstring

ID of the document group invite.

pending_invite_linkunknown

Changes

No recorded changes to this operation across all 1 revision of this API.