JiwaAPI

<back to all web services

SO_PaymentsQuery

Requires Authentication
SO_PaymentsQuery Parameters:
NameParameterData TypeRequiredDescription
PaymentIDquerystringNo
PaymentIDStartsWithquerystringNo
PaymentIDEndsWithquerystringNo
PaymentIDContainsquerystringNo
PaymentIDLikequerystringNo
PaymentIDBetweenquerystring[]No
PaymentIDInquerystring[]No
InvoiceHistoryIDquerystringNo
InvoiceHistoryIDStartsWithquerystringNo
InvoiceHistoryIDEndsWithquerystringNo
InvoiceHistoryIDContainsquerystringNo
InvoiceHistoryIDLikequerystringNo
InvoiceHistoryIDBetweenquerystring[]No
InvoiceHistoryIDInquerystring[]No
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
PaymentTypeIDquerystringNo
PaymentTypeIDStartsWithquerystringNo
PaymentTypeIDEndsWithquerystringNo
PaymentTypeIDContainsquerystringNo
PaymentTypeIDLikequerystringNo
PaymentTypeIDBetweenquerystring[]No
PaymentTypeIDInquerystring[]No
PaymentRefquerystringNo
PaymentRefStartsWithquerystringNo
PaymentRefEndsWithquerystringNo
PaymentRefContainsquerystringNo
PaymentRefLikequerystringNo
PaymentRefBetweenquerystring[]No
PaymentRefInquerystring[]No
AmountPaidquerydecimal?No
AmountPaidGreaterThanOrEqualToquerydecimal?No
AmountPaidGreaterThanquerydecimal?No
AmountPaidLessThanquerydecimal?No
AmountPaidLessThanOrEqualToquerydecimal?No
AmountPaidNotEqualToquerydecimal?No
AmountPaidBetweenqueryNullable<Decimal>[]No
AmountPaidInqueryNullable<Decimal>[]No
PaymentDatequeryDateTime?No
PaymentDateGreaterThanOrEqualToqueryDateTime?No
PaymentDateGreaterThanqueryDateTime?No
PaymentDateLessThanqueryDateTime?No
PaymentDateLessThanOrEqualToqueryDateTime?No
PaymentDateNotEqualToqueryDateTime?No
PaymentDateBetweenqueryDateTime[]No
PaymentDateInqueryDateTime[]No
AuthorisationStatusqueryshort?No
AuthorisationStatusGreaterThanOrEqualToqueryshort?No
AuthorisationStatusGreaterThanqueryshort?No
AuthorisationStatusLessThanqueryshort?No
AuthorisationStatusLessThanOrEqualToqueryshort?No
AuthorisationStatusNotEqualToqueryshort?No
AuthorisationStatusBetweenqueryshort[]No
AuthorisationStatusInqueryshort[]No
AuthorisationNumberquerystringNo
AuthorisationNumberStartsWithquerystringNo
AuthorisationNumberEndsWithquerystringNo
AuthorisationNumberContainsquerystringNo
AuthorisationNumberLikequerystringNo
AuthorisationNumberBetweenquerystring[]No
AuthorisationNumberInquerystring[]No
ProcessPaymentquerybool?No
Processedquerybool?No
DBTransIDquerystringNo
DBTransIDStartsWithquerystringNo
DBTransIDEndsWithquerystringNo
DBTransIDContainsquerystringNo
DBTransIDLikequerystringNo
DBTransIDBetweenquerystring[]No
DBTransIDInquerystring[]No
PaymentGatewayReturnCodequeryint?No
PaymentGatewayReturnCodeGreaterThanOrEqualToqueryint?No
PaymentGatewayReturnCodeGreaterThanqueryint?No
PaymentGatewayReturnCodeLessThanqueryint?No
PaymentGatewayReturnCodeLessThanOrEqualToqueryint?No
PaymentGatewayReturnCodeNotEqualToqueryint?No
PaymentGatewayReturnCodeBetweenqueryNullable<Int32>[]No
PaymentGatewayReturnCodeInqueryNullable<Int32>[]No
PaymentGatewayReturnMessagequerystringNo
PaymentGatewayReturnMessageStartsWithquerystringNo
PaymentGatewayReturnMessageEndsWithquerystringNo
PaymentGatewayReturnMessageContainsquerystringNo
PaymentGatewayReturnMessageLikequerystringNo
PaymentGatewayReturnMessageBetweenquerystring[]No
PaymentGatewayReturnMessageInquerystring[]No
AmountTenderedquerydecimal?No
AmountTenderedGreaterThanOrEqualToquerydecimal?No
AmountTenderedGreaterThanquerydecimal?No
AmountTenderedLessThanquerydecimal?No
AmountTenderedLessThanOrEqualToquerydecimal?No
AmountTenderedNotEqualToquerydecimal?No
AmountTenderedBetweenqueryNullable<Decimal>[]No
AmountTenderedInqueryNullable<Decimal>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_Payments Parameters:
NameParameterData TypeRequiredDescription
PaymentIDformstringNo
InvoiceHistoryIDformstringNo
InvoiceIDformstringNo
PaymentTypeIDformstringNo
PaymentRefformstringNo
AmountPaidformdecimal?No
PaymentDateformDateTimeNo
AuthorisationStatusformshortNo
AuthorisationNumberformstringNo
ProcessPaymentformboolNo
ProcessedformboolNo
DBTransIDformstringNo
PaymentGatewayReturnCodeformint?No
PaymentGatewayReturnMessageformstringNo
AmountTenderedformdecimal?No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/SO_PaymentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PaymentID":"String","PaymentIDStartsWith":"String","PaymentIDEndsWith":"String","PaymentIDContains":"String","PaymentIDLike":"String","PaymentIDBetween":["String"],"PaymentIDIn":["String"],"InvoiceHistoryID":"String","InvoiceHistoryIDStartsWith":"String","InvoiceHistoryIDEndsWith":"String","InvoiceHistoryIDContains":"String","InvoiceHistoryIDLike":"String","InvoiceHistoryIDBetween":["String"],"InvoiceHistoryIDIn":["String"],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"PaymentTypeID":"String","PaymentTypeIDStartsWith":"String","PaymentTypeIDEndsWith":"String","PaymentTypeIDContains":"String","PaymentTypeIDLike":"String","PaymentTypeIDBetween":["String"],"PaymentTypeIDIn":["String"],"PaymentRef":"String","PaymentRefStartsWith":"String","PaymentRefEndsWith":"String","PaymentRefContains":"String","PaymentRefLike":"String","PaymentRefBetween":["String"],"PaymentRefIn":["String"],"AmountPaid":0,"AmountPaidGreaterThanOrEqualTo":0,"AmountPaidGreaterThan":0,"AmountPaidLessThan":0,"AmountPaidLessThanOrEqualTo":0,"AmountPaidNotEqualTo":0,"AmountPaidBetween":[0],"AmountPaidIn":[0],"PaymentDate":"0001-01-01T00:00:00.0000000","PaymentDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","PaymentDateGreaterThan":"0001-01-01T00:00:00.0000000","PaymentDateLessThan":"0001-01-01T00:00:00.0000000","PaymentDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","PaymentDateNotEqualTo":"0001-01-01T00:00:00.0000000","PaymentDateBetween":["0001-01-01T00:00:00.0000000"],"PaymentDateIn":["0001-01-01T00:00:00.0000000"],"AuthorisationStatus":0,"AuthorisationStatusGreaterThanOrEqualTo":0,"AuthorisationStatusGreaterThan":0,"AuthorisationStatusLessThan":0,"AuthorisationStatusLessThanOrEqualTo":0,"AuthorisationStatusNotEqualTo":0,"AuthorisationStatusBetween":[0],"AuthorisationStatusIn":[0],"AuthorisationNumber":"String","AuthorisationNumberStartsWith":"String","AuthorisationNumberEndsWith":"String","AuthorisationNumberContains":"String","AuthorisationNumberLike":"String","AuthorisationNumberBetween":["String"],"AuthorisationNumberIn":["String"],"ProcessPayment":false,"Processed":false,"DBTransID":"String","DBTransIDStartsWith":"String","DBTransIDEndsWith":"String","DBTransIDContains":"String","DBTransIDLike":"String","DBTransIDBetween":["String"],"DBTransIDIn":["String"],"PaymentGatewayReturnCode":0,"PaymentGatewayReturnCodeGreaterThanOrEqualTo":0,"PaymentGatewayReturnCodeGreaterThan":0,"PaymentGatewayReturnCodeLessThan":0,"PaymentGatewayReturnCodeLessThanOrEqualTo":0,"PaymentGatewayReturnCodeNotEqualTo":0,"PaymentGatewayReturnCodeBetween":[0],"PaymentGatewayReturnCodeIn":[0],"PaymentGatewayReturnMessage":"String","PaymentGatewayReturnMessageStartsWith":"String","PaymentGatewayReturnMessageEndsWith":"String","PaymentGatewayReturnMessageContains":"String","PaymentGatewayReturnMessageLike":"String","PaymentGatewayReturnMessageBetween":["String"],"PaymentGatewayReturnMessageIn":["String"],"AmountTendered":0,"AmountTenderedGreaterThanOrEqualTo":0,"AmountTenderedGreaterThan":0,"AmountTenderedLessThan":0,"AmountTenderedLessThanOrEqualTo":0,"AmountTenderedNotEqualTo":0,"AmountTenderedBetween":[0],"AmountTenderedIn":[0],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"PaymentID":"String","InvoiceHistoryID":"String","InvoiceID":"String","PaymentTypeID":"String","PaymentRef":"String","AmountPaid":0,"AuthorisationNumber":"String","DBTransID":"String","PaymentGatewayReturnCode":0,"PaymentGatewayReturnMessage":"String","AmountTendered":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}