How to create an envelope with a Payment Item field using the C# .NET SDK

Question

Hi Team,I am implementing the DocuSign Payments feature using the C# .NET SDK and would appreciate some guidance.My requirement is to:Upload a PDF document through my ASP.NET Core Web API.	Create a new envelope programmatically (without using an existing envelope ID).	Add a signer.	Add a Payment Item field to the envelope.	Configure a payment amount.	Send the envelope so that the signer is prompted to make the payment during the signing process.I have reviewed the Payments documentation and several community posts, but I could not find a complete REST API or C# SDK example that demonstrates how to create the Payment Item field programmatically.Could someone please clarify the following?Which REST API endpoint or .NET SDK classes should be used to add a Payment Item field while creating an envelope?	Is the Payment Item field represented as a Formula Tab with a paymentDetails object, or is there another recommended approach?	Is there a complete C# (.NET) example that uploads a PDF, creates an envelope, configures the Payment Item field, and sends the envelope?	Is there any official documentation that explains how to implement this feature using the eSignature REST API and .NET SDK?Any guidance, sample code, or documentation links would be greatly appreciated.Thank you!

Koll.Klienstuber · Accepted Answer

@bharathshyamSending a payment using C# is possible.The resources I’d suggest is:“How to send a request for payment”https://developers.docusign.com/docs/esign-rest-api/how-to/request-a-payment/This article walks through the steps required with sample C# code.The full C# code sample from that article is pasted below if it helps. It’s found under “Step 3. Create the envelope definition“EnvelopeDefinition envelope = MakeEnvelope(signerEmail, signerName, ccEmail, ccName, envStatus, gatawayAccountId, gatewayName, gatewayDisplayName); private static EnvelopeDefinition MakeEnvelope(string signerEmail,string signerName,string ccEmail,string ccName,string envStatus,string gatewayAccountId,string gatewayName,string gatewayDisplayName) {// Data for this method// signerEmail// signerName// ccEmail// ccName// envStatus// document 1 (html) has multiple tags:// /l1q/ and /l2q/ -- quantities: drop down// /l1e/ and /l2e/ -- extended: payment lines// /l3t/ -- total -- formula//// The envelope has two recipients.// recipient 1 - signer// recipient 2 - cc// The envelope will be sent first to the signer.// After it is signed, a copy is sent to the cc person.///////////////////////////////////////////////////////////////////// //// NOTA BENA: This method programmatically constructs the //// order form. For many use cases, it would be //// better to create the order form as a template //// using the DocuSign web tool as a WYSIWYG //// form designer. //// /////////////////////////////////////////////////////////////////////// Order form constantsint l1Price = 5;int l2Price = 150;int currencyMultiplier = 100;string l1Name = "Harmonica";string l1Description = $"${l1Price} each", l2Name = "Xylophone";string l2Description = $"${l2Price} each";// Payment line itemsPaymentLineItem paymentLineIteml1 = new PaymentLineItem{ Name = l1Name, Description = l1Description, AmountReference = "l1e",},paymentLineIteml2 = new PaymentLineItem{ Name = l2Name, Description = l2Description, AmountReference = "l2e",};PaymentDetails paymentDetails = new PaymentDetails{ GatewayAccountId = gatewayAccountId, CurrencyCode = "USD", GatewayName = gatewayName, GatewayDisplayName = gatewayDisplayName, LineItems = new List { paymentLineIteml1, paymentLineIteml2 },};// read file from a local directory// The read could raise an exception if the file is not available!string doc1Html1 = System.IO.File.ReadAllText("order_form.html");// Substitute values into the HTML// Substitute for: {signerName}, {signerEmail}, {ccName}, {ccEmail}var doc1Html2 = doc1Html1.Replace("{signerName}", signerName) .Replace("{signerEmail}", signerEmail) .Replace("{ccName}", ccName) .Replace("{ccEmail}", ccEmail);// create the envelope definitionEnvelopeDefinition env = new EnvelopeDefinition{ EmailSubject = "Please complete your order",};// add the documentsstring doc1B64 = Convert.ToBase64String(Encoding.UTF8.GetBytes(doc1Html2));Document doc1 = new Document{ DocumentBase64 = doc1B64, Name = "Order form", // can be different from actual file name FileExtension = "html", // Source data format. Signed docs are always pdf. DocumentId = "1", // a label used to reference the doc};env.Documents = new List { doc1 };// create a signer recipient to sign the document, identified by name and email// We're setting the parameters via the object creationSigner signer1 = new Signer{ Email = signerEmail, Name = signerName, RecipientId = "1", RoutingOrder = "1",};// routingOrder (lower means earlier) determines the order of deliveries// to the recipients. Parallel routing order is supported by using the// same integer as the order for two or more recipients.// create a cc recipient to receive a copy of the documents, identified by name and email// We're setting the parameters via settersCarbonCopy cc1 = new CarbonCopy{ Email = ccEmail, Name = ccName, RoutingOrder = "2", RecipientId = "2",};// Create signHere fields (also known as tabs) on the documents,// We're using anchor (autoPlace) positioningSignHere signHere1 = new SignHere{ AnchorString = "/sn1/", AnchorYOffset = "10", AnchorUnits = "pixels", AnchorXOffset = "20",};ListItem listItem0 = new ListItem { Text = "none", Value = "0" }, listItem1 = new ListItem { Text = "1", Value = "1" }, listItem2 = new ListItem { Text = "2", Value = "2" }, listItem3 = new ListItem { Text = "3", Value = "3" }, listItem4 = new ListItem { Text = "4", Value = "4" }, listItem5 = new ListItem { Text = "5", Value = "5" }, listItem6 = new ListItem { Text = "6", Value = "6" }, listItem7 = new ListItem { Text = "7", Value = "7" }, listItem8 = new ListItem { Text = "8", Value = "8" }, listItem9 = new ListItem { Text = "9", Value = "9" }, listItem10 = new ListItem { Text = "10", Value = "10" } ;List listl1Q = new List{ Font = "helvetica", FontSize = "size11", AnchorString = "/l1q/", AnchorYOffset = "-10", AnchorUnits = "pixels", AnchorXOffset = "0", ListItems = new List { listItem0, listItem1, listItem2, listItem3, listItem4, listItem5, listItem6, listItem7, listItem8, listItem9, listItem10, }, Required = "true", TabLabel = "l1q",},listl2Q = new List{ Font = "helvetica", FontSize = "size11", AnchorString = "/l2q/", AnchorYOffset = "-10", AnchorUnits = "pixels", AnchorXOffset = "0", ListItems = new List { listItem0, listItem1, listItem2, listItem3, listItem4, listItem5, listItem6, listItem7, listItem8, listItem9, listItem10, }, Required = "true", TabLabel = "l2q",};// create two formula tabs for the extended price on the line itemsFormulaTab formulal1E = new FormulaTab{ Font = "helvetica", FontSize = "size11", AnchorString = "/l1e/", AnchorYOffset = "-8", AnchorUnits = "pixels", AnchorXOffset = "105", TabLabel = "l1e", Formula = $"[l1q] * {l1Price}", RoundDecimalPlaces = "0", Required = "true", Locked = "true", DisableAutoSize = "false",},formulal2E = new FormulaTab{ Font = "helvetica", FontSize = "size11", AnchorString = "/l2e/", AnchorYOffset = "-8", AnchorUnits = "pixels", AnchorXOffset = "105", TabLabel = "l2e", Formula = $"[l2q] * {l2Price}", RoundDecimalPlaces = "0", Required = "true", Locked = "true", DisableAutoSize = "false",},// Formula for the totalformulal3T = new FormulaTab{ Font = "helvetica", Bold = "true", FontSize = "size12", AnchorString = "/l3t/", AnchorYOffset = "-8", AnchorUnits = "pixels", AnchorXOffset = "50", TabLabel = "l3t", Formula = $"[l1e] + [l2e]", RoundDecimalPlaces = "0", Required = "true", Locked = "true", DisableAutoSize = "false",};// Hidden formula for the payment itselfFormulaTab formulaPayment = new FormulaTab{ TabLabel = "payment", Formula = $"([l1e] + [l2e]) * {currencyMultiplier}", RoundDecimalPlaces = "0", PaymentDetails = paymentDetails, Hidden = "true", Required = "true", Locked = "true", DocumentId = "1", PageNumber = "1", XPosition = "0", YPosition = "0",};// Tabs are set per recipient / signerTabs signer1Tabs = new Tabs{ SignHereTabs = new List { signHere1 }, ListTabs = new List { listl1Q, listl2Q }, FormulaTabs = new List { formulal1E, formulal2E, formulal3T, formulaPayment },};signer1.Tabs = signer1Tabs;// Add the recipients to the envelope objectRecipients recipients = new Recipients{ Signers = new List { signer1 }, CarbonCopies = new List { cc1 },};env.Recipients = recipients;// Request that the envelope be sent by setting |status| to "sent".// To request that the envelope be created as a draft, set to "created"env.Status = envStatus;return env; }The endpoint would be the standard create envelope endpoint and inside the body of the request is where you define details of the envelope like the documents, fields (payment tab), and recipients.https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/Our quick start also has an example and the link to it is here:https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/It states:“Additional configuration: Docusign paymentsTo use the payments code example in the Multiple code examples, Authorization Code Grant, and JWT Grant project Quickstart, first create a test payment gateway on the Payments page in your developer account. See Configure a payment gateway for details.Once you've created a payment gateway, save the Gateway Account ID GUID to launcher-csharp/appsettings.json.”

Sign up

You can login or register as either a Docusign customer or developer. If you don’t already have a Docusign customer or developer account, you can create one for free when registering.

Docusign Community

You can login or register as either a Docusign customer or developer. If you don’t already have a Docusign customer or developer account, you can create one for free when registering.