-
Notifications
You must be signed in to change notification settings - Fork 57
/
transferData.ts
352 lines (346 loc) · 13.8 KB
/
transferData.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
/*
* The version of the OpenAPI document: v4
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit this class manually.
*/
import { Amount } from './amount';
import { BalanceMutation } from './balanceMutation';
import { BankCategoryData } from './bankCategoryData';
import { ConfirmationTrackingData } from './confirmationTrackingData';
import { EstimationTrackingData } from './estimationTrackingData';
import { InternalCategoryData } from './internalCategoryData';
import { InternalReviewTrackingData } from './internalReviewTrackingData';
import { IssuedCard } from './issuedCard';
import { PaymentInstrument } from './paymentInstrument';
import { PlatformPayment } from './platformPayment';
import { ResourceReference } from './resourceReference';
import { TransactionRulesResult } from './transactionRulesResult';
import { TransferEvent } from './transferEvent';
import { TransferNotificationCounterParty } from './transferNotificationCounterParty';
export class TransferData {
'accountHolder'?: ResourceReference;
'amount': Amount;
'balanceAccount'?: ResourceReference;
/**
* The unique identifier of the balance platform.
*/
'balancePlatform'?: string;
/**
* The list of the latest balance statuses in the transfer.
*/
'balances'?: Array<BalanceMutation>;
/**
* The category of the transfer. Possible values: - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: a transfer initiated by an Adyen-issued card. - **platformPayment**: funds movements related to payments that are acquired for your users.
*/
'category': TransferData.CategoryEnum;
/**
* The relevant data according to the transfer category.
*/
'categoryData'?: BankCategoryData | InternalCategoryData | IssuedCard | PlatformPayment | null;
'counterparty'?: TransferNotificationCounterParty;
/**
* The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
*/
'creationDate'?: Date;
/**
* Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , \' + Space** Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ \' \" ! ?**
*/
'description'?: string;
/**
* The direction of the transfer. Possible values: **incoming**, **outgoing**.
*/
'direction'?: TransferData.DirectionEnum;
/**
* The list of events leading up to the current status of the transfer.
*/
'events'?: Array<TransferEvent>;
/**
* The ID of the resource.
*/
'id'?: string;
'paymentInstrument'?: PaymentInstrument;
/**
* Additional information about the status of the transfer.
*/
'reason'?: TransferData.ReasonEnum;
/**
* Your reference for the transfer, used internally within your platform. If you don\'t provide this in the request, Adyen generates a unique reference.
*/
'reference'?: string;
/**
* A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds. Supported characters: **a-z**, **A-Z**, **0-9**.The maximum length depends on the `category`. - **internal**: 80 characters - **bank**: 35 characters when transferring to an IBAN, 15 characters for others.
*/
'referenceForBeneficiary'?: string;
/**
* The sequence number of the transfer webhook. The numbers start from 1 and increase with each new webhook for a specific transfer. The sequence number can help you restore the correct sequence of events even if they arrive out of order.
*/
'sequenceNumber'?: number;
/**
* The result of the transfer. For example, **authorised**, **refused**, or **error**.
*/
'status': TransferData.StatusEnum;
/**
* The latest tracking information of the transfer.
*/
'tracking'?: ConfirmationTrackingData | EstimationTrackingData | InternalReviewTrackingData | null;
'transactionRulesResult'?: TransactionRulesResult;
/**
* The type of transfer or transaction. For example, **refund**, **payment**, **internalTransfer**, **bankTransfer**.
*/
'type'?: TransferData.TypeEnum;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "accountHolder",
"baseName": "accountHolder",
"type": "ResourceReference"
},
{
"name": "amount",
"baseName": "amount",
"type": "Amount"
},
{
"name": "balanceAccount",
"baseName": "balanceAccount",
"type": "ResourceReference"
},
{
"name": "balancePlatform",
"baseName": "balancePlatform",
"type": "string"
},
{
"name": "balances",
"baseName": "balances",
"type": "Array<BalanceMutation>"
},
{
"name": "category",
"baseName": "category",
"type": "TransferData.CategoryEnum"
},
{
"name": "categoryData",
"baseName": "categoryData",
"type": "BankCategoryData | InternalCategoryData | IssuedCard | PlatformPayment | null"
},
{
"name": "counterparty",
"baseName": "counterparty",
"type": "TransferNotificationCounterParty"
},
{
"name": "creationDate",
"baseName": "creationDate",
"type": "Date"
},
{
"name": "description",
"baseName": "description",
"type": "string"
},
{
"name": "direction",
"baseName": "direction",
"type": "TransferData.DirectionEnum"
},
{
"name": "events",
"baseName": "events",
"type": "Array<TransferEvent>"
},
{
"name": "id",
"baseName": "id",
"type": "string"
},
{
"name": "paymentInstrument",
"baseName": "paymentInstrument",
"type": "PaymentInstrument"
},
{
"name": "reason",
"baseName": "reason",
"type": "TransferData.ReasonEnum"
},
{
"name": "reference",
"baseName": "reference",
"type": "string"
},
{
"name": "referenceForBeneficiary",
"baseName": "referenceForBeneficiary",
"type": "string"
},
{
"name": "sequenceNumber",
"baseName": "sequenceNumber",
"type": "number"
},
{
"name": "status",
"baseName": "status",
"type": "TransferData.StatusEnum"
},
{
"name": "tracking",
"baseName": "tracking",
"type": "ConfirmationTrackingData | EstimationTrackingData | InternalReviewTrackingData | null"
},
{
"name": "transactionRulesResult",
"baseName": "transactionRulesResult",
"type": "TransactionRulesResult"
},
{
"name": "type",
"baseName": "type",
"type": "TransferData.TypeEnum"
} ];
static getAttributeTypeMap() {
return TransferData.attributeTypeMap;
}
}
export namespace TransferData {
export enum CategoryEnum {
Bank = 'bank',
Internal = 'internal',
IssuedCard = 'issuedCard',
PlatformPayment = 'platformPayment'
}
export enum DirectionEnum {
Incoming = 'incoming',
Outgoing = 'outgoing'
}
export enum ReasonEnum {
AmountLimitExceeded = 'amountLimitExceeded',
Approved = 'approved',
BalanceAccountTemporarilyBlockedByTransactionRule = 'balanceAccountTemporarilyBlockedByTransactionRule',
CounterpartyAccountBlocked = 'counterpartyAccountBlocked',
CounterpartyAccountClosed = 'counterpartyAccountClosed',
CounterpartyAccountNotFound = 'counterpartyAccountNotFound',
CounterpartyAddressRequired = 'counterpartyAddressRequired',
CounterpartyBankTimedOut = 'counterpartyBankTimedOut',
CounterpartyBankUnavailable = 'counterpartyBankUnavailable',
DeclinedByTransactionRule = 'declinedByTransactionRule',
Error = 'error',
NotEnoughBalance = 'notEnoughBalance',
PendingApproval = 'pendingApproval',
RefusedByCounterpartyBank = 'refusedByCounterpartyBank',
RouteNotFound = 'routeNotFound',
ScaFailed = 'scaFailed',
Unknown = 'unknown'
}
export enum StatusEnum {
ApprovalPending = 'approvalPending',
AtmWithdrawal = 'atmWithdrawal',
AtmWithdrawalReversalPending = 'atmWithdrawalReversalPending',
AtmWithdrawalReversed = 'atmWithdrawalReversed',
AuthAdjustmentAuthorised = 'authAdjustmentAuthorised',
AuthAdjustmentError = 'authAdjustmentError',
AuthAdjustmentRefused = 'authAdjustmentRefused',
Authorised = 'authorised',
BankTransfer = 'bankTransfer',
BankTransferPending = 'bankTransferPending',
Booked = 'booked',
BookingPending = 'bookingPending',
Cancelled = 'cancelled',
CapturePending = 'capturePending',
CaptureReversalPending = 'captureReversalPending',
CaptureReversed = 'captureReversed',
Captured = 'captured',
CapturedExternally = 'capturedExternally',
Chargeback = 'chargeback',
ChargebackExternally = 'chargebackExternally',
ChargebackPending = 'chargebackPending',
ChargebackReversalPending = 'chargebackReversalPending',
ChargebackReversed = 'chargebackReversed',
Credited = 'credited',
DepositCorrection = 'depositCorrection',
DepositCorrectionPending = 'depositCorrectionPending',
Dispute = 'dispute',
DisputeClosed = 'disputeClosed',
DisputeExpired = 'disputeExpired',
DisputeNeedsReview = 'disputeNeedsReview',
Error = 'error',
Expired = 'expired',
Failed = 'failed',
Fee = 'fee',
FeePending = 'feePending',
InternalTransfer = 'internalTransfer',
InternalTransferPending = 'internalTransferPending',
InvoiceDeduction = 'invoiceDeduction',
InvoiceDeductionPending = 'invoiceDeductionPending',
ManualCorrectionPending = 'manualCorrectionPending',
ManuallyCorrected = 'manuallyCorrected',
MatchedStatement = 'matchedStatement',
MatchedStatementPending = 'matchedStatementPending',
MerchantPayin = 'merchantPayin',
MerchantPayinPending = 'merchantPayinPending',
MerchantPayinReversed = 'merchantPayinReversed',
MerchantPayinReversedPending = 'merchantPayinReversedPending',
MiscCost = 'miscCost',
MiscCostPending = 'miscCostPending',
PaymentCost = 'paymentCost',
PaymentCostPending = 'paymentCostPending',
Received = 'received',
RefundPending = 'refundPending',
RefundReversalPending = 'refundReversalPending',
RefundReversed = 'refundReversed',
Refunded = 'refunded',
RefundedExternally = 'refundedExternally',
Refused = 'refused',
Rejected = 'rejected',
ReserveAdjustment = 'reserveAdjustment',
ReserveAdjustmentPending = 'reserveAdjustmentPending',
Returned = 'returned',
SecondChargeback = 'secondChargeback',
SecondChargebackPending = 'secondChargebackPending',
Undefined = 'undefined'
}
export enum TypeEnum {
AtmWithdrawal = 'atmWithdrawal',
AtmWithdrawalReversal = 'atmWithdrawalReversal',
BalanceAdjustment = 'balanceAdjustment',
BalanceMigration = 'balanceMigration',
BalanceRollover = 'balanceRollover',
BankDirectDebit = 'bankDirectDebit',
BankTransfer = 'bankTransfer',
CapitalFundsCollection = 'capitalFundsCollection',
Capture = 'capture',
CaptureReversal = 'captureReversal',
CardTransfer = 'cardTransfer',
CashOutFee = 'cashOutFee',
CashOutFunding = 'cashOutFunding',
CashOutInstruction = 'cashOutInstruction',
Chargeback = 'chargeback',
ChargebackCorrection = 'chargebackCorrection',
ChargebackReversal = 'chargebackReversal',
ChargebackReversalCorrection = 'chargebackReversalCorrection',
DepositCorrection = 'depositCorrection',
Fee = 'fee',
Grant = 'grant',
Installment = 'installment',
InstallmentReversal = 'installmentReversal',
InternalDirectDebit = 'internalDirectDebit',
InternalTransfer = 'internalTransfer',
InvoiceDeduction = 'invoiceDeduction',
Leftover = 'leftover',
ManualCorrection = 'manualCorrection',
MiscCost = 'miscCost',
Payment = 'payment',
PaymentCost = 'paymentCost',
Refund = 'refund',
RefundReversal = 'refundReversal',
Repayment = 'repayment',
ReserveAdjustment = 'reserveAdjustment',
SecondChargeback = 'secondChargeback',
SecondChargebackCorrection = 'secondChargebackCorrection'
}
}