POST api/PaymentSetup/WireAddUpdate

Add/Update Wire Configuration.

Request Information

URI Parameters

None.

Body Parameters

WireConfig
NameDescriptionTypeAdditional information
DocumentId

Unique Document Id - Not required

integer

None.
ClientId

Client Id

integer

None.
VendorCode

Vendor Code - Required, 50 character max

string

None.
PayeeName

Payee Name - Required, 35 charater max

string

None.
Address1

Address Line 1 - Required, 35 character max

string

None.
Address2

Address Line 2 - Not Required, 35 character max

string

None.
City

City - Required, 32 character max

string

None.
State

State - Required, 32 character max (Expecting abbrieviation for state)

string

None.
Zip

Zip Code - Required, 11 character max

string

None.
Country

Country - Required, 3 character max (Expecting abbreviation for country)

string

None.
AccountType

Account Type - Required, 50 character max

string

None.
AccountID

Account ID - Required, 34 character max

string

None.
BankName

Bank Name - Not Required, 35 character max

string

None.
BankType

Bank Type - Required, 80 character max

string

None.
BankID

Bank ID - Required, 34 character max

string

None.
BankAddress1

Bank Address Line 1 - Not Required, 35 character max

string

None.
BankAddress2

Bank Address Line 2 - Not Required, 35 character max

string

None.
BankCountry

Bank Country - Required, 3 character max (Expecting abbreviation for country)

string

None.
IsInternational

Is International - Not Required

boolean

None.
IsValid

Is Valid - Not Required

boolean

None.
IsApproved

Is Approved - Not Required

boolean

None.
IntermediateBankType1

Intermediate Bank Type 1 - Not Required, 35 character max

string

None.
IntermediateBankID1

Intermediate Bank ID 1 - Not Required, 35 character max

string

None.
IntermediateBankType2

Intermediate Bank Type 2 - Not Required, 35 character max

string

None.
IntermediateBankID2

Intermediate Bank ID 2 - Not Required, 35 character max

string

None.
RefBeneficiary1

Reference Beneficiary 1 - Not Required, 35 character max

string

None.
RefBeneficiary2

Reference Beneficiary 2 - Not Required, 35 character max

string

None.
RefBeneficiary3

Reference Beneficiary 3 - Not Required, 35 character max

string

None.
RefBeneficiary4

Reference Beneficiary 4 - Not Required, 35 character max

string

None.
RefBank1

Reference Bank 1 - Not Required, 35 character max

string

None.
RefBank2

Reference Bank 2 - Not Required, 35 character max

string

None.
RefBank3

Reference Bank 3 - Not Required, 35 character max

string

None.
RefBank4

Reference Bank 4 - Not Required, 35 character max

string

None.
ClientName

Client Name - Read Only

string

None.
CompanyCode

Company Code - Not Required, 50 character max

string

None.
CompanyName

Company Name - Read Only

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "DocumentId": 1,
  "ClientId": 2,
  "VendorCode": "sample string 3",
  "PayeeName": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "City": "sample string 7",
  "State": "sample string 8",
  "Zip": "sample string 9",
  "Country": "sample string 10",
  "AccountType": "sample string 11",
  "AccountID": "sample string 12",
  "BankName": "sample string 13",
  "BankType": "sample string 14",
  "BankID": "sample string 15",
  "BankAddress1": "sample string 16",
  "BankAddress2": "sample string 17",
  "BankCountry": "sample string 18",
  "IsInternational": true,
  "IsValid": true,
  "IsApproved": true,
  "IntermediateBankType1": "sample string 22",
  "IntermediateBankID1": "sample string 23",
  "IntermediateBankType2": "sample string 24",
  "IntermediateBankID2": "sample string 25",
  "RefBeneficiary1": "sample string 26",
  "RefBeneficiary2": "sample string 27",
  "RefBeneficiary3": "sample string 28",
  "RefBeneficiary4": "sample string 29",
  "RefBank1": "sample string 30",
  "RefBank2": "sample string 31",
  "RefBank3": "sample string 32",
  "RefBank4": "sample string 33",
  "ClientName": "sample string 34",
  "CompanyCode": "sample string 35",
  "CompanyName": "sample string 36"
}

application/xml, text/xml

Sample: 
<PaymentSetupController.WireConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <AccountID>sample string 12</AccountID>
  <AccountType>sample string 11</AccountType>
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <BankAddress1>sample string 16</BankAddress1>
  <BankAddress2>sample string 17</BankAddress2>
  <BankCountry>sample string 18</BankCountry>
  <BankID>sample string 15</BankID>
  <BankName>sample string 13</BankName>
  <BankType>sample string 14</BankType>
  <City>sample string 7</City>
  <ClientId>2</ClientId>
  <ClientName>sample string 34</ClientName>
  <CompanyCode>sample string 35</CompanyCode>
  <CompanyName>sample string 36</CompanyName>
  <Country>sample string 10</Country>
  <DocumentId>1</DocumentId>
  <IntermediateBankID1>sample string 23</IntermediateBankID1>
  <IntermediateBankID2>sample string 25</IntermediateBankID2>
  <IntermediateBankType1>sample string 22</IntermediateBankType1>
  <IntermediateBankType2>sample string 24</IntermediateBankType2>
  <IsApproved>true</IsApproved>
  <IsInternational>true</IsInternational>
  <IsValid>true</IsValid>
  <PayeeName>sample string 4</PayeeName>
  <RefBank1>sample string 30</RefBank1>
  <RefBank2>sample string 31</RefBank2>
  <RefBank3>sample string 32</RefBank3>
  <RefBank4>sample string 33</RefBank4>
  <RefBeneficiary1>sample string 26</RefBeneficiary1>
  <RefBeneficiary2>sample string 27</RefBeneficiary2>
  <RefBeneficiary3>sample string 28</RefBeneficiary3>
  <RefBeneficiary4>sample string 29</RefBeneficiary4>
  <State>sample string 8</State>
  <VendorCode>sample string 3</VendorCode>
  <Zip>sample string 9</Zip>
</PaymentSetupController.WireConfig>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResult
NameDescriptionTypeAdditional information
IsValid

API call result

boolean

None.
Comments

Comments about the activities of the API call

string

None.
Errors

List of 0 to many errors encountered processing the API call

Collection of ErrorMessage

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsValid": true,
  "Comments": "sample string 2",
  "Errors": [
    {
      "Message": "sample string 1"
    },
    {
      "Message": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample: 
<APIResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
  <Comments>sample string 2</Comments>
  <Errors>
    <APIResult.ErrorMessage>
      <Message>sample string 1</Message>
    </APIResult.ErrorMessage>
    <APIResult.ErrorMessage>
      <Message>sample string 1</Message>
    </APIResult.ErrorMessage>
  </Errors>
  <IsValid>true</IsValid>
</APIResult>