GetPayment

Endpoint URL

https://www.yournetosite.com.au/do/WS/NetoAPI

Method

POST

XML Headers

NETOAPI_ACTION	GetPayment
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	GetPayment
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 get payment data. A successful call to GetPayment returns the data requested.

XSD Schema

GetPayment XSD | GetPayment Response XSD

GetPayment Post

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

XML POST

<?xml version="1.0" encoding="utf-8"?>
<GetPayment>
   <Filter> 
    <PaymentID>(Integer)</PaymentID>    
    <OrderID>(String)</OrderID>    
    <Page>(Integer)</Page>    
    <Limit>(Integer)</Limit>    
    <DatePaidFrom>(DateTime)</DatePaidFrom>    
    <DatePaidTo>(DateTime)</DatePaidTo>    
    <OutputSelector>ID</OutputSelector>    
    <OutputSelector>AmountPaid</OutputSelector>    
    <OutputSelector>CurrencyCode</OutputSelector>    
    <OutputSelector>DatePaid</OutputSelector>    
    <OutputSelector>DatePaidLocal</OutputSelector>    
    <OutputSelector>DatePaidUTC</OutputSelector>    
    <OutputSelector>PaymentMethod</OutputSelector>    
    <OutputSelector>PaymentMethodName</OutputSelector>    
    <OutputSelector>ProcessBy</OutputSelector>    
    <OutputSelector>AuthorisationMessage</OutputSelector>    
    <OutputSelector>CardHolder</OutputSelector>    
    <OutputSelector>CardExpiryDate</OutputSelector>    
    <OutputSelector>CardAuthorisation</OutputSelector>    
    <OutputSelector>AccountName</OutputSelector>    
    <OutputSelector>AccountBSB</OutputSelector>    
    <OutputSelector>PaymentNotes</OutputSelector>    
    <OutputSelector>AccountNumber</OutputSelector>    
    <OutputSelector>ChequeNumber</OutputSelector>    
   </Filter>
</GetPayment>

JSON POST

{
  "Filter": {
    "PaymentID":["Integer"/*, ...*/],
    "OrderID":["String"/*, ...*/],
    "Page":"Integer",
    "Limit":"Integer",
    "DatePaidFrom":"DateTime",
    "DatePaidTo":"DateTime",
    "OutputSelector":["Enumeration"/*, ...*/] 
} 
}

<Filter>

Element Name	Required	Field Type / Options
PaymentID	Optional Supports Multiple Elements	Integer
OrderID	Optional Supports Multiple Elements	String(15)
Page	Optional	Integer
Limit	Optional	Integer
DatePaidFrom	Optional	DateTime
DatePaidTo	Optional	DateTime

<OutputSelector>

Determines what is returned by the POST. Refer to the example response below this table or the related XSD schema for details and restrictions of each output element.

Note: Each OutputSelector should be a separate element in your post.

OutputSelector	Enumeration (ID, AmountPaid, CurrencyCode, DatePaid, DatePaidLocal, DatePaidUTC, PaymentMethod, PaymentMethodName, ProcessBy, AuthorisationMessage, CardHolder, CardExpiryDate, CardAuthorisation, AccountName, AccountBSB, PaymentNotes, AccountNumber, ChequeNumber)

GetPayment Responses

XML Response

<?xml version="1.0" encoding="utf-8"?>
<GetPayment>
   <Payment> 
    <ID>(Integer)</ID>    
    <PaymentID>(Integer)</PaymentID>    
    <OrderID>(String)</OrderID>    
    <AmountPaid>(Decimal)</AmountPaid>    
    <CurrencyCode>(String)</CurrencyCode>    
    <DatePaid>(DateTime)</DatePaid>    
    <DatePaidLocal>(DateTime)</DatePaidLocal>    
    <DatePaidUTC>(DateTime)</DatePaidUTC>    
    <PaymentMethod>(String)</PaymentMethod>    
    <PaymentMethodName>(String)</PaymentMethodName>    
    <ProcessBy>(String)</ProcessBy>    
    <AuthorisationMessage>(String)</AuthorisationMessage>    
    <CardHolder>(String)</CardHolder>    
    <CardExpiryDate>(String)</CardExpiryDate>    
    <CardAuthorisation>(String)</CardAuthorisation>    
    <AccountName>(String)</AccountName>    
    <AccountBSB>(String)</AccountBSB>    
    <AccountNumber>(String)</AccountNumber>    
    <ChequeNumber>(String)</ChequeNumber>    
    <PaymentNotes>(String)</PaymentNotes>    
   </Payment>  

</GetPayment>

JSON Response

{
  "Payment": [ {
    "ID":"Integer",
    "PaymentID":"Integer",
    "OrderID":"String",
    "AmountPaid":"Decimal",
    "CurrencyCode":"String",
    "DatePaid":"DateTime",
    "DatePaidLocal":"DateTime",
    "DatePaidUTC":"DateTime",
    "PaymentMethod":"String",
    "PaymentMethodName":"String",
    "ProcessBy":"String",
    "AuthorisationMessage":"String",
    "CardHolder":"String",
    "CardExpiryDate":"String",
    "CardAuthorisation":"String",
    "AccountName":"String",
    "AccountBSB":"String",
    "AccountNumber":"String",
    "ChequeNumber":"String",
    "PaymentNotes":"String" 
} ] 
}

<Payment>

Element Name	Field Type
ID	Integer
PaymentID	Integer
OrderID	String
AmountPaid	Decimal
CurrencyCode	String
DatePaid	DateTime
DatePaidLocal	DateTime
DatePaidUTC	DateTime
PaymentMethod	String
PaymentMethodName	String
ProcessBy	String
AuthorisationMessage	String
CardHolder	String
CardExpiryDate	String
CardAuthorisation	String
AccountName	String
AccountBSB	String
AccountNumber	String
ChequeNumber	String
PaymentNotes	String