This endpoint allows API users to add a payment request field to a document.

For more information, see the Request payments guide.

[!NOTE] The payment request field is a text field with a specific validator ID. You can only add one payment request field to your invite.

For payment requests with field values, you must use the following validator IDs:

• 7ef095fd94ce63b670b52b2e83457d59ac796a39 (currency amount format 1) - comma for thousands, dot for decimals. Example: 8,100.00
• 824085fd04ce63b670b11b2e83457d59ac796a39 (currency amount format 2) - dot for thousands, comma for decimals. Example: 8.100,00

[!NOTE] To request payment from the recipient, you have to connect to the payment service and send a signature invite with a payment request. The recipient will be asked to pay the amount you specified once they’ve completed the document.

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

{
  "fields": [
    {
      "x": 358,
      "y": 171,
      "name": "payment_field",
      "role": "Signer 1",
      "type": "text",
      "width": 177,
      "height": 50,
      "validator_id": "7ef095fd94ce63b670b52b2e83457d59ac796a39",
      "prefilled_text": "8100"
    }
  ]
}