COLH-1139 Add funding transactions client

lib/api/funding-transactions.js

@@ -0,0 +1,31 @@
+/**
+ * @module funding-transactions
+ */
+
+'use strict';
+
+var client = require('../client');
+
+module.exports = {
+  /**
+   * Get the funding transaction for a given id
+   * @param {Object} params Object, which contains parameters of the sought transaction. id is required.
+   * @return {Promise}      Promise; if fulfilled returns object, if rejected returns APIerror.
+   */
+  getFundingTransaction: function (params) {
+        params = params || {};
+        if (!params.hasOwnProperty('id')) {
+            throw new Error('id is required');
+        }
+
+        var url = '/v2/funding_transactions/' + params.id;
+
+        var promise = client.request({
+            url: url,
+            method: 'GET',
+            qs: params
+        });
+
+        return promise;
+    }
+};

lib/currency-cloud.js

@@ -15,6 +15,7 @@ module.exports = {
   contacts: require('./api/contacts'),
   conversions: require('./api/conversions'),
   funding: require('./api/funding'),
+  fundingTransactions: require('./api/funding-transactions'),
   ibans: require('./api/ibans'),
   payers: require('./api/payers'),
   payments: require('./api/payments'),

test/api/fixtures/funding-transactions.js

@@ -0,0 +1,40 @@
+var nock = require('nock');
+
+nock('https://devapi.currencycloud.com:443')
+  .post('/v2/authenticate/api', {
+    "login_id": "development@currencycloud.com",
+    "api_key": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
+  })
+  .reply(200, {"auth_token": "38d5ae520d6987decfe7c12aa5ec4422"});
+
+nock('https://devapi.currencycloud.com:443', {"encodedQueryParams": true})
+    .get('/v2/funding_transactions/e68301d3-5b04-4c1d-8f8b-13a9b8437040')
+    .query({"id": "e68301d3-5b04-4c1d-8f8b-13a9b8437040"})
+    .reply(200, {
+      "id":"e68301d3-5b04-4c1d-8f8b-13a9b8437040",
+      "amount":"1.11",
+      "currency":"USD",
+      "rail":"SEPA",
+      "additional_information":"CFST20231016143117",
+      "receiving_account_routing_code":null,
+      "value_date":"2023-10-16T00:00:00+00:00",
+      "receiving_account_number":"8302996933",
+      "receiving_account_iban":null,
+      "created_at":"2023-10-16T13:31:18+00:00",
+      "updated_at":"2023-10-16T13:31:18+00:00",
+      "completed_at":null,
+      "sender":{
+        "sender_id":"5c675fa4-fdf0-4ee6-b5bb-156b36765433",
+        "sender_address":"test",
+        "sender_country":"GB",
+        "sender_name":"test",
+        "sender_bic":null,
+        "sender_iban":null,
+        "sender_account_number":null,
+        "sender_routing_code":null
+      }
+    });
+
+nock('https://devapi.currencycloud.com:443')
+  .post('/v2/authenticate/close_session')
+  .reply(200, {});

test/api/funding-transactions.js

@@ -0,0 +1,46 @@
+'use strict';
+
+var currencyCloud = require('../../lib/currency-cloud');
+var expect = require('chai').expect;
+var prepost = require('../prepost');
+var recorder = prepost.recorder('funding-transactions');
+var setup = prepost.setup;
+var teardown = prepost.teardown;
+
+describe('fundingTransactions', function () {
+    before(function (done) {
+        recorder.read();
+        setup.login()
+            .then(function () {
+                done();
+            });
+    });
+
+    after(function (done) {
+        teardown.logout()
+            .then(function () {
+                recorder.write(done);
+            });
+    });
+
+    describe('get funding transaction', function () {
+        it('fails if required parameters are missing', function () {
+            expect(function () {
+                currencyCloud.fundingTransactions.getFundingTransaction(/*no params*/);
+            }).to.throw();
+        });
+        it('successfully get funding transaction', function (done) {
+            currencyCloud.fundingTransactions.getFundingTransaction({
+                id: 'e68301d3-5b04-4c1d-8f8b-13a9b8437040'
+            })
+                .then(function (gotten) {
+                    expect(gotten).to.have.property('id').to.eql('e68301d3-5b04-4c1d-8f8b-13a9b8437040');
+                    expect(gotten).to.have.property('amount').that.is.not.null;
+                    expect(gotten).to.have.property('currency').to.eql('USD');
+                    expect(gotten).to.have.property('sender').that.is.not.null;
+                    done();
+                })
+                .catch(done);
+        });
+    });
+});