@payabli/sdk-node 0.0.144 → 0.0.146

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.
Files changed (76) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/query/client/Client.d.ts +58 -0
  3. package/dist/cjs/api/resources/query/client/Client.js +160 -0
  4. package/dist/cjs/api/resources/query/client/requests/ListSubscriptionsOrgRequest.d.ts +1 -0
  5. package/dist/cjs/api/resources/query/client/requests/ListSubscriptionsRequest.d.ts +1 -0
  6. package/dist/cjs/api/resources/query/client/requests/ListTransactionsOrgRequest.d.ts +9 -0
  7. package/dist/cjs/api/resources/query/client/requests/ListTransactionsRequest.d.ts +9 -0
  8. package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts +8 -6
  9. package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts +8 -6
  10. package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.d.ts +72 -0
  11. package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.js +3 -0
  12. package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsRequest.d.ts +72 -0
  13. package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsRequest.js +3 -0
  14. package/dist/cjs/api/resources/query/client/requests/ListVendorsOrgRequest.d.ts +1 -0
  15. package/dist/cjs/api/resources/query/client/requests/ListVendorsRequest.d.ts +1 -0
  16. package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
  17. package/dist/cjs/api/resources/queryTypes/types/QueryTransferDetailResponse.d.ts +2 -0
  18. package/dist/cjs/api/resources/queryTypes/types/QueryTransferSummary.d.ts +2 -0
  19. package/dist/cjs/api/resources/queryTypes/types/VCardTransactionQueryResponse.d.ts +49 -0
  20. package/dist/cjs/api/resources/queryTypes/types/VCardTransactionQueryResponse.js +3 -0
  21. package/dist/cjs/api/resources/queryTypes/types/VCardTransactionRecord.d.ts +86 -0
  22. package/dist/cjs/api/resources/queryTypes/types/VCardTransactionRecord.js +3 -0
  23. package/dist/cjs/api/resources/queryTypes/types/index.d.ts +2 -0
  24. package/dist/cjs/api/resources/queryTypes/types/index.js +2 -0
  25. package/dist/cjs/api/types/CustomerQueryRecords.d.ts +2 -0
  26. package/dist/cjs/api/types/QueryResponseTransactions.d.ts +74 -0
  27. package/dist/cjs/api/types/SplitCount.d.ts +4 -0
  28. package/dist/cjs/api/types/SplitCount.js +3 -0
  29. package/dist/cjs/api/types/SubscriptionQueryRecords.d.ts +10 -0
  30. package/dist/cjs/api/types/TransactionQueryRecords.d.ts +1 -0
  31. package/dist/cjs/api/types/TransactionQueryRecordsCustomer.d.ts +1 -0
  32. package/dist/cjs/api/types/VCardSummary.d.ts +4 -2
  33. package/dist/cjs/api/types/VendorResponseStoredMethod.d.ts +2 -1
  34. package/dist/cjs/api/types/index.d.ts +1 -0
  35. package/dist/cjs/api/types/index.js +1 -0
  36. package/dist/cjs/version.d.ts +1 -1
  37. package/dist/cjs/version.js +1 -1
  38. package/dist/esm/BaseClient.mjs +2 -2
  39. package/dist/esm/api/resources/query/client/Client.d.mts +58 -0
  40. package/dist/esm/api/resources/query/client/Client.mjs +160 -0
  41. package/dist/esm/api/resources/query/client/requests/ListSubscriptionsOrgRequest.d.mts +1 -0
  42. package/dist/esm/api/resources/query/client/requests/ListSubscriptionsRequest.d.mts +1 -0
  43. package/dist/esm/api/resources/query/client/requests/ListTransactionsOrgRequest.d.mts +9 -0
  44. package/dist/esm/api/resources/query/client/requests/ListTransactionsRequest.d.mts +9 -0
  45. package/dist/esm/api/resources/query/client/requests/ListVcardsOrgRequest.d.mts +8 -6
  46. package/dist/esm/api/resources/query/client/requests/ListVcardsRequest.d.mts +8 -6
  47. package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.d.mts +72 -0
  48. package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.mjs +2 -0
  49. package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsRequest.d.mts +72 -0
  50. package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsRequest.mjs +2 -0
  51. package/dist/esm/api/resources/query/client/requests/ListVendorsOrgRequest.d.mts +1 -0
  52. package/dist/esm/api/resources/query/client/requests/ListVendorsRequest.d.mts +1 -0
  53. package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
  54. package/dist/esm/api/resources/queryTypes/types/QueryTransferDetailResponse.d.mts +2 -0
  55. package/dist/esm/api/resources/queryTypes/types/QueryTransferSummary.d.mts +2 -0
  56. package/dist/esm/api/resources/queryTypes/types/VCardTransactionQueryResponse.d.mts +49 -0
  57. package/dist/esm/api/resources/queryTypes/types/VCardTransactionQueryResponse.mjs +2 -0
  58. package/dist/esm/api/resources/queryTypes/types/VCardTransactionRecord.d.mts +86 -0
  59. package/dist/esm/api/resources/queryTypes/types/VCardTransactionRecord.mjs +2 -0
  60. package/dist/esm/api/resources/queryTypes/types/index.d.mts +2 -0
  61. package/dist/esm/api/resources/queryTypes/types/index.mjs +2 -0
  62. package/dist/esm/api/types/CustomerQueryRecords.d.mts +2 -0
  63. package/dist/esm/api/types/QueryResponseTransactions.d.mts +74 -0
  64. package/dist/esm/api/types/SplitCount.d.mts +4 -0
  65. package/dist/esm/api/types/SplitCount.mjs +2 -0
  66. package/dist/esm/api/types/SubscriptionQueryRecords.d.mts +10 -0
  67. package/dist/esm/api/types/TransactionQueryRecords.d.mts +1 -0
  68. package/dist/esm/api/types/TransactionQueryRecordsCustomer.d.mts +1 -0
  69. package/dist/esm/api/types/VCardSummary.d.mts +4 -2
  70. package/dist/esm/api/types/VendorResponseStoredMethod.d.mts +2 -1
  71. package/dist/esm/api/types/index.d.mts +1 -0
  72. package/dist/esm/api/types/index.mjs +1 -0
  73. package/dist/esm/version.d.mts +1 -1
  74. package/dist/esm/version.mjs +1 -1
  75. package/package.json +1 -1
  76. package/reference.md +150 -0
