Syntch Gateway API

<back to all web services

GetTransactions

Reporting - Transaction Detail
Requires Authentication
Requires any of the roles:Reseller, Merchant
The following routes are available for this service:
POST/reports/transactions/Get a list of transactions based on your search criteria.
GET/reports/transactions/Get a list of transactions based on your search criteria.
GetTransactions Parameters:
NameParameterData TypeRequiredDescription
BeginDatemodelstringYesBeginning date of the transaction record query.
EndDatemodelstringNoEnd date of the transaction record query.
TransactionTypemodelList<TransactionType>NoIf provided, only those transactions matching the TransactionTypes will be included.

Allowable Values

  • Authorization
  • Sale
  • Return
  • Void
  • Force
  • Capture
  • CaptureAll
  • RepeatSale
  • Adjustment
  • Activate
  • Deactivate
  • Redeem
  • Inquire
  • Reload
InvoiceNumbermodelstringNoThe invoice ID that was included in the original transaction. If provided, only those transactions with matching invoiceId will be included.
SettlementFlagmodelSettlementFlag?NoThe SettlementFlag parameter allows you to choose whether settled or unsettled transactions are included in the results.

Allowable Values

  • All
  • Unsettled
  • Settled
SettleBeginDatemodelstringNoBeginning date of the settlement search window.
SettleEndDatemodelstringNoEnd date of the settlement search window.
SettleMessagemodelstringNoThe settlement ID or message returned from the host.
SettleStatusmodelSettleStatus?NoAllows you to choose whether settled or unsettled transactions are included in the results.
UsernamemodelstringNoThe user who originated the transactions. If provided, only those transactions created by the matching User will be included.
ResultCodemodelList<string>NoIf provided, only those transactions matching the Result will be included.
RegistermodelstringNoThe register (if applicable) on which the transaction was processed
ApprovalCodemodelstringNoThe approval code is a alphanumeric value generated by the issuing bank. This field may also be used by payment processors to return error messages. Note: Approval codes are not necessarily unique and there is potential (rare) for more than one record to be returned.
NameOnInstrumentmodelstringNoFor card transactions, this is the name on the card. For check transactions, this is the name on the check. If provided, only those transactions with a matching instrument name will be included.
CustomerIdmodelstringNoMerchant-assigned identifier of the customer associated with the transaction(s)
ContractIdmodelstringNoMerchant-assigned identifier of the contract associated with the transaction(s)
ContractKeymodelint?NoSystem-assigned identifier of the contract associated with the transaction(s)
SortFieldmodelstringNoThe field name by which the records will be sorted. Default is 'BeginDate'.

Allowable Values

  • PnRef
  • InvoiceNumber
  • TransactionTimestamp
  • AuthorizationTimestamp
  • MerchantKey
  • ResellerKey
  • PaymentType
  • TransactionType
  • Processor
CustomFieldsmodelCustomField[]NoCustom field value(s) used to filter query results
TotalAmountMaxmodeldecimal?NoSpecifies the maximum amount value of the transactions being searched for. In DDDDDD.CC format
TotalAmountMinmodeldecimal?NoSpecifies the minimum amount value of the transactions being searched for. In DDDDDD.CC format
PaymentTypemodelList<PaymentType>NoIf provided, only those transactions matching the Payment Type will be included.

Allowable Values

  • VISA
  • DINERS
  • AMEX
  • MASTERCARD
  • JAL
  • JCB
  • DISCOVER
  • CARTEBLANCHE
  • EBT
  • LOYALTY
  • DEBIT
  • ECG
  • CASH
  • VERIFY
  • ECHECK
CardNumbermodelstringNoIf provided, only those transactions with an exact Card Number match will be included.
CheckTypemodelList<CheckType>NoIf provided, only those transactions matching the Check Type will be included.

Allowable Values

  • Business
  • Personal
CheckAccountTypemodelList<CheckAccountType>NoIf provided, only those transactions matching the Check Account Type will be included.

Allowable Values

  • Checking
  • Savings
CheckAccountNumbermodelint?NoIf provided, only those transactions with an exact Check Account Number match will be included.
CheckRoutingNumbermodelint?NoIf provided, only those transactions with an exact Check Routing Number match will be included.
SortedRequestDto Parameters:
NameParameterData TypeRequiredDescription
SortDirectionquerystringNoThe direction in which the records will be sorted. Default is 'asc'.

Allowable Values

  • Asc
  • Desc
