---
updatedAt: 2026-07-09T19:39:10.000Z
agentTools:
projectIndex: https://developer.i-payout.com/llms.txt
---
# Search transaction(s)
This API will return list of transactions. You can use the filters like MerchantReferenceId, MerchantBatchId and LogTransactionId to filter the result data set. Atleast one parameter is required in the filter to search the data.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "IPS Portal Rest API - V1",
"description": "i-payout API",
"contact": {
"name": "i-payout tech support",
"email": "techsupport@i-payout.com"
},
"license": {
"name": "i-payout API",
"url": "http://www.i-payout.com"
},
"version": "v1"
},
"paths": {
"/api/v1/reports/transactions": {
"get": {
"tags": [
"Report"
],
"summary": "Search transaction(s)",
"description": "This API will return list of transactions. You can use the filters like MerchantReferenceId, MerchantBatchId and LogTransactionId to filter the result data set. Atleast one parameter is required in the filter to search the data.",
"operationId": "TransactionSearch",
"parameters": [
{
"name": "merchantReferenceId",
"in": "query",
"description": "Merchant reference id for the transaction",
"schema": {
"type": "string"
}
},
{
"name": "merchantBatchId",
"in": "query",
"description": "Merchant batch id for the transaction",
"schema": {
"type": "string"
}
},
{
"name": "logTransactionId",
"in": "query",
"description": "IPS log transaction id",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Current page number",
"schema": {
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of records per page",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponseTransactionsReport"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponseTransactionsReport"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiResponse"
}
}
}
}
},
"security": [
{
"Bearer": [],
"X-MerchantId": []
}
]
}
}
},
"components": {
"schemas": {
"ApiResponse": {
"type": "object",
"properties": {
"isSuccess": {
"type": "boolean",
"description": "Indicates if the API call was successful or not."
},
"message": {
"type": "string",
"description": "A human readable status message that may be used for debugging.",
"nullable": true
},
"statusCode": {
"$ref": "#/components/schemas/StatusConstants"
},
"logIdentifier": {
"type": "string",
"description": "Utilized for support, a log identifier to provide to i-payout when requesting technical support.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Standard API Response object."
},
"ApiResponseTransactionsReport": {
"type": "object",
"properties": {
"isSuccess": {
"type": "boolean",
"description": "Indicates if the API call was successful or not."
},
"message": {
"type": "string",
"description": "A human readable status message that may be used for debugging.",
"nullable": true
},
"statusCode": {
"$ref": "#/components/schemas/StatusConstants"
},
"logIdentifier": {
"type": "string",
"description": "Utilized for support, a log identifier to provide to i-payout when requesting technical support.",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/TransactionLogReportEntityDto"
}
},
"additionalProperties": false
},
"CommonFeeType": {
"enum": [
"NoFee",
"ACHUserErrorFee",
"MonthlyMaintenanceFee",
"VAToVA",
"VAToWire_Domestic",
"ElectronicBillPayment",
"MailedBillPayment",
"SVCToSVC",
"VAToCheckWriting",
"VAToWire_International",
"SignUpFee_USA",
"AccountCorrectionFee",
"FailedCardOrder",
"CardPreloadFee",
"AccountClosureFee",
"VAToPaypal",
"VAToWesternUnion",
"BankAccountToVA",
"CreditCardToVA",
"WireToVA_Domestic",
"Chargeback",
"PayoutToVirtual",
"CCSVCPurchase",
"VAToMerchant",
"WireToVA_International",
"Link_Bank_Account",
"YearlyMembership",
"SolidTrustPayToVA",
"AlertPayToVA",
"StoredValueCardPurchase_Free_Domestic",
"PhoneSupport",
"AccountReopen",
"CheckToVA",
"CheckToVADecline",
"MerchantCommissionWithdrawal",
"MoneyBookersToVA",
"MerchantToVA",
"SVC_Upgrade_Lvl_2",
"SVC_Upgrade_Lvl_3",
"VAToCC_NonUSA",
"VAToRemittance",
"InsufficientFunds",
"ACHChargeback",
"ACHNoticeOfChange",
"DormantFee",
"FX_Exchange",
"MassEmail",
"SMSFee",
"StopPaymentOnCheck",
"FailedWires",
"BankAccountToVA_International",
"PayoutToVirtual_International",
"FreeSMSFee",
"BankAccountToVA_Sofort",
"BankAccountToVA_Poli",
"BankAccountToVA_Envoy",
"BankAccountToVA_Travelex",
"BankAccountToVA_1",
"BankAccountToVA_2",
"VAToBusinessVA",
"WebMoneytoVA",
"VAToWebMoney",
"AlipayToVA",
"DineroMailToVA",
"VAToSVC_Payoneer",
"VAToSVC_Qolo",
"VAToAlertPay",
"VAToSVC_Intercash",
"UseMyServicesToVA",
"StoredValueCardPurchase_Free_International",
"SVCOrderPayoneer_Domestic",
"SVCOrderPayoneer_International",
"SVCOrder_Qolo_Domestic",
"SVCOrder_Qolo_International",
"SVCOrderMarqeta_Domestic",
"SVCOrderMarqeta_International",
"CashDepositToVA",
"CashDepositToVA_ZipZap",
"CashDepositToVA_uKash",
"VAToSolidTrustPay",
"VAToeCheck",
"ChinaPayToVA",
"BoletoToVA",
"GoogleCheckoutToVA",
"QiwiToVA",
"VAToQiwi",
"SVCOrderSwift_Domestic",
"SVCOrderSwift_International",
"VAToSVC_Swift",
"DebitCardToVA",
"PayPalToVA",
"PaymentOption_Citcon",
"RBKMoneyToVa",
"BillpayToVa",
"CashDepositToVA_PaySafeCard",
"TwoCheckoutToVA",
"WireToVA_EUR",
"CreditCard_MaintenanceFee",
"PaymenexToVA",
"EcommPayToVA",
"VAToPaymenex",
"BitcoinToVA",
"VAToBitcoin",
"VAToCC_USA",
"ReplacePrepaidCard",
"CashDepositToVA_Kadu",
"VAToWire_International_LocalCurrency",
"AstropayToVA",
"CoalaPayToVA",
"CouponPurchase",
"SignUpFee_NonUSA",
"GiftCardPurchase",
"WeChatToVA",
"VAToePayment",
"CASHUToVA",
"CashDepositToVA_Neosurf",
"GoInterpayToVA",
"UnionPayToVA",
"PaymentOption_IDEAL",
"PaymentOption_GiroPay",
"PaymentOption_EPS",
"PaymentOption_SOFORT",
"PaymentOption_SEPA",
"Virtual_to_ECheck",
"PaymentOption_POLI_Australia",
"PaymentOption_POLI_NewZealand",
"VAToCash",
"VAToVoucherPayment",
"W9_Verification",
"W8BEN_Verification",
"TaxForm_Distribution",
"ID_Document_Collection",
"Customer_KYC_Check",
"Bulk_Shipment_Fee",
"Minimum_Monthly_Revenue",
"Platform_Implementation_Fee",
"PaymentOption_Thunes",
"PaymentOption_DollarSmart",
"MerchantManualDebitFee",
"SameDayACHFee",
"TINExpediteVerification",
"RealtimeACHFee"
],
"type": "string",
"description": "The fee type of this transaction. For possible values, see Fee Code Details ."
},
"StatusConstants": {
"enum": [
"NO_ERROR",
"EMAIL_ADDRESS_EXISTS",
"CAPTCHA_FAILED",
"INVALID_REFERENCEID",
"INVALID_OPERATION",
"INVALID_TIN_VALIDATION_STATUS",
"RECORD_NOT_FOUND",
"Already_Exist",
"Batch_Closed",
"IP_BLACKLISTED",
"CREDIT_CARD_PROCESSOR_ISSUE",
"FEES_NOT_ACCEPTED",
"PAYOUT_CAPABILITIES_DISABLED",
"INVALID_RECURRING_PAYMENT_STATUS",
"INVOICE_CAPABILITIES_DISABLED",
"INVALID_EWALLET_REGISTRATION",
"PRIVATE_KEY_ISSUE",
"FILE_NOT_EXISTS",
"OLDUSER_NEWUSER_MISMATCH",
"USER_CANNOT_CREATED",
"CANNOT_CREATE_NEW_BATCH",
"REFERENCEID_ALREADY_EXISTS",
"DELETE_RECORD_ERROR",
"FX_ConversionRate_Issue",
"RATE_LIMIT_EXCEEDED",
"IP_NOT_ALLOWED",
"COUNTRY_NOT_ALLOWED",
"INVALID_FIELD_VALUE_LENGTH",
"UNAUTHORIZED_API_CALL",
"FEE_VALUE_NOT_FOUND_FOR_CUSTOMER",
"IPADDRESS_GENERATION_ISSUE",
"MERCHANT_NOT_FOUND",
"INVALID_PARAMS",
"Missing_HEADER_PARAMS",
"INVALID_URL",
"INVALID_AMOUNT",
"INVALID_CURRENCY",
"REQUIRED_PARAMETER",
"INVALID_REQUEST_PARAM",
"INVALID_REQUEST_RESPONSE_PARAM",
"INVALID_SERVER_CONFIG",
"ACCESS_DENIED",
"INVALID_COUNTRY_CODE",
"PROCESSING",
"PENDING",
"NO_RECORDS_FOUND",
"INVALID_MERCHANT",
"PAL_INVALID_EMAIL",
"INVALID_CARD_NUMBER",
"INSUFFICIENT_FUNDS",
"USERNAME_EXISTS",
"USER_NOT_LOGGED_IN",
"INVALID_CLIENT_CREDENTIALS",
"ACCOUNT_NOT_FOUND",
"GENERAL_ERROR",
"CUSTOMER_NOT_FOUND",
"INTERNAL_ERROR"
],
"type": "string",
"description": "Api response status code. For possible values, see Status Code Values ."
},
"StopPaymentOnCheckStatus": {
"enum": [
"NeverInitiated",
"Completed",
"Initiated",
"Declined"
],
"type": "string"
},
"TransactionInfoDTO": {
"type": "object",
"properties": {
"logTransactionId": {
"type": "integer",
"description": "The i-payout logging transaction id which may be utilized for debugging purposes.",
"format": "int64"
},
"currencyCode": {
"type": "string",
"description": "The currency code of this transaction.",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount of this transaction.",
"format": "double"
},
"toUsername": {
"type": "string",
"description": "The username of the recipient of this transaction.",
"nullable": true
},
"fromUsername": {
"type": "string",
"description": "The username of the sender of this transaction.",
"nullable": true
},
"tranDescription": {
"type": "string",
"description": "The transaction description.",
"nullable": true
},
"tranType": {
"$ref": "#/components/schemas/TransactionType"
},
"feeType": {
"$ref": "#/components/schemas/CommonFeeType"
},
"tranStatus": {
"$ref": "#/components/schemas/TransactionStatusType"
},
"customerFeeAmount": {
"type": "number",
"description": "The fees that are to be paid by the customer for this transaction.",
"format": "double"
},
"merchantFeeAmount": {
"type": "number",
"description": "The fees that are to be paid by the merchant for this transaction.",
"format": "double"
},
"merchantReferenceId": {
"type": "string",
"description": "The merchant specified merchant reference id, as specified in the original transaction.",
"nullable": true
},
"merchantBatchId": {
"type": "string",
"description": "For PayOut transactions, the merchant specified merchant batch id.",
"nullable": true
},
"userMemo": {
"type": "string",
"description": "A user speicified memo for this transaction.",
"nullable": true
},
"managerComments": {
"type": "string",
"description": "If specified, manager comments that have been attributed to this transaction.",
"nullable": true
},
"transactionTime": {
"type": "string",
"description": "The date and time of this transaction. TBD: Add format.",
"format": "date-time"
},
"lastUpdatedTime": {
"type": "string",
"description": "The date and time of the last update of this transaction in the format YYYY-MM-DDThh:mm:ss.ms as defined in ISO 8601.",
"format": "date-time"
},
"other": {
"type": "string",
"description": "Comments associated with this transaction.",
"nullable": true
},
"globalProfileId": {
"type": "integer",
"description": "The i-payout global profile id associated with this transaction.",
"format": "int64"
},
"globalProfileName": {
"type": "string",
"description": "The global profile name associated with this transaction.",
"nullable": true
},
"stopPayOnCheckStatus": {
"$ref": "#/components/schemas/StopPaymentOnCheckStatus"
},
"stopPaymentOnCheckInitiatedBy": {
"type": "integer",
"description": "If a stop payment has been initiated on this transaction, the initiator of the stop payment request.",
"format": "int64"
},
"stopPaymentOnCheckInitiatedtime": {
"type": "string",
"description": "If a stop payment has been initiated on this transaction, the date and time of the stop payment initiation. TBD: Add format.",
"format": "date-time"
},
"achSubmitDate": {
"type": "string",
"description": "The ACH submittal date in the format YYYY-MM-DDThh:mm:ss.ms as defined in ISO 8601.",
"format": "date-time"
},
"transactionGuid": {
"type": "string",
"format": "uuid"
},
"canResendConfirmationEmailLink": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TransactionLogReportEntityDto": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"description": "Total number of items on all pages",
"format": "int32"
},
"pageNumber": {
"type": "integer",
"description": "Current page number",
"format": "int32"
},
"pageSize": {
"type": "integer",
"description": "Number of records per page",
"format": "int32"
},
"pageCount": {
"type": "integer",
"description": "Total number of pages",
"format": "int32"
},
"transactionLogDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionInfoDTO"
},
"description": "Contains list of Transaction details",
"nullable": true
}
},
"additionalProperties": false
},
"TransactionStatusType": {
"enum": [
"Pending",
"Settled",
"Unknown",
"Voided",
"FailedVoided",
"PendingToVoid",
"PendingToApprove",
"Unsent",
"Sent",
"SentButNoReply",
"Processing",
"All",
"Declined"
],
"type": "string",
"description": "The transaction status. For possible values, see Status Code Details ."
},
"TransactionType": {
"enum": [
"Virtual_Credit",
"Virtual_Debit",
"Virtual_Payout",
"Collect_Fees",
"Return_CollectedFees",
"Order_Prepaid_Card",
"CC_Order_Prepaid_Card",
"ACH_Funding_Checks",
"ACH_Funding_Wires",
"ACH_Funding_ACHs",
"Merchant_PrefundDeposit",
"MerchantCommissionWithdrawal",
"WIRE_Funding_EFT",
"BankAccountVerification",
"ACH_Funding_SVCLoad",
"ACH_Funding_CC",
"ACH_Funding_Remittance",
"ACH_Funding_EFT",
"ACH_Funding_MerchanteWallet",
"Virtual_To_Bank",
"Virtual_To_Wire",
"Virtual_To_Check",
"Virtual_To_Virtual",
"Virtual_To_SVC",
"Virtual_To_Merchant",
"Virtual_To_CreditCard",
"Virtual_To_Remittance",
"Bank_To_Virtual",
"Wire_To_Virtual",
"Check_To_Virtual",
"SVC_To_Virtual",
"CreditCard_To_Virtual",
"STP_To_Virtual",
"AlertPay_To_Virtual",
"Merchant_To_Virtual",
"SVC_To_SVC",
"SVC_To_BankAccount",
"SVC_Upgrade",
"MerchantBalanceWithdrawal",
"Virtual_MassPayout",
"Virtual_To_BusinessVirtual",
"WebMoney_To_Virtual",
"Virtual_To_WebMoney",
"ACH_Funding_WebMoney",
"Alipay_To_Virtual",
"DineroMail_To_Virtual",
"Virtual_To_AlertPay",
"UseMyServices_To_Virtual",
"CashDeposit_To_Virtual",
"AlliedWalletRedirect_To_Virtual",
"Virtual_To_SolidTrustPay",
"ChinaPay_To_Virtual",
"Boleto_To_Virtual",
"GoogleCheckout_To_Virtual",
"Virtual_To_eCheck",
"Qiwi_To_Virtual",
"Virtual_To_Qiwi",
"ACH_Funding_Qiwi",
"DebitCard_To_Virtual",
"PayPal_To_Virtual",
"CrossMerchant_Debit",
"CrossMerchant_Credit",
"LibertyReserve_To_Virtual",
"RBKMoney_To_Virtual",
"ACH_Funding_CrossMerchantTransfer",
"Refund_To_CreditCard",
"Billpay_To_Virtual",
"Payout_Adjustment",
"TwoCheckout_To_Virtual",
"Paymenex_To_Virtual",
"Ecommpay_To_Virtual",
"Virtual_To_Paymenex",
"ACH_Funding_Paymenex",
"Virtual_To_Bitcoin",
"Bitcoin_To_Virtual",
"ACH_Funding_Bitcoin",
"TaxWithholding",
"Virtual_To_PayPal",
"ACH_Funding_PayPal",
"Astropay_To_Virtual",
"CoalaPay_To_Virtual",
"CouponPurchase",
"CouponReturned",
"CouponRedeemed",
"GiftCardPurchase",
"ACH_Funding_GiftCard",
"WeChat_To_Virtual",
"Virtual_To_ePayment",
"ACH_Funding_ePayment",
"CASHU_To_Virtual",
"GoInterpay_To_Virtual",
"UnionPay_To_Virtual",
"PaymentOptions_To_Virtual",
"Virtual_To_Cash",
"ACH_Funding_Cash",
"VATAdjustment",
"Virtual_To_VoucherPayment",
"Refund_VoucherPayment",
"All"
],
"type": "string",
"description": "The transaction type. For possible values, see Transaction Type Code Details ."
}
},
"securitySchemes": {
"basic": {
"type": "http",
"description": "Use API username and password to get the dynamic bearer token which can be used to access all other API, Example: 'Basic 12345adfad'",
"scheme": "basic"
},
"Bearer": {
"type": "apiKey",
"description": "JWT Authorization header using the Bearer scheme.Enter 'Bearer' [space] and then your token in the text input below. Example: 'Bearer 12345abcdef'",
"name": "Authorization",
"in": "header"
},
"X-MerchantId": {
"type": "apiKey",
"description": "Merchant Identifier (GUID)",
"name": "X-MerchantId",
"in": "header"
}
}
},
"security": [
{
"Bearer": [],
"basic": [],
"X-MerchantId": []
}
]
}
```