| Requires any of the roles: | Reseller, Merchant |
| GET | /reports/settlements/{batchId} | Gets a list of detailed transaction data by batch id. |
|---|
| 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
|
| 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 |
|---|---|---|---|---|
| Transactions | model | List<TransactionDetail> | No | A collection of transactions for the designated batch. |
| Pagination | model | PaginationStats | No | Pagination stats regarding the result set. |
| 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). |
| 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. |
| 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. |
| 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). |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CashAmount | model | decimal | No | The amount of the cash transaction. |
| 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. |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| 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/settlements/{batchId} HTTP/1.1
Host: syntch.simpay.net
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Transactions":[{"PnRef":0,"InvoiceNumber":"String","SequenceNumber":"String","TransactionTimestamp":"0001-01-01T00:00:00.0000000","AuthorizationTimestamp":"0001-01-01T00:00:00.0000000","MerchantKey":0,"UserName":"String","RegisterNumber":"String","ResellerKey":0,"PaymentType":"String","TransactionType":"String","Processor":"String","ProcessorError":"String","SettlementMessage":"String","VoidFlag":"String","SettleFlag":"String","SettlementTimestamp":"0001-01-01T00:00:00.0000000","IP":"String","CustomerId":"String","CustomerKey":0,"CustomerName":"String","OriginalTransactionPnRef":0,"CustomerReference":"String","BatchNumber":"String","BatchSequenceNumber":"String","Adjusted":"String","TransactionFinishTimestamp":"0001-01-01T00:00:00.0000000","ProcessorRequestTimestamp":"0001-01-01T00:00:00.0000000","ProcessorResponseTimestamp":"0001-01-01T00:00:00.0000000","BatchId":"String","ReversalFlag":"String","EntryMode":"String","CardDetail":{"Token":"String","MaskedPAN":"String","NameOnCard":"String","AuthorizationAmount":0,"TipAmount":0,"TotalAmount":0,"CashBackAmount":0,"SurchargeAmount":0,"AccountType":"String","ResultCode":"String","ResultText":"String","ApprovalCode":"String","HostReferenceNumber":"String","AvsResponse":"String","AvsResponseText":"String","CvvResponse":"String","CvvResponseText":"String","Level3Amount":0,"CardExpiration":"String","Street":"String","ZipCode":"String","ThreeDSPaayDetail":{"Status":"String","AcsTransId":"String","AuthValue":"String","CardToken":"String","DsTransId":"String","Eci":"String","ProtocolVersion":"String"}},"CheckDetail":{"Token":"String","CheckNumber":"String","AccountNumber":"String","RoutingNumber":"String","DriversLicenseNumber":"String","SocialSecurityNumber":"String","DateOfBirth":"String","StateCode":"String","NameOnCheck":"String","EmailAddress":"String","PhoneNumber":"String","CheckAmount":0,"ResultCode":"String","ResultText":"String","HostApproval":"String","HostReferenceNumber":"String","ResultMessage":"String","SecondaryResultMessage":"String","TertiaryResultMessage":"String","AccountType":"String","CheckType":"String","SECCode":"String"},"CashDetail":{"CashAmount":0},"InvoiceDetail":{"PurchaseOrderNumber":"String","ShippingAmount":0,"TaxAmount":0,"DutyAmount":0,"ConvenienceAmount":0},"CustomFields":[{"Key":0,"Name":"String","Value":"String"}],"AssociatedTransactions":[{"TransactionId":0,"MerchantKey":0,"Timestamp":"0001-01-01T00:00:00.0000000","PaymentType":"String","TransactionType":"String","Amount":0,"Username":"String","CustomerId":"String","CustomerKey":0,"Payer":"String","Result":"String","SettleFlag":"String"}],"Tags":["String"]}],"Pagination":{"CurrentPageNumber":0,"PageSize":0,"TotalRecordCount":0}}