@@ -70,6 +70,7 @@ export interface ListSubscriptionsRequest {
70
70
  * - `orgName` (ne, eq, ct, nct)
71
71
  * - `externalPaypointId` (ct, nct, ne, eq)
72
72
  * - `subId` (eq, ne)
73
+ * - `idPmethod` (eq, ne, ct, nct, in, nin). Filters by the subscription's linked stored method identifier (the value returned in `StoredMethod.IdPmethod`). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: `idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e)`.
73
74
  * - `orderDescription` (ct, nct)
74
75
  * - `cycles` (eq, ne, gt, ge, lt, le)
75
76
  * - `leftcycles` (eq, ne, gt, ge, lt, le)
@@ -6,6 +6,14 @@ import type * as Payabli from "../../../../index.mjs";
6
6
  * limitRecord: 0,
7
7
  * sortBy: "desc(field_name)"
8
8
  * }
9
+ *
10
+ * @example
11
+ * {
12
+ * limitRecord: 1,
13
+ * parameters: {
14
+ * "operation(eq)": "Reject"
15
+ * }
16
+ * }
9
17
  */
10
18
  export interface ListTransactionsOrgRequest {
11
19
  exportFormat?: Payabli.ExportFormat;
@@ -39,6 +47,7 @@ export interface ListTransactionsOrgRequest {
39
47
  * - `scheduleId` (ne, eq)
40
48
  * - `returnId` (ne, eq)
41
49
  * - `refundId` (ne, eq)
50
+ * - `rejectId` (ne, eq)
42
51
  * - `idTrans` (ne, eq)
43
52
  * - `orgId` (ne, eq)
44
53
  * - `paypointId` (ne, eq)
@@ -6,6 +6,14 @@ import type * as Payabli from "../../../../index.mjs";
6
6
  * limitRecord: 0,
7
7
  * sortBy: "desc(field_name)"
8
8
  * }
9
+ *
10
+ * @example
11
+ * {
12
+ * limitRecord: 1,
13
+ * parameters: {
14
+ * "operation(eq)": "Reject"
15
+ * }
16
+ * }
9
17
  */
10
18
  export interface ListTransactionsRequest {
11
19
  exportFormat?: Payabli.ExportFormat;
@@ -39,6 +47,7 @@ export interface ListTransactionsRequest {
39
47
  * - `scheduleId` (ne, eq)
40
48
  * - `returnId` (ne, eq)
41
49
  * - `refundId` (ne, eq)
50
+ * - `rejectId` (ne, eq)
42
51
  * - `idTrans` (ne, eq)
43
52
  * - `orgId` (ne, eq)
44
53
  * - `paypointId` (ne, eq)
@@ -30,13 +30,13 @@ export interface ListVcardsOrgRequest {
30
30
  * </Info>
31
31
  * List of field names accepted:
32
32
  *
33
- * - `status` (in, nin, eq, ne)
33
+ * - `status` (eq, ne, ct, nct, sw, ew)
34
34
  * - `createdAt` (gt, ge, lt, le, eq, ne)
35
35
  * - `cardToken` (ct, nct, eq, ne)
36
36
  * - `lastFour` (ct, nct, eq, ne)
37
37
  * - `expirationDate` (ct, nct, eq, ne)
38
- * - `payoutId` (ct, nct, eq, ne, in, nin)
39
- * - `vendorId` (ct, nct, eq, ne, in, nin)
38
+ * - `payoutId` (eq, ne, gt, ge, lt, le)
39
+ * - `vendorId` (eq, ne, gt, ge, lt, le)
40
40
  * - `miscData1` (ct, nct, eq, ne)
41
41
  * - `miscData2` (ct, nct, eq, ne)
42
42
  * - `currentUses` (gt, ge, lt, le, eq, ne)
@@ -44,10 +44,10 @@ export interface ListVcardsOrgRequest {
44
44
  * - `balance` (gt, ge, lt, le, eq, ne)
45
45
  * - `paypointLegal` (ne, eq, ct, nct)
46
46
  * - `paypointDba` (ne, eq, ct, nct)
47
- * - `orgName` (ne, eq, ct, nct)
47
+ * - `orgName` (eq, ne, ct, nct, sw, ew)
48
48
  * - `externalPaypointId` (ct, nct, eq, ne)
49
- * - `paypointId` (in, nin, eq, ne)
50
- * - `cardType` (eq)
49
+ * - `paypointId` (eq, ne, gt, ge, lt, le)
50
+ * - `cardType` (eq, ne, gt, ge, lt, le)
51
51
  *
52
52
  * List of comparison accepted - enclosed between parentheses:
53
53
  *
@@ -59,6 +59,8 @@ export interface ListVcardsOrgRequest {
59
59
  * - ne => not equal
60
60
  * - ct => contains
61
61
  * - nct => not contains
62
+ * - sw => starts with
63
+ * - ew => ends with
62
64
  * - in => inside array separated by "|"
63
65
  * - nin => not inside array separated by "|"
64
66
  */
@@ -30,13 +30,13 @@ export interface ListVcardsRequest {
30
30
  * </Info>
31
31
  * List of field names accepted:
32
32
  *
33
- * - `status` (in, nin, eq, ne)
33
+ * - `status` (eq, ne, ct, nct, sw, ew)
34
34
  * - `createdAt` (gt, ge, lt, le, eq, ne)
35
35
  * - `cardToken` (ct, nct, eq, ne)
36
36
  * - `lastFour` (ct, nct, eq, ne)
37
37
  * - `expirationDate` (ct, nct, eq, ne)
38
- * - `payoutId` (ct, nct, eq, ne, in, nin)
39
- * - `vendorId` (ct, nct, eq, ne, in, nin)
38
+ * - `payoutId` (eq, ne, gt, ge, lt, le)
39
+ * - `vendorId` (eq, ne, gt, ge, lt, le)
40
40
  * - `miscData1` (ct, nct, eq, ne)
41
41
  * - `miscData2` (ct, nct, eq, ne)
42
42
  * - `currentUses` (gt, ge, lt, le, eq, ne)
@@ -44,10 +44,10 @@ export interface ListVcardsRequest {
44
44
  * - `balance` (gt, ge, lt, le, eq, ne)
45
45
  * - `paypointLegal` (ne, eq, ct, nct)
46
46
  * - `paypointDba` (ne, eq, ct, nct)
47
- * - `orgName` (ne, eq, ct, nct)
47
+ * - `orgName` (eq, ne, ct, nct, sw, ew)
48
48
  * - `externalPaypointId` (ct, nct, eq, ne)
49
- * - `paypointId` (in, nin, eq, ne)
50
- * - `cardType` (eq)
49
+ * - `paypointId` (eq, ne, gt, ge, lt, le)
50
+ * - `cardType` (eq, ne, gt, ge, lt, le)
51
51
  *
52
52
  * List of comparison accepted - enclosed between parentheses:
53
53
  *
@@ -59,6 +59,8 @@ export interface ListVcardsRequest {
59
59
  * - ne => not equal
60
60
  * - ct => contains
61
61
  * - nct => not contains
62
+ * - sw => starts with
63
+ * - ew => ends with
62
64
  * - in => inside array separated by "|"
63
65
  * - nin => not inside array separated by "|"
64
66
  */
@@ -0,0 +1,72 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * fromRecord: 0,
5
+ * limitRecord: 20,
6
+ * sortBy: "desc(CreatedOn)"
7
+ * }
8
+ */
9
+ export interface ListVcardsTransactionsOrgRequest {
10
+ /** The number of records to skip before starting to collect the result set. */
11
+ fromRecord?: number;
12
+ /** Max number of records to return for the query. Use `0` or negative value to return all records. */
13
+ limitRecord?: number;
14
+ /**
15
+ * Collection of field names, conditions, and values used to filter the query.
16
+ *
17
+ * <Info>
18
+ * **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
19
+ *
20
+ * Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
21
+ *
22
+ * For example:
23
+ *
24
+ * --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/org/236?parameters=transactionAmount(gt)=100&limitRecord=20
25
+ *
26
+ * should become:
27
+ *
28
+ * --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/org/236?transactionAmount(gt)=100&limitRecord=20
29
+ * </Info>
30
+ *
31
+ * List of field names accepted:
32
+ *
33
+ * - `identifier` (eq, ne, ct, nct)
34
+ * - `transactionType` (eq, ne, ct, nct)
35
+ * - `transactionStatus` (eq, ne, ct, nct, in, nin)
36
+ * - `transactionAmount` (eq, ne, gt, ge, lt, le, ct, nct)
37
+ * - `transactionCreatedOn` (eq, ne, gt, ge, lt, le)
38
+ * - `cardToken` (ct, nct, eq, ne)
39
+ * - `lastFour` (ct, nct, eq, ne)
40
+ * - `expirationDate` (ct, nct, eq, ne)
41
+ * - `mcc` (ct, nct, eq, ne)
42
+ * - `payoutId` (gt, lt, eq, ne)
43
+ * - `customerId` (gt, lt, eq, ne)
44
+ * - `vendorId` (gt, lt, eq, ne)
45
+ * - `miscData1` (ct, nct, eq, ne)
46
+ * - `miscData2` (ct, nct, eq, ne)
47
+ * - `currentUses` (gt, ge, lt, le, eq, ne)
48
+ * - `amount` (gt, ge, lt, le, eq, ne)
49
+ * - `balance` (gt, ge, lt, le, eq, ne)
50
+ * - `paypointLegal` (ne, eq, ct, nct)
51
+ * - `paypointDba` (ne, eq, ct, nct)
52
+ * - `orgName` (ne, eq, ct, nct, in, nin)
53
+ * - `externalPaypointID` (ct, nct, eq, ne)
54
+ * - `paypointId` (gt, lt, eq, ne)
55
+ *
56
+ * List of comparison accepted - enclosed between parentheses:
57
+ *
58
+ * - eq or empty => equal
59
+ * - gt => greater than
60
+ * - ge => greater or equal
61
+ * - lt => less than
62
+ * - le => less or equal
63
+ * - ne => not equal
64
+ * - ct => contains
65
+ * - nct => not contains
66
+ * - in => inside array separated by "|"
67
+ * - nin => not inside array separated by "|"
68
+ */
69
+ parameters?: Record<string, string>;
70
+ /** The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. */
71
+ sortBy?: string;
72
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,72 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * fromRecord: 0,
5
+ * limitRecord: 20,
6
+ * sortBy: "desc(CreatedOn)"
7
+ * }
8
+ */
9
+ export interface ListVcardsTransactionsRequest {
10
+ /** The number of records to skip before starting to collect the result set. */
11
+ fromRecord?: number;
12
+ /** Max number of records to return for the query. Use `0` or negative value to return all records. */
13
+ limitRecord?: number;
14
+ /**
15
+ * Collection of field names, conditions, and values used to filter the query.
16
+ *
17
+ * <Info>
18
+ * **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
19
+ *
20
+ * Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
21
+ *
22
+ * For example:
23
+ *
24
+ * --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?parameters=transactionAmount(gt)=100&limitRecord=20
25
+ *
26
+ * should become:
27
+ *
28
+ * --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?transactionAmount(gt)=100&limitRecord=20
29
+ * </Info>
30
+ *
31
+ * List of field names accepted:
32
+ *
33
+ * - `identifier` (eq, ne, ct, nct)
34
+ * - `transactionType` (eq, ne, ct, nct)
35
+ * - `transactionStatus` (eq, ne, ct, nct, in, nin)
36
+ * - `transactionAmount` (eq, ne, gt, ge, lt, le, ct, nct)
37
+ * - `transactionCreatedOn` (eq, ne, gt, ge, lt, le)
38
+ * - `cardToken` (ct, nct, eq, ne)
39
+ * - `lastFour` (ct, nct, eq, ne)
40
+ * - `expirationDate` (ct, nct, eq, ne)
41
+ * - `mcc` (ct, nct, eq, ne)
42
+ * - `payoutId` (gt, lt, eq, ne)
43
+ * - `customerId` (gt, lt, eq, ne)
44
+ * - `vendorId` (gt, lt, eq, ne)
45
+ * - `miscData1` (ct, nct, eq, ne)
46
+ * - `miscData2` (ct, nct, eq, ne)
47
+ * - `currentUses` (gt, ge, lt, le, eq, ne)
48
+ * - `amount` (gt, ge, lt, le, eq, ne)
49
+ * - `balance` (gt, ge, lt, le, eq, ne)
50
+ * - `paypointLegal` (ne, eq, ct, nct)
51
+ * - `paypointDba` (ne, eq, ct, nct)
52
+ * - `orgName` (ne, eq, ct, nct, in, nin)
53
+ * - `externalPaypointID` (ct, nct, eq, ne)
54
+ * - `paypointId` (gt, lt, eq, ne)
55
+ *
56
+ * List of comparison accepted - enclosed between parentheses:
57
+ *
58
+ * - eq or empty => equal
59
+ * - gt => greater than
60
+ * - ge => greater or equal
61
+ * - lt => less than
62
+ * - le => less or equal
63
+ * - ne => not equal
64
+ * - ct => contains
65
+ * - nct => not contains
66
+ * - in => inside array separated by "|"
67
+ * - nin => not inside array separated by "|"
68
+ */
69
+ parameters?: Record<string, string>;
70
+ /** The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. */
71
+ sortBy?: string;
72
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -39,6 +39,7 @@ export interface ListVendorsOrgRequest {
39
39
  * - `ein` (ct, nct, eq, ne)
40
40
  * - `phone` (ct, nct, eq, ne)
41
41
  * - `email` (ct, nct, eq, ne)
42
+ * - `remitEmail` (ct, nct, eq, ne)
42
43
  * - `address` (ct, nct, eq, ne)
43
44
  * - `city` (ct, nct, eq, ne)
44
45
  * - `state` (ct, nct, eq, ne)
@@ -39,6 +39,7 @@ export interface ListVendorsRequest {
39
39
  * - `ein` (ct, nct, eq, ne)
40
40
  * - `phone` (ct, nct, eq, ne)
41
41
  * - `email` (ct, nct, eq, ne)
42
+ * - `remitEmail` (ct, nct, eq, ne)
42
43
  * - `address` (ct, nct, eq, ne)
43
44
  * - `city` (ct, nct, eq, ne)
44
45
  * - `state` (ct, nct, eq, ne)
@@ -36,5 +36,7 @@ export type { ListUsersOrgRequest } from "./ListUsersOrgRequest.mjs";
36
36
  export type { ListUsersPaypointRequest } from "./ListUsersPaypointRequest.mjs";
37
37
  export type { ListVcardsOrgRequest } from "./ListVcardsOrgRequest.mjs";
38
38
  export type { ListVcardsRequest } from "./ListVcardsRequest.mjs";
39
+ export type { ListVcardsTransactionsOrgRequest } from "./ListVcardsTransactionsOrgRequest.mjs";
40
+ export type { ListVcardsTransactionsRequest } from "./ListVcardsTransactionsRequest.mjs";
39
41
  export type { ListVendorsOrgRequest } from "./ListVendorsOrgRequest.mjs";
40
42
  export type { ListVendorsRequest } from "./ListVendorsRequest.mjs";
@@ -43,6 +43,8 @@ export declare namespace QueryTransferDetailResponse {
43
43
  netTransferAmount: number | null;
44
44
  /** Total amount directed to split funding destinations */
45
45
  splitFundingAmount: number | null;
46
+ /** Total amount rejected by card networks or issuing banks after authorization or settling in this transaction */
47
+ cardRejectedAmount: number | null;
46
48
  billingFeesDetails: Payabli.BillingFeeDetail[] | null;
47
49
  ParentOrgName: Payabli.OrgParentName | null;
48
50
  PaypointDbaname: Payabli.Dbaname | null;
@@ -31,6 +31,8 @@ export interface QueryTransferSummary {
31
31
  refunds: number | null;
32
32
  /** Funds being held for fraud or risk concerns. */
33
33
  heldAmount: number | null;
34
+ /** Total amount rejected by card networks or issuing banks after authorization or settling. This value is the sum of all rejected amounts for transactions in the transfer. */
35
+ cardRejectedAmount: number | null;
34
36
  /** Number of records in the response. */
35
37
  totalRecords: Payabli.Totalrecords | null;
36
38
  /** The total sum of the transfers in the response. */
@@ -0,0 +1,49 @@
1
+ import type * as Payabli from "../../../index.mjs";
2
+ /**
3
+ * Response body for queries about virtual card transactions.
4
+ *
5
+ * @example
6
+ * {
7
+ * Summary: {
8
+ * totalPages: 20,
9
+ * totalRecords: 393,
10
+ * totalAmount: 231.58,
11
+ * totalactive: 388,
12
+ * totalamountactive: 219.58,
13
+ * totalbalanceactive: -213.83
14
+ * },
15
+ * Records: [{
16
+ * Identifier: "7HQ2P9B4XD",
17
+ * CardToken: "5RJ8MN2KC4",
18
+ * LastFour: "1234",
19
+ * ExpirationDate: "06-30-2029",
20
+ * Mcc: "5943",
21
+ * PayoutId: 84210,
22
+ * CustomerId: 1542,
23
+ * VendorId: 9821,
24
+ * MiscData1: "Invoice #12345",
25
+ * MiscData2: "Project: Office Supplies",
26
+ * CurrentUses: 1,
27
+ * Amount: 500,
28
+ * Balance: 425.5,
29
+ * PaypointId: 236,
30
+ * PaypointLegal: "Global Factory LLC",
31
+ * PaypointDba: "Global Factory",
32
+ * ExternalPaypointID: "pay-10",
33
+ * OrgName: "SupplyPro",
34
+ * Type: "AUTHORIZATION",
35
+ * Status: "AUTHORIZATION",
36
+ * CreatedOn: "2026-05-05 03:28:53.082830",
37
+ * TransactionAmount: "74.500",
38
+ * PostedAmount: "0.000",
39
+ * PostedOn: null,
40
+ * MerchantName: "Office Supply Co.",
41
+ * AuthorizationStatus: "AUTHORIZATION",
42
+ * ReasonToDecline: null
43
+ * }]
44
+ * }
45
+ */
46
+ export interface VCardTransactionQueryResponse {
47
+ Summary: Payabli.VCardSummary;
48
+ Records: Payabli.VCardTransactionRecord[];
49
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,86 @@
1
+ import type * as Payabli from "../../../index.mjs";
2
+ /**
3
+ * A virtual card transaction record returned by the query.
4
+ *
5
+ * @example
6
+ * {
7
+ * Identifier: "7HQ2P9B4XD",
8
+ * CardToken: "5RJ8MN2KC4",
9
+ * LastFour: "1234",
10
+ * ExpirationDate: "06-30-2029",
11
+ * Mcc: "5943",
12
+ * PayoutId: 84210,
13
+ * CustomerId: 1542,
14
+ * VendorId: 9821,
15
+ * MiscData1: "Invoice #12345",
16
+ * MiscData2: "Project: Office Supplies",
17
+ * CurrentUses: 1,
18
+ * Amount: 500,
19
+ * Balance: 425.5,
20
+ * PaypointId: 236,
21
+ * PaypointLegal: "Global Factory LLC",
22
+ * PaypointDba: "Global Factory",
23
+ * ExternalPaypointID: "pay-10",
24
+ * OrgName: "SupplyPro",
25
+ * Type: "AUTHORIZATION",
26
+ * Status: "AUTHORIZATION",
27
+ * CreatedOn: "2026-05-05 03:28:53.082830",
28
+ * TransactionAmount: "74.500",
29
+ * PostedAmount: "0.000",
30
+ * PostedOn: null,
31
+ * MerchantName: "Office Supply Co.",
32
+ * AuthorizationStatus: "AUTHORIZATION",
33
+ * ReasonToDecline: null
34
+ * }
35
+ */
36
+ export interface VCardTransactionRecord {
37
+ /** Unique identifier for the transaction. */
38
+ Identifier: string | null;
39
+ /** Token of the virtual card associated with the transaction. */
40
+ CardToken: string | null;
41
+ /** Last four digits of the masked virtual card number. */
42
+ LastFour: string | null;
43
+ /** Expiration date of the virtual card used for the transaction. */
44
+ ExpirationDate: string | null;
45
+ Mcc: Payabli.Mcc | null;
46
+ /** Identifier of the payout linked to this transaction. */
47
+ PayoutId: number | null;
48
+ /** Identifier of the customer linked to this transaction. */
49
+ CustomerId: number | null;
50
+ /** Identifier of the vendor linked to this transaction. */
51
+ VendorId: number | null;
52
+ /** Custom field 1 from the virtual card. */
53
+ MiscData1: string | null;
54
+ /** Custom field 2 from the virtual card. */
55
+ MiscData2: string | null;
56
+ /** Number of times the virtual card has been used. */
57
+ CurrentUses: number | null;
58
+ /** Authorized amount on the virtual card. */
59
+ Amount: number | null;
60
+ /** Current balance remaining on the virtual card. */
61
+ Balance: number | null;
62
+ /** Numeric identifier of the paypoint that issued the virtual card. */
63
+ PaypointId: number | null;
64
+ PaypointLegal: Payabli.Legalname | null;
65
+ PaypointDba: Payabli.Dbaname | null;
66
+ ExternalPaypointID: Payabli.ExternalPaypointId | null;
67
+ OrgName: Payabli.OrgParentName | null;
68
+ /** Transaction type, such as `AUTHORIZATION`. */
69
+ Type: string | null;
70
+ /** Transaction status, such as `AUTHORIZATION`. */
71
+ Status: string | null;
72
+ /** Date and time the transaction was created. Format: `YYYY-MM-DD HH:MM:SS.ffffff`. */
73
+ CreatedOn: string | null;
74
+ /** Amount of the transaction, as a string value. */
75
+ TransactionAmount: string | null;
76
+ /** Posted amount of the transaction, as a string value. */
77
+ PostedAmount: string | null;
78
+ /** Date and time the transaction was posted, in format `YYYY-MM-DD HH:MM:SS.ffffff`. Null when the transaction hasn't posted yet. */
79
+ PostedOn: string | null;
80
+ /** Name of the merchant where the virtual card was used. */
81
+ MerchantName: string | null;
82
+ /** Authorization status of the transaction. */
83
+ AuthorizationStatus: string | null;
84
+ /** Reason the transaction was declined, when applicable. */
85
+ ReasonToDecline: string | null;
86
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -24,3 +24,5 @@ export * from "./TransferOutMessageProperties.mjs";
24
24
  export * from "./TransferOutQueryResponse.mjs";
25
25
  export * from "./TransferOutRecord.mjs";
26
26
  export * from "./TransferOutSummary.mjs";
27
+ export * from "./VCardTransactionQueryResponse.mjs";
28
+ export * from "./VCardTransactionRecord.mjs";
@@ -24,3 +24,5 @@ export * from "./TransferOutMessageProperties.mjs";
24
24
  export * from "./TransferOutQueryResponse.mjs";
25
25
  export * from "./TransferOutRecord.mjs";
26
26
  export * from "./TransferOutSummary.mjs";
27
+ export * from "./VCardTransactionQueryResponse.mjs";
28
+ export * from "./VCardTransactionRecord.mjs";
@@ -104,6 +104,7 @@ import type * as Payabli from "../index.mjs";
104
104
  * PayorId: 1551,
105
105
  * PaypointId: 226,
106
106
  * SettlementStatus: 2,
107
+ * splitCount: 0,
107
108
  * TotalAmount: 30.22,
108
109
  * TransStatus: 1
109
110
  * }],
@@ -160,6 +161,7 @@ import type * as Payabli from "../index.mjs";
160
161
  * PayorId: 1551,
161
162
  * PaypointId: 226,
162
163
  * SettlementStatus: 2,
164
+ * splitCount: 0,
163
165
  * TotalAmount: 30.22,
164
166
  * TransStatus: 1
165
167
  * }],
@@ -1,6 +1,80 @@
1
1
  import type * as Payabli from "../index.mjs";
2
2
  /**
3
3
  * Response payload for queries related to transactions
4
+ *
5
+ * @example
6
+ * {
7
+ * Records: [{
8
+ * ParentOrgName: "RealistRoofing",
9
+ * PaypointDbaname: "Eagle-Pointe",
10
+ * PaypointLegalname: "Eagle-Pointe",
11
+ * PaypointEntryname: "entry399",
12
+ * PaymentTransId: "399-8e7e5fc7-f483-43cc-9e78-d8a36ac857bf",
13
+ * ConnectorName: "GP",
14
+ * Method: "card",
15
+ * PayorId: 155974,
16
+ * PaymentData: {
17
+ * MaskedAccount: "5XXXXXXXXXXX4415",
18
+ * AccountExp: "12/29",
19
+ * HolderName: "RENEE DESCARTES",
20
+ * binData: {
21
+ * binMatchedLength: "9",
22
+ * binCardBrand: "MASTERCARD",
23
+ * binCardType: "CREDIT",
24
+ * binCardCategory: "MIXED PRODUCT",
25
+ * binCardIssuer: "ALLIED IRISH BANKS, PLC",
26
+ * binCardIssuerCountry: "IRELAND",
27
+ * binCardIsRegulated: "False",
28
+ * binCardUseCategory: "PERSONAL"
29
+ * },
30
+ * paymentDetails: {
31
+ * totalAmount: 6.79,
32
+ * serviceFee: 0,
33
+ * currency: "USD"
34
+ * }
35
+ * },
36
+ * TransStatus: -4,
37
+ * PaypointId: 399,
38
+ * splitFundingInstructions: [{}],
39
+ * splitCount: 1,
40
+ * TotalAmount: -6.79,
41
+ * NetAmount: -6.79,
42
+ * FeeAmount: 0,
43
+ * SettlementStatus: 0,
44
+ * Operation: "Reject",
45
+ * Source: "api",
46
+ * OrgId: 39,
47
+ * TransactionTime: "2026-03-02T18:56:23.109188",
48
+ * Customer: {
49
+ * FirstName: "Blaise",
50
+ * LastName: "Pascal",
51
+ * CompanyName: "Pensees LLC",
52
+ * BillingAddress1: "49912 Aufengrupt Pointe",
53
+ * BillingAddress2: "apt 6",
54
+ * BillingCity: "South Litzy",
55
+ * BillingState: "FL",
56
+ * BillingZip: "33000",
57
+ * BillingCountry: "US",
58
+ * BillingPhone: "+18955791994",
59
+ * BillingEmail: "blaise.pascal@gmail.com",
60
+ * CustomerNumber: "o99t",
61
+ * customerId: 155974,
62
+ * customerStatus: 1
63
+ * },
64
+ * TransactionEvents: [{
65
+ * TransEvent: "Created",
66
+ * EventData: "Card Reject - CTDR Id: 1379241",
67
+ * EventTime: "2026-03-02T18:56:23.352035"
68
+ * }]
69
+ * }],
70
+ * Summary: {
71
+ * totalRecords: 14,
72
+ * totalAmount: -79.48,
73
+ * totalNetAmount: -74.41,
74
+ * totalPages: 14,
75
+ * pageSize: 1
76
+ * }
77
+ * }
4
78
  */
5
79
  export interface QueryResponseTransactions {
6
80
  Records?: Payabli.TransactionQueryRecords[] | undefined;
@@ -0,0 +1,4 @@
1
+ /**
2
+ * Number of split funding instructions associated with the transaction. Returns `0` when the transaction has no splits.
3
+ */
4
+ export type SplitCount = number;
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -40,6 +40,16 @@ export interface SubscriptionQueryRecords {
40
40
  Source?: Payabli.Source | undefined;
41
41
  /** The subscription start date. */
42
42
  StartDate: string | null;
43
+ /**
44
+ * The full stored payment method record linked to the subscription
45
+ * and charged on each billing cycle. Returned as `null` for legacy
46
+ * subscriptions that don't have a linked stored method.
47
+ *
48
+ * The shape is the same across payment vehicles (card, ACH, check).
49
+ * Only the populated fields differ. For example, `ABA` is populated
50
+ * for ACH, while `ExpDate` and `binData` are populated for card.
51
+ */
52
+ StoredMethod: Payabli.VendorResponseStoredMethod | null;
43
53
  /** Events associated with the subscription. */
44
54
  SubEvents?: Payabli.GeneralEvents[] | undefined;
45
55
  /**
@@ -48,6 +48,7 @@ export interface TransactionQueryRecords {
48
48
  SettlementStatus?: number | undefined;
49
49
  Source?: Payabli.Source | undefined;
50
50
  splitFundingInstructions?: Payabli.SplitFunding | undefined;
51
+ splitCount: Payabli.SplitCount;
51
52
  /** Transaction total amount (including service fee or sub-charge) */
52
53
  TotalAmount?: number | undefined;
53
54
  /** Events associated with this transaction. */
@@ -48,6 +48,7 @@ export interface TransactionQueryRecordsCustomer {
48
48
  SettlementStatus?: number | undefined;
49
49
  Source?: Payabli.Source | undefined;
50
50
  splitFundingInstructions?: Payabli.SplitFunding | undefined;
51
+ splitCount: Payabli.SplitCount;
51
52
  /** Transaction total amount (including service fee or sub-charge) */
52
53
  TotalAmount?: number | undefined;
53
54
  /** Events associated with this transaction. */
@@ -4,12 +4,14 @@ export interface VCardSummary {
4
4
  totalRecords: Payabli.Totalrecords;
5
5
  /** Total amount for the records. */
6
6
  totalAmount: number;
7
+ /** Total net amount for the records. */
8
+ totalNetAmount?: number | undefined;
7
9
  /** Total number of active vCards. */
8
10
  totalactive: number;
9
11
  /** Total amount of active vCards. */
10
- totalamounteactive: number;
12
+ totalamountactive: number;
11
13
  /** Total balance of active vCards. */
12
14
  totalbalanceactive: number;
13
- pageIdentifier?: Payabli.PageIdentifier | undefined;
15
+ pageidentifier?: Payabli.PageIdentifier | undefined;
14
16
  pageSize?: Payabli.Pagesize | undefined;
15
17
  }