42-cent-base
Advanced tools
Comparing version 0.1.0 to 0.2.0
@@ -72,3 +72,40 @@ Global | ||
getSettledBatchList(from, to) | ||
----------------------------- | ||
get a batch list of settled transaction within the window of time | ||
**Parameters** | ||
**from**: String | Date, Lower limit. If String, it must be a valid date string: a string which will result in a valid Javascript Date object if passed as argument of the Date constructor | ||
**to**: String | Date, Upper limit (or today if not provided). If String, it must be a valid date string: a string which will result in a valid Javascript Date object if passed as argument of the Date constructor | ||
**Returns**: Promise, - The promise should resolve with the following fields | ||
<dl> | ||
<dt>batchList</dt> | ||
<dd>An array of batch where a batch will have the following fields | ||
<dl> | ||
<dt>batchId</dt> | ||
<dd>The id the batch is referenced by in the gateway internal system</dd> | ||
<dt>settlementDate</dt> | ||
<dd>A string for the settlement date time (UTC)</dd> | ||
<dt>chargeAmount</dt> | ||
<dd>the total amount from the charged transactions during the window of time</dd> | ||
<dt>chargeCount</dt> | ||
<dd>the total count of charged transactions during the window of time</dd> | ||
<dt>refundAmount</dt> | ||
<dd>the total amount from the refunded transactions during the window of time</dd> | ||
<dt>refundCount</dt> | ||
<dd>the total count of refund transactions during the window of time</dd> | ||
<dt>voidCount</dt> | ||
<dd>the total count of voided transactions during the window of time</dd> | ||
<dt>declineCount</dt> | ||
<dd>the total count of voided transactions during the window of time</dd> | ||
<dt>errorCount</dt> | ||
<dd>the total count of voided transactions during the window of time</dd> | ||
</dl> | ||
</dd> | ||
</dl> | ||
--- | ||
@@ -75,0 +112,0 @@ |
@@ -71,3 +71,39 @@ var _ = require('lodash'); | ||
/** | ||
* get a batch list of settled transaction within the window of time | ||
* @param {String | Date} from - Lower limit. If String, it must be a valid date string: a string which will result in a valid Javascript Date object if passed as argument of the Date constructor | ||
* @param {String | Date} [to] - Upper limit (or today if not provided). If String, it must be a valid date string: a string which will result in a valid Javascript Date object if passed as argument of the Date constructor | ||
* @returns {Promise} - The promise should resolve with the following fields | ||
* <dl> | ||
* <dt>batchList</dt> | ||
* <dd>An array of batch where a batch will have the following fields | ||
* <dl> | ||
* <dt>batchId</dt> | ||
* <dd>The id the batch is referenced by in the gateway internal system</dd> | ||
* <dt>settlementDate</dt> | ||
* <dd>A string for the settlement date time (UTC)</dd> | ||
* <dt>chargeAmount</dt> | ||
* <dd>the total amount from the charged transactions during the window of time</dd> | ||
* <dt>chargeCount</dt> | ||
* <dd>the total count of charged transactions during the window of time</dd> | ||
* <dt>refundAmount</dt> | ||
* <dd>the total amount from the refunded transactions during the window of time</dd> | ||
* <dt>refundCount</dt> | ||
* <dd>the total count of refund transactions during the window of time</dd> | ||
* <dt>voidCount</dt> | ||
* <dd>the total count of voided transactions during the window of time</dd> | ||
* <dt>declineCount</dt> | ||
* <dd>the total count of voided transactions during the window of time</dd> | ||
* <dt>errorCount</dt> | ||
* <dd>the total count of voided transactions during the window of time</dd> | ||
* </dl> | ||
* </dd> | ||
* </dl> | ||
*/ | ||
BaseGateway.prototype.getSettledBatchList = function getTransactionsList(from, to) { | ||
return Promise.reject(throwNotImplemented()); | ||
}; | ||
module.exports = BaseGateway; | ||
{ | ||
"name": "42-cent-base", | ||
"version": "0.1.0", | ||
"version": "0.2.0", | ||
"description": "structural interface for 42-cent adaptors", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -75,3 +75,40 @@ # 42-cent-base | ||
getSettledBatchList(from, to) | ||
----------------------------- | ||
get a batch list of settled transaction within the window of time | ||
**Parameters** | ||
**from**: String | Date, Lower limit. If String, it must be a valid date string: a string which will result in a valid Javascript Date object if passed as argument of the Date constructor | ||
**to**: String | Date, Upper limit (or today if not provided). If String, it must be a valid date string: a string which will result in a valid Javascript Date object if passed as argument of the Date constructor | ||
**Returns**: Promise, - The promise should resolve with the following fields | ||
<dl> | ||
<dt>batchList</dt> | ||
<dd>An array of batch where a batch will have the following fields | ||
<dl> | ||
<dt>batchId</dt> | ||
<dd>The id the batch is referenced by in the gateway internal system</dd> | ||
<dt>settlementDate</dt> | ||
<dd>A string for the settlement date time (UTC)</dd> | ||
<dt>chargeAmount</dt> | ||
<dd>the total amount from the charged transactions during the window of time</dd> | ||
<dt>chargeCount</dt> | ||
<dd>the total count of charged transactions during the window of time</dd> | ||
<dt>refundAmount</dt> | ||
<dd>the total amount from the refunded transactions during the window of time</dd> | ||
<dt>refundCount</dt> | ||
<dd>the total count of refund transactions during the window of time</dd> | ||
<dt>voidCount</dt> | ||
<dd>the total count of voided transactions during the window of time</dd> | ||
<dt>declineCount</dt> | ||
<dd>the total count of voided transactions during the window of time</dd> | ||
<dt>errorCount</dt> | ||
<dd>the total count of voided transactions during the window of time</dd> | ||
</dl> | ||
</dd> | ||
</dl> | ||
--- | ||
@@ -78,0 +115,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
17248
161
147