Syntch Gateway API

GetSettlementDetail

Reporting - Settlement

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

The following routes are available for this service:
GET	/reports/settlements/{batchId}	Gets a list of detailed transaction data by batch id.

**GetSettlementDetail** Parameters:
Name	Parameter	Data Type	Required	Description
BatchId	path	string	Yes	The batch id to query.
SortField	query	string	No	The field name by which the records will be sorted. Default is 'BeginDate'. Allowable Values PnRef InvoiceNumber TransactionTimestamp AuthorizationTimestamp MerchantKey ResellerKey PaymentType TransactionType Processor

**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.

**TransactionDetailResults** Parameters:
Name	Parameter	Data Type	Required	Description
Transactions	model	List<TransactionDetail>	No	A collection of transactions for the designated batch.
Pagination	model	PaginationStats	No	Pagination stats regarding the result set.

**TransactionDetail** Parameters:
Name	Parameter	Data Type	Required	Description
PnRef	model	int	No	The PnRef (unique identifier) of the transaction.
InvoiceNumber	model	string	No	The invoice number submitted on the transaction.
SequenceNumber	model	string	No	The transaction's Sequence Number.
TransactionTimestamp	model	DateTime?	No	The timestamp of the transaction.
AuthorizationTimestamp	model	DateTime?	No	The timestamp of the authorization.
MerchantKey	model	int	No	Merchant key on the transaction.
UserName	model	string	No	Username that initiated the transaction.
RegisterNumber	model	string	No	Register used in the transaction.
ResellerKey	model	int?	No	Reseller key on the transaction.
PaymentType	model	string	No	Payment type used in the transaction.
TransactionType	model	string	No	The transaction type processed (sale, return, etc.).
Processor	model	string	No	The processor of the transaction.
ProcessorError	model	string	No	The error set by the processor.
SettlementMessage	model	string	No	Settlement message.
VoidFlag	model	string	No	Indicates if the transaction has been voided.
SettleFlag	model	string	No	Indicates if the transaction has been settled.
SettlementTimestamp	model	DateTime?	No	The timestamp of the transaction's settlement
IP	model	string	No	IP address from which the transaction was processed.
CustomerId	model	string	No	Customer Id on the transaction.
CustomerKey	model	int?	No	Customer key on the transaction.
CustomerName	model	string	No	Customer Name on the transaction.
OriginalTransactionPnRef	model	int?	No	The PnRef of the original transaction (if this was a follow-on transaction).
CustomerReference	model	string	No	Additional customer reference.
BatchNumber	model	string	No	The batch number to which the transaction belongs.
BatchSequenceNumber	model	string	No	Sequence number of the batch.
Adjusted	model	string	No	Indicates if the transaction has been adjusted.
TransactionFinishTimestamp	model	DateTime?	No	The timestamp for the completion of the transaction.
ProcessorRequestTimestamp	model	DateTime?	No	The timestamp for beginning the processor communication.
ProcessorResponseTimestamp	model	DateTime?	No	The timestamp for ending the processor communication.
BatchId	model	string	No	The Id for the batch this transaction was a member of.
ReversalFlag	model	string	No	Indicates if the transaction has been reversed.
EntryMode	model	string	No	The entry mode of the transaction.
CardDetail	model	CardDetail	No	Selected details of the transaction's card data (if present).
CheckDetail	model	CheckDetail	No	Selected details of the transaction's check data (if present).
CashDetail	model	CashDetail	No	Selected details of the transaction's cash data (if present).
InvoiceDetail	model	InvoiceDetail	No	Selected details of the transaction's invoice (if present).
CustomFields	model	List<CustomField>	No	A collection of the transaction's custom field data (if present).
AssociatedTransactions	model	List<FilteredTransactionDetail>	No	The collection of transactions related to the transaction.
Tags	model	List<string>	No	A collection of the transaction's tag data (if present).

**CardDetail** Parameters:
Name	Parameter	Data Type	Required	Description
Token	model	string	No	The token stored as a result of the transaction.
MaskedPAN	model	string	No	The transaction's masked account number.
NameOnCard	model	string	No	The cardholder's name.
AuthorizationAmount	model	decimal	No	The amount of the authorization.
TipAmount	model	decimal	No	The Amount of the tip.
TotalAmount	model	decimal	No	The total amount of the transaction.
CashBackAmount	model	decimal	No	The amount of cash returned on the transaction.
SurchargeAmount	model	decimal	No	The surcharge amount.
AccountType	model	string	No	The type of card account.
ResultCode	model	string	No	The transaction's result code.
ResultText	model	string	No	The transaction's result text.
ApprovalCode	model	string	No	The transaction's approval code.
HostReferenceNumber	model	string	No	The transaction's processor reference number.
AvsResponse	model	string	No	The transaction's AVS response.
AvsResponseText	model	string	No	The transaction's AVS response message.
CvvResponse	model	string	No	The transaction's CVV response.
CvvResponseText	model	string	No	The transaction's CVV response message.
Level3Amount	model	decimal?	No	The transaction's level 3 amount.
CardExpiration	model	string	No	The card's expiration date.
Street	model	string	No	The street address associated with the card.
ZipCode	model	string	No	The zip code associated with the card.
ThreeDSPaayDetail	model	ThreeDSPaayDetail	No	The 3D Secure results, if any, on the card transaction.

