POST api/PaymentSetup/ACHAddUpdate

Add/Update ACH Configuration

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DocumentId	Unique Document Id - Not required	integer	None.
ClientId	Client Id - Required	integer	None.
VendorCode	Vendor Code - Required, 50 character max	string	None.
PayeeName	Payee Name - Required, 35 character 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 abbreviation for state)	string	None.
Zip	Zip - Required, 11 character max	string	None.
Country	Country - Required, 50 character max (Expecting abbrevition for country)	string	None.
AccountID	Account ID - Required, 34 character max	string	None.
AccountType	Account Type - Required, 80 character max	string	None.
BankType	Bank Type - Required, 80 character max	string	None.
BankID	Bank ID - Required, 34 character max	string	None.
BankName	Bank Name - Not Required, 35 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 abbreviated country)	string	None.
IsValid	Is Valid - Not required	boolean	None.
IsApproved	Is Approved - Not required	boolean	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",
  "AccountID": "sample string 11",
  "AccountType": "sample string 12",
  "BankType": "sample string 13",
  "BankID": "sample string 14",
  "BankName": "sample string 15",
  "BankAddress1": "sample string 16",
  "BankAddress2": "sample string 17",
  "BankCountry": "sample string 18",
  "IsValid": true,
  "IsApproved": true,
  "ClientName": "sample string 21",
  "CompanyCode": "sample string 22",
  "CompanyName": "sample string 23"
}

application/xml, text/xml

Sample:

<PaymentSetupController.ACHConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <AccountID>sample string 11</AccountID>
  <AccountType>sample string 12</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 14</BankID>
  <BankName>sample string 15</BankName>
  <BankType>sample string 13</BankType>
  <City>sample string 7</City>
  <ClientId>2</ClientId>
  <ClientName>sample string 21</ClientName>
  <CompanyCode>sample string 22</CompanyCode>
  <CompanyName>sample string 23</CompanyName>
  <Country>sample string 10</Country>
  <DocumentId>1</DocumentId>
  <IsApproved>true</IsApproved>
  <IsValid>true</IsValid>
  <PayeeName>sample string 4</PayeeName>
  <State>sample string 8</State>
  <VendorCode>sample string 3</VendorCode>
  <Zip>sample string 9</Zip>
</PaymentSetupController.ACHConfig>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResult

Name	Description	Type	Additional 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>