rebilly-js-sdk 62.199.0 → 62.200.1
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/CHANGELOG.md +1 -1
- package/dist/rebilly-js-sdk.d.cts +492 -0
- package/dist/rebilly-js-sdk.d.mts +492 -0
- package/dist/rebilly-js-sdk.d.ts +492 -0
- package/dist/rebilly-js-sdk.es.mjs +1 -1
- package/dist/rebilly-js-sdk.umd.js +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -23392,7 +23392,11 @@ export interface coreComponents {
|
|
|
23392
23392
|
| "payment-card-expiration-reminder-7-days"
|
|
23393
23393
|
| "payment-card-expired"
|
|
23394
23394
|
| "payment-instrument-modified"
|
|
23395
|
+
| "payout-request-batch-created"
|
|
23396
|
+
| "payout-request-batch-deleted"
|
|
23397
|
+
| "payout-request-batch-modified"
|
|
23395
23398
|
| "payout-request-canceled"
|
|
23399
|
+
| "payout-request-changed"
|
|
23396
23400
|
| "payout-request-created"
|
|
23397
23401
|
| "payout-request-fulfilled"
|
|
23398
23402
|
| "payout-request-modified"
|
|
@@ -28292,6 +28296,121 @@ export interface coreComponents {
|
|
|
28292
28296
|
rel?: "self";
|
|
28293
28297
|
}[];
|
|
28294
28298
|
};
|
|
28299
|
+
/** Details specific to the payout request or allocation change that triggered the webhook. */
|
|
28300
|
+
PayoutRequestChange: {
|
|
28301
|
+
/** Resource status before the change. */
|
|
28302
|
+
previousStatus?: string;
|
|
28303
|
+
/** Resource status after the change. */
|
|
28304
|
+
status?: string;
|
|
28305
|
+
/** Reason for blocking the payout request. */
|
|
28306
|
+
blockReason?: string;
|
|
28307
|
+
/** Additional information about the block. */
|
|
28308
|
+
blockDescription?: string | null;
|
|
28309
|
+
/** Reason for splitting the payout request. */
|
|
28310
|
+
splitReason?: string;
|
|
28311
|
+
/** Additional information about the split. */
|
|
28312
|
+
splitDescription?: string | null;
|
|
28313
|
+
/** Party that canceled the payout request. */
|
|
28314
|
+
canceledBy?: string;
|
|
28315
|
+
/** Additional information about the cancellation. */
|
|
28316
|
+
description?: string;
|
|
28317
|
+
/** Amount of the change in the resource currency. */
|
|
28318
|
+
amount?: number;
|
|
28319
|
+
/** Payout request amount that remains available for allocation. */
|
|
28320
|
+
remainingAllocationAmount?: number;
|
|
28321
|
+
/** Total fulfilled amount in the payout request currency. */
|
|
28322
|
+
totalFulfilled?: number;
|
|
28323
|
+
/** ID of the payment instrument. */
|
|
28324
|
+
paymentInstrumentId?: string;
|
|
28325
|
+
/** ID of the payout request allocation. */
|
|
28326
|
+
allocationId?: string;
|
|
28327
|
+
/** ID of the transaction, or `null` when no transaction is available. */
|
|
28328
|
+
transactionId?: string | null;
|
|
28329
|
+
/** ID of the payout request that received the merged amount. */
|
|
28330
|
+
mergedIntoPayoutRequestId?: string;
|
|
28331
|
+
/** ID of the related Replay transfer. */
|
|
28332
|
+
replayTransferId?: string | null;
|
|
28333
|
+
/** Specifies whether the allocation is created automatically. */
|
|
28334
|
+
isAutoAllocation?: boolean;
|
|
28335
|
+
/** Specifies whether a replacement payout request contains the remaining amount. */
|
|
28336
|
+
replacedByRemainder?: boolean;
|
|
28337
|
+
};
|
|
28338
|
+
PayoutRequestChangedRequest: {
|
|
28339
|
+
/** Webhook event type. */
|
|
28340
|
+
eventType: string;
|
|
28341
|
+
/** Specific payout request change that triggered the webhook. */
|
|
28342
|
+
changeType:
|
|
28343
|
+
| "payout-request-created"
|
|
28344
|
+
| "payout-request-modified"
|
|
28345
|
+
| "payout-request-blocked"
|
|
28346
|
+
| "payout-request-unblocked"
|
|
28347
|
+
| "payout-request-ready"
|
|
28348
|
+
| "payout-request-returned-to-pending"
|
|
28349
|
+
| "payout-request-approved"
|
|
28350
|
+
| "payout-request-approval-undone"
|
|
28351
|
+
| "payout-request-processing-started"
|
|
28352
|
+
| "payout-request-fulfilled"
|
|
28353
|
+
| "payout-request-payment-instrument-selected"
|
|
28354
|
+
| "payout-request-allocated"
|
|
28355
|
+
| "payout-request-split"
|
|
28356
|
+
| "payout-request-merged"
|
|
28357
|
+
| "payout-request-canceled";
|
|
28358
|
+
change: coreComponents["schemas"]["PayoutRequestChange"];
|
|
28359
|
+
/** ID of the payout request. */
|
|
28360
|
+
payoutRequestId: string;
|
|
28361
|
+
/** ID of the customer associated with the payout request. */
|
|
28362
|
+
customerId: string;
|
|
28363
|
+
/** Date and time when the change occurred. */
|
|
28364
|
+
occurredTime: string;
|
|
28365
|
+
_embedded: {
|
|
28366
|
+
payoutRequest: coreComponents["schemas"]["PayoutRequest"];
|
|
28367
|
+
customer: coreComponents["schemas"]["Customer"];
|
|
28368
|
+
};
|
|
28369
|
+
_links: {
|
|
28370
|
+
/** URL of the related payout request. */
|
|
28371
|
+
href: string;
|
|
28372
|
+
rel: string;
|
|
28373
|
+
}[];
|
|
28374
|
+
};
|
|
28375
|
+
PayoutRequestChangedAllocation: {
|
|
28376
|
+
/** Webhook event type. */
|
|
28377
|
+
eventType: string;
|
|
28378
|
+
/** Specific payout request allocation change that triggered the webhook. */
|
|
28379
|
+
changeType:
|
|
28380
|
+
| "payout-request-allocation-created"
|
|
28381
|
+
| "payout-request-allocation-queued"
|
|
28382
|
+
| "payout-request-allocation-returned-to-pending"
|
|
28383
|
+
| "payout-request-allocation-processing-started"
|
|
28384
|
+
| "payout-request-allocation-waiting-completion"
|
|
28385
|
+
| "payout-request-allocation-completed"
|
|
28386
|
+
| "payout-request-allocation-declined"
|
|
28387
|
+
| "payout-request-allocation-failed"
|
|
28388
|
+
| "payout-request-allocation-canceled";
|
|
28389
|
+
change: coreComponents["schemas"]["PayoutRequestChange"];
|
|
28390
|
+
/** ID of the changed payout request allocation. */
|
|
28391
|
+
allocationId: string;
|
|
28392
|
+
/** ID of the payout request. */
|
|
28393
|
+
payoutRequestId: string;
|
|
28394
|
+
/** ID of the customer associated with the payout request. */
|
|
28395
|
+
customerId: string;
|
|
28396
|
+
/** Date and time when the change occurred. */
|
|
28397
|
+
occurredTime: string;
|
|
28398
|
+
_embedded: {
|
|
28399
|
+
allocation: coreComponents["schemas"]["PayoutRequestAllocation"];
|
|
28400
|
+
payoutRequest: coreComponents["schemas"]["PayoutRequest"];
|
|
28401
|
+
customer: coreComponents["schemas"]["Customer"];
|
|
28402
|
+
};
|
|
28403
|
+
_links: {
|
|
28404
|
+
/** URL of the related resource. */
|
|
28405
|
+
href: string;
|
|
28406
|
+
/** Type of related resource. */
|
|
28407
|
+
rel: "allocation" | "payoutRequest";
|
|
28408
|
+
}[];
|
|
28409
|
+
};
|
|
28410
|
+
/** Payout request or payout request allocation change details. */
|
|
28411
|
+
PayoutRequestChangedWebhookPayload:
|
|
28412
|
+
| coreComponents["schemas"]["PayoutRequestChangedRequest"]
|
|
28413
|
+
| coreComponents["schemas"]["PayoutRequestChangedAllocation"];
|
|
28295
28414
|
/** ID of the checkout form. */
|
|
28296
28415
|
CheckoutFormId: string;
|
|
28297
28416
|
};
|
|
@@ -30363,6 +30482,45 @@ export interface coreComponents {
|
|
|
30363
30482
|
};
|
|
30364
30483
|
};
|
|
30365
30484
|
};
|
|
30485
|
+
/** Payload of a webhook event for a batch of payout requests. */
|
|
30486
|
+
PayoutRequestBatchWebhook: {
|
|
30487
|
+
content: {
|
|
30488
|
+
"application/json": {
|
|
30489
|
+
/** ID of the batch of payout requests. */
|
|
30490
|
+
batchId: string;
|
|
30491
|
+
/** Type of event that triggered the webhook. */
|
|
30492
|
+
eventType:
|
|
30493
|
+
| "payout-request-batch-created"
|
|
30494
|
+
| "payout-request-batch-modified";
|
|
30495
|
+
/** Date and time when the batch change occurred. */
|
|
30496
|
+
occurredTime: string;
|
|
30497
|
+
/** Embedded objects related to the batch event for payout requests. */
|
|
30498
|
+
_embedded: {
|
|
30499
|
+
payoutRequestBatch: coreComponents["schemas"]["PayoutRequestBatch"];
|
|
30500
|
+
};
|
|
30501
|
+
/** Links to related resources. */
|
|
30502
|
+
_links: {
|
|
30503
|
+
/** URL of the link. */
|
|
30504
|
+
href: string;
|
|
30505
|
+
/** Type of relationship for the link. */
|
|
30506
|
+
rel: "payoutRequestBatch";
|
|
30507
|
+
}[];
|
|
30508
|
+
};
|
|
30509
|
+
};
|
|
30510
|
+
};
|
|
30511
|
+
/** Payload of a webhook event for a deleted batch of payout requests. */
|
|
30512
|
+
PayoutRequestBatchDeletedWebhook: {
|
|
30513
|
+
content: {
|
|
30514
|
+
"application/json": {
|
|
30515
|
+
/** ID of the deleted batch of payout requests. */
|
|
30516
|
+
batchId: string;
|
|
30517
|
+
/** Type of event that triggered the webhook. */
|
|
30518
|
+
eventType: "payout-request-batch-deleted";
|
|
30519
|
+
/** Date and time of the batch deletion. */
|
|
30520
|
+
occurredTime: string;
|
|
30521
|
+
};
|
|
30522
|
+
};
|
|
30523
|
+
};
|
|
30366
30524
|
/** Payload of payout request-related webhook event. */
|
|
30367
30525
|
PayoutRequestWebhook: {
|
|
30368
30526
|
content: {
|
|
@@ -30389,6 +30547,12 @@ export interface coreComponents {
|
|
|
30389
30547
|
};
|
|
30390
30548
|
};
|
|
30391
30549
|
};
|
|
30550
|
+
/** Payload of a webhook event for a payout request or payout request allocation change. */
|
|
30551
|
+
PayoutRequestChangedWebhook: {
|
|
30552
|
+
content: {
|
|
30553
|
+
"application/json": coreComponents["schemas"]["PayoutRequestChangedWebhookPayload"];
|
|
30554
|
+
};
|
|
30555
|
+
};
|
|
30392
30556
|
/** Payload of quote-related webhook event. */
|
|
30393
30557
|
QuoteWebhook: {
|
|
30394
30558
|
content: {
|
|
@@ -63177,7 +63341,11 @@ export interface storefrontComponents {
|
|
|
63177
63341
|
| "payment-card-expiration-reminder-7-days"
|
|
63178
63342
|
| "payment-card-expired"
|
|
63179
63343
|
| "payment-instrument-modified"
|
|
63344
|
+
| "payout-request-batch-created"
|
|
63345
|
+
| "payout-request-batch-deleted"
|
|
63346
|
+
| "payout-request-batch-modified"
|
|
63180
63347
|
| "payout-request-canceled"
|
|
63348
|
+
| "payout-request-changed"
|
|
63181
63349
|
| "payout-request-created"
|
|
63182
63350
|
| "payout-request-fulfilled"
|
|
63183
63351
|
| "payout-request-modified"
|
|
@@ -68077,6 +68245,121 @@ export interface storefrontComponents {
|
|
|
68077
68245
|
rel?: "self";
|
|
68078
68246
|
}[];
|
|
68079
68247
|
};
|
|
68248
|
+
/** Details specific to the payout request or allocation change that triggered the webhook. */
|
|
68249
|
+
PayoutRequestChange: {
|
|
68250
|
+
/** Resource status before the change. */
|
|
68251
|
+
previousStatus?: string;
|
|
68252
|
+
/** Resource status after the change. */
|
|
68253
|
+
status?: string;
|
|
68254
|
+
/** Reason for blocking the payout request. */
|
|
68255
|
+
blockReason?: string;
|
|
68256
|
+
/** Additional information about the block. */
|
|
68257
|
+
blockDescription?: string | null;
|
|
68258
|
+
/** Reason for splitting the payout request. */
|
|
68259
|
+
splitReason?: string;
|
|
68260
|
+
/** Additional information about the split. */
|
|
68261
|
+
splitDescription?: string | null;
|
|
68262
|
+
/** Party that canceled the payout request. */
|
|
68263
|
+
canceledBy?: string;
|
|
68264
|
+
/** Additional information about the cancellation. */
|
|
68265
|
+
description?: string;
|
|
68266
|
+
/** Amount of the change in the resource currency. */
|
|
68267
|
+
amount?: number;
|
|
68268
|
+
/** Payout request amount that remains available for allocation. */
|
|
68269
|
+
remainingAllocationAmount?: number;
|
|
68270
|
+
/** Total fulfilled amount in the payout request currency. */
|
|
68271
|
+
totalFulfilled?: number;
|
|
68272
|
+
/** ID of the payment instrument. */
|
|
68273
|
+
paymentInstrumentId?: string;
|
|
68274
|
+
/** ID of the payout request allocation. */
|
|
68275
|
+
allocationId?: string;
|
|
68276
|
+
/** ID of the transaction, or `null` when no transaction is available. */
|
|
68277
|
+
transactionId?: string | null;
|
|
68278
|
+
/** ID of the payout request that received the merged amount. */
|
|
68279
|
+
mergedIntoPayoutRequestId?: string;
|
|
68280
|
+
/** ID of the related Replay transfer. */
|
|
68281
|
+
replayTransferId?: string | null;
|
|
68282
|
+
/** Specifies whether the allocation is created automatically. */
|
|
68283
|
+
isAutoAllocation?: boolean;
|
|
68284
|
+
/** Specifies whether a replacement payout request contains the remaining amount. */
|
|
68285
|
+
replacedByRemainder?: boolean;
|
|
68286
|
+
};
|
|
68287
|
+
PayoutRequestChangedRequest: {
|
|
68288
|
+
/** Webhook event type. */
|
|
68289
|
+
eventType: string;
|
|
68290
|
+
/** Specific payout request change that triggered the webhook. */
|
|
68291
|
+
changeType:
|
|
68292
|
+
| "payout-request-created"
|
|
68293
|
+
| "payout-request-modified"
|
|
68294
|
+
| "payout-request-blocked"
|
|
68295
|
+
| "payout-request-unblocked"
|
|
68296
|
+
| "payout-request-ready"
|
|
68297
|
+
| "payout-request-returned-to-pending"
|
|
68298
|
+
| "payout-request-approved"
|
|
68299
|
+
| "payout-request-approval-undone"
|
|
68300
|
+
| "payout-request-processing-started"
|
|
68301
|
+
| "payout-request-fulfilled"
|
|
68302
|
+
| "payout-request-payment-instrument-selected"
|
|
68303
|
+
| "payout-request-allocated"
|
|
68304
|
+
| "payout-request-split"
|
|
68305
|
+
| "payout-request-merged"
|
|
68306
|
+
| "payout-request-canceled";
|
|
68307
|
+
change: storefrontComponents["schemas"]["PayoutRequestChange"];
|
|
68308
|
+
/** ID of the payout request. */
|
|
68309
|
+
payoutRequestId: string;
|
|
68310
|
+
/** ID of the customer associated with the payout request. */
|
|
68311
|
+
customerId: string;
|
|
68312
|
+
/** Date and time when the change occurred. */
|
|
68313
|
+
occurredTime: string;
|
|
68314
|
+
_embedded: {
|
|
68315
|
+
payoutRequest: storefrontComponents["schemas"]["PayoutRequest"];
|
|
68316
|
+
customer: storefrontComponents["schemas"]["Customer"];
|
|
68317
|
+
};
|
|
68318
|
+
_links: {
|
|
68319
|
+
/** URL of the related payout request. */
|
|
68320
|
+
href: string;
|
|
68321
|
+
rel: string;
|
|
68322
|
+
}[];
|
|
68323
|
+
};
|
|
68324
|
+
PayoutRequestChangedAllocation: {
|
|
68325
|
+
/** Webhook event type. */
|
|
68326
|
+
eventType: string;
|
|
68327
|
+
/** Specific payout request allocation change that triggered the webhook. */
|
|
68328
|
+
changeType:
|
|
68329
|
+
| "payout-request-allocation-created"
|
|
68330
|
+
| "payout-request-allocation-queued"
|
|
68331
|
+
| "payout-request-allocation-returned-to-pending"
|
|
68332
|
+
| "payout-request-allocation-processing-started"
|
|
68333
|
+
| "payout-request-allocation-waiting-completion"
|
|
68334
|
+
| "payout-request-allocation-completed"
|
|
68335
|
+
| "payout-request-allocation-declined"
|
|
68336
|
+
| "payout-request-allocation-failed"
|
|
68337
|
+
| "payout-request-allocation-canceled";
|
|
68338
|
+
change: storefrontComponents["schemas"]["PayoutRequestChange"];
|
|
68339
|
+
/** ID of the changed payout request allocation. */
|
|
68340
|
+
allocationId: string;
|
|
68341
|
+
/** ID of the payout request. */
|
|
68342
|
+
payoutRequestId: string;
|
|
68343
|
+
/** ID of the customer associated with the payout request. */
|
|
68344
|
+
customerId: string;
|
|
68345
|
+
/** Date and time when the change occurred. */
|
|
68346
|
+
occurredTime: string;
|
|
68347
|
+
_embedded: {
|
|
68348
|
+
allocation: storefrontComponents["schemas"]["PayoutRequestAllocation"];
|
|
68349
|
+
payoutRequest: storefrontComponents["schemas"]["PayoutRequest"];
|
|
68350
|
+
customer: storefrontComponents["schemas"]["Customer"];
|
|
68351
|
+
};
|
|
68352
|
+
_links: {
|
|
68353
|
+
/** URL of the related resource. */
|
|
68354
|
+
href: string;
|
|
68355
|
+
/** Type of related resource. */
|
|
68356
|
+
rel: "allocation" | "payoutRequest";
|
|
68357
|
+
}[];
|
|
68358
|
+
};
|
|
68359
|
+
/** Payout request or payout request allocation change details. */
|
|
68360
|
+
PayoutRequestChangedWebhookPayload:
|
|
68361
|
+
| storefrontComponents["schemas"]["PayoutRequestChangedRequest"]
|
|
68362
|
+
| storefrontComponents["schemas"]["PayoutRequestChangedAllocation"];
|
|
68080
68363
|
/** ID of the checkout form. */
|
|
68081
68364
|
CheckoutFormId: string;
|
|
68082
68365
|
};
|
|
@@ -70148,6 +70431,45 @@ export interface storefrontComponents {
|
|
|
70148
70431
|
};
|
|
70149
70432
|
};
|
|
70150
70433
|
};
|
|
70434
|
+
/** Payload of a webhook event for a batch of payout requests. */
|
|
70435
|
+
PayoutRequestBatchWebhook: {
|
|
70436
|
+
content: {
|
|
70437
|
+
"application/json": {
|
|
70438
|
+
/** ID of the batch of payout requests. */
|
|
70439
|
+
batchId: string;
|
|
70440
|
+
/** Type of event that triggered the webhook. */
|
|
70441
|
+
eventType:
|
|
70442
|
+
| "payout-request-batch-created"
|
|
70443
|
+
| "payout-request-batch-modified";
|
|
70444
|
+
/** Date and time when the batch change occurred. */
|
|
70445
|
+
occurredTime: string;
|
|
70446
|
+
/** Embedded objects related to the batch event for payout requests. */
|
|
70447
|
+
_embedded: {
|
|
70448
|
+
payoutRequestBatch: storefrontComponents["schemas"]["PayoutRequestBatch"];
|
|
70449
|
+
};
|
|
70450
|
+
/** Links to related resources. */
|
|
70451
|
+
_links: {
|
|
70452
|
+
/** URL of the link. */
|
|
70453
|
+
href: string;
|
|
70454
|
+
/** Type of relationship for the link. */
|
|
70455
|
+
rel: "payoutRequestBatch";
|
|
70456
|
+
}[];
|
|
70457
|
+
};
|
|
70458
|
+
};
|
|
70459
|
+
};
|
|
70460
|
+
/** Payload of a webhook event for a deleted batch of payout requests. */
|
|
70461
|
+
PayoutRequestBatchDeletedWebhook: {
|
|
70462
|
+
content: {
|
|
70463
|
+
"application/json": {
|
|
70464
|
+
/** ID of the deleted batch of payout requests. */
|
|
70465
|
+
batchId: string;
|
|
70466
|
+
/** Type of event that triggered the webhook. */
|
|
70467
|
+
eventType: "payout-request-batch-deleted";
|
|
70468
|
+
/** Date and time of the batch deletion. */
|
|
70469
|
+
occurredTime: string;
|
|
70470
|
+
};
|
|
70471
|
+
};
|
|
70472
|
+
};
|
|
70151
70473
|
/** Payload of payout request-related webhook event. */
|
|
70152
70474
|
PayoutRequestWebhook: {
|
|
70153
70475
|
content: {
|
|
@@ -70174,6 +70496,12 @@ export interface storefrontComponents {
|
|
|
70174
70496
|
};
|
|
70175
70497
|
};
|
|
70176
70498
|
};
|
|
70499
|
+
/** Payload of a webhook event for a payout request or payout request allocation change. */
|
|
70500
|
+
PayoutRequestChangedWebhook: {
|
|
70501
|
+
content: {
|
|
70502
|
+
"application/json": storefrontComponents["schemas"]["PayoutRequestChangedWebhookPayload"];
|
|
70503
|
+
};
|
|
70504
|
+
};
|
|
70177
70505
|
/** Payload of quote-related webhook event. */
|
|
70178
70506
|
QuoteWebhook: {
|
|
70179
70507
|
content: {
|
|
@@ -89944,7 +90272,11 @@ export interface reportsComponents {
|
|
|
89944
90272
|
| "payment-card-expiration-reminder-7-days"
|
|
89945
90273
|
| "payment-card-expired"
|
|
89946
90274
|
| "payment-instrument-modified"
|
|
90275
|
+
| "payout-request-batch-created"
|
|
90276
|
+
| "payout-request-batch-deleted"
|
|
90277
|
+
| "payout-request-batch-modified"
|
|
89947
90278
|
| "payout-request-canceled"
|
|
90279
|
+
| "payout-request-changed"
|
|
89948
90280
|
| "payout-request-created"
|
|
89949
90281
|
| "payout-request-fulfilled"
|
|
89950
90282
|
| "payout-request-modified"
|
|
@@ -94844,6 +95176,121 @@ export interface reportsComponents {
|
|
|
94844
95176
|
rel?: "self";
|
|
94845
95177
|
}[];
|
|
94846
95178
|
};
|
|
95179
|
+
/** Details specific to the payout request or allocation change that triggered the webhook. */
|
|
95180
|
+
PayoutRequestChange: {
|
|
95181
|
+
/** Resource status before the change. */
|
|
95182
|
+
previousStatus?: string;
|
|
95183
|
+
/** Resource status after the change. */
|
|
95184
|
+
status?: string;
|
|
95185
|
+
/** Reason for blocking the payout request. */
|
|
95186
|
+
blockReason?: string;
|
|
95187
|
+
/** Additional information about the block. */
|
|
95188
|
+
blockDescription?: string | null;
|
|
95189
|
+
/** Reason for splitting the payout request. */
|
|
95190
|
+
splitReason?: string;
|
|
95191
|
+
/** Additional information about the split. */
|
|
95192
|
+
splitDescription?: string | null;
|
|
95193
|
+
/** Party that canceled the payout request. */
|
|
95194
|
+
canceledBy?: string;
|
|
95195
|
+
/** Additional information about the cancellation. */
|
|
95196
|
+
description?: string;
|
|
95197
|
+
/** Amount of the change in the resource currency. */
|
|
95198
|
+
amount?: number;
|
|
95199
|
+
/** Payout request amount that remains available for allocation. */
|
|
95200
|
+
remainingAllocationAmount?: number;
|
|
95201
|
+
/** Total fulfilled amount in the payout request currency. */
|
|
95202
|
+
totalFulfilled?: number;
|
|
95203
|
+
/** ID of the payment instrument. */
|
|
95204
|
+
paymentInstrumentId?: string;
|
|
95205
|
+
/** ID of the payout request allocation. */
|
|
95206
|
+
allocationId?: string;
|
|
95207
|
+
/** ID of the transaction, or `null` when no transaction is available. */
|
|
95208
|
+
transactionId?: string | null;
|
|
95209
|
+
/** ID of the payout request that received the merged amount. */
|
|
95210
|
+
mergedIntoPayoutRequestId?: string;
|
|
95211
|
+
/** ID of the related Replay transfer. */
|
|
95212
|
+
replayTransferId?: string | null;
|
|
95213
|
+
/** Specifies whether the allocation is created automatically. */
|
|
95214
|
+
isAutoAllocation?: boolean;
|
|
95215
|
+
/** Specifies whether a replacement payout request contains the remaining amount. */
|
|
95216
|
+
replacedByRemainder?: boolean;
|
|
95217
|
+
};
|
|
95218
|
+
PayoutRequestChangedRequest: {
|
|
95219
|
+
/** Webhook event type. */
|
|
95220
|
+
eventType: string;
|
|
95221
|
+
/** Specific payout request change that triggered the webhook. */
|
|
95222
|
+
changeType:
|
|
95223
|
+
| "payout-request-created"
|
|
95224
|
+
| "payout-request-modified"
|
|
95225
|
+
| "payout-request-blocked"
|
|
95226
|
+
| "payout-request-unblocked"
|
|
95227
|
+
| "payout-request-ready"
|
|
95228
|
+
| "payout-request-returned-to-pending"
|
|
95229
|
+
| "payout-request-approved"
|
|
95230
|
+
| "payout-request-approval-undone"
|
|
95231
|
+
| "payout-request-processing-started"
|
|
95232
|
+
| "payout-request-fulfilled"
|
|
95233
|
+
| "payout-request-payment-instrument-selected"
|
|
95234
|
+
| "payout-request-allocated"
|
|
95235
|
+
| "payout-request-split"
|
|
95236
|
+
| "payout-request-merged"
|
|
95237
|
+
| "payout-request-canceled";
|
|
95238
|
+
change: reportsComponents["schemas"]["PayoutRequestChange"];
|
|
95239
|
+
/** ID of the payout request. */
|
|
95240
|
+
payoutRequestId: string;
|
|
95241
|
+
/** ID of the customer associated with the payout request. */
|
|
95242
|
+
customerId: string;
|
|
95243
|
+
/** Date and time when the change occurred. */
|
|
95244
|
+
occurredTime: string;
|
|
95245
|
+
_embedded: {
|
|
95246
|
+
payoutRequest: reportsComponents["schemas"]["PayoutRequest"];
|
|
95247
|
+
customer: reportsComponents["schemas"]["Customer"];
|
|
95248
|
+
};
|
|
95249
|
+
_links: {
|
|
95250
|
+
/** URL of the related payout request. */
|
|
95251
|
+
href: string;
|
|
95252
|
+
rel: string;
|
|
95253
|
+
}[];
|
|
95254
|
+
};
|
|
95255
|
+
PayoutRequestChangedAllocation: {
|
|
95256
|
+
/** Webhook event type. */
|
|
95257
|
+
eventType: string;
|
|
95258
|
+
/** Specific payout request allocation change that triggered the webhook. */
|
|
95259
|
+
changeType:
|
|
95260
|
+
| "payout-request-allocation-created"
|
|
95261
|
+
| "payout-request-allocation-queued"
|
|
95262
|
+
| "payout-request-allocation-returned-to-pending"
|
|
95263
|
+
| "payout-request-allocation-processing-started"
|
|
95264
|
+
| "payout-request-allocation-waiting-completion"
|
|
95265
|
+
| "payout-request-allocation-completed"
|
|
95266
|
+
| "payout-request-allocation-declined"
|
|
95267
|
+
| "payout-request-allocation-failed"
|
|
95268
|
+
| "payout-request-allocation-canceled";
|
|
95269
|
+
change: reportsComponents["schemas"]["PayoutRequestChange"];
|
|
95270
|
+
/** ID of the changed payout request allocation. */
|
|
95271
|
+
allocationId: string;
|
|
95272
|
+
/** ID of the payout request. */
|
|
95273
|
+
payoutRequestId: string;
|
|
95274
|
+
/** ID of the customer associated with the payout request. */
|
|
95275
|
+
customerId: string;
|
|
95276
|
+
/** Date and time when the change occurred. */
|
|
95277
|
+
occurredTime: string;
|
|
95278
|
+
_embedded: {
|
|
95279
|
+
allocation: reportsComponents["schemas"]["PayoutRequestAllocation"];
|
|
95280
|
+
payoutRequest: reportsComponents["schemas"]["PayoutRequest"];
|
|
95281
|
+
customer: reportsComponents["schemas"]["Customer"];
|
|
95282
|
+
};
|
|
95283
|
+
_links: {
|
|
95284
|
+
/** URL of the related resource. */
|
|
95285
|
+
href: string;
|
|
95286
|
+
/** Type of related resource. */
|
|
95287
|
+
rel: "allocation" | "payoutRequest";
|
|
95288
|
+
}[];
|
|
95289
|
+
};
|
|
95290
|
+
/** Payout request or payout request allocation change details. */
|
|
95291
|
+
PayoutRequestChangedWebhookPayload:
|
|
95292
|
+
| reportsComponents["schemas"]["PayoutRequestChangedRequest"]
|
|
95293
|
+
| reportsComponents["schemas"]["PayoutRequestChangedAllocation"];
|
|
94847
95294
|
/** ID of the checkout form. */
|
|
94848
95295
|
CheckoutFormId: string;
|
|
94849
95296
|
};
|
|
@@ -96915,6 +97362,45 @@ export interface reportsComponents {
|
|
|
96915
97362
|
};
|
|
96916
97363
|
};
|
|
96917
97364
|
};
|
|
97365
|
+
/** Payload of a webhook event for a batch of payout requests. */
|
|
97366
|
+
PayoutRequestBatchWebhook: {
|
|
97367
|
+
content: {
|
|
97368
|
+
"application/json": {
|
|
97369
|
+
/** ID of the batch of payout requests. */
|
|
97370
|
+
batchId: string;
|
|
97371
|
+
/** Type of event that triggered the webhook. */
|
|
97372
|
+
eventType:
|
|
97373
|
+
| "payout-request-batch-created"
|
|
97374
|
+
| "payout-request-batch-modified";
|
|
97375
|
+
/** Date and time when the batch change occurred. */
|
|
97376
|
+
occurredTime: string;
|
|
97377
|
+
/** Embedded objects related to the batch event for payout requests. */
|
|
97378
|
+
_embedded: {
|
|
97379
|
+
payoutRequestBatch: reportsComponents["schemas"]["PayoutRequestBatch"];
|
|
97380
|
+
};
|
|
97381
|
+
/** Links to related resources. */
|
|
97382
|
+
_links: {
|
|
97383
|
+
/** URL of the link. */
|
|
97384
|
+
href: string;
|
|
97385
|
+
/** Type of relationship for the link. */
|
|
97386
|
+
rel: "payoutRequestBatch";
|
|
97387
|
+
}[];
|
|
97388
|
+
};
|
|
97389
|
+
};
|
|
97390
|
+
};
|
|
97391
|
+
/** Payload of a webhook event for a deleted batch of payout requests. */
|
|
97392
|
+
PayoutRequestBatchDeletedWebhook: {
|
|
97393
|
+
content: {
|
|
97394
|
+
"application/json": {
|
|
97395
|
+
/** ID of the deleted batch of payout requests. */
|
|
97396
|
+
batchId: string;
|
|
97397
|
+
/** Type of event that triggered the webhook. */
|
|
97398
|
+
eventType: "payout-request-batch-deleted";
|
|
97399
|
+
/** Date and time of the batch deletion. */
|
|
97400
|
+
occurredTime: string;
|
|
97401
|
+
};
|
|
97402
|
+
};
|
|
97403
|
+
};
|
|
96918
97404
|
/** Payload of payout request-related webhook event. */
|
|
96919
97405
|
PayoutRequestWebhook: {
|
|
96920
97406
|
content: {
|
|
@@ -96941,6 +97427,12 @@ export interface reportsComponents {
|
|
|
96941
97427
|
};
|
|
96942
97428
|
};
|
|
96943
97429
|
};
|
|
97430
|
+
/** Payload of a webhook event for a payout request or payout request allocation change. */
|
|
97431
|
+
PayoutRequestChangedWebhook: {
|
|
97432
|
+
content: {
|
|
97433
|
+
"application/json": reportsComponents["schemas"]["PayoutRequestChangedWebhookPayload"];
|
|
97434
|
+
};
|
|
97435
|
+
};
|
|
96944
97436
|
/** Payload of quote-related webhook event. */
|
|
96945
97437
|
QuoteWebhook: {
|
|
96946
97438
|
content: {
|