v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Transaction List API

get/api/v1/txnfetch

Query parameters

appidstring required

Merchant APP ID (Alphanumeric - Length of 32 chars and special chars $@%#)

appkeystring required

Merchant APP KEY (Alphanumeric - Length of 32 chars and special chars $@%#)

epistring required

EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2

date_filterinteger

Set the date filter. <table> <tbody><tr> <th>Date Filter</th> <th>Options</th> </tr> <tr> <td>Recent (Used by default if date filter is not passed)</td> <td>0</td> </tr> <tr> <td>Today</td> <td>1</td> </tr> <tr> <td>MTD</td> <td>2</td> </tr> <tr> <td>Yesterday</td> <td>3</td> </tr> <tr> <td>Last Month</td> <td>4</td> </tr> <tr> <td>Current Week</td> <td>5</td> </tr> <tr> <td>Last Week</td> <td>6</td> </tr> <tr> <td>Last 90 Days (Need to pass Start date and End Date)</td> <td>7</td> </tr> <tr> <td>Last 90Days Behind(Need to pass Start date and End Date)</td> <td>8</td> </tr> <tr> <td>No Date Filter is to be used Filter and TXN_ID required</td> <td>9</td> </tr></tbody></table>

start_date_rangestring date

Set the start date of fetch the transaction (Ex: YYYY-MM-DD)

end_date_rangestring date

Set the end date of fetch the transaction (Ex: YYYY-MM-DD)

sourceinteger

Set the source type. <table> <tbody><tr> <th>Source</th> <th>Options</th> </tr> <tr> <td>ALL</td> <td>0</td> </tr> <tr> <td>Valor Connect</td> <td>1</td> </tr> <tr> <td>WooCommerce</td> <td>2</td> </tr> <tr> <td>Magento</td> <td>3</td> </tr> <tr> <td>BigCommerce</td> <td>4</td> </tr> <tr> <td>Shopify</td> <td>5</td> </tr> <tr> <td>Oscommerce</td> <td>6</td> </tr> <tr> <td>Opencart</td> <td>7</td> </tr> <tr> <td>PassageJs</td> <td>8</td> </tr> </tbody></table>

transaction_typeinteger

Set the transaction type. <table> <tbody><tr> <th>Transaction Type</th> <th>Options</th> </tr> <tr> <td>ALL</td> <td>0</td> </tr> <tr> <td>SALE</td> <td>1</td> </tr> <tr> <td>CASH SALE</td> <td>2</td> </tr> <tr> <td>DEBIT SALE</td> <td>3</td> </tr> <tr> <td>REFUND</td> <td>4</td> </tr> <tr> <td>VOID</td> <td>5</td> </tr> <tr> <td>AUTH</td> <td>6</td> </tr> <tr> <td>COMPLETION</td> <td>7</td> </tr> <tr> <td>REVERSAL</td> <td>8</td> </tr> <tr> <td>GIFT CARD</td> <td>9</td> </tr> <tr> <td>E-INVOICE</td> <td>10</td> </tr> <tr> <td>PAYNOW</td> <td>11</td> </tr> <tr> <td>WITHDRAWAL</td> <td>12</td> </tr> <tr> <td>RECURRING</td> <td>13</td> </tr> <tr> <td>PURCHASE</td> <td>14</td> </tr> <tr> <td>RETURN</td> <td>15</td> </tr> <tr> <td>ADVANCE</td> <td>16</td> </tr> </tbody></table>

card_typeinteger

Set the card brand. <table> <tbody><tr> <th>Card Brand</th> <th>Options</th> </tr> <tr> <td>ALL</td> <td>0</td> </tr> <tr> <td>VISA</td> <td>1</td> </tr> <tr> <td>MASTER CARD</td> <td>2</td> </tr> <tr> <td>DISCOVER</td> <td>3</td> </tr> <tr> <td>AMEX</td> <td>4</td> </tr> <tr> <td>JCB</td> <td>5</td> </tr> <tr> <td>DINERS</td> <td>6</td> </tr> <tr> <td>MAESTRO</td> <td>7</td> </tr> <tr> <td>EBT</td> <td>8</td> </tr> <tr> <td>UNKNOWN CARD</td> <td>9</td> </tr> </tbody></table>

transaction_statusstring

To fetch the transaction list (All, Approved, Declined)

devicesstring

Set the Device type. <table> <tbody><tr> <th>Device Type</th> <th>Options</th> </tr> <tr> <td>ALL</td> <td>0</td> </tr> <tr> <td>RCKT</td> <td>1</td> </tr> <tr> <td>VL100</td> <td>2</td> </tr> <tr> <td>VL110</td> <td>3</td> </tr> <tr> <td>VL500</td> <td>4</td> </tr> <tr> <td>Virtual Terminal</td> <td>5</td> </tr> <tr> <td>VP100</td> <td>6</td> </tr> <tr> <td>VP500</td> <td>7</td> </tr> </tbody></table>

processorstring

Set the processor. <table> <tbody><tr> <th>Processor</th> <th>Options</th> </tr> <tr> <td>ALL</td> <td>0</td> </tr> <tr> <td>Valutec</td> <td>1</td> </tr> <tr> <td>Factor 4</td> <td>2</td> </tr> <tr> <td>POSTILION</td> <td>3</td> </tr> <tr> <td>EPX</td> <td>4</td> </tr> <tr> <td>EPI</td> <td>5</td> </tr> <tr> <td>PRIORITY</td> <td>6</td> </tr> <tr> <td>AGILPAY</td> <td>7</td> </tr> <tr> <td>TSYS Sierra</td> <td>8</td> </tr> <tr> <td>FDR Omaha</td> <td>9</td> </tr> <tr> <td>FDR CARDNET</td> <td>10</td> </tr> <tr> <td>FDR BUYPASS</td> <td>11</td> </tr> <tr> <td>FDR NASHVILLE</td> <td>12</td> </tr> </tbody></table>

filterstring
<table> <tbody><tr> <th>Filter</th> <th>Options</th> </tr> <tr> <td>''</td> <td>0</td> </tr> <tr> <td>EPI</td> <td>EPI</td> </tr> <tr> <td>RRN</td> <td>RRN</td> </tr> <tr> <td>REF TXN ID</td> <td>TXNID</td> </tr> <tr> <td>MID</td> <td>MID</td> </tr> <tr> <td>AMOUNT</td> <td>AMOUNT</td> </tr> <tr> <td>APPROVAL CODE</td> <td>APPROVAL_CODE</td> </tr> <tr> <td>VT INVOICE</td> <td>VT_INVOICE</td> </tr> <tr> <td>ADDNL VAL1</td> <td>ADDNL_VAL1</td> </tr> <tr> <td>ADDNL VAL2</td> <td>ADDNL_VAL2</td> </tr> <tr> <td>SUBSCRIPTION ID</td> <td>SUBSCRIPTION_ID</td> </tr> </tbody></table>
filter_textstring

To search the value for filter by text (EPI, RRN, TXNID, MID, Approval Code, Subscription ID, VT-Invoice, Add Val1, Add Val2, and Amount).)

limitinteger required
offsetinteger required

Offset for pagination. Default 0

offline_modeinteger

Offline mode should be set 0 or 1

versionstring

To add pagination metadata, include this field

epi_filterboolean

To display only transactions that correspond to the specified EPI

child_epistring

If the merchant has multi-MIDs, they need to send both the child EPI and the parent EPI in the EPI request

Response

200

object required