@payabli/sdk-node 0.0.129 → 0.0.130
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/bill/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/bill/client/Client.js +2 -2
- package/dist/cjs/api/resources/cloud/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/cloud/client/Client.js +4 -4
- package/dist/cjs/api/resources/export/client/Client.d.ts +14 -14
- package/dist/cjs/api/resources/export/client/Client.js +14 -14
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/hostedPaymentPages/client/Client.js +3 -3
- package/dist/cjs/api/resources/invoice/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/invoice/client/Client.js +3 -3
- package/dist/cjs/api/resources/lineItem/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/lineItem/client/Client.js +2 -2
- package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +10 -10
- package/dist/cjs/api/resources/moneyIn/client/Client.js +10 -10
- package/dist/cjs/api/resources/moneyIn/types/TransactionDetailResponseData.d.ts +2 -2
- package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +31 -0
- package/dist/cjs/api/resources/moneyOut/client/Client.js +75 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.d.ts +10 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.js +13 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/index.js +1 -0
- package/dist/cjs/api/resources/organization/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/organization/client/Client.js +1 -1
- package/dist/cjs/api/resources/paypoint/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/paypoint/client/Client.js +6 -6
- package/dist/cjs/api/resources/query/client/Client.d.ts +63 -2
- package/dist/cjs/api/resources/query/client/Client.js +228 -2
- package/dist/cjs/api/resources/query/client/requests/ListTransactionsOrgRequest.d.ts +0 -1
- package/dist/cjs/api/resources/query/client/requests/ListTransferDetailsOutRequest.d.ts +45 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransferDetailsOutRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersOutOrgRequest.d.ts +46 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersOutOrgRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersOutPaypointRequest.d.ts +46 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersOutPaypointRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransfersPaypointRequest.d.ts +0 -1
- package/dist/cjs/api/resources/query/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/queryTypes/types/QueryBatchesResponse.d.ts +3 -3
- package/dist/cjs/api/resources/queryTypes/types/TransferOutBankAccount.d.ts +11 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutBankAccount.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBill.d.ts +36 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBill.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBillAttachment.d.ts +15 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailBillAttachment.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailCheckData.d.ts +9 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailCheckData.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailEvent.d.ts +11 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailEvent.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailPaymentData.d.ts +41 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailPaymentData.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailQueryResponse.d.ts +10 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailQueryResponse.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailRecord.d.ts +132 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailRecord.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendor.d.ts +96 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendor.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.d.ts +35 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutEventData.d.ts +15 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutEventData.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutMessage.d.ts +22 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutMessage.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutMessageProperties.d.ts +9 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutMessageProperties.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutQueryResponse.d.ts +10 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutQueryResponse.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutRecord.d.ts +74 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutRecord.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutSummary.d.ts +11 -0
- package/dist/cjs/api/resources/queryTypes/types/TransferOutSummary.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/index.d.ts +16 -0
- package/dist/cjs/api/resources/queryTypes/types/index.js +16 -0
- package/dist/cjs/api/resources/v2MoneyInTypes/types/V2BadRequestError.d.ts +1 -1
- package/dist/cjs/api/resources/v2MoneyInTypes/types/V2ResponseCode.d.ts +1 -1
- package/dist/cjs/api/types/Entry.d.ts +1 -1
- package/dist/cjs/api/types/PendingFeeAmount.d.ts +1 -1
- package/dist/cjs/api/types/QueryTransactionEvents.d.ts +1 -1
- package/dist/cjs/api/types/Responsecode.d.ts +1 -1
- package/dist/cjs/api/types/ResultCodeText.d.ts +1 -1
- package/dist/cjs/api/types/ResultCodev2.d.ts +1 -1
- package/dist/cjs/api/types/SettingElement.d.ts +1 -1
- package/dist/cjs/api/types/Transfer.d.ts +2 -1
- package/dist/cjs/api/types/TransferBankAccount.d.ts +1 -0
- package/dist/cjs/api/types/TransferQueryResponse.d.ts +2 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/bill/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/bill/client/Client.mjs +2 -2
- package/dist/esm/api/resources/cloud/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/cloud/client/Client.mjs +4 -4
- package/dist/esm/api/resources/export/client/Client.d.mts +14 -14
- package/dist/esm/api/resources/export/client/Client.mjs +14 -14
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/hostedPaymentPages/client/Client.mjs +3 -3
- package/dist/esm/api/resources/invoice/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/invoice/client/Client.mjs +3 -3
- package/dist/esm/api/resources/lineItem/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/lineItem/client/Client.mjs +2 -2
- package/dist/esm/api/resources/moneyIn/client/Client.d.mts +10 -10
- package/dist/esm/api/resources/moneyIn/client/Client.mjs +10 -10
- package/dist/esm/api/resources/moneyIn/types/TransactionDetailResponseData.d.mts +2 -2
- package/dist/esm/api/resources/moneyOut/client/Client.d.mts +31 -0
- package/dist/esm/api/resources/moneyOut/client/Client.mjs +75 -0
- package/dist/esm/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.d.mts +10 -0
- package/dist/esm/api/resources/moneyOutTypes/types/AllowedCheckPaymentStatus.mjs +10 -0
- package/dist/esm/api/resources/moneyOutTypes/types/index.d.mts +1 -0
- package/dist/esm/api/resources/moneyOutTypes/types/index.mjs +1 -0
- package/dist/esm/api/resources/organization/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/organization/client/Client.mjs +1 -1
- package/dist/esm/api/resources/paypoint/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/paypoint/client/Client.mjs +6 -6
- package/dist/esm/api/resources/query/client/Client.d.mts +63 -2
- package/dist/esm/api/resources/query/client/Client.mjs +228 -2
- package/dist/esm/api/resources/query/client/requests/ListTransactionsOrgRequest.d.mts +0 -1
- package/dist/esm/api/resources/query/client/requests/ListTransferDetailsOutRequest.d.mts +45 -0
- package/dist/esm/api/resources/query/client/requests/ListTransferDetailsOutRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersOutOrgRequest.d.mts +46 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersOutOrgRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersOutPaypointRequest.d.mts +46 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersOutPaypointRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListTransfersPaypointRequest.d.mts +0 -1
- package/dist/esm/api/resources/query/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/queryTypes/types/QueryBatchesResponse.d.mts +3 -3
- package/dist/esm/api/resources/queryTypes/types/TransferOutBankAccount.d.mts +11 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutBankAccount.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBill.d.mts +36 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBill.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBillAttachment.d.mts +15 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailBillAttachment.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailCheckData.d.mts +9 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailCheckData.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailEvent.d.mts +11 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailEvent.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailPaymentData.d.mts +41 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailPaymentData.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailQueryResponse.d.mts +10 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailQueryResponse.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailRecord.d.mts +132 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailRecord.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendor.d.mts +96 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendor.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.d.mts +35 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutDetailVendorBillingData.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutEventData.d.mts +15 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutEventData.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutMessage.d.mts +22 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutMessage.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutMessageProperties.d.mts +9 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutMessageProperties.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutQueryResponse.d.mts +10 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutQueryResponse.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutRecord.d.mts +74 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutRecord.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutSummary.d.mts +11 -0
- package/dist/esm/api/resources/queryTypes/types/TransferOutSummary.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/index.d.mts +16 -0
- package/dist/esm/api/resources/queryTypes/types/index.mjs +16 -0
- package/dist/esm/api/resources/v2MoneyInTypes/types/V2BadRequestError.d.mts +1 -1
- package/dist/esm/api/resources/v2MoneyInTypes/types/V2ResponseCode.d.mts +1 -1
- package/dist/esm/api/types/Entry.d.mts +1 -1
- package/dist/esm/api/types/PendingFeeAmount.d.mts +1 -1
- package/dist/esm/api/types/QueryTransactionEvents.d.mts +1 -1
- package/dist/esm/api/types/Responsecode.d.mts +1 -1
- package/dist/esm/api/types/ResultCodeText.d.mts +1 -1
- package/dist/esm/api/types/ResultCodev2.d.mts +1 -1
- package/dist/esm/api/types/SettingElement.d.mts +1 -1
- package/dist/esm/api/types/Transfer.d.mts +2 -1
- package/dist/esm/api/types/TransferBankAccount.d.mts +1 -0
- package/dist/esm/api/types/TransferQueryResponse.d.mts +2 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +360 -48
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A record representing an outbound transfer detail.
|
|
4
|
+
*/
|
|
5
|
+
export interface TransferOutDetailRecord {
|
|
6
|
+
/** Unique identifier for the transfer detail. */
|
|
7
|
+
transferDetailId: number | null;
|
|
8
|
+
/** The ID of the transfer this detail belongs to. */
|
|
9
|
+
transferId: number | null;
|
|
10
|
+
/** The transaction ID in Payabli's system. */
|
|
11
|
+
transactionId: string | null;
|
|
12
|
+
/** The outbound transaction ID. */
|
|
13
|
+
IdOut: number | null;
|
|
14
|
+
/** Payment method used. */
|
|
15
|
+
method: string | null;
|
|
16
|
+
/** The transaction type (credit or debit). */
|
|
17
|
+
type: string | null;
|
|
18
|
+
/** Category of the transaction detail. */
|
|
19
|
+
category: string | null;
|
|
20
|
+
/** The gross amount of the transaction. */
|
|
21
|
+
grossAmount: number | null;
|
|
22
|
+
/** Amount returned. */
|
|
23
|
+
returnedAmount: number | null;
|
|
24
|
+
/** Amount refunded. */
|
|
25
|
+
refundAmount: number | null;
|
|
26
|
+
/** Amount being held. */
|
|
27
|
+
holdAmount: number | null;
|
|
28
|
+
/** Amount released. */
|
|
29
|
+
releasedAmount: number | null;
|
|
30
|
+
/** Billing fees amount. */
|
|
31
|
+
billingFeesAmount: number | null;
|
|
32
|
+
/** Adjustments amount. */
|
|
33
|
+
adjustmentsAmount: number | null;
|
|
34
|
+
/** Net transfer amount after deductions. */
|
|
35
|
+
netTransferAmount: number | null;
|
|
36
|
+
/** Detailed breakdown of billing fees. */
|
|
37
|
+
billingFeesDetails: Payabli.BillingFeeDetail[] | null;
|
|
38
|
+
/** Date and time the record was created. */
|
|
39
|
+
CreatedAt: string | null;
|
|
40
|
+
/** Comments on the transfer detail. */
|
|
41
|
+
Comments: string | null;
|
|
42
|
+
/** Vendor information. */
|
|
43
|
+
Vendor: Payabli.TransferOutDetailVendor | null;
|
|
44
|
+
/** DBA name of the paypoint. */
|
|
45
|
+
PaypointDbaname: string | null;
|
|
46
|
+
/** Legal name of the paypoint. */
|
|
47
|
+
PaypointLegalname: string | null;
|
|
48
|
+
/** ID of the paypoint. */
|
|
49
|
+
PaypointId: number | null;
|
|
50
|
+
/** Status of the transfer detail. */
|
|
51
|
+
Status: number | null;
|
|
52
|
+
/** Payment ID. */
|
|
53
|
+
PaymentId: string | null;
|
|
54
|
+
/** Transaction ID. */
|
|
55
|
+
TransId: string | null;
|
|
56
|
+
/** Transaction status. */
|
|
57
|
+
TransStatus: number | null;
|
|
58
|
+
/** Detailed transaction status. */
|
|
59
|
+
TransStatusDetail: string | null;
|
|
60
|
+
/** Name of the transaction status. */
|
|
61
|
+
TransStatusName: string | null;
|
|
62
|
+
/** Category of the transaction status. */
|
|
63
|
+
TransStatusCategory: string | null;
|
|
64
|
+
/** Date and time the record was last updated. */
|
|
65
|
+
LastUpdated: string | null;
|
|
66
|
+
/** Total amount of the transaction. */
|
|
67
|
+
TotalAmount: number | null;
|
|
68
|
+
/** Net amount of the transaction. */
|
|
69
|
+
NetAmount: number | null;
|
|
70
|
+
/** Fee amount for the transaction. */
|
|
71
|
+
FeeAmount: number | null;
|
|
72
|
+
/** Source of the transaction. */
|
|
73
|
+
Source: string | null;
|
|
74
|
+
/** Name of the parent organization. */
|
|
75
|
+
ParentOrgName: string | null;
|
|
76
|
+
/** ID of the parent organization. */
|
|
77
|
+
ParentOrgId: number | null;
|
|
78
|
+
/** Batch number for the transfer. */
|
|
79
|
+
BatchNumber: string | null;
|
|
80
|
+
/** Status of the payment. */
|
|
81
|
+
PaymentStatus: string | null;
|
|
82
|
+
/** Payment method used. */
|
|
83
|
+
PaymentMethod: string | null;
|
|
84
|
+
/** Token for the card used. */
|
|
85
|
+
CardToken: string | null;
|
|
86
|
+
/** Check number if paid by check. */
|
|
87
|
+
CheckNumber: string | null;
|
|
88
|
+
/** Check data if paid by check. */
|
|
89
|
+
CheckData: Payabli.TransferOutDetailCheckData | null;
|
|
90
|
+
/** Payment data for the transaction. */
|
|
91
|
+
PaymentData: Payabli.TransferOutDetailPaymentData | null;
|
|
92
|
+
/** Bills associated with the transfer. */
|
|
93
|
+
Bills: Payabli.TransferOutDetailBill[] | null;
|
|
94
|
+
/** Events associated with the transfer. */
|
|
95
|
+
Events: Payabli.TransferOutDetailEvent[] | null;
|
|
96
|
+
/** External paypoint ID. */
|
|
97
|
+
externalPaypointID: string | null;
|
|
98
|
+
/** Entry name for the paypoint. */
|
|
99
|
+
EntryName: string | null;
|
|
100
|
+
/** Gateway used for the transaction. */
|
|
101
|
+
Gateway: string | null;
|
|
102
|
+
/** ID of the batch. */
|
|
103
|
+
BatchId: number | null;
|
|
104
|
+
/** Whether the transfer has virtual card transactions. */
|
|
105
|
+
HasVcardTransactions: boolean | null;
|
|
106
|
+
/** Whether this is a same-day ACH transaction. */
|
|
107
|
+
IsSameDayACH: boolean | null;
|
|
108
|
+
/** ID of the schedule if applicable. */
|
|
109
|
+
ScheduleId: number | null;
|
|
110
|
+
/** Settlement status. */
|
|
111
|
+
SettlementStatus: string | null;
|
|
112
|
+
/** Name of the settlement status. */
|
|
113
|
+
SettlementStatusName: string | null;
|
|
114
|
+
/** Date of settlement. */
|
|
115
|
+
SettlementDate: string | null;
|
|
116
|
+
/** Whether the transaction was flagged for risk. */
|
|
117
|
+
RiskFlagged: boolean | null;
|
|
118
|
+
/** Date and time the transaction was flagged. */
|
|
119
|
+
RiskFlaggedOn: string | null;
|
|
120
|
+
/** Risk status of the transaction. */
|
|
121
|
+
RiskStatus: string | null;
|
|
122
|
+
/** Reason for the risk flag. */
|
|
123
|
+
RiskReason: string | null;
|
|
124
|
+
/** Action taken for risk. */
|
|
125
|
+
RiskAction: string | null;
|
|
126
|
+
/** Code for the risk action. */
|
|
127
|
+
RiskActionCode: number | null;
|
|
128
|
+
/** Payout program used. */
|
|
129
|
+
PayoutProgram: string | null;
|
|
130
|
+
/** ACH trace number. */
|
|
131
|
+
AchTraceNumber: string | null;
|
|
132
|
+
}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Vendor information for an outbound transfer detail.
|
|
4
|
+
*/
|
|
5
|
+
export interface TransferOutDetailVendor {
|
|
6
|
+
/** The vendor's unique number. */
|
|
7
|
+
VendorNumber: string | null;
|
|
8
|
+
/** Primary name of the vendor. */
|
|
9
|
+
Name1: string | null;
|
|
10
|
+
/** Secondary name of the vendor. */
|
|
11
|
+
Name2: string | null;
|
|
12
|
+
/** Employer Identification Number. */
|
|
13
|
+
EIN: string | null;
|
|
14
|
+
/** Vendor's phone number. */
|
|
15
|
+
Phone: string | null;
|
|
16
|
+
/** Vendor's email address. */
|
|
17
|
+
Email: string | null;
|
|
18
|
+
/** Email for remittance notifications. */
|
|
19
|
+
RemitEmail: string | null;
|
|
20
|
+
/** Primary address line. */
|
|
21
|
+
Address1: string | null;
|
|
22
|
+
/** Secondary address line. */
|
|
23
|
+
Address2: string | null;
|
|
24
|
+
/** City of the vendor. */
|
|
25
|
+
City: string | null;
|
|
26
|
+
/** State of the vendor. */
|
|
27
|
+
State: string | null;
|
|
28
|
+
/** ZIP code of the vendor. */
|
|
29
|
+
Zip: string | null;
|
|
30
|
+
/** Country of the vendor. */
|
|
31
|
+
Country: string | null;
|
|
32
|
+
/** Merchant Category Code. */
|
|
33
|
+
Mcc: string | null;
|
|
34
|
+
/** Location code for the vendor. */
|
|
35
|
+
LocationCode: string | null;
|
|
36
|
+
/** List of contacts for the vendor. */
|
|
37
|
+
Contacts: Payabli.ContactsResponse[] | null;
|
|
38
|
+
/** Billing data for the vendor. */
|
|
39
|
+
BillingData: Payabli.TransferOutDetailVendorBillingData | null;
|
|
40
|
+
/** Preferred payment method. */
|
|
41
|
+
PaymentMethod: string | null;
|
|
42
|
+
/** Status of the vendor. */
|
|
43
|
+
VendorStatus: number | null;
|
|
44
|
+
/** Unique identifier for the vendor. */
|
|
45
|
+
VendorId: number | null;
|
|
46
|
+
/** Enrollment status of the vendor. */
|
|
47
|
+
EnrollmentStatus: number | null;
|
|
48
|
+
/** Summary information about the vendor. */
|
|
49
|
+
Summary: string | null;
|
|
50
|
+
/** Legal name of the paypoint. */
|
|
51
|
+
PaypointLegalname: string | null;
|
|
52
|
+
/** ID of the paypoint. */
|
|
53
|
+
PaypointId: number | null;
|
|
54
|
+
/** DBA name of the paypoint. */
|
|
55
|
+
PaypointDbaname: string | null;
|
|
56
|
+
/** Entry name of the paypoint. */
|
|
57
|
+
PaypointEntryname: string | null;
|
|
58
|
+
/** Name of the parent organization. */
|
|
59
|
+
ParentOrgName: string | null;
|
|
60
|
+
/** ID of the parent organization. */
|
|
61
|
+
ParentOrgId: number | null;
|
|
62
|
+
/** Date the vendor was created. */
|
|
63
|
+
CreatedDate: string | null;
|
|
64
|
+
/** Date the vendor was last updated. */
|
|
65
|
+
LastUpdated: string | null;
|
|
66
|
+
/** Primary remittance address line. */
|
|
67
|
+
remitAddress1: string | null;
|
|
68
|
+
/** Secondary remittance address line. */
|
|
69
|
+
remitAddress2: string | null;
|
|
70
|
+
/** Remittance city. */
|
|
71
|
+
remitCity: string | null;
|
|
72
|
+
/** Remittance state. */
|
|
73
|
+
remitState: string | null;
|
|
74
|
+
/** Remittance ZIP code. */
|
|
75
|
+
remitZip: string | null;
|
|
76
|
+
/** Remittance country. */
|
|
77
|
+
remitCountry: string | null;
|
|
78
|
+
/** Primary payee name. */
|
|
79
|
+
payeeName1: string | null;
|
|
80
|
+
/** Secondary payee name. */
|
|
81
|
+
payeeName2: string | null;
|
|
82
|
+
/** Custom field 1. */
|
|
83
|
+
customField1: string | null;
|
|
84
|
+
/** Custom field 2. */
|
|
85
|
+
customField2: string | null;
|
|
86
|
+
/** Customer vendor account number. */
|
|
87
|
+
customerVendorAccount: string | null;
|
|
88
|
+
/** Internal reference ID. */
|
|
89
|
+
InternalReferenceId: number | null;
|
|
90
|
+
/** Additional data for the vendor. */
|
|
91
|
+
additionalData: Record<string, unknown> | null;
|
|
92
|
+
/** External paypoint ID. */
|
|
93
|
+
externalPaypointID: string | null;
|
|
94
|
+
/** Stored payment methods for the vendor. */
|
|
95
|
+
StoredMethods: unknown[] | null;
|
|
96
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Billing data for a vendor.
|
|
3
|
+
*/
|
|
4
|
+
export interface TransferOutDetailVendorBillingData {
|
|
5
|
+
/** Unique identifier for the billing data. */
|
|
6
|
+
id: number | null;
|
|
7
|
+
/** The account ID. */
|
|
8
|
+
accountId: string | null;
|
|
9
|
+
/** A nickname for the account. */
|
|
10
|
+
nickname: string | null;
|
|
11
|
+
/** The name of the bank. */
|
|
12
|
+
bankName: string | null;
|
|
13
|
+
/** The routing number. */
|
|
14
|
+
routingAccount: string | null;
|
|
15
|
+
/** The account number. */
|
|
16
|
+
accountNumber: string | null;
|
|
17
|
+
/** The type of account. */
|
|
18
|
+
typeAccount: string | null;
|
|
19
|
+
/** The name of the account holder. */
|
|
20
|
+
bankAccountHolderName: string | null;
|
|
21
|
+
/** The type of account holder. */
|
|
22
|
+
bankAccountHolderType: string | null;
|
|
23
|
+
/** The function of the bank account. */
|
|
24
|
+
bankAccountFunction: number | null;
|
|
25
|
+
/** Whether the account is verified. */
|
|
26
|
+
verified: boolean | null;
|
|
27
|
+
/** The status of the billing data. */
|
|
28
|
+
status: number | null;
|
|
29
|
+
/** Services associated with the billing data. */
|
|
30
|
+
services: unknown[] | null;
|
|
31
|
+
/** Whether this is the default billing data. */
|
|
32
|
+
default: boolean | null;
|
|
33
|
+
/** The country of the bank account. */
|
|
34
|
+
country: string | null;
|
|
35
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Event data associated with an outbound transfer.
|
|
3
|
+
*/
|
|
4
|
+
export interface TransferOutEventData {
|
|
5
|
+
/** Description of the event. */
|
|
6
|
+
description: string | null;
|
|
7
|
+
/** The time the event occurred. */
|
|
8
|
+
eventTime: string | null;
|
|
9
|
+
/** Reference data for the event. */
|
|
10
|
+
refData: string | null;
|
|
11
|
+
/** Additional event data, which may contain detailed transaction information. */
|
|
12
|
+
extraData: unknown | null;
|
|
13
|
+
/** The source of the event. */
|
|
14
|
+
source: string | null;
|
|
15
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A message associated with an outbound transfer.
|
|
4
|
+
*/
|
|
5
|
+
export interface TransferOutMessage {
|
|
6
|
+
/** Unique identifier for the message. */
|
|
7
|
+
Id: number | null;
|
|
8
|
+
/** The ID of the room where the message was sent. */
|
|
9
|
+
RoomId: number | null;
|
|
10
|
+
/** The ID of the user who sent the message. */
|
|
11
|
+
UserId: number | null;
|
|
12
|
+
/** The name of the user who sent the message. */
|
|
13
|
+
UserName: string | null;
|
|
14
|
+
/** The content of the message. */
|
|
15
|
+
Content: string | null;
|
|
16
|
+
/** The time the message was created. */
|
|
17
|
+
CreatedAt: string | null;
|
|
18
|
+
/** The type of message. */
|
|
19
|
+
MessageType: number | null;
|
|
20
|
+
/** Additional properties for the message. */
|
|
21
|
+
MessageProperties: Payabli.TransferOutMessageProperties | null;
|
|
22
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Properties associated with a transfer message.
|
|
3
|
+
*/
|
|
4
|
+
export interface TransferOutMessageProperties {
|
|
5
|
+
/** The original status of the transfer before the message. */
|
|
6
|
+
originalTransferStatus: string | null;
|
|
7
|
+
/** The current status of the transfer after the message. */
|
|
8
|
+
currentTransferStatus: string | null;
|
|
9
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Response body for queries about outbound transfers.
|
|
4
|
+
*/
|
|
5
|
+
export interface TransferOutQueryResponse {
|
|
6
|
+
/** Summary information about the transfers. */
|
|
7
|
+
Summary: Payabli.TransferOutSummary;
|
|
8
|
+
/** List of outbound transfer records. */
|
|
9
|
+
Records: Payabli.TransferOutRecord[];
|
|
10
|
+
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A record representing an outbound transfer.
|
|
4
|
+
*/
|
|
5
|
+
export interface TransferOutRecord {
|
|
6
|
+
/** Unique identifier for the transfer. */
|
|
7
|
+
transferId: number | null;
|
|
8
|
+
/** The ID of the paypoint associated with the transfer. */
|
|
9
|
+
paypointId: number | null;
|
|
10
|
+
/** The batch number for the transfer. */
|
|
11
|
+
batchNumber: string | null;
|
|
12
|
+
/** The currency of the batch. */
|
|
13
|
+
batchCurrency: string | null;
|
|
14
|
+
/** The number of records in the batch. */
|
|
15
|
+
batchRecords: number | null;
|
|
16
|
+
/** An identifier for the transfer. */
|
|
17
|
+
transferIdentifier: string | null;
|
|
18
|
+
/** The ID of the batch. */
|
|
19
|
+
batchId: number | null;
|
|
20
|
+
/** The net amount of the batch. */
|
|
21
|
+
batchNetAmount: number | null;
|
|
22
|
+
/** The status of the batch. */
|
|
23
|
+
batchStatus: number | null;
|
|
24
|
+
/** The entry name for the paypoint. */
|
|
25
|
+
paypointEntryName: string | null;
|
|
26
|
+
/** The legal name of the paypoint. */
|
|
27
|
+
paypointLegalName: string | null;
|
|
28
|
+
/** The DBA name of the paypoint. */
|
|
29
|
+
paypointDbaName: string | null;
|
|
30
|
+
/** URL to the paypoint's logo. */
|
|
31
|
+
paypointLogo: string | null;
|
|
32
|
+
/** The name of the parent organization. */
|
|
33
|
+
parentOrgName: string | null;
|
|
34
|
+
/** The ID of the parent organization. */
|
|
35
|
+
parentOrgId: number | null;
|
|
36
|
+
/** URL to the parent organization's logo. */
|
|
37
|
+
parentOrgLogo: string | null;
|
|
38
|
+
/** The entry name for the parent organization. */
|
|
39
|
+
parentOrgEntryName: string | null;
|
|
40
|
+
/** External identifier for the paypoint. */
|
|
41
|
+
externalPaypointID: string | null;
|
|
42
|
+
/** Bank account information for the transfer. */
|
|
43
|
+
bankAccount: Payabli.TransferOutBankAccount | null;
|
|
44
|
+
/** The date of the transfer. */
|
|
45
|
+
transferDate: string | null;
|
|
46
|
+
/** The processor used for the transfer. */
|
|
47
|
+
processor: string | null;
|
|
48
|
+
/** The status of the transfer. */
|
|
49
|
+
transferStatus: number | null;
|
|
50
|
+
/** The gross amount of the transfer. */
|
|
51
|
+
grossAmount: number | null;
|
|
52
|
+
/** The chargeback amount deducted from the transfer. */
|
|
53
|
+
chargeBackAmount: number | null;
|
|
54
|
+
/** The returned amount deducted from the transfer. */
|
|
55
|
+
returnedAmount: number | null;
|
|
56
|
+
/** The amount being held. */
|
|
57
|
+
holdAmount: number | null;
|
|
58
|
+
/** The amount that has been released. */
|
|
59
|
+
releasedAmount: number | null;
|
|
60
|
+
/** The billing fees amount. */
|
|
61
|
+
billingFeesAmount: number | null;
|
|
62
|
+
/** The third party paid amount. */
|
|
63
|
+
thirdPartyPaidAmount: number | null;
|
|
64
|
+
/** The adjustments amount. */
|
|
65
|
+
adjustmentsAmount: number | null;
|
|
66
|
+
/** The net transfer amount after all deductions. */
|
|
67
|
+
netTransferAmount: number | null;
|
|
68
|
+
/** The split funding amount. */
|
|
69
|
+
splitAmount: number | null;
|
|
70
|
+
/** List of events associated with the transfer. */
|
|
71
|
+
eventsData: Payabli.TransferOutEventData[] | null;
|
|
72
|
+
/** List of messages associated with the transfer. */
|
|
73
|
+
messages: Payabli.TransferOutMessage[] | null;
|
|
74
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Summary information for outbound transfer queries.
|
|
3
|
+
*/
|
|
4
|
+
export interface TransferOutSummary {
|
|
5
|
+
/** Number of pages in the response. */
|
|
6
|
+
totalPages: number | null;
|
|
7
|
+
/** Number of records in the response. */
|
|
8
|
+
totalRecords: number | null;
|
|
9
|
+
/** Number of records per page. */
|
|
10
|
+
pageSize: number | null;
|
|
11
|
+
}
|
|
@@ -6,3 +6,19 @@ export * from "./QueryBatchesTransfer.js";
|
|
|
6
6
|
export * from "./QueryTransferDetailResponse.js";
|
|
7
7
|
export * from "./QueryTransferResponse.js";
|
|
8
8
|
export * from "./QueryTransferSummary.js";
|
|
9
|
+
export * from "./TransferOutBankAccount.js";
|
|
10
|
+
export * from "./TransferOutDetailBill.js";
|
|
11
|
+
export * from "./TransferOutDetailBillAttachment.js";
|
|
12
|
+
export * from "./TransferOutDetailCheckData.js";
|
|
13
|
+
export * from "./TransferOutDetailEvent.js";
|
|
14
|
+
export * from "./TransferOutDetailPaymentData.js";
|
|
15
|
+
export * from "./TransferOutDetailQueryResponse.js";
|
|
16
|
+
export * from "./TransferOutDetailRecord.js";
|
|
17
|
+
export * from "./TransferOutDetailVendor.js";
|
|
18
|
+
export * from "./TransferOutDetailVendorBillingData.js";
|
|
19
|
+
export * from "./TransferOutEventData.js";
|
|
20
|
+
export * from "./TransferOutMessage.js";
|
|
21
|
+
export * from "./TransferOutMessageProperties.js";
|
|
22
|
+
export * from "./TransferOutQueryResponse.js";
|
|
23
|
+
export * from "./TransferOutRecord.js";
|
|
24
|
+
export * from "./TransferOutSummary.js";
|
|
@@ -22,3 +22,19 @@ __exportStar(require("./QueryBatchesTransfer.js"), exports);
|
|
|
22
22
|
__exportStar(require("./QueryTransferDetailResponse.js"), exports);
|
|
23
23
|
__exportStar(require("./QueryTransferResponse.js"), exports);
|
|
24
24
|
__exportStar(require("./QueryTransferSummary.js"), exports);
|
|
25
|
+
__exportStar(require("./TransferOutBankAccount.js"), exports);
|
|
26
|
+
__exportStar(require("./TransferOutDetailBill.js"), exports);
|
|
27
|
+
__exportStar(require("./TransferOutDetailBillAttachment.js"), exports);
|
|
28
|
+
__exportStar(require("./TransferOutDetailCheckData.js"), exports);
|
|
29
|
+
__exportStar(require("./TransferOutDetailEvent.js"), exports);
|
|
30
|
+
__exportStar(require("./TransferOutDetailPaymentData.js"), exports);
|
|
31
|
+
__exportStar(require("./TransferOutDetailQueryResponse.js"), exports);
|
|
32
|
+
__exportStar(require("./TransferOutDetailRecord.js"), exports);
|
|
33
|
+
__exportStar(require("./TransferOutDetailVendor.js"), exports);
|
|
34
|
+
__exportStar(require("./TransferOutDetailVendorBillingData.js"), exports);
|
|
35
|
+
__exportStar(require("./TransferOutEventData.js"), exports);
|
|
36
|
+
__exportStar(require("./TransferOutMessage.js"), exports);
|
|
37
|
+
__exportStar(require("./TransferOutMessageProperties.js"), exports);
|
|
38
|
+
__exportStar(require("./TransferOutQueryResponse.js"), exports);
|
|
39
|
+
__exportStar(require("./TransferOutRecord.js"), exports);
|
|
40
|
+
__exportStar(require("./TransferOutSummary.js"), exports);
|
|
@@ -13,7 +13,7 @@ export interface V2BadRequestError {
|
|
|
13
13
|
detail: string;
|
|
14
14
|
/** Request URL that caused the error. */
|
|
15
15
|
instance: string;
|
|
16
|
-
/** Payabli's unified response code for validation errors. Starts with 'E'. See [Pay In unified response codes reference](/
|
|
16
|
+
/** Payabli's unified response code for validation errors. Starts with 'E'. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information. */
|
|
17
17
|
code: string;
|
|
18
18
|
/** Dictionary of field-specific validation errors. Keys are field paths (e.g., "paymentMethod.cardnumber") and values are arrays of error details. */
|
|
19
19
|
errors: Record<string, Payabli.V2BadRequestErrorDetail[]>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Payabli's unified response code. Starts with `A` (Approved) or `D` (Declined) followed by a four-digit code that provides specific details about the transaction result. See [Pay In unified response codes reference](/
|
|
2
|
+
* Payabli's unified response code. Starts with `A` (Approved) or `D` (Declined) followed by a four-digit code that provides specific details about the transaction result. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
3
3
|
*/
|
|
4
4
|
export type V2ResponseCode = string;
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
*
|
|
3
3
|
* The difference between the configured pass-through fee and the fee amount sent in the request. When transferring funds, Payabli uses this field to deduct the fee difference and transfer the correct amount to the merchant.
|
|
4
4
|
*
|
|
5
|
-
* When a paypoint is set up to absorb fees, and the pass-through fee sent with the request is less than the configured amount, the difference must be covered by the merchant. See [Fee Configuration](/guides/passthrough-
|
|
5
|
+
* When a paypoint is set up to absorb fees, and the pass-through fee sent with the request is less than the configured amount, the difference must be covered by the merchant. See [Fee Configuration](/guides/pay-in-fees-passthrough-overview#fee-configuration) to learn more about pass-through fee settings.
|
|
6
6
|
*/
|
|
7
7
|
export type PendingFeeAmount = number | undefined;
|
|
@@ -3,7 +3,7 @@ export interface QueryTransactionEvents {
|
|
|
3
3
|
EventData?: QueryTransactionEvents.EventData;
|
|
4
4
|
/** Date and time of event. */
|
|
5
5
|
EventTime?: string;
|
|
6
|
-
/** Event descriptor. See [TransEvent Reference](/
|
|
6
|
+
/** Event descriptor. See [TransEvent Reference](/guides/pay-in-transevents-reference) for more details. */
|
|
7
7
|
TransEvent?: string;
|
|
8
8
|
}
|
|
9
9
|
export declare namespace QueryTransactionEvents {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Description of the result code. See [Pay In unified response codes](/developers/references/pay-in-unified-response-codes) for more information.
|
|
2
|
+
* Description of the result code. See [Pay In unified response codes](/developers/references/pay-in-unified-response-codes-reference) for more information.
|
|
3
3
|
*/
|
|
4
4
|
export type ResultCodeText = string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Unified result code for the transaction. See [Pay In unified response codes](/developers/references/pay-in-unified-response-codes) for more information.
|
|
2
|
+
* Unified result code for the transaction. See [Pay In unified response codes](/developers/references/pay-in-unified-response-codes-reference) for more information.
|
|
3
3
|
*/
|
|
4
4
|
export type ResultCodev2 = string;
|
|
@@ -6,6 +6,6 @@ export interface SettingElement {
|
|
|
6
6
|
order?: Payabli.Order;
|
|
7
7
|
/** When `true`, Payabli automatically sends the receipt to the payor email address. */
|
|
8
8
|
sendAuto?: boolean;
|
|
9
|
-
/** When `true`, you must send the reciept to the payor manually using the [/MoneyIn/sendreceipt/\{transId\}](/api-reference/moneyin/send-receipt-for-transaction) endpoint. */
|
|
9
|
+
/** When `true`, you must send the reciept to the payor manually using the [/MoneyIn/sendreceipt/\{transId\}](/developers/api-reference/moneyin/send-receipt-for-transaction) endpoint. */
|
|
10
10
|
sendManual?: boolean;
|
|
11
11
|
}
|
|
@@ -20,7 +20,8 @@ import type * as Payabli from "../index.js";
|
|
|
20
20
|
* externalPaypointID: "ext-12345",
|
|
21
21
|
* bankAccount: {
|
|
22
22
|
* accountNumber: "****1234",
|
|
23
|
-
* routingNumber: "123456789"
|
|
23
|
+
* routingNumber: "123456789",
|
|
24
|
+
* bankName: "Riverdale Community Bank"
|
|
24
25
|
* },
|
|
25
26
|
* transferDate: "2024-11-17T08:20:07.288+00:00",
|
|
26
27
|
* processor: "gp",
|
|
@@ -21,7 +21,8 @@ import type * as Payabli from "../index.js";
|
|
|
21
21
|
* externalPaypointID: "ext-12345",
|
|
22
22
|
* bankAccount: {
|
|
23
23
|
* accountNumber: "****1234",
|
|
24
|
-
* routingNumber: "123456789"
|
|
24
|
+
* routingNumber: "123456789",
|
|
25
|
+
* bankName: "Riverdale Community Bank"
|
|
25
26
|
* },
|
|
26
27
|
* transferDate: "2024-11-17T08:20:07.288+00:00",
|
|
27
28
|
* processor: "gp",
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.0.
|
|
1
|
+
export declare const SDK_VERSION = "0.0.130";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@payabli/sdk-node",
|
|
9
|
-
"X-Fern-SDK-Version": "0.0.
|
|
10
|
-
"User-Agent": "@payabli/sdk-node/0.0.
|
|
9
|
+
"X-Fern-SDK-Version": "0.0.130",
|
|
10
|
+
"User-Agent": "@payabli/sdk-node/0.0.130",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|