opf-validator-beta 0.0.13
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/README.md +557 -0
- package/dist/consent/index.d.ts +9 -0
- package/dist/consent/index.d.ts.map +1 -0
- package/dist/consent/index.js +12 -0
- package/dist/consent/index.js.map +1 -0
- package/dist/consent/package.json +6 -0
- package/dist/consent/successResponses/index.d.ts +89 -0
- package/dist/consent/successResponses/index.d.ts.map +1 -0
- package/dist/consent/successResponses/index.js +6 -0
- package/dist/consent/successResponses/index.js.map +1 -0
- package/dist/consent/validators/createConsent.d.ts +33 -0
- package/dist/consent/validators/createConsent.d.ts.map +1 -0
- package/dist/consent/validators/createConsent.js +206 -0
- package/dist/consent/validators/createConsent.js.map +1 -0
- package/dist/consent/validators/createConsentExtensions.d.ts +33 -0
- package/dist/consent/validators/createConsentExtensions.d.ts.map +1 -0
- package/dist/consent/validators/createConsentExtensions.js +194 -0
- package/dist/consent/validators/createConsentExtensions.js.map +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +54 -0
- package/dist/index.js.map +7 -0
- package/dist/payments/index.d.ts +11 -0
- package/dist/payments/index.d.ts.map +1 -0
- package/dist/payments/index.js +18 -0
- package/dist/payments/index.js.map +1 -0
- package/dist/payments/package.json +6 -0
- package/dist/payments/successResponses/index.d.ts +129 -0
- package/dist/payments/successResponses/index.d.ts.map +1 -0
- package/dist/payments/successResponses/index.js +6 -0
- package/dist/payments/successResponses/index.js.map +1 -0
- package/dist/payments/validators/createPaymentConsent.d.ts +66 -0
- package/dist/payments/validators/createPaymentConsent.d.ts.map +1 -0
- package/dist/payments/validators/createPaymentConsent.js +509 -0
- package/dist/payments/validators/createPaymentConsent.js.map +1 -0
- package/dist/payments/validators/createPixPayment.d.ts +35 -0
- package/dist/payments/validators/createPixPayment.d.ts.map +1 -0
- package/dist/payments/validators/createPixPayment.js +343 -0
- package/dist/payments/validators/createPixPayment.js.map +1 -0
- package/dist/payments/validators/patchPixPayment.d.ts +40 -0
- package/dist/payments/validators/patchPixPayment.d.ts.map +1 -0
- package/dist/payments/validators/patchPixPayment.js +192 -0
- package/dist/payments/validators/patchPixPayment.js.map +1 -0
- package/dist/recurring-payments/index.d.ts +13 -0
- package/dist/recurring-payments/index.d.ts.map +1 -0
- package/dist/recurring-payments/index.js +17 -0
- package/dist/recurring-payments/index.js.map +1 -0
- package/dist/recurring-payments/package.json +6 -0
- package/dist/recurring-payments/successResponses/index.d.ts +175 -0
- package/dist/recurring-payments/successResponses/index.d.ts.map +1 -0
- package/dist/recurring-payments/successResponses/index.js +6 -0
- package/dist/recurring-payments/successResponses/index.js.map +1 -0
- package/dist/recurring-payments/validators/createRecurringConsent.d.ts +96 -0
- package/dist/recurring-payments/validators/createRecurringConsent.d.ts.map +1 -0
- package/dist/recurring-payments/validators/createRecurringConsent.js +664 -0
- package/dist/recurring-payments/validators/createRecurringConsent.js.map +1 -0
- package/dist/recurring-payments/validators/createRecurringRetryPixPayment.d.ts +19 -0
- package/dist/recurring-payments/validators/createRecurringRetryPixPayment.d.ts.map +1 -0
- package/dist/recurring-payments/validators/createRecurringRetryPixPayment.js +42 -0
- package/dist/recurring-payments/validators/createRecurringRetryPixPayment.js.map +1 -0
- package/dist/recurring-payments/validators/patchPixPayment.d.ts +38 -0
- package/dist/recurring-payments/validators/patchPixPayment.d.ts.map +1 -0
- package/dist/recurring-payments/validators/patchPixPayment.js +124 -0
- package/dist/recurring-payments/validators/patchPixPayment.js.map +1 -0
- package/dist/recurring-payments/validators/patchRecurringConsent.d.ts +87 -0
- package/dist/recurring-payments/validators/patchRecurringConsent.d.ts.map +1 -0
- package/dist/recurring-payments/validators/patchRecurringConsent.js +558 -0
- package/dist/recurring-payments/validators/patchRecurringConsent.js.map +1 -0
- package/dist/utils/index.d.ts +9 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/index.js +25 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/openFinanceErrors.d.ts +90 -0
- package/dist/utils/openFinanceErrors.d.ts.map +1 -0
- package/dist/utils/openFinanceErrors.js +114 -0
- package/dist/utils/openFinanceErrors.js.map +1 -0
- package/dist/utils/package.json +6 -0
- package/dist/utils/paymentErrors.d.ts +9 -0
- package/dist/utils/paymentErrors.d.ts.map +1 -0
- package/dist/utils/paymentErrors.js +13 -0
- package/dist/utils/paymentErrors.js.map +1 -0
- package/dist/utils/successResponses.d.ts +52 -0
- package/dist/utils/successResponses.d.ts.map +1 -0
- package/dist/utils/successResponses.js +6 -0
- package/dist/utils/successResponses.js.map +1 -0
- package/dist/utils/validateHeaderParameters.d.ts +51 -0
- package/dist/utils/validateHeaderParameters.d.ts.map +1 -0
- package/dist/utils/validateHeaderParameters.js +197 -0
- package/dist/utils/validateHeaderParameters.js.map +1 -0
- package/dist/utils/validationHelpers.d.ts +89 -0
- package/dist/utils/validationHelpers.d.ts.map +1 -0
- package/dist/utils/validationHelpers.js +374 -0
- package/dist/utils/validationHelpers.js.map +1 -0
- package/package.json +30 -0
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Interfaces de Sucesso para Respostas de Payments
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Resposta de sucesso para POST /payment-consents (CreatePaymentConsent)
|
|
6
|
+
*/
|
|
7
|
+
export interface CreatePaymentConsentSuccessResponse {
|
|
8
|
+
data: {
|
|
9
|
+
consentId: string;
|
|
10
|
+
creationDateTime: string;
|
|
11
|
+
status: string;
|
|
12
|
+
statusUpdateDateTime: string;
|
|
13
|
+
permissions: string[];
|
|
14
|
+
expirationDateTime: string;
|
|
15
|
+
loggedUser?: {
|
|
16
|
+
document: {
|
|
17
|
+
identification: string;
|
|
18
|
+
rel: string;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
links?: {
|
|
23
|
+
self: string;
|
|
24
|
+
};
|
|
25
|
+
meta?: {
|
|
26
|
+
requestDateTime: string;
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Resposta de sucesso para GET /payment-consents/:consentId (GetPaymentConsent)
|
|
31
|
+
*/
|
|
32
|
+
export interface GetPaymentConsentSuccessResponse {
|
|
33
|
+
data: {
|
|
34
|
+
consentId: string;
|
|
35
|
+
creationDateTime: string;
|
|
36
|
+
status: string;
|
|
37
|
+
statusUpdateDateTime: string;
|
|
38
|
+
permissions: string[];
|
|
39
|
+
expirationDateTime: string;
|
|
40
|
+
loggedUser?: {
|
|
41
|
+
document: {
|
|
42
|
+
identification: string;
|
|
43
|
+
rel: string;
|
|
44
|
+
};
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
links?: {
|
|
48
|
+
self: string;
|
|
49
|
+
};
|
|
50
|
+
meta?: {
|
|
51
|
+
requestDateTime: string;
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Resposta de sucesso para POST /pix-payments (CreatePixPayment)
|
|
56
|
+
*/
|
|
57
|
+
export interface CreatePixPaymentSuccessResponse {
|
|
58
|
+
data: {
|
|
59
|
+
paymentId: string;
|
|
60
|
+
endToEndId: string;
|
|
61
|
+
consentId: string;
|
|
62
|
+
creationDateTime: string;
|
|
63
|
+
status: string;
|
|
64
|
+
statusUpdateDateTime: string;
|
|
65
|
+
amount: string;
|
|
66
|
+
currency: string;
|
|
67
|
+
};
|
|
68
|
+
links?: {
|
|
69
|
+
self: string;
|
|
70
|
+
};
|
|
71
|
+
meta?: {
|
|
72
|
+
requestDateTime: string;
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Resposta de sucesso para GET /pix-payments/:paymentId (GetPixPayment)
|
|
77
|
+
*/
|
|
78
|
+
export interface GetPixPaymentSuccessResponse {
|
|
79
|
+
data: {
|
|
80
|
+
paymentId: string;
|
|
81
|
+
endToEndId: string;
|
|
82
|
+
consentId: string;
|
|
83
|
+
creationDateTime: string;
|
|
84
|
+
status: string;
|
|
85
|
+
statusUpdateDateTime: string;
|
|
86
|
+
amount: string;
|
|
87
|
+
currency: string;
|
|
88
|
+
creditorAccount?: {
|
|
89
|
+
ispb: string;
|
|
90
|
+
issuer?: string;
|
|
91
|
+
number: string;
|
|
92
|
+
accountType: string;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
links?: {
|
|
96
|
+
self: string;
|
|
97
|
+
};
|
|
98
|
+
meta?: {
|
|
99
|
+
requestDateTime: string;
|
|
100
|
+
};
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Resposta de sucesso para PATCH /pix-payments/:paymentId (PatchPixPayment)
|
|
104
|
+
*/
|
|
105
|
+
export interface PatchPixPaymentSuccessResponse {
|
|
106
|
+
data: {
|
|
107
|
+
paymentId: string;
|
|
108
|
+
status: string;
|
|
109
|
+
statusUpdateDateTime: string;
|
|
110
|
+
cancellation?: {
|
|
111
|
+
cancelledAt: string;
|
|
112
|
+
cancelledBy: {
|
|
113
|
+
document: {
|
|
114
|
+
identification: string;
|
|
115
|
+
rel: string;
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
reason: string;
|
|
119
|
+
cancelledFrom: string;
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
links?: {
|
|
123
|
+
self: string;
|
|
124
|
+
};
|
|
125
|
+
meta?: {
|
|
126
|
+
requestDateTime: string;
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/payments/successResponses/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,WAAW,EAAE,MAAM,EAAE,CAAC;QACtB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,UAAU,CAAC,EAAE;YACX,QAAQ,EAAE;gBACR,cAAc,EAAE,MAAM,CAAC;gBACvB,GAAG,EAAE,MAAM,CAAC;aACb,CAAC;SACH,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,WAAW,EAAE,MAAM,EAAE,CAAC;QACtB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,UAAU,CAAC,EAAE;YACX,QAAQ,EAAE;gBACR,cAAc,EAAE,MAAM,CAAC;gBACvB,GAAG,EAAE,MAAM,CAAC;aACb,CAAC;SACH,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,gBAAgB,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,eAAe,CAAC,EAAE;YAChB,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,MAAM,EAAE,MAAM,CAAC;YACf,WAAW,EAAE,MAAM,CAAC;SACrB,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE;QACJ,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,YAAY,CAAC,EAAE;YACb,WAAW,EAAE,MAAM,CAAC;YACpB,WAAW,EAAE;gBACX,QAAQ,EAAE;oBACR,cAAc,EAAE,MAAM,CAAC;oBACvB,GAAG,EAAE,MAAM,CAAC;iBACb,CAAC;aACH,CAAC;YACF,MAAM,EAAE,MAAM,CAAC;YACf,aAAa,EAAE,MAAM,CAAC;SACvB,CAAC;KACH,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/payments/successResponses/index.ts"],"names":[],"mappings":";AAAA;;GAEG"}
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Validações para CreatePaymentConsent
|
|
3
|
+
* Segue as regras especificadas no Open Finance Brasil para Iniciação de Pagamento
|
|
4
|
+
*/
|
|
5
|
+
import { ValidationResult } from "../../utils/openFinanceErrors";
|
|
6
|
+
interface LoggedUserDocument {
|
|
7
|
+
identification: string;
|
|
8
|
+
rel: string;
|
|
9
|
+
}
|
|
10
|
+
interface LoggedUserPayment {
|
|
11
|
+
document: LoggedUserDocument;
|
|
12
|
+
}
|
|
13
|
+
interface BusinessEntityPayment {
|
|
14
|
+
document: {
|
|
15
|
+
identification: string;
|
|
16
|
+
rel: string;
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
interface CreditorIdentification {
|
|
20
|
+
personType: string;
|
|
21
|
+
cpfCnpj: string;
|
|
22
|
+
name: string;
|
|
23
|
+
}
|
|
24
|
+
interface PaymentDetails {
|
|
25
|
+
localInstrument: string;
|
|
26
|
+
creditorAccount: {
|
|
27
|
+
ispb: string;
|
|
28
|
+
issuer?: string;
|
|
29
|
+
number: string;
|
|
30
|
+
accountType: string;
|
|
31
|
+
};
|
|
32
|
+
payloadJWS?: string;
|
|
33
|
+
qrCode?: string;
|
|
34
|
+
}
|
|
35
|
+
interface PaymentObject {
|
|
36
|
+
type: string;
|
|
37
|
+
currency: string;
|
|
38
|
+
amount: string;
|
|
39
|
+
details: PaymentDetails;
|
|
40
|
+
porpuse?: string;
|
|
41
|
+
schedule?: object;
|
|
42
|
+
date?: string;
|
|
43
|
+
ibgeTownCode?: string;
|
|
44
|
+
}
|
|
45
|
+
interface DebtorAccount {
|
|
46
|
+
ispb: string;
|
|
47
|
+
issuer?: string;
|
|
48
|
+
number: string;
|
|
49
|
+
accountType: string;
|
|
50
|
+
}
|
|
51
|
+
interface CreatePaymentConsentData {
|
|
52
|
+
loggedUser: LoggedUserPayment;
|
|
53
|
+
businessEntity?: BusinessEntityPayment;
|
|
54
|
+
creditor: CreditorIdentification;
|
|
55
|
+
payment: PaymentObject;
|
|
56
|
+
debtorAccount?: DebtorAccount;
|
|
57
|
+
}
|
|
58
|
+
interface CreatePaymentConsentPayload {
|
|
59
|
+
data: CreatePaymentConsentData;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Valida o payload de criação de consentimento de pagamento
|
|
63
|
+
*/
|
|
64
|
+
export declare function validateCreatePaymentConsent(payload: any): ValidationResult;
|
|
65
|
+
export { CreatePaymentConsentPayload, CreatePaymentConsentData, LoggedUserPayment, CreditorIdentification, PaymentObject, };
|
|
66
|
+
//# sourceMappingURL=createPaymentConsent.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createPaymentConsent.d.ts","sourceRoot":"","sources":["../../../src/payments/validators/createPaymentConsent.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEL,gBAAgB,EAIjB,MAAM,+BAA+B,CAAC;AAGvC,UAAU,kBAAkB;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,UAAU,iBAAiB;IACzB,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,UAAU,qBAAqB;IAC7B,QAAQ,EAAE;QACR,cAAc,EAAE,MAAM,CAAC;QACvB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED,UAAU,sBAAsB;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,UAAU,cAAc;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE;QACf,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,cAAc,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,wBAAwB;IAChC,UAAU,EAAE,iBAAiB,CAAC;IAC9B,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,QAAQ,EAAE,sBAAsB,CAAC;IACjC,OAAO,EAAE,aAAa,CAAC;IACvB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,UAAU,2BAA2B;IACnC,IAAI,EAAE,wBAAwB,CAAC;CAChC;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,GAAG,GAAG,gBAAgB,CAsD3E;AAgiBD,OAAO,EACL,2BAA2B,EAC3B,wBAAwB,EACxB,iBAAiB,EACjB,sBAAsB,EACtB,aAAa,GACd,CAAC"}
|