| Requires any of the roles: | Reseller, Merchant |
| GET | /reports/openauthorizations/ | Get a list of open authorization transactions. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BeginDate | query | string | Yes | Beginning date of the open authorization query (defaults to 7 days ago). |
| EndDate | query | string | No | End date of the open authorization query (defaults to 'now'). |
| TransactionId | query | int | No | Filter by TransactionId. |
| Username | query | string | No | Filter by Username. |
| PaymentType | query | List<string> | No | Filter by PaymentType.Allowable Values
|
| ProcessorID | query | string | No | Filter by processor. |
| CardHolderName | query | string | No | Filter by card holder name. |
| AuthorizedAmount | query | decimal? | No | Filter by AuthAmount. |
| SortField | query | string | No | The field name by which the records will be sorted. Default is 'Timestamp'.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SortDirection | query | string | No | The direction in which the records will be sorted. Default is 'asc'.Allowable Values
|
| SortField | query | string | No | The field name by which the records will be sorted. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageSize | query | short | No | The number of records per page. Default is 20. |
| PageNumber | query | short | No | The page number to fetch. Default is 1. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OpenAuthorizations | model | List<OpenAuthorizationTransaction> | No | A collection of open authorizations. |
| Pagination | model | PaginationStats | No | Pagination stats regarding the result set. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransactionId | model | int | No | The Transaction Id (unique gateway identifier) of the transaction. |
| InvoiceNumber | form | string | No | |
| TransactionType | form | string | No | |
| TransactionTimestamp | form | string | No | |
| MerchantKey | form | string | No | |
| Username | form | string | No | |
| ResellerKey | form | int | No | |
| PaymentType | form | string | No | |
| ProcessorID | form | string | No | |
| AuthorizedAmount | form | string | No | |
| ResultCode | form | string | No | |
| AuthorizationCode | form | string | No | |
| HostReferenceNumber | form | string | No | |
| Service | form | string | No | |
| AccountLast4 | form | string | No | |
| CardHolderName | form | string | No | |
| ExpirationDate | form | string | No | |
| ResultText | form | string | No | |
| ResellerName | form | string | No | |
| MerchantName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CurrentPageNumber | form | int | No | |
| PageSize | form | int | No | |
| TotalRecordCount | form | int | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /reports/openauthorizations/ HTTP/1.1 Host: syntch.simpay.net Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"OpenAuthorizations":[{"TransactionId":0,"InvoiceNumber":"String","TransactionType":"String","TransactionTimestamp":"String","MerchantKey":"String","Username":"String","ResellerKey":0,"PaymentType":"String","ProcessorID":"String","AuthorizedAmount":"String","ResultCode":"String","AuthorizationCode":"String","HostReferenceNumber":"String","Service":"String","AccountLast4":"String","CardHolderName":"String","ExpirationDate":"String","ResultText":"String","ResellerName":"String","MerchantName":"String"}],"Pagination":{"CurrentPageNumber":0,"PageSize":0,"TotalRecordCount":0}}