DocuSign Payments REST API 创建选项卡并保存付款方式

Question

我正在使用 Docusign REST API 并尝试创建一个付款选项卡，该选项卡将使用 Stripe 保存签名者的付款方式。

在Docusign API指南和StackOverflow上有一些信息，解释了如何使用API收取付款，但我还没有找到任何资源来解释如何保存和授权付款方式以供将来计费，尽管此功能在Docusign网站上手动创建信封时可用。 (要在Docusign网站上执行此操作，您只需单击标准字段-->付款项-->付款类型-->保存付款方式。 由于该功能在网站上可用，因此也应该可以通过 API 实现。

以下代码取自堆栈溢出的另一个问题，它用于设置用于收集付款的选项卡，但同样没有使用 Stripe 保存付款方式以备将来收费：

"numberTabs": [{
"xPosition": 268,
"yPosition": 142,
"documentId": "12345",
"recipientId": "1",
"pageNumber": 1,
"value": 250,
"maxLength": 4000,
"width": 80,
"height": 16,
"tabLabel": "PaymentFixed 646b5192-a101-4cdc-a7e5-5e9bd1b80612",
"paymentItemName": "Test Item Name",
"paymentItemCode": "54321",
"paymentItemDescription": "Test Item Details"
}],
"formulaTabs": [{
"paymentDetails": {
"currencyCode": "USD",
"gatewayAccountId": "8cfb9a83-1f4c-40b1-b7a9-dd382ee0ca7d",
"lineItems": [{
"amountReference": "PaymentFixed 646b5192-a101-4cdc-a7e5-5e9bd1b80612",
"name": "Test Item Name",
"description": "Test Item Details",
"itemCode": "54321"
}]
},
"formula": "([PaymentFixed 646b5192-a101-4cdc-a7e5-5e9bd1b80612]) * 100",
"recipientId": "1",
"documentId": "12345",
"tabLabel": "PaymentReceipt e47eed9a-85ca-4094-8d0f-50e51d5d1ee0",
"xPosition": 0,
"yPosition": 0,
"pageNumber": 1,
"required": true,
"locked": true,
"hidden": true
}]

如何修改此代码以收取付款并保存付款方式以供将来计费？

提前致谢

Answer 1

您需要传递"paymentOption": "save_and_authorize"才能收取一次性付款，并在 Stripe 上保存付款方式。您还需要添加一个 TextTab 以在签名屏幕上显示保存付款方式，完整的代码以收取一次性付款和保存付款方式将如下所示：

{
"compositeTemplates": [
{
"document": {
"documentBase64": "<Base64>",
"documentId": "1",
"fileExtension": "docx",
"name": "Doc1"
},
"inlineTemplates": [
{
"recipients": {
"signers": [
{
"email": "[e-mail]",
"name": "John Doe",
"recipientId": "88089475",
"tabs": {
"textTabs": [
{
"tabLabel": "PaymentFuture 53d3ce8e-a043-4d0a-93ff-37eee94d3555",
"documentId": "1",
"pageNumber": 1,
"recipientId": "88089475",
"xPosition": 201,
"yPosition": 219,
"locked": true
}
],
"numberTabs": [
{
"tabLabel": "PaymentFixed 91684e58-85c6-4441-be08-efebac5476b8",
"value": 10,
"maxLength": 4000,
"width": 84,
"height": 22,
"pageNumber": 1,
"documentId": "1",
"recipientId": "88089475",
"paymentItemName": "Name1",
"paymentItemCode": "Code1",
"paymentItemDescription": "Details1",
"xPosition": 201,
"yPosition": 158
}
],
"formulaTabs": [
{
"tabLabel": "PaymentReceipt 7a59b203-d9e8-4e3b-8b4d-776d8869cc30",
"roundDecimalPlaces": 0,
"formula": "([PaymentFixed 91684e58-85c6-4441-be08-efebac5476b8]) * 100",
"hidden": true,
"pageNumber": 1,
"paymentDetails": {
"currencyCode": "USD",
"gatewayAccountId": "1d0702f5-f317-4af7-835d-1c8769434fae",
"gatewayName": "Stripe",
"paymentOption": "save_and_authorize",
"lineItems": [
{
"amountReference": "PaymentFixed 91684e58-85c6-4441-be08-efebac5476b8",
"name": "Name1",
"description": "Details1",
"itemCode": "Code1"
},
{
"amountReference": "PaymentFuture 53d3ce8e-a043-4d0a-93ff-37eee94d3555",
"name": "Monthly Payment $50",
"description": "Monthly Payment Desc",
"itemCode": "505050"
}
]
},
"recipientId": "88089475",
"documentId": "1",
"xPosition": 0,
"yPosition": 0
}
]
}
}
]
},
"sequence": "2"
}
]
}
],
"status": "sent",
"emailSubject": "Payment Authorize"
}