Sample Payload

This page provides example request payloads for submitting merchant onboarding applications.

Onboarding applications can be submitted with varying levels of detail depending on the integration flow. In all cases, applications that are sent directly to a signer must include fee information at the time of submission.

Fee values are rendered directly in the signing experience and cannot be edited once the application has been sent. As a result, applications submitted without fees cannot complete the signing process.

The examples below demonstrate a minimal but complete application payload that can successfully be sent to a signer, along with a reference view of the fee structure used within that payload.

Minimal Application Payload

A minimal application is intended for use cases where an integrator wants to initiate the onboarding process quickly by sending an application directly to a signer, rather than collecting full merchant details up front.

At a minimum, this payload must include:

• Merchant and partner identifiers

• Signer name and email

• Fee information that will be presented to the signer

Once submitted, the signer receives a DocuSign link containing the supplied fee details. These values cannot be changed after the application is created.

{
  "merchantName": "Test 20260117-0822",
  "partnerId": "6952be96ad796eff8c281e31",
  "partnerMid": "partner-test-20260117-0822",
  "signerName": "Test 20260117-0822",
  "signerEmail": "[email protected]",
  "feeInformation": {
    "achSettlementFixedFee": {
      "sellRate": 1
    },
    "wireSettlementFixedFee": {
      "sellRate": 20
    },
    "settlementReturnFixedFee": {
      "sellRate": 25
    },
    "monthlyMaintenanceFee": {
      "sellRate": 19.99
    },
    "cryptoFees": {
      "transactionRate": {
        "sellRate": 2.5
      },
      "perItemFee": {
        "sellRate": 0.25
      }
    },
    "digitalWalletsFees": [
      {
        "tenderType": "alipay",
        "paymentLocationType": "inStore",
        "transactionRate": {
          "sellRate": 3.1
        },
        "perItemFee": {
          "sellRate": 0.3
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      },
      {
        "tenderType": "alipay",
        "paymentLocationType": "online",
        "transactionRate": {
          "sellRate": 3.1
        },
        "perItemFee": {
          "sellRate": 0.3
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      },
      {
        "tenderType": "paypal",
        "paymentLocationType": "inStore",
        "transactionRate": {
          "sellRate": 2.29
        },
        "perItemFee": {
          "sellRate": 0.09
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      },
      {
        "tenderType": "paypal",
        "paymentLocationType": "online",
        "transactionRate": {
          "sellRate": 3.6
        },
        "perItemFee": {
          "sellRate": 0.49
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      },
      {
        "tenderType": "venmo",
        "paymentLocationType": "inStore",
        "transactionRate": {
          "sellRate": 2.29
        },
        "perItemFee": {
          "sellRate": 0.09
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      },
      {
        "tenderType": "venmo",
        "paymentLocationType": "online",
        "transactionRate": {
          "sellRate": 3.6
        },
        "perItemFee": {
          "sellRate": 0.49
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      },
      {
        "tenderType": "weChatPay",
        "paymentLocationType": "inStore",
        "transactionRate": {
          "sellRate": 3.1
        },
        "perItemFee": {
          "sellRate": 0.3
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      },
      {
        "tenderType": "weChatPay",
        "paymentLocationType": "online",
        "transactionRate": {
          "sellRate": 3.1
        },
        "perItemFee": {
          "sellRate": 0.3
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      },
      {
        "tenderType": "klarna",
        "paymentLocationType": "inStore",
        "transactionRate": {
          "sellRate": 5.79
        },
        "perItemFee": {
          "sellRate": 0.45
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      },
      {
        "tenderType": "klarna",
        "paymentLocationType": "online",
        "transactionRate": {
          "sellRate": 5.79
        },
        "perItemFee": {
          "sellRate": 0.45
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      }
    ]
  }
}

Fee Information Reference

The feeInformation object defines the pricing values displayed to the signer during the onboarding process. These values must be provided when creating applications that are sent directly to signing.

This section isolates the fee structure for easier reuse and reference.

{
  "feeInformation": {
    "achSettlementFixedFee": {
      "sellRate": 1
    },
    "wireSettlementFixedFee": {
      "sellRate": 20
    },
    "settlementReturnFixedFee": {
      "sellRate": 25
    },
    "monthlyMaintenanceFee": {
      "sellRate": 19.99
    },
    "cryptoFees": {
      "transactionRate": {
        "sellRate": 2.5
      },
      "perItemFee": {
        "sellRate": 0.25
      }
    },
    "digitalWalletsFees": [
      {
        "tenderType": "alipay",
        "paymentLocationType": "inStore",
        "transactionRate": {
          "sellRate": 3.1
        },
        "perItemFee": {
          "sellRate": 0.3
        },
        "refundFee": {
          "sellRate": 0
        },
        "chargebackFee": {
          "sellRate": 0
        }
      }
    ]
  }
}