| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentID | query | string | No | |
| PaymentIDStartsWith | query | string | No | |
| PaymentIDEndsWith | query | string | No | |
| PaymentIDContains | query | string | No | |
| PaymentIDLike | query | string | No | |
| PaymentIDBetween | query | string[] | No | |
| PaymentIDIn | query | string[] | No | |
| InvoiceHistoryID | query | string | No | |
| InvoiceHistoryIDStartsWith | query | string | No | |
| InvoiceHistoryIDEndsWith | query | string | No | |
| InvoiceHistoryIDContains | query | string | No | |
| InvoiceHistoryIDLike | query | string | No | |
| InvoiceHistoryIDBetween | query | string[] | No | |
| InvoiceHistoryIDIn | query | string[] | No | |
| InvoiceID | query | string | No | |
| InvoiceIDStartsWith | query | string | No | |
| InvoiceIDEndsWith | query | string | No | |
| InvoiceIDContains | query | string | No | |
| InvoiceIDLike | query | string | No | |
| InvoiceIDBetween | query | string[] | No | |
| InvoiceIDIn | query | string[] | No | |
| PaymentTypeID | query | string | No | |
| PaymentTypeIDStartsWith | query | string | No | |
| PaymentTypeIDEndsWith | query | string | No | |
| PaymentTypeIDContains | query | string | No | |
| PaymentTypeIDLike | query | string | No | |
| PaymentTypeIDBetween | query | string[] | No | |
| PaymentTypeIDIn | query | string[] | No | |
| PaymentRef | query | string | No | |
| PaymentRefStartsWith | query | string | No | |
| PaymentRefEndsWith | query | string | No | |
| PaymentRefContains | query | string | No | |
| PaymentRefLike | query | string | No | |
| PaymentRefBetween | query | string[] | No | |
| PaymentRefIn | query | string[] | No | |
| AmountPaid | query | decimal? | No | |
| AmountPaidGreaterThanOrEqualTo | query | decimal? | No | |
| AmountPaidGreaterThan | query | decimal? | No | |
| AmountPaidLessThan | query | decimal? | No | |
| AmountPaidLessThanOrEqualTo | query | decimal? | No | |
| AmountPaidNotEqualTo | query | decimal? | No | |
| AmountPaidBetween | query | Nullable<Decimal>[] | No | |
| AmountPaidIn | query | Nullable<Decimal>[] | No | |
| PaymentDate | query | DateTime? | No | |
| PaymentDateGreaterThanOrEqualTo | query | DateTime? | No | |
| PaymentDateGreaterThan | query | DateTime? | No | |
| PaymentDateLessThan | query | DateTime? | No | |
| PaymentDateLessThanOrEqualTo | query | DateTime? | No | |
| PaymentDateNotEqualTo | query | DateTime? | No | |
| PaymentDateBetween | query | DateTime[] | No | |
| PaymentDateIn | query | DateTime[] | No | |
| AuthorisationStatus | query | short? | No | |
| AuthorisationStatusGreaterThanOrEqualTo | query | short? | No | |
| AuthorisationStatusGreaterThan | query | short? | No | |
| AuthorisationStatusLessThan | query | short? | No | |
| AuthorisationStatusLessThanOrEqualTo | query | short? | No | |
| AuthorisationStatusNotEqualTo | query | short? | No | |
| AuthorisationStatusBetween | query | short[] | No | |
| AuthorisationStatusIn | query | short[] | No | |
| AuthorisationNumber | query | string | No | |
| AuthorisationNumberStartsWith | query | string | No | |
| AuthorisationNumberEndsWith | query | string | No | |
| AuthorisationNumberContains | query | string | No | |
| AuthorisationNumberLike | query | string | No | |
| AuthorisationNumberBetween | query | string[] | No | |
| AuthorisationNumberIn | query | string[] | No | |
| ProcessPayment | query | bool? | No | |
| Processed | query | bool? | No | |
| DBTransID | query | string | No | |
| DBTransIDStartsWith | query | string | No | |
| DBTransIDEndsWith | query | string | No | |
| DBTransIDContains | query | string | No | |
| DBTransIDLike | query | string | No | |
| DBTransIDBetween | query | string[] | No | |
| DBTransIDIn | query | string[] | No | |
| PaymentGatewayReturnCode | query | int? | No | |
| PaymentGatewayReturnCodeGreaterThanOrEqualTo | query | int? | No | |
| PaymentGatewayReturnCodeGreaterThan | query | int? | No | |
| PaymentGatewayReturnCodeLessThan | query | int? | No | |
| PaymentGatewayReturnCodeLessThanOrEqualTo | query | int? | No | |
| PaymentGatewayReturnCodeNotEqualTo | query | int? | No | |
| PaymentGatewayReturnCodeBetween | query | Nullable<Int32>[] | No | |
| PaymentGatewayReturnCodeIn | query | Nullable<Int32>[] | No | |
| PaymentGatewayReturnMessage | query | string | No | |
| PaymentGatewayReturnMessageStartsWith | query | string | No | |
| PaymentGatewayReturnMessageEndsWith | query | string | No | |
| PaymentGatewayReturnMessageContains | query | string | No | |
| PaymentGatewayReturnMessageLike | query | string | No | |
| PaymentGatewayReturnMessageBetween | query | string[] | No | |
| PaymentGatewayReturnMessageIn | query | string[] | No | |
| AmountTendered | query | decimal? | No | |
| AmountTenderedGreaterThanOrEqualTo | query | decimal? | No | |
| AmountTenderedGreaterThan | query | decimal? | No | |
| AmountTenderedLessThan | query | decimal? | No | |
| AmountTenderedLessThanOrEqualTo | query | decimal? | No | |
| AmountTenderedNotEqualTo | query | decimal? | No | |
| AmountTenderedBetween | query | Nullable<Decimal>[] | No | |
| AmountTenderedIn | query | Nullable<Decimal>[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentID | form | string | No | |
| InvoiceHistoryID | form | string | No | |
| InvoiceID | form | string | No | |
| PaymentTypeID | form | string | No | |
| PaymentRef | form | string | No | |
| AmountPaid | form | decimal? | No | |
| PaymentDate | form | DateTime | No | |
| AuthorisationStatus | form | short | No | |
| AuthorisationNumber | form | string | No | |
| ProcessPayment | form | bool | No | |
| Processed | form | bool | No | |
| DBTransID | form | string | No | |
| PaymentGatewayReturnCode | form | int? | No | |
| PaymentGatewayReturnMessage | form | string | No | |
| AmountTendered | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SO_PaymentsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
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: text/csv
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"}}}