Syntch Gateway API

GetOpenAuthorizations

Reporting - Open Authorizations

**Requires Authentication**
Requires any of the roles:	Reseller, Merchant

The following routes are available for this service:
GET	/reports/openauthorizations/	Get a list of open authorization transactions.

**GetOpenAuthorizations** Parameters:
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 CREDIT VISA DINERS AMEX MASTERCARD JAL JCB DISCOVER CARTEBLANCHE EBT DEBIT ECG VERIFY ECHECK
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 TransactionId TransactionTimestamp Username PaymentType CardHolderName ProcessorID AuthorizedAmount

**SortedRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
SortDirection	query	string	No	The direction in which the records will be sorted. Default is 'asc'. Allowable Values Asc Desc
SortField	query	string	No	The field name by which the records will be sorted.

**PaginatedRequestDto** Parameters:
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.

**OpenAuthorizationResults** Parameters:
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.

**OpenAuthorizationTransaction** Parameters:
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

**PaginationStats** Parameters:
Name	Parameter	Data Type	Required
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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OpenAuthorizationResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Reporting.Responses">
  <OpenAuthorizations>
    <OpenAuthorizationTransaction>
      <AccountLast4>String</AccountLast4>
      <AuthorizationCode>String</AuthorizationCode>
      <AuthorizedAmount>String</AuthorizedAmount>
      <CardHolderName>String</CardHolderName>
      <ExpirationDate>String</ExpirationDate>
      <HostReferenceNumber>String</HostReferenceNumber>
      <InvoiceNumber>String</InvoiceNumber>
      <MerchantKey>String</MerchantKey>
      <MerchantName>String</MerchantName>
      <PaymentType>String</PaymentType>
      <ProcessorID>String</ProcessorID>
      <ResellerKey>0</ResellerKey>
      <ResellerName>String</ResellerName>
      <ResultCode>String</ResultCode>
      <ResultText>String</ResultText>
      <Service>String</Service>
      <TransactionId>0</TransactionId>
      <TransactionTimestamp>String</TransactionTimestamp>
      <TransactionType>String</TransactionType>
      <Username>String</Username>
    </OpenAuthorizationTransaction>
  </OpenAuthorizations>
  <Pagination xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.Infrastructure.Common">
    <d2p1:CurrentPageNumber>0</d2p1:CurrentPageNumber>
    <d2p1:PageSize>0</d2p1:PageSize>
    <d2p1:TotalRecordCount>0</d2p1:TotalRecordCount>
  </Pagination>
</OpenAuthorizationResults>

Syntch Gateway API

GetOpenAuthorizations

Allowable Values

Allowable Values

Allowable Values

HTTP + XML