entities/transaction.js

  1. import axios from 'axios';
  2. import debug from 'debug';
  3. import {defaultHeaders} from '../utils/http';
  4. import {typeValidation} from '../utils/validator';
  6. const log = debug('starling:transaction-service');
  8. const transactionSource = (source) => {
  9.   if (source === 'MASTER_CARD') {
  10.     return '/mastercard';
  11.   } else if (source === 'FASTER_PAYMENTS_IN') {
  12.     return '/fps/in';
  13.   } else if (source === 'FASTER_PAYMENTS_OUT') {
  14.     return '/fps/out';
  15.   } else if (source === 'DIRECT_DEBIT') {
  16.     return '/direct-debit';
  17.   } else {
  18.     return ''
  19.   }
  20. };
  22. /**
  23.  * Service to interact with a customer's transactions
  24.  */
  25. class Transaction {
  26.   /**
  27.    * Create a new transaction service
  28.    * @param {Object} options - configuration parameters
  29.    */
  30.   constructor (options) {
  31.     this.options = options;
  32.   }
  34.   /**
  35.    * Gets the customer's transactions over the given period
  36.    * @param {string} accessToken - the oauth bearer token.
  37.    * @param {string} fromDate - filter transactions after this date. Format: YYYY-MM-DD
  38.    * @param {string} toDate - filter transactions before this date. Format: YYYY-MM-DD
  39.    * @param {string=} source - the transaction type (e.g. faster payments, mastercard).
  40.    * If not specified, results are not filtered by source.
  41.    * @return {Promise} - the http request promise
  42.    */
  43.   getTransactions (accessToken, fromDate, toDate, source) {
  44.     typeValidation(arguments, getTransactionsParameterDefinition);
  45.     const url = `${this.options.apiUrl}/api/v1/transactions${transactionSource(source)}`;
  46.     log(`GET ${url} from=${fromDate} to=${toDate}`);
  48.     return axios({
  49.       method: 'GET',
  50.       url,
  51.       params: {
  52.         from: fromDate,
  53.         to: toDate
  54.       },
  55.       headers: defaultHeaders(accessToken)
  56.     });
  57.   }
  59.   /**
  60.    * Gets the full details of a single transaction
  61.    * @param {string} accessToken - the oauth bearer token
  62.    * @param {string} transactionId - the unique transaction ID
  63.    * @param {string=} source - the transaction type (e.g. faster payments, mastercard).
  64.    * If not specified, only generic transaction information will be returned.
  65.    * @return {Promise} - the http request promise
  66.    */
  67.   getTransaction (accessToken, transactionId, source) {
  68.     typeValidation(arguments, getTransactionParameterDefinition);
  69.     const url = `${this.options.apiUrl}/api/v1/transactions${transactionSource(source)}/${transactionId}`;
  70.     log(`GET ${url}`);
  71.     return axios({
  72.       method: 'GET',
  73.       url,
  74.       headers: defaultHeaders(accessToken)
  75.     });
  76.   }
  77. }
  79. const getTransactionsParameterDefinition = [
  80.   {name: 'accessToken', validations: ['required', 'string']},
  81.   {name: 'fromDate', validations: ['optional', 'string']},
  82.   {name: 'toDate', validations: ['optional', 'string']},
  83.   {name: 'source', validations: ['optional', 'string']}
  84. ];
  86. const getTransactionParameterDefinition = [
  87.   {name: 'accessToken', validations: ['required', 'string']},
  88.   {name: 'transactionId', validations: ['required', 'string']},
  89.   {name: 'source', validations: ['optional', 'string']}
  90. ];
  92. module.exports = Transaction;