**ThreeDSPaayDetail** Parameters:
Name	Parameter	Data Type	Required	Description
Status	model	string	No	The 3D Secure status, Y (yes, authenticated), A (attempted but protected), N (not authenticated, U (unavailable).
AcsTransId	model	string	No	ACS/Issuing Banks ID.
AuthValue	model	string	No	The 3D Secure Cardholder authentication verification value.
CardToken	model	string	No	The 3D Secure results, if any, on the card transaction.
DsTransId	model	string	No	3DS/Directory Server Transaction ID.
Eci	model	string	No	The 3D Secure E-commerce indicator. Values: '0', '1', '2', '5', '6', or '7'.
ProtocolVersion	model	string	No	The 3D Secure protocol version.

**CheckDetail** Parameters:
Name	Parameter	Data Type	Required	Description
Token	model	string	No	The token stored as a result of the transaction.
CheckNumber	model	string	No	Uniquely identifies an individual’s check.
AccountNumber	model	string	No	Uniquely identifies the check owner’s bank account.
RoutingNumber	model	string	No	Uniquely identifies the bank holding funds.
DriversLicenseNumber	model	string	No	Check owner’s driver’s license number.
SocialSecurityNumber	model	string	No	Check owner's social security numbe.r
DateOfBirth	model	string	No	Check owner's date of birth.
StateCode	model	string	No	Check owner’s two-character state code.
NameOnCheck	model	string	No	Name of the check owner.
EmailAddress	model	string	No	Email address of the check owner.
PhoneNumber	model	string	No	Phone number provided as check verification data.
CheckAmount	model	decimal	No	Total amount of the transaction.
ResultCode	model	string	No	Gateway result code.
ResultText	model	string	No	Description of the gateway result.
HostApproval	model	string	No	Approval code or host error.
HostReferenceNumber	model	string	No	Reference number provided by the processor.
ResultMessage	model	string	No	Processor result message.
SecondaryResultMessage	model	string	No	Additional result message detail (optional).
TertiaryResultMessage	model	string	No	Additional result message detail (optional).
AccountType	model	string	No	Type of account (checking/savings).
CheckType	model	string	No	The type of check used for the transaction.
SECCode	model	string	No	The Standard Entry Class code used for the transaction (if any).

**CashDetail** Parameters:
Name	Parameter	Data Type	Required	Description
CashAmount	model	decimal	No	The amount of the cash transaction.

**InvoiceDetail** Parameters:
Name	Parameter	Data Type	Required	Description
PurchaseOrderNumber	model	string	No	Purchase order number for the transaction.
ShippingAmount	model	decimal	No	Shipping amount for the transaction.
TaxAmount	model	decimal	No	Tax amount for the transaction.
DutyAmount	model	decimal	No	Duty amount for the transaction.
ConvenienceAmount	model	decimal	No	Convenience fee for the transaction.

**CustomField** Parameters:
Name	Parameter	Data Type	Required	Description
Key	model	int?	No	Gateway key for the custom field
Name	model	string	No	Name of the custom field as set by the merchant
Value	model	string	No	Value (if applicable) to store in the custom field

**FilteredTransactionDetail** Parameters:
Name	Parameter	Data Type	Required
TransactionId	form	int	No
MerchantKey	form	int	No
Timestamp	form	DateTime	No
PaymentType	form	string	No
TransactionType	form	string	No
Amount	form	decimal	No
Username	form	string	No
CustomerId	form	string	No
CustomerKey	form	int?	No
Payer	form	string	No
Result	form	string	No
SettleFlag	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/settlements/{batchId} HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml

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

<TransactionDetailResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Reporting.Responses">
  <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>
  <Transactions>
    <TransactionDetail>
      <Adjusted>String</Adjusted>
      <AssociatedTransactions xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Reporting.Responses.Statistics">
        <d4p1:FilteredTransactionDetail>
          <d4p1:Amount>0</d4p1:Amount>
          <d4p1:CustomerId>String</d4p1:CustomerId>
          <d4p1:CustomerKey>0</d4p1:CustomerKey>
          <d4p1:MerchantKey>0</d4p1:MerchantKey>
          <d4p1:Payer>String</d4p1:Payer>
          <d4p1:PaymentType>String</d4p1:PaymentType>
          <d4p1:Result>String</d4p1:Result>
          <d4p1:SettleFlag>String</d4p1:SettleFlag>
          <d4p1:Timestamp>0001-01-01T00:00:00</d4p1:Timestamp>
          <d4p1:TransactionId>0</d4p1:TransactionId>
          <d4p1:TransactionType>String</d4p1:TransactionType>
          <d4p1:Username>String</d4p1:Username>
        </d4p1: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:d4p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">
        <d4p1:CustomField>
          <d4p1:Key>0</d4p1:Key>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Value>String</d4p1:Value>
        </d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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>
  </Transactions>
</TransactionDetailResults>

Syntch Gateway API

GetSettlementDetail

Allowable Values

Allowable Values

HTTP + XML