AddPayment

Overview

Endpoint URL https://www.yournetosite.com.au/do/WS/NetoAPI
Method POST
XML Headers
NETOAPI_ACTION AddPayment
NETOAPI_USERNAME Your Neto Username (generate this in your Neto control panel)
NETOAPI_KEY Your Neto API Secure Key (generate this in your Neto control panel)
JSON Headers
NETOAPI_ACTION AddPayment
NETOAPI_USERNAME Your Neto Username (generate this in your Neto control panel)
NETOAPI_KEY Your Neto API Secure Key (generate this in your Neto control panel)
Accept application/json
Description Use this call to add a new payment to an order/invoice. A successful call to AddPayment returns the unique identifier (PaymentID) for the new payment, and the date and time the payment was added (CurrentTime)
XSD Schema AddPayment XSD   |   AddPayment Response XSD

Example - Add Multiple Payments in a Single Call

Post - XML

<?xml version="1.0" encoding="utf-8"?>
<AddPayment>
  <Payment>
    <OrderID>N100000</OrderID>
    <PaymentMethodName>Direct Deposit</PaymentMethodName>
    <CardAuthorisation>34628374623784</CardAuthorisation>
    <AmountPaid>99.95</AmountPaid>
    <DatePaid>2012-12-13</DatePaid>
  </Payment>
  <Payment>
    <OrderID>N100001</OrderID>
    <PaymentMethodName>Visa</PaymentMethodName>
    <CardAuthorisation>34628374623784</CardAuthorisation>
    <AmountPaid>99.95</AmountPaid>
    <DatePaid>2012-12-13</DatePaid>
  </Payment>
  <Payment>
    <OrderID>N100003</OrderID>
    <PaymentMethodName>Cheque</PaymentMethodName>
    <CardAuthorisation>34628374623784</CardAuthorisation>
    <AmountPaid>100.69</AmountPaid>
    <DatePaid>2012-12-13</DatePaid>
  </Payment>    
</AddPayment>

AddPayment Post

You must specify at least one filter and one OutputSelector in your AddPayment request. These will determine the results returned.

XML POST

<?xml version="1.0" encoding="utf-8"?>
<AddPayment>
   <Payment> 
    <OrderID>(String)</OrderID>    
    <PaymentMethodID>(Integer)</PaymentMethodID>    
    <PaymentMethodName>(String)</PaymentMethodName>    
    <CardAuthorisation>(String)</CardAuthorisation>    
    <AmountPaid>(Decimal)</AmountPaid>    
    <DatePaid>(Date)</DatePaid>    
     <TransactionNotes> 
       <TransactionNote> 
        <Title>(String)</Title>        
        <Description>(String)</Description>        
       </TransactionNote>      
     </TransactionNotes>   </Payment>  

</AddPayment>

JSON POST

{
  "Payment": [ {
    "OrderID":"String",
    "PaymentMethodID":"Integer",
    "PaymentMethodName":"String",
    "CardAuthorisation":"String",
    "AmountPaid":"Decimal",
    "DatePaid":"Date",
    "TransactionNotes": {
      "TransactionNote": [ {
        "Title":"String",
        "Description":"String" 
} ]  
}  
} ] 
}

<Payment>

Element Name Required Field Type / Options
OrderID Required String(15)
PaymentMethodID Optional Integer
PaymentMethodName Optional String(100)
CardAuthorisation Required String
AmountPaid Required Decimal
DatePaid Optional Date
TransactionNotes Optional TransactionNotesType

<TransactionNotes>

Element Name Required Field Type / Options
TransactionNote Optional
Supports Multiple Elements
TransactionNoteType

<TransactionNote>

Element Name Required Field Type / Options
Title Required String(150)
Description Required String(5000)

AddPayment Responses

XML Response

<?xml version="1.0" encoding="utf-8"?>
<AddPayment>
   <Payment> 
    <PaymentID>(Integer)</PaymentID>    
   </Payment>  
   <Messages> 
     <Error> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
      <Description>(String)</Description>      
     </Error>    
     <Warning> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
     </Warning>    
   </Messages>
</AddPayment>

JSON Response

{
  "Payment": [ {
    "PaymentID":"Integer" 
} ] ,  "Messages": {
    "Error": [ {
      "Message":"String",
      "SeverityCode":"String",
      "Description":"String" 
} ] ,    "Warning": [ {
      "Message":"String",
      "SeverityCode":"String" 
} ]  
} 
}

<Payment>

Element Name Field Type
PaymentID Integer

<Messages>

Element Name Field Type
Error ErrorType
Warning WarningType

<Error>

Element Name Field Type
Message String
SeverityCode String
Description String

<Warning>

Element Name Field Type
Message String
SeverityCode String

If you are a vendor creating an integration with neto, we would like to hear from you!

Contact Us

Was this article useful?

Be notified when this page is updated. Optional.