Skip to content

Commit

Permalink
added ach and cash docs
Browse files Browse the repository at this point in the history
  • Loading branch information
corepay committed Oct 1, 2023
1 parent 5d61a6e commit 5d22fdb
Show file tree
Hide file tree
Showing 74 changed files with 863 additions and 129 deletions.
2 changes: 1 addition & 1 deletion js-sdk/assets/navigation.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion js-sdk/assets/search.js

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions js-sdk/classes/index.QorDirectSDK.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">QorDirectSDK</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/index.ts#L9">index.ts:9</a></li></ul></aside>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/index.ts#L9">index.ts:9</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -84,39 +84,39 @@ <h4>Example</h4><pre><code class="language-js"><span class="hl-3">import</span><
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/index.ts#L38">index.ts:38</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/index.ts#L38">index.ts:38</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="achPayments" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ach<wbr/>Payments</span><a href="#achPayments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">ach<wbr/>Payments</span><span class="tsd-signature-symbol">:</span> <a href="resources_ach_payments.AchPayments.html" class="tsd-signature-type tsd-kind-class">AchPayments</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/index.ts#L11">index.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/index.ts#L11">index.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="cardPayments" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>card<wbr/>Payments</span><a href="#cardPayments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">card<wbr/>Payments</span><span class="tsd-signature-symbol">:</span> <a href="resources_card_payments.CardPayments.html" class="tsd-signature-type tsd-kind-class">CardPayments</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/index.ts#L10">index.ts:10</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/index.ts#L10">index.ts:10</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="cashPayments" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>cash<wbr/>Payments</span><a href="#cashPayments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">cash<wbr/>Payments</span><span class="tsd-signature-symbol">:</span> <a href="resources_cash_payments.CashPayments.html" class="tsd-signature-type tsd-kind-class">CashPayments</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/index.ts#L12">index.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/index.ts#L12">index.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="marketplace" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>marketplace</span><a href="#marketplace" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">marketplace</span><span class="tsd-signature-symbol">:</span> <a href="resources_marketplace.Marketplace.html" class="tsd-signature-type tsd-kind-class">Marketplace</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/index.ts#L14">index.ts:14</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/index.ts#L14">index.ts:14</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="proofOfDelivery" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>proof<wbr/>Of<wbr/>Delivery</span><a href="#proofOfDelivery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">proof<wbr/>Of<wbr/>Delivery</span><span class="tsd-signature-symbol">:</span> <a href="resources_proof_of_delivery.ProofOfDelivery.html" class="tsd-signature-type tsd-kind-class">ProofOfDelivery</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/index.ts#L15">index.ts:15</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/index.ts#L15">index.ts:15</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="transactions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>transactions</span><a href="#transactions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">transactions</span><span class="tsd-signature-symbol">:</span> <a href="resources_transactions.Transactions.html" class="tsd-signature-type tsd-kind-class">Transactions</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/index.ts#L13">index.ts:13</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/index.ts#L13">index.ts:13</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
48 changes: 44 additions & 4 deletions js-sdk/classes/resources_ach_payments.AchPayments.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">AchPayments</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in resources/ach-payments.ts:8</li></ul></aside>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/resources/ach-payments.ts#L12">resources/ach-payments.ts:12</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -36,6 +36,8 @@ <h3 class="tsd-index-heading">Constructors</h3>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Methods</h3>
<div class="tsd-index-list"><a href="resources_ach_payments.AchPayments.html#processAchPayment" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>process<wbr/>Ach<wbr/>Payment</span></a>
<a href="resources_ach_payments.AchPayments.html#processCreditCardRefund" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>process<wbr/>Credit<wbr/>Card<wbr/>Refund</span></a>
<a href="resources_ach_payments.AchPayments.html#processCreditCardVoid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>process<wbr/>Credit<wbr/>Card<wbr/>Void</span></a>
<a href="resources_ach_payments.AchPayments.html#request" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>request</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
Expand All @@ -59,7 +61,7 @@ <h4 class="tsd-returns-title">Returns <a href="resources_ach_payments.AchPayment
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from Base.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/base.ts#L22">base.ts:22</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/base.ts#L22">base.ts:22</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="processAchPayment" class="tsd-anchor"></a>
Expand All @@ -74,7 +76,43 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">req</span>: <a href="../types/types_ach_payments_types.PaymentAchRequest.html" class="tsd-signature-type tsd-kind-type-alias">PaymentAchRequest</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/types_ach_payments_types.PaymentAchResponse.html" class="tsd-signature-type tsd-kind-type-alias">PaymentAchResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in resources/ach-payments.ts:9</li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/resources/ach-payments.ts#L13">resources/ach-payments.ts:13</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="processCreditCardRefund" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>process<wbr/>Credit<wbr/>Card<wbr/>Refund</span><a href="#processCreditCardRefund" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="processCreditCardRefund.processCreditCardRefund-1"><span class="tsd-kind-call-signature">process<wbr/>Credit<wbr/>Card<wbr/>Refund</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">req</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/types_ach_payments_types.PaymentAchRefundResponse.html" class="tsd-signature-type tsd-kind-type-alias">PaymentAchRefundResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#processCreditCardRefund.processCreditCardRefund-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Process a credit card refund.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">req</span>: <a href="../types/types_ach_payments_types.PaymentAchRefund.html" class="tsd-signature-type tsd-kind-type-alias">PaymentAchRefund</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/types_ach_payments_types.PaymentAchRefundResponse.html" class="tsd-signature-type tsd-kind-type-alias">PaymentAchRefundResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The ACH/Bank account payment refund response.</p>

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/resources/ach-payments.ts#L128">resources/ach-payments.ts:128</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="processCreditCardVoid" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>process<wbr/>Credit<wbr/>Card<wbr/>Void</span><a href="#processCreditCardVoid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="processCreditCardVoid.processCreditCardVoid-1"><span class="tsd-kind-call-signature">process<wbr/>Credit<wbr/>Card<wbr/>Void</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">req</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/types_ach_payments_types.PaymentAchVoidResponse.html" class="tsd-signature-type tsd-kind-type-alias">PaymentAchVoidResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#processCreditCardVoid.processCreditCardVoid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Processes an ACH/Bank account payment void.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">req</span>: <a href="../types/types_ach_payments_types.PaymentAchVoid.html" class="tsd-signature-type tsd-kind-type-alias">PaymentAchVoid</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/types_ach_payments_types.PaymentAchVoidResponse.html" class="tsd-signature-type tsd-kind-type-alias">PaymentAchVoidResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
<li>The ACH/Bank account payment void response.</li>
</ul>

<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/resources/ach-payments.ts#L113">resources/ach-payments.ts:113</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="request" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
Expand Down Expand Up @@ -110,7 +148,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise<
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from Base.request</p>
<ul>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/cb4a17a/src/base.ts#L37">base.ts:37</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/QorLabs/qor-direct-js-sdk/blob/d38cd80/src/base.ts#L37">base.ts:37</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand All @@ -132,6 +170,8 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<ul>
<li><a href="#constructor" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
<li><a href="#processAchPayment" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>process<wbr/>Ach<wbr/>Payment</span></a></li>
<li><a href="#processCreditCardRefund" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>process<wbr/>Credit<wbr/>Card<wbr/>Refund</span></a></li>
<li><a href="#processCreditCardVoid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>process<wbr/>Credit<wbr/>Card<wbr/>Void</span></a></li>
<li><a href="#request" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>request</span></a></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>qor-direct-sdk</span></a>
Expand Down
Loading

0 comments on commit 5d22fdb

Please sign in to comment.