POST request/contract/precontract/esign/payment

Update docusign precontract Payment details

Request Information

URI Parameters

None.

Body Parameters

ContractPaymentInfo
NameDescriptionTypeAdditional information
AccountName

string

String length: inclusive between 0 and 100

AccountNumber

string

None.

BankAddress

AddressInfo

None.

BankManager

string

None.

BankReference

string

None.

BillingAddress

AddressInfo

None.

Consent

boolean

None.

Id

string

None.

PaymentAddressOptionId

byte

None.

PaymentMethodId

byte

None.

PaymentTermId

byte

None.

SortCode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "paymentAddressOptionId": 64,
  "paymentMethodId": 64,
  "paymentTermId": 64,
  "bankManager": "sample string 2",
  "bankAddress": {
    "line1": "sample string 1",
    "line2": "sample string 2",
    "city": "sample string 3",
    "county": "sample string 4",
    "postcode": "sample string 5"
  },
  "bankReference": "sample string 3",
  "billingAddress": {
    "line1": "sample string 1",
    "line2": "sample string 2",
    "city": "sample string 3",
    "county": "sample string 4",
    "postcode": "sample string 5"
  },
  "consent": true,
  "sortCode": "sample string 5",
  "accountNumber": "sample string 6",
  "accountName": "sample string 7"
}

text/html

Sample:
{"id":"sample string 1","paymentAddressOptionId":64,"paymentMethodId":64,"paymentTermId":64,"bankManager":"sample string 2","bankAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"bankReference":"sample string 3","billingAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"consent":true,"sortCode":"sample string 5","accountNumber":"sample string 6","accountName":"sample string 7"}

application/xml, text/xml

Sample:
<ContractPaymentInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.QuoteDto">
  <AccountName xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">sample string 7</AccountName>
  <AccountNumber xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">sample string 6</AccountNumber>
  <SortCode xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">sample string 5</SortCode>
  <BankAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:County>sample string 4</d2p1:County>
    <d2p1:Line1>sample string 1</d2p1:Line1>
    <d2p1:Line2>sample string 2</d2p1:Line2>
    <d2p1:Postcode>sample string 5</d2p1:Postcode>
  </BankAddress>
  <BankManager>sample string 2</BankManager>
  <BankReference>sample string 3</BankReference>
  <BillingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:County>sample string 4</d2p1:County>
    <d2p1:Line1>sample string 1</d2p1:Line1>
    <d2p1:Line2>sample string 2</d2p1:Line2>
    <d2p1:Postcode>sample string 5</d2p1:Postcode>
  </BillingAddress>
  <Consent>true</Consent>
  <Id>sample string 1</Id>
  <PaymentAddressOptionId>64</PaymentAddressOptionId>
  <PaymentMethodId>64</PaymentMethodId>
  <PaymentTermId>64</PaymentTermId>
</ContractPaymentInfo>

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>