btrz-api-client 8.29.0 → 8.30.0

package/src/endpoints/btrzpay/customerCards.js

@@ -1,6 +1,24 @@
-const {authorizationHeaders} = require("../endpoints_helpers");
-function customerCardsFactory({client, internalAuthTokenProvider}) {
+const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * Factory for customer cards API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, all: function, create: function, remove: function }}
+ */
+function customerCardsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /payment-methods/:paymentMethodId/customers/:customerId/cards/:customerCardId - get card.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {string} opts.customerCardId - Customer card id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, paymentMethodId, customerId, customerCardId, headers}) {
     return client.get(`/payment-methods/${paymentMethodId}/customers/${customerId}/cards/${customerCardId}`, {
       params: {},
@@ -8,6 +26,16 @@ function customerCardsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /payment-methods/:paymentMethodId/customers/:customerId/cards - list cards.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, paymentMethodId, customerId, headers}) {
     return client.get(`/payment-methods/${paymentMethodId}/customers/${customerId}/cards`, {
       params: {},
@@ -15,6 +43,17 @@ function customerCardsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /payment-methods/:paymentMethodId/customers/:customerId/cards - create card.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {Object} opts.customerCard - Customer card payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, paymentMethodId, customerId, customerCard, headers}) {
     return client({
       url: `/payment-methods/${paymentMethodId}/customers/${customerId}/cards`,
@@ -24,6 +63,17 @@ function customerCardsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/:paymentMethodId/customers/:customerId/cards/:customerCardId - remove card.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {string} opts.customerCardId - Customer card id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, paymentMethodId, customerId, customerCardId, headers}) {
     return client({
       url: `/payment-methods/${paymentMethodId}/customers/${customerId}/cards/${customerCardId}`,

package/src/endpoints/btrzpay/customers.js

@@ -1,5 +1,23 @@
-const {authorizationHeaders} = require("../endpoints_helpers");
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Factory for payment-method customers API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, create: function, remove: function }}
+ */
 function customersFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /payment-methods/:paymentMethodId/customers/:customerId - get customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, paymentMethodId, customerId, headers}) {
     return client.get(`/payment-methods/${paymentMethodId}/customers/${customerId}`, {
       params: {},
@@ -7,6 +25,16 @@ function customersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /payment-methods/:paymentMethodId/customers - create customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {Object} opts.customer - Customer payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, paymentMethodId, customer, headers}) {
     return client({
       url: `/payment-methods/${paymentMethodId}/customers`,
@@ -16,6 +44,16 @@ function customersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/:paymentMethodId/customers/:customerId - remove customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {string} opts.customerId - Customer id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, paymentMethodId, customerId, headers}) {
     return client({
       url: `/payment-methods/${paymentMethodId}/customers/${customerId}`,

package/src/endpoints/btrzpay/datalogic.js

@@ -1,9 +1,30 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} DatalogicQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for Datalogic API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ payments: Object, referenceNumber: Object, authCode: Object }}
+ */
 function datalogicFactory({client}) {
   const payments = {
+    /**
+     * GET /datalogic/payments - list Datalogic payments.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {DatalogicQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all({token, jwtToken, headers, query, internalAuthTokenProvider}) {
       return client({
         url: "/datalogic/payments",
@@ -11,6 +32,17 @@ function datalogicFactory({client}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /datalogic/payments/:referenceNumber - update Datalogic payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.referenceNumber - Reference number
+     * @param {Object} [opts.data] - Request body
+     * @param {DatalogicQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({token, jwtToken, headers, query, referenceNumber, data, internalAuthTokenProvider}) {
       return client({
         url: `/datalogic/payments/${referenceNumber}`,
@@ -20,6 +52,17 @@ function datalogicFactory({client}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /datalogic/reverse/:referenceNumber - reverse Datalogic payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.referenceNumber - Reference number
+     * @param {Object} [opts.data] - Request body
+     * @param {DatalogicQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     reverse({token, jwtToken, headers, query, referenceNumber, data, internalAuthTokenProvider}) {
       return client({
         url: `/datalogic/reverse/${referenceNumber}`,
@@ -32,6 +75,14 @@ function datalogicFactory({client}) {
   };
 
   const referenceNumber = {
+    /**
+     * GET /datalogic/reference-number - get reference number.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, headers, internalAuthTokenProvider}) {
       return client({
         url: "/datalogic/reference-number",
@@ -41,6 +92,14 @@ function datalogicFactory({client}) {
   };
 
   const authCode = {
+    /**
+     * GET /datalogic/auth-code - get auth code.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, headers, internalAuthTokenProvider}) {
       return client({
         url: "/datalogic/auth-code",

package/src/endpoints/btrzpay/docs.js

@@ -1,4 +1,15 @@
+/**
+ * Factory for API docs (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function docsFactory({client}) {
+  /**
+   * GET /api-docs-v2 - get API docs.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client.get("/api-docs-v2", {});
   }

package/src/endpoints/btrzpay/oxxo.js

@@ -1,9 +1,36 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
-function oxxoFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for GET /oxxo/:token/payments (btrz-api-payments getSpec).
+ * @typedef {Object} OxxoPaymentsListQuery
+ * @property {string} [referenceNumber] - Payment reference number
+ */
+
+/**
+ * POST /oxxo/:token/payments/:referenceNumber and POST /oxxo/:token/reverse/:referenceNumber do not define
+ * query params in backend getSpec (path + body only). Use for optional query keys forwarded as-is.
+ * @typedef {Object} OxxoPostQuery
+ */
+
+/**
+ * Factory for OXXO API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ token: Object, payments: Object }}
+ */
+function oxxoFactory({client, internalAuthTokenProvider: _internalAuthTokenProvider}) {
   const token = {
+    /**
+     * GET /oxxo/token - get OXXO token.
+     * @param {Object} opts
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({jwtToken, headers, internalAuthTokenProvider}) {
       return client({
         url: "/oxxo/token",
@@ -13,6 +40,16 @@ function oxxoFactory({client, internalAuthTokenProvider}) {
   };
 
   const payments = {
+    /**
+     * GET /oxxo/:oxxoToken/payments - list OXXO payments.
+     * @param {Object} opts
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.oxxoToken - OXXO token
+     * @param {OxxoPaymentsListQuery} [opts.query] - referenceNumber (optional)
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>} GetOxxoPaymentsResponse; 400 ERROR_GETTING_PAYMENT_METHODS
+     */
     all({jwtToken, headers, oxxoToken, query, internalAuthTokenProvider}) {
       return client({
         url: `/oxxo/${oxxoToken}/payments`,
@@ -20,6 +57,18 @@ function oxxoFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /oxxo/:oxxoToken/payments/:referenceNumber - update OXXO payment.
+     * @param {Object} opts
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.oxxoToken - OXXO token
+     * @param {string} opts.referenceNumber - Payment reference number
+     * @param {OxxoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+     * @param {Object} opts.data - Request body (PostOxxoPaymentsPayload)
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({jwtToken, headers, oxxoToken, query, referenceNumber, data, internalAuthTokenProvider}) {
       return client({
         url: `/oxxo/${oxxoToken}/payments/${referenceNumber}`,
@@ -29,13 +78,26 @@ function oxxoFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({jwtToken, internalAuthTokenProvider, headers})
       });
     },
-    reverse({token, jwtToken, headers, query, referenceNumber, data, internalAuthTokenProvider, oxxoToken}) {
+    /**
+     * POST /oxxo/:oxxoToken/reverse/:referenceNumber - reverse OXXO payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.oxxoToken - OXXO token
+     * @param {string} opts.referenceNumber - Payment reference number
+     * @param {OxxoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
+     * @param {Object} [opts.data] - Request body (PostOxxoReversePayload)
+     * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    reverse({token: authToken, jwtToken, headers, query, referenceNumber, data, internalAuthTokenProvider, oxxoToken}) {
       return client({
         url: `/oxxo/${oxxoToken}/reverse/${referenceNumber}`,
         method: "post",
         params: query,
         data,
-        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+        headers: authorizationHeaders({token: authToken, jwtToken, internalAuthTokenProvider, headers})
       });
     }
   };

package/src/endpoints/btrzpay/payment-methods.js

@@ -1,7 +1,30 @@
 /* eslint-disable import/extensions */
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function paymentMethodsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /payment-methods (btrz-api-payments). Passed through as-is when no backend spec found.
+ * @typedef {Object} PaymentMethodsListQuery
+ * @property {string} [providerName] - Filter by provider name (deprecated; use getByProviderName for single provider)
+ */
+
+/**
+ * Factory for payment methods API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} methods all, getByProviderName, create, get, update, setToAgency,
+ *   createDefaultPaymentMethods, deleteCustomersCreditCardInfo, deletePaymentMethodsDomain
+ */
+function paymentMethodsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /payment-methods - list payment methods.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PaymentMethodsListQuery} [opts.query] - Optional query params (e.g. providerName)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/payment-methods", {
       params: query,
@@ -9,38 +32,88 @@ function paymentMethodsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function getByProviderName({ token, jwtToken, providerName, headers }) { //deprecated
+  /**
+   * GET /payment-methods?providerName= - get by provider name (deprecated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.providerName - Provider name
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   * @deprecated
+   */
+  function getByProviderName({token, jwtToken, providerName, headers}) {
     return client({
       url: `/payment-methods?providerName=${providerName}`,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, paymentMethod, headers }) {
+  /**
+   * POST /payment-methods - create payment method.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.paymentMethod - Payment method payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, paymentMethod, headers}) {
     return client({
       url: "/payment-methods",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { paymentMethod }
+      data: {paymentMethod}
     });
   }
 
-  function get({ token, jwtToken, paymentMethodId, headers, query = {} }) {
+  /**
+   * GET /payment-methods/:paymentMethodId - get payment method.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {PaymentMethodsListQuery} [opts.query] - Optional query params (e.g. providerName); forwarded to API
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, paymentMethodId, headers, query = {}}) {
     return client.get(`/payment-methods/${paymentMethodId}`, {
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function update({ token, jwtToken, paymentMethodId, paymentMethod, headers }) {
+  /**
+   * PUT /payment-methods/:paymentMethodId - update payment method.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @param {Object} opts.paymentMethod - Payment method payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, paymentMethodId, paymentMethod, headers}) {
     return client({
       url: `/payment-methods/${paymentMethodId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { paymentMethod }
+      data: {paymentMethod}
     });
   }
 
+  /**
+   * POST /payment-methods-to-agencies - set payment methods to agency.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.agencyId - Agency id
+   * @param {string} opts.providerId - Provider id
+   * @param {string[]} opts.paymentMethodNames - Payment method names
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function setToAgency({token, jwtToken, agencyId, providerId, paymentMethodNames, headers}) {
     return client({
       url: "/payment-methods-to-agencies",
@@ -50,6 +123,14 @@ function paymentMethodsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * POST /default-payment-methods - create default payment methods.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.accountId - Account id
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function createDefaultPaymentMethods({token, jwtToken, accountId}) {
     return client({
       url: "/default-payment-methods",
@@ -59,6 +140,14 @@ function paymentMethodsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/:paymentMethodId/customers - delete customers credit card info.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentMethodId - Payment method id
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteCustomersCreditCardInfo({token, jwtToken, paymentMethodId}) {
     return client({
       url: `/payment-methods/${paymentMethodId}/customers`,
@@ -67,6 +156,14 @@ function paymentMethodsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * DELETE /payment-methods/domains/:domain - delete payment methods domain.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.domain - Domain
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deletePaymentMethodsDomain({token, jwtToken, domain}) {
     return client({
       url: `/payment-methods/domains/${domain}`,

package/src/endpoints/btrzpay/payments.js

@@ -1,17 +1,41 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function paymentsFactory({ client, internalAuthTokenProvider }) {
-
-  function create({ token, jwtToken, payments, headers }) {
+/**
+ * Factory for payments API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, get: function }}
+ */
+function paymentsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /payments - create payments.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.payments - Payments payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, payments, headers}) {
     return client({
       url: "/payments",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { payments }
+      data: {payments}
     });
   }
 
-  function get({ token, jwtToken, transactionId, headers }) {
+  /**
+   * GET /transactions/:transactionId - get transaction.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.transactionId - Transaction id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, transactionId, headers}) {
     return client.get(`/transactions/${transactionId}`, {
       params: {},
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})