POST api/WOInvoice/CreatetheHPPACHPaymentLinks

Create the HPP ACH Payment Links

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceID	integer	None.
PaymentAmount	decimal number	None.
CustomerName	string	None.
CustomerEmail	string	None.
APIKey	string	None.
SendMail	boolean	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "invoiceID": 1,
  "paymentAmount": 2.0,
  "customerName": "sample string 3",
  "customerEmail": "sample string 4",
  "apiKey": "sample string 5",
  "sendMail": true
}

application/xml, text/xml

Sample:

<HPPInvoiceLinkRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <APIKey>sample string 5</APIKey>
  <CustomerEmail>sample string 4</CustomerEmail>
  <CustomerName>sample string 3</CustomerName>
  <InvoiceID>1</InvoiceID>
  <PaymentAmount>2</PaymentAmount>
  <SendMail>true</SendMail>
</HPPInvoiceLinkRequestModel>

multipart/form-data

Sample:

<HPPInvoiceLinkRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><APIKey>sample string 5</APIKey><CustomerEmail>sample string 4</CustomerEmail><CustomerName>sample string 3</CustomerName><InvoiceID>1</InvoiceID><PaymentAmount>2</PaymentAmount><SendMail>true</SendMail></HPPInvoiceLinkRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel

Name	Type	Additional information
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>