SortFieldquerystringNoThe field name by which the records will be sorted.
PaginatedRequestDto Parameters:
NameParameterData TypeRequiredDescription
PageSizequeryshortNoThe number of records per page. Default is 20.
PageNumberqueryshortNoThe page number to fetch. Default is 1.
TransactionType Enum:
Void
Settle
SettleAll
Reversal
Refund
Sale
AuthOnly
OfflineAuth
CardVerify
AuthCapture
Adjustment
RepeatSale
BalanceInquire
SettlementFlag Enum:
NameValue
Unsettled0
Settled1
All99
SettleStatus Enum:
open
settled
rolledBack
CustomField Parameters:
NameParameterData TypeRequiredDescription
Keymodelint?NoGateway key for the custom field
NamemodelstringNoName of the custom field as set by the merchant
ValuemodelstringNoValue (if applicable) to store in the custom field
PaymentType Enum:
VISA
DINERS
AMEX
MASTERCARD
JAL
JCB
DISCOVER
CARTEBLANCHE
EBT
LOYALTY
DEBIT
ECG
CASH
VERIFY
ECHECK
CheckType Enum:
NameValue
Personal1
Business2
CheckAccountType Enum:
NameValue
Checking1
Savings2

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.

POST /reports/transactions/ HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetTransactions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Reporting.Requests">
  <PageNumber xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">0</PageNumber>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">0</PageSize>
  <SortDirection xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">String</SortDirection>
  <SortField xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">String</SortField>
  <ApprovalCode>String</ApprovalCode>
  <BeginDate>0001-01-01T00:00:00</BeginDate>
  <CardNumber>String</CardNumber>
  <CheckAccountNumber>0</CheckAccountNumber>
  <CheckAccountType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.Infrastructure.Common">
    <d2p1:CheckAccountType>Checking</d2p1:CheckAccountType>
  </CheckAccountType>
  <CheckRoutingNumber>0</CheckRoutingNumber>
  <CheckType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.Infrastructure.Common">
    <d2p1:CheckType>Personal</d2p1:CheckType>
  </CheckType>
  <ContractId>String</ContractId>
  <ContractKey>0</ContractKey>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">
    <d2p1:CustomField>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:CustomField>
  </CustomFields>
  <CustomerId>String</CustomerId>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <InvoiceNumber>String</InvoiceNumber>
  <NameOnInstrument>String</NameOnInstrument>
  <PaymentType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.Enumerations">
    <d2p1:PaymentType>VISA</d2p1:PaymentType>
  </PaymentType>
  <Register>String</Register>
  <ResultCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ResultCode>
  <SettleBeginDate>0001-01-01T00:00:00</SettleBeginDate>
  <SettleEndDate>0001-01-01T00:00:00</SettleEndDate>
  <SettleMessage>String</SettleMessage>
  <SettleStatus>open</SettleStatus>
  <SettlementFlag>Unsettled</SettlementFlag>
  <TotalAmountMax>0</TotalAmountMax>
  <TotalAmountMin>0</TotalAmountMin>
  <TransactionType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.Enumerations">
    <d2p1:TransactionType>Authorization</d2p1:TransactionType>
  </TransactionType>
  <Username>String</Username>
</GetTransactions>

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

<ArrayOfTransactionDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Reporting.Responses">
  <TransactionDetail>
    <Adjusted>String</Adjusted>
    <AssociatedTransactions xmlns:d3p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Reporting.Responses.Statistics">
      <d3p1:FilteredTransactionDetail>
        <d3p1:Amount>0</d3p1:Amount>
        <d3p1:CustomerId>String</d3p1:CustomerId>
        <d3p1:CustomerKey>0</d3p1:CustomerKey>
        <d3p1:MerchantKey>0</d3p1:MerchantKey>
        <d3p1:Payer>String</d3p1:Payer>
        <d3p1:PaymentType>String</d3p1:PaymentType>
        <d3p1:Result>String</d3p1:Result>
        <d3p1:SettleFlag>String</d3p1:SettleFlag>
        <d3p1:Timestamp>0001-01-01T00:00:00</d3p1:Timestamp>
        <d3p1:TransactionId>0</d3p1:TransactionId>
        <d3p1:TransactionType>String</d3p1:TransactionType>
        <d3p1:Username>String</d3p1:Username>
      </d3p1:FilteredTransactionDetail>
    </AssociatedTransactions>
    <AuthorizationTimestamp>0001-01-01T00:00:00</AuthorizationTimestamp>
    <BatchId>String</BatchId>
    <BatchNumber>String</BatchNumber>
    <BatchSequenceNumber>String</BatchSequenceNumber>
    <CardDetail>
      <AccountType>String</AccountType>
      <ApprovalCode>String</ApprovalCode>
      <AuthorizationAmount>0</AuthorizationAmount>
      <AvsResponse>String</AvsResponse>
      <AvsResponseText>String</AvsResponseText>
      <CardExpiration>String</CardExpiration>
      <CashBackAmount>0</CashBackAmount>
      <CvvResponse>String</CvvResponse>
      <CvvResponseText>String</CvvResponseText>
      <HostReferenceNumber>String</HostReferenceNumber>
      <Level3Amount>0</Level3Amount>
      <MaskedPAN>String</MaskedPAN>
      <NameOnCard>String</NameOnCard>
      <ResultCode>String</ResultCode>
      <ResultText>String</ResultText>
      <Street>String</Street>
      <SurchargeAmount>0</SurchargeAmount>
      <ThreeDSPaayDetail>
        <AcsTransId>String</AcsTransId>
        <AuthValue>String</AuthValue>
        <CardToken>String</CardToken>
        <DsTransId>String</DsTransId>
        <Eci>String</Eci>
        <ProtocolVersion>String</ProtocolVersion>
        <Status>String</Status>
      </ThreeDSPaayDetail>
      <TipAmount>0</TipAmount>
      <Token>String</Token>
      <TotalAmount>0</TotalAmount>
      <ZipCode>String</ZipCode>
    </CardDetail>
    <CashDetail>
      <CashAmount>0</CashAmount>
    </CashDetail>
    <CheckDetail>
      <AccountNumber>String</AccountNumber>
      <AccountType>String</AccountType>
      <CheckAmount>0</CheckAmount>
      <CheckNumber>String</CheckNumber>
      <CheckType>String</CheckType>
      <DateOfBirth>String</DateOfBirth>
      <DriversLicenseNumber>String</DriversLicenseNumber>
      <EmailAddress>String</EmailAddress>
      <HostApproval>String</HostApproval>
      <HostReferenceNumber>String</HostReferenceNumber>
      <NameOnCheck>String</NameOnCheck>
      <PhoneNumber>String</PhoneNumber>
      <ResultCode>String</ResultCode>
      <ResultMessage>String</ResultMessage>
      <ResultText>String</ResultText>
      <RoutingNumber>String</RoutingNumber>
      <SECCode>String</SECCode>
      <SecondaryResultMessage>String</SecondaryResultMessage>
      <SocialSecurityNumber>String</SocialSecurityNumber>
      <StateCode>String</StateCode>
      <TertiaryResultMessage>String</TertiaryResultMessage>
      <Token>String</Token>
    </CheckDetail>
    <CustomFields xmlns:d3p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">
      <d3p1:CustomField>
        <d3p1:Key>0</d3p1:Key>
        <d3p1:Name>String</d3p1:Name>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:CustomField>
    </CustomFields>
    <CustomerId>String</CustomerId>
    <CustomerKey>0</CustomerKey>
    <CustomerName>String</CustomerName>
    <CustomerReference>String</CustomerReference>
    <EntryMode>String</EntryMode>
    <IP>String</IP>
    <InvoiceDetail>
      <ConvenienceAmount>0</ConvenienceAmount>
      <DutyAmount>0</DutyAmount>
      <PurchaseOrderNumber>String</PurchaseOrderNumber>
      <ShippingAmount>0</ShippingAmount>
      <TaxAmount>0</TaxAmount>
    </InvoiceDetail>
    <InvoiceNumber>String</InvoiceNumber>
    <MerchantKey>0</MerchantKey>
    <OriginalTransactionPnRef>0</OriginalTransactionPnRef>
    <PaymentType>String</PaymentType>
    <PnRef>0</PnRef>
    <Processor>String</Processor>
    <ProcessorError>String</ProcessorError>
    <ProcessorRequestTimestamp>0001-01-01T00:00:00</ProcessorRequestTimestamp>
    <ProcessorResponseTimestamp>0001-01-01T00:00:00</ProcessorResponseTimestamp>
    <RegisterNumber>String</RegisterNumber>
    <ResellerKey>0</ResellerKey>
    <ReversalFlag>String</ReversalFlag>
    <SequenceNumber>String</SequenceNumber>
    <SettleFlag>String</SettleFlag>
    <SettlementMessage>String</SettlementMessage>
    <SettlementTimestamp>0001-01-01T00:00:00</SettlementTimestamp>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Tags>
    <TransactionFinishTimestamp>0001-01-01T00:00:00</TransactionFinishTimestamp>
    <TransactionTimestamp>0001-01-01T00:00:00</TransactionTimestamp>
    <TransactionType>String</TransactionType>
    <UserName>String</UserName>
    <VoidFlag>String</VoidFlag>
  </TransactionDetail>
</ArrayOfTransactionDetail>