@capibox/bridge-server 0.0.61 → 0.0.62
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/index.d.mts +3378 -446
- package/dist/index.d.ts +3378 -446
- package/dist/index.js +46 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +46 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -553,6 +553,10 @@ interface components {
|
|
|
553
553
|
*/
|
|
554
554
|
swagger_type: "" | "public" | "crm";
|
|
555
555
|
};
|
|
556
|
+
AllIntegrationsResponseDto: {
|
|
557
|
+
granted: components["schemas"]["IntegrationResponseDto"][];
|
|
558
|
+
other: components["schemas"]["IntegrationResponseDto"][];
|
|
559
|
+
};
|
|
556
560
|
FunnelTemplatesEnumDto: {
|
|
557
561
|
/**
|
|
558
562
|
* @description Available templates for the home page
|
|
@@ -757,44 +761,53 @@ interface components {
|
|
|
757
761
|
slug: string;
|
|
758
762
|
};
|
|
759
763
|
SessionResponseDto: {
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
764
|
+
/**
|
|
765
|
+
* @description Session ID
|
|
766
|
+
* @example 1
|
|
767
|
+
*/
|
|
768
|
+
id: number;
|
|
769
|
+
/**
|
|
770
|
+
* @description Session UUID
|
|
771
|
+
* @example 550e8400-e29b-41d4-a716-446655440000
|
|
772
|
+
*/
|
|
773
|
+
uuid: string;
|
|
774
|
+
/**
|
|
775
|
+
* @description Transaction ID
|
|
776
|
+
* @example txn_123456789
|
|
777
|
+
*/
|
|
778
|
+
transactionId: string;
|
|
779
|
+
/**
|
|
780
|
+
* @description User ID
|
|
781
|
+
* @example user_123456789
|
|
782
|
+
*/
|
|
783
|
+
userId: string;
|
|
784
|
+
/**
|
|
785
|
+
* @description Trustpilot link
|
|
786
|
+
* @example https://www.trustpilot.com/review/example.com
|
|
787
|
+
*/
|
|
788
|
+
trustpilotLink?: string;
|
|
789
|
+
/**
|
|
790
|
+
* @description Postback URL
|
|
791
|
+
* @example https://jumptask.go2cloud.org/aff_lsr?transaction_id=txn_123456789&adv_sub=user_123456789
|
|
792
|
+
*/
|
|
793
|
+
postbackUrl?: string;
|
|
794
|
+
/**
|
|
795
|
+
* @description Session status
|
|
796
|
+
* @example created
|
|
797
|
+
*/
|
|
798
|
+
status: string;
|
|
799
|
+
/**
|
|
800
|
+
* Format: date-time
|
|
801
|
+
* @description Creation date
|
|
802
|
+
* @example 2024-01-01T00:00:00.000Z
|
|
803
|
+
*/
|
|
770
804
|
createdAt: string;
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
* "utm_source": "google",
|
|
777
|
-
* "utm_medium": "cpc",
|
|
778
|
-
* "utm_campaign": "adwords"
|
|
779
|
-
* } */
|
|
780
|
-
query: {
|
|
781
|
-
[key: string]: unknown;
|
|
782
|
-
};
|
|
783
|
-
/** @example https://www.example.com */
|
|
784
|
-
referer: string;
|
|
785
|
-
/** @example main/a */
|
|
786
|
-
slug: string;
|
|
805
|
+
/**
|
|
806
|
+
* Format: date-time
|
|
807
|
+
* @description Last update date
|
|
808
|
+
* @example 2024-01-01T00:00:00.000Z
|
|
809
|
+
*/
|
|
787
810
|
updatedAt: string;
|
|
788
|
-
/** @example Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36 */
|
|
789
|
-
useragent: string;
|
|
790
|
-
/** @example {
|
|
791
|
-
* "language": "en",
|
|
792
|
-
* "currency": "USD",
|
|
793
|
-
* "email": "xxx@example.com"
|
|
794
|
-
* } */
|
|
795
|
-
extraData: {
|
|
796
|
-
[key: string]: unknown;
|
|
797
|
-
};
|
|
798
811
|
};
|
|
799
812
|
SessionResponseFullDto: {
|
|
800
813
|
success: number;
|
|
@@ -1149,6 +1162,16 @@ interface components {
|
|
|
1149
1162
|
* @example 123456789
|
|
1150
1163
|
*/
|
|
1151
1164
|
orderId: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* @description The customer ID for the payment
|
|
1167
|
+
* @example 67a8d72e-d8a4-4e98-8786-ee079c6c7d6f
|
|
1168
|
+
*/
|
|
1169
|
+
customerId: string;
|
|
1170
|
+
/**
|
|
1171
|
+
* @description The currency code for the payment
|
|
1172
|
+
* @example USD
|
|
1173
|
+
*/
|
|
1174
|
+
currencyCode: string;
|
|
1152
1175
|
/**
|
|
1153
1176
|
* @description The amount you would like to charge the customer, in minor units. e.g. for $7, use 700.
|
|
1154
1177
|
* @example 1000
|
|
@@ -1164,10 +1187,13 @@ interface components {
|
|
|
1164
1187
|
metadata?: {
|
|
1165
1188
|
[key: string]: unknown;
|
|
1166
1189
|
};
|
|
1190
|
+
customer: components["schemas"]["PrimerCreatePaymentRequestCustomer"];
|
|
1191
|
+
order: components["schemas"]["PrimerCreatePaymentRequestOrder"];
|
|
1167
1192
|
};
|
|
1168
1193
|
PrimerCreatePaymentResponseDto: {
|
|
1169
1194
|
/** @example success */
|
|
1170
1195
|
success: boolean;
|
|
1196
|
+
data: components["schemas"]["PrimerPaymentResponseDto"];
|
|
1171
1197
|
};
|
|
1172
1198
|
PrimerCreateRecurringPaymentRequestDto: {
|
|
1173
1199
|
/**
|
|
@@ -1180,6 +1206,16 @@ interface components {
|
|
|
1180
1206
|
* @example 123456789
|
|
1181
1207
|
*/
|
|
1182
1208
|
orderId: string;
|
|
1209
|
+
/**
|
|
1210
|
+
* @description The customer ID for the payment
|
|
1211
|
+
* @example 67a8d72e-d8a4-4e98-8786-ee079c6c7d6f
|
|
1212
|
+
*/
|
|
1213
|
+
customerId: string;
|
|
1214
|
+
/**
|
|
1215
|
+
* @description The currency code for the payment
|
|
1216
|
+
* @example USD
|
|
1217
|
+
*/
|
|
1218
|
+
currencyCode: string;
|
|
1183
1219
|
/**
|
|
1184
1220
|
* @description The amount you would like to charge the customer, in minor units. e.g. for $7, use 700.
|
|
1185
1221
|
* @example 1000
|
|
@@ -1195,6 +1231,8 @@ interface components {
|
|
|
1195
1231
|
metadata?: {
|
|
1196
1232
|
[key: string]: unknown;
|
|
1197
1233
|
};
|
|
1234
|
+
customer: components["schemas"]["PrimerCreatePaymentRequestCustomer"];
|
|
1235
|
+
order: components["schemas"]["PrimerCreatePaymentRequestOrder"];
|
|
1198
1236
|
};
|
|
1199
1237
|
PrimerCreateReferencePaymentRequestWithDelayDto: {
|
|
1200
1238
|
/**
|
|
@@ -1367,102 +1405,29 @@ interface components {
|
|
|
1367
1405
|
updatedAt: string;
|
|
1368
1406
|
};
|
|
1369
1407
|
BadRequestErrorDto: {
|
|
1370
|
-
/**
|
|
1371
|
-
* @description HTTP status code.
|
|
1372
|
-
* @example 400
|
|
1373
|
-
*/
|
|
1408
|
+
/** @example 400 */
|
|
1374
1409
|
statusCode: number;
|
|
1375
|
-
/**
|
|
1376
|
-
* @description List of error messages.
|
|
1377
|
-
* @example [
|
|
1378
|
-
* "property must be a string"
|
|
1379
|
-
* ]
|
|
1380
|
-
*/
|
|
1381
1410
|
message: string[];
|
|
1382
|
-
/**
|
|
1383
|
-
* @description Error message.
|
|
1384
|
-
* @example Bad Request
|
|
1385
|
-
*/
|
|
1411
|
+
/** @example Bad Request */
|
|
1386
1412
|
error: string;
|
|
1387
1413
|
};
|
|
1388
1414
|
DisputeResponseDto: {
|
|
1389
|
-
/**
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
/**
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
disputeCreatedUtc: string;
|
|
1405
|
-
/**
|
|
1406
|
-
* Format: date-time
|
|
1407
|
-
* @description The date and time when the original charge was created in UTC.
|
|
1408
|
-
* @example 2025-07-30T15:30:00Z
|
|
1409
|
-
*/
|
|
1410
|
-
chargeCreatedUtc: string;
|
|
1411
|
-
/**
|
|
1412
|
-
* @description The amount of the dispute.
|
|
1413
|
-
* @example 100.5
|
|
1414
|
-
*/
|
|
1415
|
-
disputeAmount: number;
|
|
1416
|
-
/**
|
|
1417
|
-
* @description The currency of the dispute.
|
|
1418
|
-
* @example USD
|
|
1419
|
-
*/
|
|
1420
|
-
disputeCurrency: string;
|
|
1421
|
-
/**
|
|
1422
|
-
* @description The amount of the original charge.
|
|
1423
|
-
* @example 100.5
|
|
1424
|
-
*/
|
|
1425
|
-
chargeAmount: number;
|
|
1426
|
-
/**
|
|
1427
|
-
* @description The currency of the original charge.
|
|
1428
|
-
* @example USD
|
|
1429
|
-
*/
|
|
1430
|
-
chargeCurrencyChargeId: string;
|
|
1431
|
-
/**
|
|
1432
|
-
* @description The reason for the dispute.
|
|
1433
|
-
* @example fraudulent
|
|
1434
|
-
*/
|
|
1415
|
+
/** @example PP-D-12345 */
|
|
1416
|
+
dispute_id: string;
|
|
1417
|
+
/** @example OPEN */
|
|
1418
|
+
dispute_state: string;
|
|
1419
|
+
/** @example INQUIRY */
|
|
1420
|
+
dispute_stage: string;
|
|
1421
|
+
/** @example 2025-09-25T12:34:56Z */
|
|
1422
|
+
create_time: string;
|
|
1423
|
+
/** @example 2025-09-26T12:34:56Z */
|
|
1424
|
+
update_time: string;
|
|
1425
|
+
/** @example 100 */
|
|
1426
|
+
disputed_amount_value: number;
|
|
1427
|
+
/** @example USD */
|
|
1428
|
+
disputed_amount_currency: string;
|
|
1429
|
+
/** @example Unauthorized transaction reported by buyer */
|
|
1435
1430
|
reason: string;
|
|
1436
|
-
/**
|
|
1437
|
-
* @description The status of the dispute.
|
|
1438
|
-
* @example needs_response
|
|
1439
|
-
*/
|
|
1440
|
-
status: string;
|
|
1441
|
-
/**
|
|
1442
|
-
* @description Indicates if this is a Visa Rapid Dispute Resolution case.
|
|
1443
|
-
* @example false
|
|
1444
|
-
*/
|
|
1445
|
-
isVisaRapidDisputeResolution: boolean;
|
|
1446
|
-
/**
|
|
1447
|
-
* @description The ID of the Payment Intent associated with the charge.
|
|
1448
|
-
* @example pi_3Lp7g22eZvKYlo2C1A2B3D4E
|
|
1449
|
-
*/
|
|
1450
|
-
paymentIntent: string;
|
|
1451
|
-
/**
|
|
1452
|
-
* @description The ID of the charge that was disputed.
|
|
1453
|
-
* @example ch_3Lp7g22eZvKYlo2C1A2B3D4E
|
|
1454
|
-
*/
|
|
1455
|
-
chargeId: string;
|
|
1456
|
-
/**
|
|
1457
|
-
* Format: date-time
|
|
1458
|
-
* @description Timestamp of when the record was created in the database.
|
|
1459
|
-
*/
|
|
1460
|
-
createdAt: string;
|
|
1461
|
-
/**
|
|
1462
|
-
* Format: date-time
|
|
1463
|
-
* @description Timestamp of when the record was last updated in the database.
|
|
1464
|
-
*/
|
|
1465
|
-
updatedAt: string;
|
|
1466
1431
|
};
|
|
1467
1432
|
EarlyFraudWarningResponseDto: {
|
|
1468
1433
|
/**
|
|
@@ -1517,36 +1482,23 @@ interface components {
|
|
|
1517
1482
|
updatedAt: string;
|
|
1518
1483
|
};
|
|
1519
1484
|
RefundResponseDto: {
|
|
1520
|
-
/**
|
|
1521
|
-
* @description Internal database ID.
|
|
1522
|
-
* @example 1
|
|
1523
|
-
*/
|
|
1485
|
+
/** @example 1 */
|
|
1524
1486
|
id: number;
|
|
1525
|
-
/**
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
* @example 1692942318
|
|
1533
|
-
*/
|
|
1534
|
-
created: number;
|
|
1535
|
-
/**
|
|
1536
|
-
* @description True if the object exists in live mode; false if the object exists in test mode.
|
|
1537
|
-
* @example false
|
|
1538
|
-
*/
|
|
1539
|
-
livemode: boolean;
|
|
1540
|
-
/** @description Full Stripe refund object stored as JSON. */
|
|
1541
|
-
data: Record<string, never>;
|
|
1487
|
+
/** @example refund_001 */
|
|
1488
|
+
externalId: string;
|
|
1489
|
+
/** @example {
|
|
1490
|
+
* "amount": 50,
|
|
1491
|
+
* "currency": "USD"
|
|
1492
|
+
* } */
|
|
1493
|
+
data: Record<string, never> | null;
|
|
1542
1494
|
/**
|
|
1543
1495
|
* Format: date-time
|
|
1544
|
-
* @
|
|
1496
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
1545
1497
|
*/
|
|
1546
1498
|
createdAt: string;
|
|
1547
1499
|
/**
|
|
1548
1500
|
* Format: date-time
|
|
1549
|
-
* @
|
|
1501
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
1550
1502
|
*/
|
|
1551
1503
|
updatedAt: string;
|
|
1552
1504
|
};
|
|
@@ -1663,19 +1615,50 @@ interface components {
|
|
|
1663
1615
|
productName: string;
|
|
1664
1616
|
};
|
|
1665
1617
|
PaymentMethodDataDto: {
|
|
1666
|
-
/**
|
|
1618
|
+
/**
|
|
1619
|
+
* @description Last 4 digits of the card
|
|
1620
|
+
* @example 4242
|
|
1621
|
+
*/
|
|
1667
1622
|
last4Digits: string;
|
|
1668
|
-
/**
|
|
1623
|
+
/**
|
|
1624
|
+
* @description First 6 digits of the card
|
|
1625
|
+
* @example 424242
|
|
1626
|
+
*/
|
|
1669
1627
|
first6Digits: string;
|
|
1670
|
-
/**
|
|
1628
|
+
/**
|
|
1629
|
+
* @description Expiration month
|
|
1630
|
+
* @example 04
|
|
1631
|
+
*/
|
|
1671
1632
|
expirationMonth: string;
|
|
1672
|
-
/**
|
|
1633
|
+
/**
|
|
1634
|
+
* @description Expiration year
|
|
1635
|
+
* @example 2028
|
|
1636
|
+
*/
|
|
1673
1637
|
expirationYear: string;
|
|
1674
|
-
/**
|
|
1638
|
+
/**
|
|
1639
|
+
* @description Card network
|
|
1640
|
+
* @example VISA
|
|
1641
|
+
*/
|
|
1675
1642
|
network: string;
|
|
1676
|
-
/**
|
|
1643
|
+
/**
|
|
1644
|
+
* @description Whether the card is network tokenized
|
|
1645
|
+
* @example false
|
|
1646
|
+
*/
|
|
1677
1647
|
isNetworkTokenized: boolean;
|
|
1678
|
-
|
|
1648
|
+
/** @description BIN data information */
|
|
1649
|
+
binData: {
|
|
1650
|
+
[key: string]: unknown;
|
|
1651
|
+
} & components["schemas"]["BinDataDto"];
|
|
1652
|
+
/**
|
|
1653
|
+
* @description Network transaction ID
|
|
1654
|
+
* @example 575454110835311
|
|
1655
|
+
*/
|
|
1656
|
+
networkTransactionId: string;
|
|
1657
|
+
/**
|
|
1658
|
+
* @description Account funding type
|
|
1659
|
+
* @example CREDIT
|
|
1660
|
+
*/
|
|
1661
|
+
accountFundingType: string;
|
|
1679
1662
|
};
|
|
1680
1663
|
ThreeDSecureAuthenticationDto: {
|
|
1681
1664
|
/** @example NOT_PERFORMED */
|
|
@@ -1708,24 +1691,12 @@ interface components {
|
|
|
1708
1691
|
amountRefunded: number;
|
|
1709
1692
|
};
|
|
1710
1693
|
TransactionDto: {
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
/** @example SALE */
|
|
1718
|
-
transactionType: string;
|
|
1719
|
-
/** @example LRXB8Q6HZRTDVCR9 */
|
|
1720
|
-
processorTransactionId: string;
|
|
1721
|
-
/** @example ADYEN */
|
|
1722
|
-
processorName: string;
|
|
1723
|
-
/** @example Parenting_Leader */
|
|
1724
|
-
processorMerchantId: string;
|
|
1725
|
-
/** @example AUTHORIZED */
|
|
1726
|
-
processorStatus: string;
|
|
1727
|
-
/** @example 8557a01b-f88d-4154-8c50-37deab59eb71-re-25092 */
|
|
1728
|
-
orderId: string;
|
|
1694
|
+
amount: components["schemas"]["AmountDto"];
|
|
1695
|
+
payee: components["schemas"]["PayeeDto"];
|
|
1696
|
+
description: string;
|
|
1697
|
+
invoice_number: string;
|
|
1698
|
+
item_list: components["schemas"]["ItemListDto"];
|
|
1699
|
+
related_resources: components["schemas"]["RelatedResourceDto"][];
|
|
1729
1700
|
};
|
|
1730
1701
|
CvvCheckDto: {
|
|
1731
1702
|
/** @example ADYEN */
|
|
@@ -1776,8 +1747,11 @@ interface components {
|
|
|
1776
1747
|
metadata: Record<string, never>;
|
|
1777
1748
|
/** @example 8557a01b-f88d-4154-8c50-37deab59eb71-re-25092 */
|
|
1778
1749
|
orderId: string;
|
|
1779
|
-
/**
|
|
1780
|
-
|
|
1750
|
+
/**
|
|
1751
|
+
* @example AUTHORIZED
|
|
1752
|
+
* @enum {string}
|
|
1753
|
+
*/
|
|
1754
|
+
status: "PENDING" | "FAILED" | "AUTHORIZED" | "SETTLING" | "PARTIALLY_SETTLED" | "SETTLED" | "DECLINED" | "CANCELLED";
|
|
1781
1755
|
order: components["schemas"]["OrderDto"];
|
|
1782
1756
|
customer: components["schemas"]["CustomerDto"];
|
|
1783
1757
|
paymentMethod: components["schemas"]["PaymentMethodDto"];
|
|
@@ -1931,27 +1905,11 @@ interface components {
|
|
|
1931
1905
|
totalPages: number;
|
|
1932
1906
|
};
|
|
1933
1907
|
PayerInfoDto: {
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
|
|
1939
|
-
* "country_code": "1",
|
|
1940
|
-
* "national_number": "4089027107"
|
|
1941
|
-
* } */
|
|
1942
|
-
phone_number?: Record<string, never>;
|
|
1943
|
-
/** @example N */
|
|
1944
|
-
address_status?: string;
|
|
1945
|
-
/** @example Y */
|
|
1946
|
-
payer_status?: string;
|
|
1947
|
-
/** @example {
|
|
1948
|
-
* "given_name": "John",
|
|
1949
|
-
* "surname": "Doe",
|
|
1950
|
-
* "alternate_full_name": "John Doe"
|
|
1951
|
-
* } */
|
|
1952
|
-
payer_name?: Record<string, never>;
|
|
1953
|
-
/** @example US */
|
|
1954
|
-
country_code?: string;
|
|
1908
|
+
email: string;
|
|
1909
|
+
first_name: string;
|
|
1910
|
+
last_name: string;
|
|
1911
|
+
payer_id: string;
|
|
1912
|
+
country_code: string;
|
|
1955
1913
|
};
|
|
1956
1914
|
TransactionRawResponseDto: {
|
|
1957
1915
|
/** @example 9GS00022P28620007 */
|
|
@@ -1972,7 +1930,7 @@ interface components {
|
|
|
1972
1930
|
transactionId: string;
|
|
1973
1931
|
/** @example Z5G000XWTTNPS */
|
|
1974
1932
|
accountNumber: string;
|
|
1975
|
-
rawResponse: components["schemas"]["
|
|
1933
|
+
rawResponse: components["schemas"]["PaypalTransactionRawResponseDto"];
|
|
1976
1934
|
/** @example 2025-09-18T10:15:08.153Z */
|
|
1977
1935
|
createdAt: string;
|
|
1978
1936
|
};
|
|
@@ -2294,38 +2252,86 @@ interface components {
|
|
|
2294
2252
|
/** @example https://example.com/product/123 */
|
|
2295
2253
|
sourceUrl: string;
|
|
2296
2254
|
};
|
|
2297
|
-
|
|
2298
|
-
/** @example
|
|
2299
|
-
|
|
2300
|
-
/** @example
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
clientData?: components["schemas"]["CustomClientData"];
|
|
2305
|
-
};
|
|
2306
|
-
TiktokCapiPayloadSessionBridge: {
|
|
2307
|
-
uuid: string;
|
|
2308
|
-
event: components["schemas"]["TiktokCapiPayloadBridge"];
|
|
2309
|
-
};
|
|
2310
|
-
ReportItemDto: {
|
|
2255
|
+
TikTokCustomClientData: {
|
|
2256
|
+
/** @example 123.123.123.123 */
|
|
2257
|
+
ip?: string;
|
|
2258
|
+
/** @example Tiktok Advertising cookie */
|
|
2259
|
+
ttp?: string;
|
|
2260
|
+
/** @example Email */
|
|
2261
|
+
email?: string;
|
|
2311
2262
|
/**
|
|
2312
|
-
* @description
|
|
2313
|
-
* @example
|
|
2263
|
+
* @description Click ID
|
|
2264
|
+
* @example 1234567890
|
|
2314
2265
|
*/
|
|
2315
|
-
|
|
2266
|
+
ttclid?: string;
|
|
2316
2267
|
/**
|
|
2317
|
-
* @description
|
|
2318
|
-
* @example
|
|
2268
|
+
* @description User agent
|
|
2269
|
+
* @example Mozilla/5.0 (Windows NT 10.0; Win64; x64)
|
|
2319
2270
|
*/
|
|
2320
|
-
|
|
2271
|
+
userAgent?: string;
|
|
2321
2272
|
/**
|
|
2322
|
-
* @description
|
|
2323
|
-
* @example
|
|
2273
|
+
* @description External ID
|
|
2274
|
+
* @example 1234567890
|
|
2324
2275
|
*/
|
|
2325
|
-
|
|
2276
|
+
externalId?: string;
|
|
2326
2277
|
/**
|
|
2327
|
-
* @description
|
|
2328
|
-
* @example
|
|
2278
|
+
* @description The user country.
|
|
2279
|
+
* @example US
|
|
2280
|
+
*/
|
|
2281
|
+
country?: string;
|
|
2282
|
+
/**
|
|
2283
|
+
* @description The user state.
|
|
2284
|
+
* @example DE
|
|
2285
|
+
*/
|
|
2286
|
+
state?: string;
|
|
2287
|
+
/**
|
|
2288
|
+
* @description The user city.
|
|
2289
|
+
* @example Berlin
|
|
2290
|
+
*/
|
|
2291
|
+
city?: string;
|
|
2292
|
+
/**
|
|
2293
|
+
* @description The user zip code.
|
|
2294
|
+
* @example 19901
|
|
2295
|
+
*/
|
|
2296
|
+
zip?: string;
|
|
2297
|
+
/**
|
|
2298
|
+
* @description The user phone number.
|
|
2299
|
+
* @example +123123231
|
|
2300
|
+
*/
|
|
2301
|
+
phone?: string;
|
|
2302
|
+
};
|
|
2303
|
+
TiktokCapiPayloadBridge: {
|
|
2304
|
+
/** @example EVENT_ID_123 */
|
|
2305
|
+
eventId: string;
|
|
2306
|
+
/** @example Purchase */
|
|
2307
|
+
eventName: string;
|
|
2308
|
+
eventData: components["schemas"]["TiktokCapiEventDataDto"];
|
|
2309
|
+
testEventCode?: string;
|
|
2310
|
+
clientData?: components["schemas"]["TikTokCustomClientData"];
|
|
2311
|
+
};
|
|
2312
|
+
TiktokCapiPayloadSessionBridge: {
|
|
2313
|
+
uuid: string;
|
|
2314
|
+
event: components["schemas"]["TiktokCapiPayloadBridge"];
|
|
2315
|
+
};
|
|
2316
|
+
ReportItemDto: {
|
|
2317
|
+
/**
|
|
2318
|
+
* @description Unique identifier for the report item
|
|
2319
|
+
* @example 1
|
|
2320
|
+
*/
|
|
2321
|
+
id: number;
|
|
2322
|
+
/**
|
|
2323
|
+
* @description Unique order identifier
|
|
2324
|
+
* @example ORD-001
|
|
2325
|
+
*/
|
|
2326
|
+
orderId: string;
|
|
2327
|
+
/**
|
|
2328
|
+
* @description Country where the order was placed
|
|
2329
|
+
* @example US
|
|
2330
|
+
*/
|
|
2331
|
+
country: string;
|
|
2332
|
+
/**
|
|
2333
|
+
* @description Customer gender
|
|
2334
|
+
* @example male
|
|
2329
2335
|
*/
|
|
2330
2336
|
gender: string;
|
|
2331
2337
|
/**
|
|
@@ -3134,195 +3140,2892 @@ interface components {
|
|
|
3134
3140
|
*/
|
|
3135
3141
|
dateRange: string;
|
|
3136
3142
|
};
|
|
3137
|
-
|
|
3138
|
-
/** @example EUR */
|
|
3139
|
-
from: string;
|
|
3140
|
-
/** @example USD */
|
|
3141
|
-
to: string;
|
|
3142
|
-
/** @example 100 */
|
|
3143
|
-
amount: number;
|
|
3144
|
-
};
|
|
3145
|
-
ConvertCurrencyResponseDto: {
|
|
3146
|
-
/**
|
|
3147
|
-
* @description Source currency
|
|
3148
|
-
* @example USD
|
|
3149
|
-
*/
|
|
3150
|
-
from: string;
|
|
3151
|
-
/**
|
|
3152
|
-
* @description Target currency
|
|
3153
|
-
* @example PKR
|
|
3154
|
-
*/
|
|
3155
|
-
to: string;
|
|
3143
|
+
MetricDto: {
|
|
3156
3144
|
/**
|
|
3157
|
-
* @description
|
|
3145
|
+
* @description Count of records
|
|
3158
3146
|
* @example 100
|
|
3159
3147
|
*/
|
|
3160
|
-
|
|
3161
|
-
/**
|
|
3162
|
-
* @description Converted amount in target currency
|
|
3163
|
-
* @example 28140
|
|
3164
|
-
*/
|
|
3165
|
-
converted: number;
|
|
3148
|
+
count: number;
|
|
3166
3149
|
/**
|
|
3167
|
-
* @description
|
|
3168
|
-
* @example
|
|
3150
|
+
* @description Total amount
|
|
3151
|
+
* @example 1000
|
|
3169
3152
|
*/
|
|
3170
|
-
|
|
3153
|
+
amount: number;
|
|
3154
|
+
};
|
|
3155
|
+
ReportsResponseDto: {
|
|
3171
3156
|
/**
|
|
3172
|
-
* @description
|
|
3173
|
-
* @example
|
|
3157
|
+
* @description Date range
|
|
3158
|
+
* @example 2025-10-27
|
|
3174
3159
|
*/
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
pixel: string;
|
|
3182
|
-
/** @description Facebook Pixel Token */
|
|
3183
|
-
token: string;
|
|
3184
|
-
/** @description Project */
|
|
3185
|
-
project: string;
|
|
3186
|
-
/** @description Active */
|
|
3187
|
-
active: boolean;
|
|
3188
|
-
};
|
|
3189
|
-
FbCapiPixelResponseDto: {
|
|
3190
|
-
/** @description Unique Record ID */
|
|
3191
|
-
id: number;
|
|
3192
|
-
/** @description Title (just for UI purposes) */
|
|
3193
|
-
title: string;
|
|
3194
|
-
/** @description Facebook Pixel ID */
|
|
3195
|
-
pixel: string;
|
|
3196
|
-
/** @description Facebook Pixel Token */
|
|
3197
|
-
token: string;
|
|
3198
|
-
/** @description Project */
|
|
3199
|
-
project: string;
|
|
3200
|
-
/** @description Active */
|
|
3201
|
-
active: boolean;
|
|
3202
|
-
};
|
|
3203
|
-
FbCapiUpdatePixelDto: {
|
|
3204
|
-
/** @description Title (just for UI purposes) */
|
|
3205
|
-
title?: string;
|
|
3206
|
-
/** @description Facebook Pixel ID */
|
|
3207
|
-
pixel?: string;
|
|
3208
|
-
/** @description Facebook Pixel Token */
|
|
3209
|
-
token?: string;
|
|
3210
|
-
/** @description Project */
|
|
3211
|
-
project?: string;
|
|
3212
|
-
/** @description Active */
|
|
3213
|
-
active?: boolean;
|
|
3214
|
-
};
|
|
3215
|
-
Event: Record<string, never>;
|
|
3216
|
-
SnapchatCapiEventFullResponseDto: {
|
|
3217
|
-
data: components["schemas"]["Event"][];
|
|
3218
|
-
total: number;
|
|
3219
|
-
page: number;
|
|
3220
|
-
limit: number;
|
|
3221
|
-
totalPages: number;
|
|
3160
|
+
date: string;
|
|
3161
|
+
payments: components["schemas"]["MetricDto"];
|
|
3162
|
+
early_frauds: components["schemas"]["MetricDto"];
|
|
3163
|
+
disputes: components["schemas"]["MetricDto"];
|
|
3164
|
+
rdr: components["schemas"]["MetricDto"];
|
|
3165
|
+
chargebacks: components["schemas"]["MetricDto"];
|
|
3222
3166
|
};
|
|
3223
|
-
|
|
3224
|
-
/** @description
|
|
3167
|
+
PaymentCreateSessionRequestDto: {
|
|
3168
|
+
/** @description Unique Customer ID for the transaction. */
|
|
3169
|
+
referenceId: string;
|
|
3170
|
+
/** @description Currency code. */
|
|
3171
|
+
currency: string;
|
|
3172
|
+
/** @description Amount to charge. */
|
|
3173
|
+
amount: number;
|
|
3174
|
+
/** @description Customer email address. */
|
|
3225
3175
|
email: string;
|
|
3226
|
-
/** @description
|
|
3227
|
-
|
|
3228
|
-
|
|
3229
|
-
|
|
3230
|
-
|
|
3231
|
-
|
|
3232
|
-
|
|
3233
|
-
|
|
3234
|
-
|
|
3235
|
-
|
|
3236
|
-
|
|
3237
|
-
|
|
3238
|
-
|
|
3239
|
-
event_time: number;
|
|
3240
|
-
/** @description Action source (e.g., WEB/web/website) */
|
|
3241
|
-
action_source: string;
|
|
3242
|
-
/** @description Event source URL where the event occurred */
|
|
3243
|
-
event_source_url: string;
|
|
3244
|
-
/** @description Access token */
|
|
3245
|
-
access_token: string;
|
|
3246
|
-
/** @description Pixel ID */
|
|
3247
|
-
pixelId: string;
|
|
3248
|
-
};
|
|
3249
|
-
SnapchatCapiPayloadDto: {
|
|
3250
|
-
/** @description Client data */
|
|
3251
|
-
clientData: components["schemas"]["SnapChatClientDataDto"];
|
|
3252
|
-
/** @description Event data */
|
|
3253
|
-
eventData: components["schemas"]["SnapChatEventDataDto"];
|
|
3254
|
-
/** @description General CAPI data */
|
|
3255
|
-
data: components["schemas"]["SnapchatCapiDataDto"];
|
|
3256
|
-
/** @description Optional postback URL */
|
|
3257
|
-
postback?: string;
|
|
3258
|
-
/** @description Optional test event code */
|
|
3259
|
-
test_event_code?: string;
|
|
3260
|
-
};
|
|
3261
|
-
SnapChatCreateEventDto: {
|
|
3262
|
-
/** @description Event name */
|
|
3263
|
-
event: string;
|
|
3264
|
-
/** @description Request data */
|
|
3265
|
-
request: components["schemas"]["SnapchatCapiPayloadDto"];
|
|
3266
|
-
/** @description Pixel ID */
|
|
3267
|
-
pixelId: number;
|
|
3268
|
-
};
|
|
3269
|
-
SnapChatEventCreateResponseDto: {
|
|
3270
|
-
id: number;
|
|
3176
|
+
/** @description Country code ISO 3166-1 alpha-2. */
|
|
3177
|
+
countryCode: string;
|
|
3178
|
+
paymentDescription: string;
|
|
3179
|
+
/**
|
|
3180
|
+
* @description Optional metadata for the transaction.
|
|
3181
|
+
* @example {
|
|
3182
|
+
* "orderId": "123",
|
|
3183
|
+
* "customerId": "456"
|
|
3184
|
+
* }
|
|
3185
|
+
*/
|
|
3186
|
+
metaData?: {
|
|
3187
|
+
[key: string]: unknown;
|
|
3188
|
+
};
|
|
3271
3189
|
};
|
|
3272
|
-
|
|
3273
|
-
/** @
|
|
3274
|
-
|
|
3190
|
+
PrimerClientErrorDto: {
|
|
3191
|
+
/** @example 400 */
|
|
3192
|
+
statusCode: number;
|
|
3193
|
+
/** @example Invalid referenceId or amount provided for Primer session. */
|
|
3194
|
+
message: string;
|
|
3195
|
+
/** @example Invalid input */
|
|
3196
|
+
error: string;
|
|
3275
3197
|
};
|
|
3276
|
-
|
|
3277
|
-
/** @example
|
|
3278
|
-
|
|
3279
|
-
/** @
|
|
3280
|
-
|
|
3198
|
+
PrimerServerErrorDto: {
|
|
3199
|
+
/** @example 500 */
|
|
3200
|
+
statusCode: number;
|
|
3201
|
+
/** @example Failed to connect to Primer services. */
|
|
3202
|
+
message: string;
|
|
3203
|
+
/** @example An unexpected error occurred */
|
|
3204
|
+
error: string;
|
|
3281
3205
|
};
|
|
3282
|
-
|
|
3206
|
+
PrimerSessionUpdateRequestDto: {
|
|
3283
3207
|
/**
|
|
3284
|
-
* @description The
|
|
3285
|
-
* @example
|
|
3286
|
-
*/
|
|
3287
|
-
email: string;
|
|
3288
|
-
/**
|
|
3289
|
-
* @description The user's IP address.
|
|
3290
|
-
* @example 123.123.123.123
|
|
3208
|
+
* @description The unique reference for the transaction.
|
|
3209
|
+
* @example order-12345
|
|
3291
3210
|
*/
|
|
3292
|
-
|
|
3211
|
+
referenceId: string;
|
|
3293
3212
|
/**
|
|
3294
|
-
* @description The
|
|
3295
|
-
* @example
|
|
3213
|
+
* @description The currency of the transaction in ISO 4217 format.
|
|
3214
|
+
* @example USD
|
|
3296
3215
|
*/
|
|
3297
|
-
|
|
3216
|
+
currency: string;
|
|
3298
3217
|
/**
|
|
3299
|
-
* @description The
|
|
3300
|
-
* @example
|
|
3218
|
+
* @description The amount of the transaction in minor units (e.g., 1000 for $10.00).
|
|
3219
|
+
* @example 1000
|
|
3301
3220
|
*/
|
|
3302
|
-
|
|
3221
|
+
amount: number;
|
|
3303
3222
|
/**
|
|
3304
|
-
* @description The
|
|
3305
|
-
* @example
|
|
3223
|
+
* @description The email address of the customer.
|
|
3224
|
+
* @example customer@example.com
|
|
3306
3225
|
*/
|
|
3307
|
-
|
|
3226
|
+
email: string;
|
|
3308
3227
|
/**
|
|
3309
|
-
* @description The
|
|
3228
|
+
* @description The two-letter country code of the customer.
|
|
3310
3229
|
* @example US
|
|
3311
3230
|
*/
|
|
3312
|
-
|
|
3231
|
+
countryCode: string;
|
|
3313
3232
|
/**
|
|
3314
|
-
* @description
|
|
3315
|
-
* @example
|
|
3233
|
+
* @description Optional metadata for the transaction.
|
|
3234
|
+
* @example {
|
|
3235
|
+
* "orderId": "123",
|
|
3236
|
+
* "customerId": "456"
|
|
3237
|
+
* }
|
|
3316
3238
|
*/
|
|
3317
|
-
|
|
3239
|
+
metaData?: Record<string, never>;
|
|
3318
3240
|
/**
|
|
3319
|
-
* @description
|
|
3320
|
-
* @example
|
|
3241
|
+
* @description Client token obtained from Primer when the session was created. Use it to update the session.
|
|
3242
|
+
* @example cltk_eyJhbGciOiJIUzI1NiIsImtpZCI6ImNsaWVudC10b2tlbi1zaWduaW5nLWtleSIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NTU2NjYzMDIsImFjY2Vzc1Rva2VuIjoiNTBlMGNkYzUtNDQ4Ny00ZjMyLTg0ZjEtNjk2OTE4ZjM5ZTAxIiwiYW5hbHl0aWNzVXJsI
|
|
3321
3243
|
*/
|
|
3322
|
-
|
|
3323
|
-
|
|
3324
|
-
|
|
3325
|
-
|
|
3244
|
+
clientToken: string;
|
|
3245
|
+
};
|
|
3246
|
+
CommonFeeDto: {
|
|
3247
|
+
/** @example SURCHARGE */
|
|
3248
|
+
type: string;
|
|
3249
|
+
/** @example 20 */
|
|
3250
|
+
amount: number;
|
|
3251
|
+
};
|
|
3252
|
+
CommonOrderLineItemDto: {
|
|
3253
|
+
/** @example t-shirt-1 */
|
|
3254
|
+
itemId: string;
|
|
3255
|
+
/** @example White T-Shirt */
|
|
3256
|
+
description: string;
|
|
3257
|
+
/** @example 500 */
|
|
3258
|
+
amount: number;
|
|
3259
|
+
/** @example 1 */
|
|
3260
|
+
quantity: number;
|
|
3261
|
+
};
|
|
3262
|
+
CommonShippingDto: {
|
|
3263
|
+
/** @example 50 */
|
|
3264
|
+
amount: number;
|
|
3265
|
+
};
|
|
3266
|
+
CommonPaymentMethodOptionsDto: {
|
|
3267
|
+
PAYMENT_CARD: Record<string, never>;
|
|
3268
|
+
GOOGLE_PAY: Record<string, never>;
|
|
3269
|
+
PAY_NL_IDEAL: Record<string, never>;
|
|
3270
|
+
};
|
|
3271
|
+
CommonPaymentMethodDto: {
|
|
3272
|
+
/** @example true */
|
|
3273
|
+
vaultOnSuccess: boolean;
|
|
3274
|
+
/** @example false */
|
|
3275
|
+
vaultOn3DS: boolean;
|
|
3276
|
+
options: components["schemas"]["CommonPaymentMethodOptionsDto"];
|
|
3277
|
+
/** @example ESTIMATED */
|
|
3278
|
+
authorizationType: string;
|
|
3279
|
+
};
|
|
3280
|
+
CommonOrderDto: {
|
|
3281
|
+
/** @example FR */
|
|
3282
|
+
countryCode: string;
|
|
3283
|
+
fees: components["schemas"]["CommonFeeDto"][];
|
|
3284
|
+
lineItems: components["schemas"]["CommonOrderLineItemDto"][];
|
|
3285
|
+
shipping: components["schemas"]["CommonShippingDto"];
|
|
3286
|
+
paymentMethod: components["schemas"]["CommonPaymentMethodDto"];
|
|
3287
|
+
/** @example ESTIMATED */
|
|
3288
|
+
authorizationType: string;
|
|
3289
|
+
};
|
|
3290
|
+
PrimerSessionUpdateResponseDto: {
|
|
3291
|
+
/** @example customer-123 */
|
|
3292
|
+
customerId: string;
|
|
3293
|
+
/** @example order-abc */
|
|
3294
|
+
orderId: string;
|
|
3295
|
+
/** @example GBP */
|
|
3296
|
+
currencyCode: string;
|
|
3297
|
+
/** @example 650 */
|
|
3298
|
+
amount: number;
|
|
3299
|
+
/** @example {
|
|
3300
|
+
* "productType": "Clothing"
|
|
3301
|
+
* } */
|
|
3302
|
+
metadata: Record<string, never>;
|
|
3303
|
+
/** @example {
|
|
3304
|
+
* "emailAddress": "john@primer.io"
|
|
3305
|
+
* } */
|
|
3306
|
+
customer: Record<string, never>;
|
|
3307
|
+
order: components["schemas"]["CommonOrderDto"];
|
|
3308
|
+
};
|
|
3309
|
+
SavedPaymentMethodDto: {
|
|
3310
|
+
/**
|
|
3311
|
+
* @description Creation timestamp
|
|
3312
|
+
* @example 2025-08-05T13:45:52.846912
|
|
3313
|
+
*/
|
|
3314
|
+
createdAt: string;
|
|
3315
|
+
/**
|
|
3316
|
+
* @description Payment method token
|
|
3317
|
+
* @example oXxI7BvGTZWRBucAd92D-HwxNzU0NDAxNTUy
|
|
3318
|
+
*/
|
|
3319
|
+
token: string;
|
|
3320
|
+
/**
|
|
3321
|
+
* @description Token type
|
|
3322
|
+
* @example MULTI_USE
|
|
3323
|
+
*/
|
|
3324
|
+
tokenType: string;
|
|
3325
|
+
/**
|
|
3326
|
+
* @description Analytics ID
|
|
3327
|
+
* @example 8YSGDNw-XrS6OlW9BSPTBG5H
|
|
3328
|
+
*/
|
|
3329
|
+
analyticsId: string;
|
|
3330
|
+
/**
|
|
3331
|
+
* @description Payment method type
|
|
3332
|
+
* @example PAYMENT_CARD
|
|
3333
|
+
*/
|
|
3334
|
+
paymentMethodType: string;
|
|
3335
|
+
/** @description Payment method data */
|
|
3336
|
+
paymentMethodData: components["schemas"]["PaymentMethodDataDto"];
|
|
3337
|
+
/**
|
|
3338
|
+
* @description Customer ID
|
|
3339
|
+
* @example 67a8d72e-d8a4-4e98-8786-ee079c6c7d6f
|
|
3340
|
+
*/
|
|
3341
|
+
customerId: string;
|
|
3342
|
+
/**
|
|
3343
|
+
* @description Payment method description
|
|
3344
|
+
* @example My first card
|
|
3345
|
+
*/
|
|
3346
|
+
description?: string;
|
|
3347
|
+
/**
|
|
3348
|
+
* @description Whether the payment method is deleted
|
|
3349
|
+
* @example false
|
|
3350
|
+
*/
|
|
3351
|
+
deleted: boolean;
|
|
3352
|
+
/**
|
|
3353
|
+
* @description Whether this is the default payment method
|
|
3354
|
+
* @example true
|
|
3355
|
+
*/
|
|
3356
|
+
default: boolean;
|
|
3357
|
+
};
|
|
3358
|
+
PrimerPaymentMethodListResponseDto: {
|
|
3359
|
+
/** @description List of payment methods */
|
|
3360
|
+
data: components["schemas"]["SavedPaymentMethodDto"][];
|
|
3361
|
+
};
|
|
3362
|
+
PrimerPaymentReferenceChargeRequestDto: {
|
|
3363
|
+
/**
|
|
3364
|
+
* @description Payment method token from customer (get from /primer/payment-methods endpoint)
|
|
3365
|
+
* @example oXxI7BvGTZWRBucAd92D-HwxNzU0NDAxNTUy
|
|
3366
|
+
*/
|
|
3367
|
+
token: string;
|
|
3368
|
+
/**
|
|
3369
|
+
* @description Customer ID (use test customer: 67a8d72e-d8a4-4e98-8786-ee079c6c7d6f)
|
|
3370
|
+
* @example 67a8d72e-d8a4-4e98-8786-ee079c6c7d6f
|
|
3371
|
+
*/
|
|
3372
|
+
customerId: string;
|
|
3373
|
+
/**
|
|
3374
|
+
* @description Order ID (your unique order identifier)
|
|
3375
|
+
* @example order-abc-123
|
|
3376
|
+
*/
|
|
3377
|
+
orderId: string;
|
|
3378
|
+
/**
|
|
3379
|
+
* @description Amount
|
|
3380
|
+
* @example 42
|
|
3381
|
+
*/
|
|
3382
|
+
amount: number;
|
|
3383
|
+
/**
|
|
3384
|
+
* @description Currency code in ISO 4217 format
|
|
3385
|
+
* @example EUR
|
|
3386
|
+
*/
|
|
3387
|
+
currency: string;
|
|
3388
|
+
/**
|
|
3389
|
+
* @description Country code (2-letter ISO code)
|
|
3390
|
+
* @example US
|
|
3391
|
+
*/
|
|
3392
|
+
country: string;
|
|
3393
|
+
/**
|
|
3394
|
+
* @description Customer email address
|
|
3395
|
+
* @example customer123@gmail.com
|
|
3396
|
+
*/
|
|
3397
|
+
email: string;
|
|
3398
|
+
/**
|
|
3399
|
+
* @description Payment metadata (optional)
|
|
3400
|
+
* @example {
|
|
3401
|
+
* "productId": 123,
|
|
3402
|
+
* "merchantId": "a13bsd62s"
|
|
3403
|
+
* }
|
|
3404
|
+
*/
|
|
3405
|
+
metaData?: {
|
|
3406
|
+
[key: string]: unknown;
|
|
3407
|
+
};
|
|
3408
|
+
};
|
|
3409
|
+
PrimerPaymentReferenceChargeResponseDto: {
|
|
3410
|
+
/**
|
|
3411
|
+
* @description Whether the reference charge was successful (true if status is SETTLED, SETTLING, or AUTHORIZED)
|
|
3412
|
+
* @example true
|
|
3413
|
+
*/
|
|
3414
|
+
success: boolean;
|
|
3415
|
+
/**
|
|
3416
|
+
* @description Error message if the request failed
|
|
3417
|
+
* @example Payment failed
|
|
3418
|
+
*/
|
|
3419
|
+
error?: string;
|
|
3420
|
+
};
|
|
3421
|
+
PrimerSyncJobSuccessResponseDto: {
|
|
3422
|
+
/**
|
|
3423
|
+
* @description Number of payments processed
|
|
3424
|
+
* @example 25
|
|
3425
|
+
*/
|
|
3426
|
+
processed: number;
|
|
3427
|
+
/**
|
|
3428
|
+
* @description Number of successful responses
|
|
3429
|
+
* @example 20
|
|
3430
|
+
*/
|
|
3431
|
+
respSuccess: number;
|
|
3432
|
+
/**
|
|
3433
|
+
* @description Number of failed responses
|
|
3434
|
+
* @example 3
|
|
3435
|
+
*/
|
|
3436
|
+
failed: number;
|
|
3437
|
+
/**
|
|
3438
|
+
* @description Number of not found responses
|
|
3439
|
+
* @example 2
|
|
3440
|
+
*/
|
|
3441
|
+
notFound: number;
|
|
3442
|
+
/** @example Payment sync completed successfully */
|
|
3443
|
+
message: string;
|
|
3444
|
+
};
|
|
3445
|
+
PrimerSyncJobErrorResponseDto: {
|
|
3446
|
+
/** @example error */
|
|
3447
|
+
status: string;
|
|
3448
|
+
/** @example Failed to execute payment sync job */
|
|
3449
|
+
message: string;
|
|
3450
|
+
};
|
|
3451
|
+
PrimerEnqueueSyncResponseDto: {
|
|
3452
|
+
/** @example success */
|
|
3453
|
+
status: string;
|
|
3454
|
+
/** @example Jobs enqueued for Primer sync */
|
|
3455
|
+
message: string;
|
|
3456
|
+
};
|
|
3457
|
+
PrimerPaymentGetResponseDto: {
|
|
3458
|
+
/**
|
|
3459
|
+
* @description Array of payment data
|
|
3460
|
+
* @example [
|
|
3461
|
+
* {
|
|
3462
|
+
* "id": "pay_123",
|
|
3463
|
+
* "status": "SETTLED",
|
|
3464
|
+
* "amount": 100,
|
|
3465
|
+
* "currencyCode": "USD"
|
|
3466
|
+
* }
|
|
3467
|
+
* ]
|
|
3468
|
+
*/
|
|
3469
|
+
data: string[];
|
|
3470
|
+
/** @example eyJ...== */
|
|
3471
|
+
nextCursor: Record<string, never> | null;
|
|
3472
|
+
/** @example null */
|
|
3473
|
+
prevCursor: Record<string, never> | null;
|
|
3474
|
+
};
|
|
3475
|
+
PrimerCreatePaymentRequestBillingAddress: {
|
|
3476
|
+
/**
|
|
3477
|
+
* @description Country code (2-letter ISO code)
|
|
3478
|
+
* @example US
|
|
3479
|
+
*/
|
|
3480
|
+
countryCode: string;
|
|
3481
|
+
};
|
|
3482
|
+
PrimerCreatePaymentRequestCustomer: {
|
|
3483
|
+
/**
|
|
3484
|
+
* @description Customer email address
|
|
3485
|
+
* @example customer123@gmail.com
|
|
3486
|
+
*/
|
|
3487
|
+
emailAddress: string;
|
|
3488
|
+
billingAddress: components["schemas"]["PrimerCreatePaymentRequestBillingAddress"];
|
|
3489
|
+
};
|
|
3490
|
+
PrimerCreatePaymentRequestPaymentMethod: {
|
|
3491
|
+
/** @description Whether the payment method should be vaulted on a successful payment or not. */
|
|
3492
|
+
vaultOnSuccess?: boolean;
|
|
3493
|
+
/** @description Whether the payment method should be vaulted after a successful 3DS authentication or not. */
|
|
3494
|
+
vaultOn3Ds?: boolean;
|
|
3495
|
+
/** @description A description of the payment, as it would typically appear on a bank statement. */
|
|
3496
|
+
descriptor?: string;
|
|
3497
|
+
/** @enum {string} */
|
|
3498
|
+
paymentType: "FIRST_PAYMENT" | "ECOMMERCE" | "SUBSCRIPTION" | "UNSCHEDULED";
|
|
3499
|
+
/**
|
|
3500
|
+
* @description Allows to adjust the authorized amount after the authorization, if supported by payment method.
|
|
3501
|
+
* @enum {string}
|
|
3502
|
+
*/
|
|
3503
|
+
authorizationType?: "ESTIMATED" | "FINAL";
|
|
3504
|
+
};
|
|
3505
|
+
PrimerCreatePaymentRequestOrder: {
|
|
3506
|
+
/**
|
|
3507
|
+
* @description Country code (2-letter ISO code)
|
|
3508
|
+
* @example US
|
|
3509
|
+
*/
|
|
3510
|
+
countryCode: string;
|
|
3511
|
+
};
|
|
3512
|
+
PrimerCreatePaymentRequestDto: {
|
|
3513
|
+
/**
|
|
3514
|
+
* @description The payment method token used to authorize the payment. If not provided, we will search for a token by client.
|
|
3515
|
+
* @example oXxI7BvGTZWRBucAd92D-HwxNzU0NDAxNTUy
|
|
3516
|
+
*/
|
|
3517
|
+
paymentMethodToken?: string;
|
|
3518
|
+
/**
|
|
3519
|
+
* @description Your reference for the payment
|
|
3520
|
+
* @example 123456789
|
|
3521
|
+
*/
|
|
3522
|
+
orderId: string;
|
|
3523
|
+
/**
|
|
3524
|
+
* @description The customer ID for the payment
|
|
3525
|
+
* @example 67a8d72e-d8a4-4e98-8786-ee079c6c7d6f
|
|
3526
|
+
*/
|
|
3527
|
+
customerId: string;
|
|
3528
|
+
/**
|
|
3529
|
+
* @description The currency code for the payment
|
|
3530
|
+
* @example USD
|
|
3531
|
+
*/
|
|
3532
|
+
currencyCode: string;
|
|
3533
|
+
/**
|
|
3534
|
+
* @description The amount you would like to charge the customer, in minor units. e.g. for $7, use 700.
|
|
3535
|
+
* @example 1000
|
|
3536
|
+
*/
|
|
3537
|
+
amount: number;
|
|
3538
|
+
/**
|
|
3539
|
+
* @description Payment metadata (optional)
|
|
3540
|
+
* @example {
|
|
3541
|
+
* "productId": 123,
|
|
3542
|
+
* "merchantId": "a13bsd62s"
|
|
3543
|
+
* }
|
|
3544
|
+
*/
|
|
3545
|
+
metadata?: {
|
|
3546
|
+
[key: string]: unknown;
|
|
3547
|
+
};
|
|
3548
|
+
customer: components["schemas"]["PrimerCreatePaymentRequestCustomer"];
|
|
3549
|
+
paymentMethod: components["schemas"]["PrimerCreatePaymentRequestPaymentMethod"];
|
|
3550
|
+
order: components["schemas"]["PrimerCreatePaymentRequestOrder"];
|
|
3551
|
+
};
|
|
3552
|
+
PrimerPaymentSearchRequestDto: {
|
|
3553
|
+
/** @example 2025-08-01T00:00:00Z */
|
|
3554
|
+
from_date?: string;
|
|
3555
|
+
/** @example 2025-08-19T23:59:59Z */
|
|
3556
|
+
to_date?: string;
|
|
3557
|
+
/**
|
|
3558
|
+
* @description Payment status filter
|
|
3559
|
+
* @example SETTLED
|
|
3560
|
+
*/
|
|
3561
|
+
status?: string;
|
|
3562
|
+
/**
|
|
3563
|
+
* @description Last 4 digits of card number
|
|
3564
|
+
* @example 1234
|
|
3565
|
+
*/
|
|
3566
|
+
last_4_digits?: string;
|
|
3567
|
+
/**
|
|
3568
|
+
* @description Minimum amount in cents
|
|
3569
|
+
* @example 1000
|
|
3570
|
+
*/
|
|
3571
|
+
min_amount?: number;
|
|
3572
|
+
/**
|
|
3573
|
+
* @description Maximum amount in cents
|
|
3574
|
+
* @example 5000
|
|
3575
|
+
*/
|
|
3576
|
+
max_amount?: number;
|
|
3577
|
+
/**
|
|
3578
|
+
* @description Currency code filter
|
|
3579
|
+
* @example USD
|
|
3580
|
+
*/
|
|
3581
|
+
currency_code?: string;
|
|
3582
|
+
/**
|
|
3583
|
+
* @description 1..100 (default 100)
|
|
3584
|
+
* @example 10
|
|
3585
|
+
*/
|
|
3586
|
+
limit?: number;
|
|
3587
|
+
/**
|
|
3588
|
+
* @description ID of the customer that has made the payment
|
|
3589
|
+
* @example 123456789
|
|
3590
|
+
*/
|
|
3591
|
+
customer_id?: string;
|
|
3592
|
+
/**
|
|
3593
|
+
* @description Filter payments by their payment processor.
|
|
3594
|
+
* @example 123456789
|
|
3595
|
+
*/
|
|
3596
|
+
processor?: string;
|
|
3597
|
+
/**
|
|
3598
|
+
* @description Return payments related to this order ID.
|
|
3599
|
+
* @example 123456789
|
|
3600
|
+
*/
|
|
3601
|
+
order_id?: string;
|
|
3602
|
+
/**
|
|
3603
|
+
* @description ID of the merchant involved in the payment.
|
|
3604
|
+
* @example 123456789
|
|
3605
|
+
*/
|
|
3606
|
+
merchant_id?: string;
|
|
3607
|
+
};
|
|
3608
|
+
LineItemDto: {
|
|
3609
|
+
itemId?: string;
|
|
3610
|
+
description?: string;
|
|
3611
|
+
amount?: number;
|
|
3612
|
+
quantity?: number;
|
|
3613
|
+
};
|
|
3614
|
+
PrimerPaymentCreatePaymentRequestDto: {
|
|
3615
|
+
/** @example pm_token_123 */
|
|
3616
|
+
paymentMethodToken: string;
|
|
3617
|
+
/** @example 3000 */
|
|
3618
|
+
amount: number;
|
|
3619
|
+
/** @example GBP */
|
|
3620
|
+
currencyCode: string;
|
|
3621
|
+
/** @example order-123 */
|
|
3622
|
+
orderId: string;
|
|
3623
|
+
/** @example customer-123 */
|
|
3624
|
+
customerId?: string;
|
|
3625
|
+
customer?: components["schemas"]["CustomerDto"];
|
|
3626
|
+
paymentMethod?: components["schemas"]["PaymentMethodDto"];
|
|
3627
|
+
lineItems?: components["schemas"]["LineItemDto"][];
|
|
3628
|
+
metadata?: Record<string, never>;
|
|
3629
|
+
};
|
|
3630
|
+
PrimerPaymentCreateReferencePaymentRequestDto: {
|
|
3631
|
+
/** @example 3000 */
|
|
3632
|
+
amount: number;
|
|
3633
|
+
/** @example GBP */
|
|
3634
|
+
currencyCode: string;
|
|
3635
|
+
/** @example order-123 */
|
|
3636
|
+
orderId: string;
|
|
3637
|
+
customer?: components["schemas"]["CustomerDto"];
|
|
3638
|
+
lineItems?: components["schemas"]["LineItemDto"][];
|
|
3639
|
+
metadata?: Record<string, never>;
|
|
3640
|
+
/** @example pm_token_123 */
|
|
3641
|
+
paymentMethodToken?: string;
|
|
3642
|
+
/** @example customer-123 */
|
|
3643
|
+
customerId: string;
|
|
3644
|
+
/** @example true */
|
|
3645
|
+
manualCapture?: boolean;
|
|
3646
|
+
};
|
|
3647
|
+
PrimerPaymentCreateRecurringPaymentRequestDto: {
|
|
3648
|
+
/** @example 3000 */
|
|
3649
|
+
amount: number;
|
|
3650
|
+
/** @example GBP */
|
|
3651
|
+
currencyCode: string;
|
|
3652
|
+
/** @example order-123 */
|
|
3653
|
+
orderId: string;
|
|
3654
|
+
/** @example customer-123 */
|
|
3655
|
+
customerId?: string;
|
|
3656
|
+
customer?: components["schemas"]["CustomerDto"];
|
|
3657
|
+
lineItems?: components["schemas"]["LineItemDto"][];
|
|
3658
|
+
metadata?: Record<string, never>;
|
|
3659
|
+
/** @example pm_token_123 */
|
|
3660
|
+
paymentMethodToken?: string;
|
|
3661
|
+
/** @example true */
|
|
3662
|
+
manualCapture?: boolean;
|
|
3663
|
+
};
|
|
3664
|
+
PrimerPaymentCapturePaymentRequestDto: {
|
|
3665
|
+
/**
|
|
3666
|
+
* @description Amount to capture in minor units (e.g., cents). If not provided, captures the full authorized amount
|
|
3667
|
+
* @example 3000
|
|
3668
|
+
*/
|
|
3669
|
+
amount?: number;
|
|
3670
|
+
/**
|
|
3671
|
+
* @description Whether this is the final capture. If false, allows subsequent captures
|
|
3672
|
+
* @default true
|
|
3673
|
+
* @example true
|
|
3674
|
+
*/
|
|
3675
|
+
final: boolean;
|
|
3676
|
+
/**
|
|
3677
|
+
* @description Array of fields to expand in the response (e.g., transactions.events)
|
|
3678
|
+
* @example [
|
|
3679
|
+
* "transactions.events"
|
|
3680
|
+
* ]
|
|
3681
|
+
*/
|
|
3682
|
+
expand?: string[];
|
|
3683
|
+
};
|
|
3684
|
+
PrimerPaymentRefundPaymentRequestDto: {
|
|
3685
|
+
/**
|
|
3686
|
+
* @description Amount to refund in minor units (e.g., cents). If not provided, defaults to full refund amount
|
|
3687
|
+
* @example 3000
|
|
3688
|
+
*/
|
|
3689
|
+
amount?: number;
|
|
3690
|
+
/**
|
|
3691
|
+
* @description Transaction event ID to target a specific partial capture for refund
|
|
3692
|
+
* @example 57a2027d-36a6-494f-ad07-a6e1d0c77772
|
|
3693
|
+
*/
|
|
3694
|
+
transactionEventId?: string;
|
|
3695
|
+
/**
|
|
3696
|
+
* @description Optional reason for the refund
|
|
3697
|
+
* @example Customer returned item
|
|
3698
|
+
*/
|
|
3699
|
+
reason?: string;
|
|
3700
|
+
};
|
|
3701
|
+
PrimerPaymentCancelPaymentRequestDto: {
|
|
3702
|
+
/**
|
|
3703
|
+
* @description Optional reason for cancelling the payment
|
|
3704
|
+
* @example Customer cancelled order #1234.
|
|
3705
|
+
*/
|
|
3706
|
+
reason?: string;
|
|
3707
|
+
};
|
|
3708
|
+
PrimerPaymentsBulkActionResponseDto: {
|
|
3709
|
+
/** @example 10 */
|
|
3710
|
+
processed: number;
|
|
3711
|
+
/** @example 10 */
|
|
3712
|
+
errors: number;
|
|
3713
|
+
};
|
|
3714
|
+
DataPaymentSearchRequestDto: {
|
|
3715
|
+
/**
|
|
3716
|
+
* @description Page number
|
|
3717
|
+
* @default 1
|
|
3718
|
+
* @example 1
|
|
3719
|
+
*/
|
|
3720
|
+
page: string;
|
|
3721
|
+
/**
|
|
3722
|
+
* @description Number of items per page
|
|
3723
|
+
* @default 10
|
|
3724
|
+
* @example 10
|
|
3725
|
+
*/
|
|
3726
|
+
limit: string;
|
|
3727
|
+
/** @description Quick Search field */
|
|
3728
|
+
quickSearch?: string;
|
|
3729
|
+
/**
|
|
3730
|
+
* @description Search by external_id (primerId)
|
|
3731
|
+
* @example pay_123456789
|
|
3732
|
+
*/
|
|
3733
|
+
external_id?: string;
|
|
3734
|
+
/**
|
|
3735
|
+
* @description Search by email
|
|
3736
|
+
* @example
|
|
3737
|
+
*/
|
|
3738
|
+
email?: string;
|
|
3739
|
+
/** @example 2025-08-09T23:59:59Z */
|
|
3740
|
+
payment_date_start?: string;
|
|
3741
|
+
/** @example 2025-08-19T23:59:59Z */
|
|
3742
|
+
payment_date_end?: string;
|
|
3743
|
+
/**
|
|
3744
|
+
* @description Search by payment type
|
|
3745
|
+
* @example Initial
|
|
3746
|
+
*/
|
|
3747
|
+
payment_type?: string;
|
|
3748
|
+
/**
|
|
3749
|
+
* @description Search by refunded
|
|
3750
|
+
* @example false
|
|
3751
|
+
*/
|
|
3752
|
+
refunded?: string;
|
|
3753
|
+
};
|
|
3754
|
+
PrimerDataPaymentResponseDto: {
|
|
3755
|
+
/** @example 1 */
|
|
3756
|
+
id: number;
|
|
3757
|
+
/** @example pay_123456789 */
|
|
3758
|
+
external_id: string;
|
|
3759
|
+
/** @example SETTLED */
|
|
3760
|
+
status: Record<string, never> | null;
|
|
3761
|
+
/** @example 1000 */
|
|
3762
|
+
amount: Record<string, never> | null;
|
|
3763
|
+
/** @example USD */
|
|
3764
|
+
currency: Record<string, never> | null;
|
|
3765
|
+
/** @example 2024-01-01T00:00:00.000Z */
|
|
3766
|
+
payment_date: Record<string, never>;
|
|
3767
|
+
/** @example Initial */
|
|
3768
|
+
payment_type: Record<string, never> | null;
|
|
3769
|
+
/**
|
|
3770
|
+
* Format: date-time
|
|
3771
|
+
* @example 2024-01-01T00:00:00.000Z
|
|
3772
|
+
*/
|
|
3773
|
+
created_at: string;
|
|
3774
|
+
/**
|
|
3775
|
+
* Format: date-time
|
|
3776
|
+
* @example 2024-01-01T00:00:00.000Z
|
|
3777
|
+
*/
|
|
3778
|
+
updated_at: string;
|
|
3779
|
+
};
|
|
3780
|
+
DataPaymentsListResponseDto: {
|
|
3781
|
+
data: components["schemas"]["PrimerDataPaymentResponseDto"][];
|
|
3782
|
+
/** @example 1 */
|
|
3783
|
+
page: number;
|
|
3784
|
+
/** @example 10 */
|
|
3785
|
+
limit: number;
|
|
3786
|
+
/** @example 100 */
|
|
3787
|
+
total: number;
|
|
3788
|
+
/** @example 10 */
|
|
3789
|
+
total_pages: number;
|
|
3790
|
+
};
|
|
3791
|
+
DataTransactionResponseDto: {
|
|
3792
|
+
/** @example 1 */
|
|
3793
|
+
id: number;
|
|
3794
|
+
/** @example txn_123456789 */
|
|
3795
|
+
external_txn_id: string;
|
|
3796
|
+
/** @example 2024-01-01T00:00:00.000Z */
|
|
3797
|
+
transaction_date: Record<string, never>;
|
|
3798
|
+
/** @example 123 */
|
|
3799
|
+
payment_id: number;
|
|
3800
|
+
/** @example pay_123456789 */
|
|
3801
|
+
payment_external_id: string;
|
|
3802
|
+
/**
|
|
3803
|
+
* Format: date-time
|
|
3804
|
+
* @example 2024-01-01T00:00:00.000Z
|
|
3805
|
+
*/
|
|
3806
|
+
created_at: string;
|
|
3807
|
+
/**
|
|
3808
|
+
* Format: date-time
|
|
3809
|
+
* @example 2024-01-01T00:00:00.000Z
|
|
3810
|
+
*/
|
|
3811
|
+
updated_at: string;
|
|
3812
|
+
};
|
|
3813
|
+
DataTransactionsListResponseDto: {
|
|
3814
|
+
data: components["schemas"]["DataTransactionResponseDto"][];
|
|
3815
|
+
/** @example 1 */
|
|
3816
|
+
page: number;
|
|
3817
|
+
/** @example 10 */
|
|
3818
|
+
limit: number;
|
|
3819
|
+
/** @example 100 */
|
|
3820
|
+
total: number;
|
|
3821
|
+
/** @example 10 */
|
|
3822
|
+
total_pages: number;
|
|
3823
|
+
};
|
|
3824
|
+
DataRefundResponseDto: {
|
|
3825
|
+
/** @example 1 */
|
|
3826
|
+
id: number;
|
|
3827
|
+
/** @example ORD-123456 */
|
|
3828
|
+
order_id: string;
|
|
3829
|
+
/** @example ref_123456789 */
|
|
3830
|
+
external_id: string;
|
|
3831
|
+
/** @example 100.5 */
|
|
3832
|
+
amount: number;
|
|
3833
|
+
/** @example USD */
|
|
3834
|
+
currency: string;
|
|
3835
|
+
/** @example completed */
|
|
3836
|
+
status: string;
|
|
3837
|
+
/** @example Refund processed successfully */
|
|
3838
|
+
message: string | null;
|
|
3839
|
+
/**
|
|
3840
|
+
* Format: date-time
|
|
3841
|
+
* @example 2024-01-01T00:00:00.000Z
|
|
3842
|
+
*/
|
|
3843
|
+
created_at: string;
|
|
3844
|
+
};
|
|
3845
|
+
DataRefundsListResponseDto: {
|
|
3846
|
+
data: components["schemas"]["DataRefundResponseDto"][];
|
|
3847
|
+
/** @example 1 */
|
|
3848
|
+
page: number;
|
|
3849
|
+
/** @example 10 */
|
|
3850
|
+
limit: number;
|
|
3851
|
+
/** @example 100 */
|
|
3852
|
+
total: number;
|
|
3853
|
+
/** @example 10 */
|
|
3854
|
+
total_pages: number;
|
|
3855
|
+
};
|
|
3856
|
+
DataFallbackReportItemDto: {
|
|
3857
|
+
/** @example pay_123456789 */
|
|
3858
|
+
payment_id: string;
|
|
3859
|
+
/** @example 2024-01-15 */
|
|
3860
|
+
date: string;
|
|
3861
|
+
/** @example 1000 */
|
|
3862
|
+
amount: number;
|
|
3863
|
+
/** @example USD */
|
|
3864
|
+
currency: string;
|
|
3865
|
+
/** @example ADYEN */
|
|
3866
|
+
psp1_name: string;
|
|
3867
|
+
/** @example DECLINED */
|
|
3868
|
+
psp1_status: string;
|
|
3869
|
+
/** @example STRIPE */
|
|
3870
|
+
psp2_name?: string;
|
|
3871
|
+
/** @example SETTLED */
|
|
3872
|
+
psp2_status?: string;
|
|
3873
|
+
/** @example PAYPAL */
|
|
3874
|
+
psp3_name?: string;
|
|
3875
|
+
/** @example AUTHORIZED */
|
|
3876
|
+
psp3_status?: string;
|
|
3877
|
+
/** @example SQUARE */
|
|
3878
|
+
psp4_name?: string;
|
|
3879
|
+
/** @example FAILED */
|
|
3880
|
+
psp4_status?: string;
|
|
3881
|
+
/** @example BRAINTREE */
|
|
3882
|
+
psp5_name?: string;
|
|
3883
|
+
/** @example SETTLING */
|
|
3884
|
+
psp5_status?: string;
|
|
3885
|
+
};
|
|
3886
|
+
DataFallbackReportListResponseDto: {
|
|
3887
|
+
data: components["schemas"]["DataFallbackReportItemDto"][];
|
|
3888
|
+
};
|
|
3889
|
+
DataFallbackReportCsvResponseDto: {
|
|
3890
|
+
/**
|
|
3891
|
+
* Format: binary
|
|
3892
|
+
* @description CSV file content as binary data
|
|
3893
|
+
* @example Payment ID,Date,Amount,Currency,PSP 1,PSP 1 Status,PSP 2,PSP 2 Status
|
|
3894
|
+
* pay_123,2024-01-15,1000,USD,ADYEN,DECLINED,STRIPE,SETTLED
|
|
3895
|
+
*/
|
|
3896
|
+
data: string;
|
|
3897
|
+
};
|
|
3898
|
+
DataExportCsvSuccessResponseDto: {
|
|
3899
|
+
/** @example success */
|
|
3900
|
+
status: string;
|
|
3901
|
+
/** @example Payments exported successfully */
|
|
3902
|
+
message: string;
|
|
3903
|
+
};
|
|
3904
|
+
DataExportCsvErrorResponseDto: {
|
|
3905
|
+
/** @example error */
|
|
3906
|
+
status: string;
|
|
3907
|
+
/** @example Start date cannot be greater than end date */
|
|
3908
|
+
message: string;
|
|
3909
|
+
};
|
|
3910
|
+
PaymentSourcePaypalAttributesVault: {
|
|
3911
|
+
/** @description Vault ID */
|
|
3912
|
+
id: string;
|
|
3913
|
+
/** @description Vault status */
|
|
3914
|
+
status: string;
|
|
3915
|
+
};
|
|
3916
|
+
PaymentSourcePaypalAttributes: {
|
|
3917
|
+
/** @description Vault details */
|
|
3918
|
+
vault: components["schemas"]["PaymentSourcePaypalAttributesVault"];
|
|
3919
|
+
};
|
|
3920
|
+
PaymentSourcePaypal: {
|
|
3921
|
+
attributes: components["schemas"]["PaymentSourcePaypalAttributes"];
|
|
3922
|
+
};
|
|
3923
|
+
PaymentSource: {
|
|
3924
|
+
paypal: components["schemas"]["PaymentSourcePaypal"];
|
|
3925
|
+
};
|
|
3926
|
+
PaypalOrderDetailsResponseDto: {
|
|
3927
|
+
/** @description Order ID */
|
|
3928
|
+
id: string;
|
|
3929
|
+
/** @description Order intent */
|
|
3930
|
+
intent: string;
|
|
3931
|
+
/** @description Order status */
|
|
3932
|
+
status: string;
|
|
3933
|
+
payment_source: components["schemas"]["PaymentSource"];
|
|
3934
|
+
/**
|
|
3935
|
+
* @description The time the authorization was created (ISO 8601 format)
|
|
3936
|
+
* @example 2025-09-10T12:00:00Z
|
|
3937
|
+
*/
|
|
3938
|
+
create_time: string;
|
|
3939
|
+
};
|
|
3940
|
+
PaypalTransactionFetchRequestDto: {
|
|
3941
|
+
/**
|
|
3942
|
+
* @description Start date (ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ)
|
|
3943
|
+
* @example 2025-08-01T00:00:00Z
|
|
3944
|
+
*/
|
|
3945
|
+
startDate: string;
|
|
3946
|
+
/**
|
|
3947
|
+
* @description End date (ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ)
|
|
3948
|
+
* @example 2025-08-02T23:59:59Z
|
|
3949
|
+
*/
|
|
3950
|
+
endDate: string;
|
|
3951
|
+
/**
|
|
3952
|
+
* @description Optional transaction ID to filter by
|
|
3953
|
+
* @example 9GS80322P28628837
|
|
3954
|
+
*/
|
|
3955
|
+
transactionId?: string;
|
|
3956
|
+
/**
|
|
3957
|
+
* @description Indicates whether the response includes only balance-impacting transactions or all transactions
|
|
3958
|
+
* @enum {string}
|
|
3959
|
+
*/
|
|
3960
|
+
balanceAffectingRecordsOnly?: "Y" | "N";
|
|
3961
|
+
/**
|
|
3962
|
+
* @description Optional transaction status to filter by
|
|
3963
|
+
* @enum {string}
|
|
3964
|
+
*/
|
|
3965
|
+
transaction_status?: "D" | "P" | "S" | "V";
|
|
3966
|
+
/** @description Filters the transactions in the response by a PayPal transaction event code */
|
|
3967
|
+
transaction_type?: string;
|
|
3968
|
+
};
|
|
3969
|
+
PaypalPayerInfoDto: {
|
|
3970
|
+
/** @example Z5GXXXXWTTNPS */
|
|
3971
|
+
account_id: string;
|
|
3972
|
+
/** @example johdoe@example.com */
|
|
3973
|
+
email_address: string;
|
|
3974
|
+
/** @example {
|
|
3975
|
+
* "country_code": "1",
|
|
3976
|
+
* "national_number": "4089027107"
|
|
3977
|
+
* } */
|
|
3978
|
+
phone_number?: Record<string, never>;
|
|
3979
|
+
/** @example N */
|
|
3980
|
+
address_status?: string;
|
|
3981
|
+
/** @example Y */
|
|
3982
|
+
payer_status?: string;
|
|
3983
|
+
/** @example {
|
|
3984
|
+
* "given_name": "John",
|
|
3985
|
+
* "surname": "Doe",
|
|
3986
|
+
* "alternate_full_name": "John Doe"
|
|
3987
|
+
* } */
|
|
3988
|
+
payer_name?: Record<string, never>;
|
|
3989
|
+
/** @example US */
|
|
3990
|
+
country_code?: string;
|
|
3991
|
+
};
|
|
3992
|
+
PaypalTransactionRawResponseDto: {
|
|
3993
|
+
/** @example 9GS00022P28620007 */
|
|
3994
|
+
transaction_id?: string;
|
|
3995
|
+
/** @example COMPLETED */
|
|
3996
|
+
transaction_status?: string;
|
|
3997
|
+
/** @example {
|
|
3998
|
+
* "value": "50.00",
|
|
3999
|
+
* "currency_code": "USD"
|
|
4000
|
+
* } */
|
|
4001
|
+
transaction_amount?: Record<string, never>;
|
|
4002
|
+
payer_info: components["schemas"]["PaypalPayerInfoDto"];
|
|
4003
|
+
};
|
|
4004
|
+
PaypalTransactionFetchResponseDto: {
|
|
4005
|
+
/** @example success */
|
|
4006
|
+
status: string;
|
|
4007
|
+
/** @example Transactions fetched and stored successfully! */
|
|
4008
|
+
message: string;
|
|
4009
|
+
data: components["schemas"]["PaypalTransactionResponseDto"][] | null;
|
|
4010
|
+
};
|
|
4011
|
+
AuthorizationSearchQueryDto: {
|
|
4012
|
+
/**
|
|
4013
|
+
* @description Search by externalId
|
|
4014
|
+
* @example auth_001
|
|
4015
|
+
*/
|
|
4016
|
+
externalId?: string;
|
|
4017
|
+
/**
|
|
4018
|
+
* @description Search by expiresIn days
|
|
4019
|
+
* @example 15
|
|
4020
|
+
*/
|
|
4021
|
+
expiresIn?: string;
|
|
4022
|
+
/**
|
|
4023
|
+
* @description Search by status
|
|
4024
|
+
* @example success
|
|
4025
|
+
*/
|
|
4026
|
+
status?: string;
|
|
4027
|
+
/**
|
|
4028
|
+
* @description Page number
|
|
4029
|
+
* @example 1
|
|
4030
|
+
*/
|
|
4031
|
+
page?: number;
|
|
4032
|
+
/**
|
|
4033
|
+
* @description Items per page
|
|
4034
|
+
* @example 10
|
|
4035
|
+
*/
|
|
4036
|
+
limit?: number;
|
|
4037
|
+
/**
|
|
4038
|
+
* @description Sort by field
|
|
4039
|
+
* @example createdAt
|
|
4040
|
+
*/
|
|
4041
|
+
sortBy?: string;
|
|
4042
|
+
/**
|
|
4043
|
+
* @description Sort order
|
|
4044
|
+
* @example DESC
|
|
4045
|
+
*/
|
|
4046
|
+
sortOrder?: string;
|
|
4047
|
+
};
|
|
4048
|
+
PaypalCaptureV1AmountDto: {
|
|
4049
|
+
/**
|
|
4050
|
+
* @description Currency code in ISO 4217 format
|
|
4051
|
+
* @example USD
|
|
4052
|
+
*/
|
|
4053
|
+
currency_code: string;
|
|
4054
|
+
/**
|
|
4055
|
+
* @description Monetary value
|
|
4056
|
+
* @example 100.00
|
|
4057
|
+
*/
|
|
4058
|
+
value: string;
|
|
4059
|
+
};
|
|
4060
|
+
PaypalCaptureV1SellerProtectionDto: {
|
|
4061
|
+
/**
|
|
4062
|
+
* @description Seller protection status
|
|
4063
|
+
* @example ELIGIBLE
|
|
4064
|
+
*/
|
|
4065
|
+
status: string;
|
|
4066
|
+
/**
|
|
4067
|
+
* @description Categories of disputes covered under seller protection
|
|
4068
|
+
* @example [
|
|
4069
|
+
* "ITEM_NOT_RECEIVED",
|
|
4070
|
+
* "UNAUTHORIZED_TRANSACTION"
|
|
4071
|
+
* ]
|
|
4072
|
+
*/
|
|
4073
|
+
dispute_categories: string[];
|
|
4074
|
+
};
|
|
4075
|
+
PaypalCaptureV1SellerReceivableBreakdownDto: {
|
|
4076
|
+
/** @description Gross amount captured */
|
|
4077
|
+
gross_amount: components["schemas"]["PaypalCaptureV1AmountDto"];
|
|
4078
|
+
/** @description PayPal fee amount */
|
|
4079
|
+
paypal_fee: components["schemas"]["PaypalCaptureV1AmountDto"];
|
|
4080
|
+
/** @description Net amount after fees */
|
|
4081
|
+
net_amount: components["schemas"]["PaypalCaptureV1AmountDto"];
|
|
4082
|
+
};
|
|
4083
|
+
PaypalCaptureV1RelatedIdsDto: Record<string, never>;
|
|
4084
|
+
PaypalCaptureV1SupplementaryDataDto: {
|
|
4085
|
+
/** @description Related identifiers container */
|
|
4086
|
+
related_ids: components["schemas"]["PaypalCaptureV1RelatedIdsDto"];
|
|
4087
|
+
};
|
|
4088
|
+
PaypalCaptureV1PayeeDto: {
|
|
4089
|
+
/**
|
|
4090
|
+
* @description Payee email address
|
|
4091
|
+
* @example sb-pfbjo24475123@business.example.com
|
|
4092
|
+
*/
|
|
4093
|
+
email_address: string;
|
|
4094
|
+
/**
|
|
4095
|
+
* @description PayPal merchant identifier
|
|
4096
|
+
* @example D6P9S9DKA57WS
|
|
4097
|
+
*/
|
|
4098
|
+
merchant_id: string;
|
|
4099
|
+
};
|
|
4100
|
+
PaypalCaptureV1LinkDto: {
|
|
4101
|
+
/**
|
|
4102
|
+
* @description Target URL for the action
|
|
4103
|
+
* @example https://api.sandbox.paypal.com/v2/payments/captures/2E9198812M925880F
|
|
4104
|
+
*/
|
|
4105
|
+
href: string;
|
|
4106
|
+
/**
|
|
4107
|
+
* @description Relation of the link to the resource
|
|
4108
|
+
* @example self
|
|
4109
|
+
*/
|
|
4110
|
+
rel: string;
|
|
4111
|
+
/**
|
|
4112
|
+
* @description HTTP method to be used with the link
|
|
4113
|
+
* @example GET
|
|
4114
|
+
*/
|
|
4115
|
+
method: string;
|
|
4116
|
+
};
|
|
4117
|
+
PaypalCaptureV1ResponseDto: {
|
|
4118
|
+
/**
|
|
4119
|
+
* @description Capture identifier
|
|
4120
|
+
* @example 2E9198812M925880F
|
|
4121
|
+
*/
|
|
4122
|
+
id: string;
|
|
4123
|
+
/** @description Captured amount */
|
|
4124
|
+
amount: components["schemas"]["PaypalCaptureV1AmountDto"];
|
|
4125
|
+
/**
|
|
4126
|
+
* @description Whether this is the final capture for the authorization
|
|
4127
|
+
* @example true
|
|
4128
|
+
*/
|
|
4129
|
+
final_capture: boolean;
|
|
4130
|
+
/** @description Seller protection information */
|
|
4131
|
+
seller_protection: components["schemas"]["PaypalCaptureV1SellerProtectionDto"];
|
|
4132
|
+
/** @description Breakdown of the amounts receivable by the seller */
|
|
4133
|
+
seller_receivable_breakdown: components["schemas"]["PaypalCaptureV1SellerReceivableBreakdownDto"];
|
|
4134
|
+
/**
|
|
4135
|
+
* @description Invoice identifier associated with the capture
|
|
4136
|
+
* @example 2025-10-250813
|
|
4137
|
+
*/
|
|
4138
|
+
invoice_id?: string;
|
|
4139
|
+
/**
|
|
4140
|
+
* @description Capture status
|
|
4141
|
+
* @example COMPLETED
|
|
4142
|
+
*/
|
|
4143
|
+
status: string;
|
|
4144
|
+
/** @description Supplementary data, including related IDs */
|
|
4145
|
+
supplementary_data: components["schemas"]["PaypalCaptureV1SupplementaryDataDto"];
|
|
4146
|
+
/** @description Information about the payee */
|
|
4147
|
+
payee: components["schemas"]["PaypalCaptureV1PayeeDto"];
|
|
4148
|
+
/**
|
|
4149
|
+
* @description Creation time in RFC 3339 format
|
|
4150
|
+
* @example 2025-10-25T05:13:24Z
|
|
4151
|
+
*/
|
|
4152
|
+
create_time: string;
|
|
4153
|
+
/**
|
|
4154
|
+
* @description Last update time in RFC 3339 format
|
|
4155
|
+
* @example 2025-10-25T05:13:24Z
|
|
4156
|
+
*/
|
|
4157
|
+
update_time: string;
|
|
4158
|
+
/** @description HATEOAS links related to the capture */
|
|
4159
|
+
links: components["schemas"]["PaypalCaptureV1LinkDto"][];
|
|
4160
|
+
};
|
|
4161
|
+
PaypalCommonAmountDto: {
|
|
4162
|
+
/**
|
|
4163
|
+
* @description The currency code of the amount
|
|
4164
|
+
* @example USD
|
|
4165
|
+
*/
|
|
4166
|
+
currency_code: string;
|
|
4167
|
+
/**
|
|
4168
|
+
* @description The value of the amount
|
|
4169
|
+
* @example 100.00
|
|
4170
|
+
*/
|
|
4171
|
+
value: string;
|
|
4172
|
+
};
|
|
4173
|
+
PaypalCaptureV1RefundDto: {
|
|
4174
|
+
amount?: components["schemas"]["PaypalCommonAmountDto"];
|
|
4175
|
+
};
|
|
4176
|
+
PaypalCaptureV1RefundSellerPayableBreakdownDto: {
|
|
4177
|
+
/**
|
|
4178
|
+
* @description Gross amount of the original capture/payment.
|
|
4179
|
+
* @example {
|
|
4180
|
+
* "currency_code": "USD",
|
|
4181
|
+
* "value": "100.00"
|
|
4182
|
+
* }
|
|
4183
|
+
*/
|
|
4184
|
+
gross_amount: components["schemas"]["PaypalCommonAmountDto"];
|
|
4185
|
+
/**
|
|
4186
|
+
* @description PayPal processing fee for the original transaction.
|
|
4187
|
+
* @example {
|
|
4188
|
+
* "currency_code": "USD",
|
|
4189
|
+
* "value": "3.49"
|
|
4190
|
+
* }
|
|
4191
|
+
*/
|
|
4192
|
+
paypal_fee: components["schemas"]["PaypalCommonAmountDto"];
|
|
4193
|
+
/**
|
|
4194
|
+
* @description Net amount credited to the seller after fees.
|
|
4195
|
+
* @example {
|
|
4196
|
+
* "currency_code": "USD",
|
|
4197
|
+
* "value": "96.51"
|
|
4198
|
+
* }
|
|
4199
|
+
*/
|
|
4200
|
+
net_amount: components["schemas"]["PaypalCommonAmountDto"];
|
|
4201
|
+
/**
|
|
4202
|
+
* @description Total amount refunded so far for the related capture/payment.
|
|
4203
|
+
* @example {
|
|
4204
|
+
* "currency_code": "USD",
|
|
4205
|
+
* "value": "100.00"
|
|
4206
|
+
* }
|
|
4207
|
+
*/
|
|
4208
|
+
total_refunded_amount: components["schemas"]["PaypalCommonAmountDto"];
|
|
4209
|
+
};
|
|
4210
|
+
PaypalCaptureV1RefundLinkDto: {
|
|
4211
|
+
/**
|
|
4212
|
+
* @description Target URL for the related action.
|
|
4213
|
+
* @example https://api.sandbox.paypal.com/v2/payments/refunds/7YS455436N518410M
|
|
4214
|
+
*/
|
|
4215
|
+
href: string;
|
|
4216
|
+
/**
|
|
4217
|
+
* @description The relation of the link to the resource.
|
|
4218
|
+
* @example self
|
|
4219
|
+
*/
|
|
4220
|
+
rel: string;
|
|
4221
|
+
/**
|
|
4222
|
+
* @description HTTP method to be used with the link.
|
|
4223
|
+
* @example GET
|
|
4224
|
+
*/
|
|
4225
|
+
method: string;
|
|
4226
|
+
};
|
|
4227
|
+
PaypalCaptureV1RefundResponseDto: {
|
|
4228
|
+
/**
|
|
4229
|
+
* @description Refund identifier.
|
|
4230
|
+
* @example 7YS455436N518410M
|
|
4231
|
+
*/
|
|
4232
|
+
id: string;
|
|
4233
|
+
/**
|
|
4234
|
+
* @description Refunded amount.
|
|
4235
|
+
* @example {
|
|
4236
|
+
* "currency_code": "USD",
|
|
4237
|
+
* "value": "100.00"
|
|
4238
|
+
* }
|
|
4239
|
+
*/
|
|
4240
|
+
amount: components["schemas"]["PaypalCommonAmountDto"];
|
|
4241
|
+
/** @description Breakdown of seller payable amounts for the original transaction and refunds. */
|
|
4242
|
+
seller_payable_breakdown: components["schemas"]["PaypalCaptureV1RefundSellerPayableBreakdownDto"];
|
|
4243
|
+
/**
|
|
4244
|
+
* @description Invoice identifier associated with the refund.
|
|
4245
|
+
* @example 2025-10-250813
|
|
4246
|
+
*/
|
|
4247
|
+
invoice_id?: string;
|
|
4248
|
+
/**
|
|
4249
|
+
* @description Refund status.
|
|
4250
|
+
* @example COMPLETED
|
|
4251
|
+
*/
|
|
4252
|
+
status: string;
|
|
4253
|
+
/**
|
|
4254
|
+
* @description Creation time in RFC 3339 format.
|
|
4255
|
+
* @example 2025-10-24T22:29:57-07:00
|
|
4256
|
+
*/
|
|
4257
|
+
create_time: string;
|
|
4258
|
+
/**
|
|
4259
|
+
* @description Last update time in RFC 3339 format.
|
|
4260
|
+
* @example 2025-10-24T22:29:57-07:00
|
|
4261
|
+
*/
|
|
4262
|
+
update_time: string;
|
|
4263
|
+
/**
|
|
4264
|
+
* @description HATEOAS links related to the refund.
|
|
4265
|
+
* @example [
|
|
4266
|
+
* {
|
|
4267
|
+
* "href": "https://api.sandbox.paypal.com/v2/payments/refunds/7YS455436N518410M",
|
|
4268
|
+
* "rel": "self",
|
|
4269
|
+
* "method": "GET"
|
|
4270
|
+
* },
|
|
4271
|
+
* {
|
|
4272
|
+
* "href": "https://api.sandbox.paypal.com/v2/payments/captures/2E9198812M925880F",
|
|
4273
|
+
* "rel": "up",
|
|
4274
|
+
* "method": "GET"
|
|
4275
|
+
* }
|
|
4276
|
+
* ]
|
|
4277
|
+
*/
|
|
4278
|
+
links: components["schemas"]["PaypalCaptureV1RefundLinkDto"][];
|
|
4279
|
+
};
|
|
4280
|
+
PaypalAuthorizationV1AmountDto: {
|
|
4281
|
+
/**
|
|
4282
|
+
* @description Currency code in ISO 4217 format
|
|
4283
|
+
* @example USD
|
|
4284
|
+
*/
|
|
4285
|
+
currency_code: string;
|
|
4286
|
+
/**
|
|
4287
|
+
* @description Monetary value
|
|
4288
|
+
* @example 100.00
|
|
4289
|
+
*/
|
|
4290
|
+
value: string;
|
|
4291
|
+
};
|
|
4292
|
+
PaypalAuthorizationV1SellerProtectionDto: {
|
|
4293
|
+
/**
|
|
4294
|
+
* @description Seller protection status
|
|
4295
|
+
* @example ELIGIBLE
|
|
4296
|
+
*/
|
|
4297
|
+
status: string;
|
|
4298
|
+
/**
|
|
4299
|
+
* @description Categories of disputes covered under seller protection
|
|
4300
|
+
* @example [
|
|
4301
|
+
* "ITEM_NOT_RECEIVED",
|
|
4302
|
+
* "UNAUTHORIZED_TRANSACTION"
|
|
4303
|
+
* ]
|
|
4304
|
+
*/
|
|
4305
|
+
dispute_categories: string[];
|
|
4306
|
+
};
|
|
4307
|
+
PaypalAuthorizationV1RelatedIdsDto: Record<string, never>;
|
|
4308
|
+
PaypalAuthorizationV1SupplementaryDataDto: {
|
|
4309
|
+
/** @description Related identifiers container */
|
|
4310
|
+
related_ids: components["schemas"]["PaypalAuthorizationV1RelatedIdsDto"];
|
|
4311
|
+
};
|
|
4312
|
+
PaypalAuthorizationV1PayeeDto: {
|
|
4313
|
+
/**
|
|
4314
|
+
* @description Payee email address
|
|
4315
|
+
* @example sb-pfbjo24475123@business.example.com
|
|
4316
|
+
*/
|
|
4317
|
+
email_address: string;
|
|
4318
|
+
/**
|
|
4319
|
+
* @description PayPal merchant identifier
|
|
4320
|
+
* @example D6P9S9DKA57WS
|
|
4321
|
+
*/
|
|
4322
|
+
merchant_id: string;
|
|
4323
|
+
};
|
|
4324
|
+
PaypalAuthorizationV1LinkDto: {
|
|
4325
|
+
/**
|
|
4326
|
+
* @description Target URL for the action
|
|
4327
|
+
* @example https://api.sandbox.paypal.com/v2/payments/authorizations/77548477XT579335T
|
|
4328
|
+
*/
|
|
4329
|
+
href: string;
|
|
4330
|
+
/**
|
|
4331
|
+
* @description Relation of the link to the resource
|
|
4332
|
+
* @example self
|
|
4333
|
+
*/
|
|
4334
|
+
rel: string;
|
|
4335
|
+
/**
|
|
4336
|
+
* @description HTTP method to be used with the link
|
|
4337
|
+
* @example GET
|
|
4338
|
+
*/
|
|
4339
|
+
method: string;
|
|
4340
|
+
};
|
|
4341
|
+
PaypalAuthorizationV1ResponseDto: {
|
|
4342
|
+
/**
|
|
4343
|
+
* @description Authorization identifier
|
|
4344
|
+
* @example 77548477XT579335T
|
|
4345
|
+
*/
|
|
4346
|
+
id: string;
|
|
4347
|
+
/**
|
|
4348
|
+
* @description Authorization status
|
|
4349
|
+
* @example CREATED
|
|
4350
|
+
*/
|
|
4351
|
+
status: string;
|
|
4352
|
+
/** @description Authorized amount */
|
|
4353
|
+
amount: components["schemas"]["PaypalAuthorizationV1AmountDto"];
|
|
4354
|
+
/**
|
|
4355
|
+
* @description Invoice identifier associated with the authorization
|
|
4356
|
+
* @example 2025-10-250814
|
|
4357
|
+
*/
|
|
4358
|
+
invoice_id?: string;
|
|
4359
|
+
/** @description Seller protection information */
|
|
4360
|
+
seller_protection: components["schemas"]["PaypalAuthorizationV1SellerProtectionDto"];
|
|
4361
|
+
/** @description Supplementary data, including related IDs */
|
|
4362
|
+
supplementary_data: components["schemas"]["PaypalAuthorizationV1SupplementaryDataDto"];
|
|
4363
|
+
/** @description Information about the payee */
|
|
4364
|
+
payee: components["schemas"]["PaypalAuthorizationV1PayeeDto"];
|
|
4365
|
+
/**
|
|
4366
|
+
* @description Authorization expiration time in RFC 3339 format
|
|
4367
|
+
* @example 2025-11-23T05:14:16Z
|
|
4368
|
+
*/
|
|
4369
|
+
expiration_time: string;
|
|
4370
|
+
/**
|
|
4371
|
+
* @description Creation time in RFC 3339 format
|
|
4372
|
+
* @example 2025-10-25T05:14:16Z
|
|
4373
|
+
*/
|
|
4374
|
+
create_time: string;
|
|
4375
|
+
/**
|
|
4376
|
+
* @description Last update time in RFC 3339 format
|
|
4377
|
+
* @example 2025-10-25T05:14:16Z
|
|
4378
|
+
*/
|
|
4379
|
+
update_time: string;
|
|
4380
|
+
/** @description HATEOAS links related to the authorization */
|
|
4381
|
+
links: components["schemas"]["PaypalAuthorizationV1LinkDto"][];
|
|
4382
|
+
};
|
|
4383
|
+
PaypalAuthorizationV1VoidAmountDto: {
|
|
4384
|
+
/**
|
|
4385
|
+
* @description Currency code in ISO 4217 format
|
|
4386
|
+
* @example USD
|
|
4387
|
+
*/
|
|
4388
|
+
currency_code: string;
|
|
4389
|
+
/**
|
|
4390
|
+
* @description Monetary value
|
|
4391
|
+
* @example 100.00
|
|
4392
|
+
*/
|
|
4393
|
+
value: string;
|
|
4394
|
+
};
|
|
4395
|
+
PaypalAuthorizationV1VoidSellerProtectionDto: {
|
|
4396
|
+
/**
|
|
4397
|
+
* @description Seller protection status
|
|
4398
|
+
* @example ELIGIBLE
|
|
4399
|
+
*/
|
|
4400
|
+
status: string;
|
|
4401
|
+
/**
|
|
4402
|
+
* @description Categories of disputes covered under seller protection
|
|
4403
|
+
* @example [
|
|
4404
|
+
* "ITEM_NOT_RECEIVED",
|
|
4405
|
+
* "UNAUTHORIZED_TRANSACTION"
|
|
4406
|
+
* ]
|
|
4407
|
+
*/
|
|
4408
|
+
dispute_categories: string[];
|
|
4409
|
+
};
|
|
4410
|
+
PaypalAuthorizationV1VoidLinkDto: {
|
|
4411
|
+
/**
|
|
4412
|
+
* @description Target URL for the action
|
|
4413
|
+
* @example https://api.sandbox.paypal.com/v2/payments/authorizations/77548477XT579335T
|
|
4414
|
+
*/
|
|
4415
|
+
href: string;
|
|
4416
|
+
/**
|
|
4417
|
+
* @description Relation of the link to the resource
|
|
4418
|
+
* @example self
|
|
4419
|
+
*/
|
|
4420
|
+
rel: string;
|
|
4421
|
+
/**
|
|
4422
|
+
* @description HTTP method to be used with the link
|
|
4423
|
+
* @example GET
|
|
4424
|
+
*/
|
|
4425
|
+
method: string;
|
|
4426
|
+
};
|
|
4427
|
+
PaypalAuthorizationV1VoidResponseDto: {
|
|
4428
|
+
/**
|
|
4429
|
+
* @description Authorization identifier
|
|
4430
|
+
* @example 77548477XT579335T
|
|
4431
|
+
*/
|
|
4432
|
+
id: string;
|
|
4433
|
+
/**
|
|
4434
|
+
* @description Authorization status
|
|
4435
|
+
* @example VOIDED
|
|
4436
|
+
*/
|
|
4437
|
+
status: string;
|
|
4438
|
+
/** @description Authorized amount */
|
|
4439
|
+
amount: components["schemas"]["PaypalAuthorizationV1VoidAmountDto"];
|
|
4440
|
+
/**
|
|
4441
|
+
* @description Invoice identifier associated with the authorization
|
|
4442
|
+
* @example 2025-10-250814
|
|
4443
|
+
*/
|
|
4444
|
+
invoice_id?: string;
|
|
4445
|
+
/** @description Seller protection information */
|
|
4446
|
+
seller_protection: components["schemas"]["PaypalAuthorizationV1VoidSellerProtectionDto"];
|
|
4447
|
+
/**
|
|
4448
|
+
* @description Authorization expiration time in RFC 3339 format
|
|
4449
|
+
* @example 2025-11-22T21:14:16-08:00
|
|
4450
|
+
*/
|
|
4451
|
+
expiration_time: string;
|
|
4452
|
+
/**
|
|
4453
|
+
* @description Creation time in RFC 3339 format
|
|
4454
|
+
* @example 2025-10-24T22:14:16-07:00
|
|
4455
|
+
*/
|
|
4456
|
+
create_time: string;
|
|
4457
|
+
/**
|
|
4458
|
+
* @description Last update time in RFC 3339 format
|
|
4459
|
+
* @example 2025-10-24T23:03:03-07:00
|
|
4460
|
+
*/
|
|
4461
|
+
update_time: string;
|
|
4462
|
+
/** @description HATEOAS links related to the authorization */
|
|
4463
|
+
links: components["schemas"]["PaypalAuthorizationV1VoidLinkDto"][];
|
|
4464
|
+
};
|
|
4465
|
+
PaypalAuthorizationV1CaptureDto: {
|
|
4466
|
+
amount?: components["schemas"]["PaypalCommonAmountDto"];
|
|
4467
|
+
/**
|
|
4468
|
+
* @description Whether this is the final capture
|
|
4469
|
+
* @example false
|
|
4470
|
+
*/
|
|
4471
|
+
final_capture?: boolean;
|
|
4472
|
+
};
|
|
4473
|
+
PaypalAuthorizationV1CaptureAmountDto: {
|
|
4474
|
+
/**
|
|
4475
|
+
* @description Currency code in ISO 4217 format
|
|
4476
|
+
* @example USD
|
|
4477
|
+
*/
|
|
4478
|
+
currency_code: string;
|
|
4479
|
+
/**
|
|
4480
|
+
* @description Monetary value
|
|
4481
|
+
* @example 100.00
|
|
4482
|
+
*/
|
|
4483
|
+
value: string;
|
|
4484
|
+
};
|
|
4485
|
+
PaypalAuthorizationV1CaptureSellerProtectionDto: {
|
|
4486
|
+
/**
|
|
4487
|
+
* @description Seller protection status
|
|
4488
|
+
* @example ELIGIBLE
|
|
4489
|
+
*/
|
|
4490
|
+
status: string;
|
|
4491
|
+
/**
|
|
4492
|
+
* @description Categories of disputes covered under seller protection
|
|
4493
|
+
* @example [
|
|
4494
|
+
* "ITEM_NOT_RECEIVED",
|
|
4495
|
+
* "UNAUTHORIZED_TRANSACTION"
|
|
4496
|
+
* ]
|
|
4497
|
+
*/
|
|
4498
|
+
dispute_categories: string[];
|
|
4499
|
+
};
|
|
4500
|
+
PaypalAuthorizationV1CaptureExchangeRateDto: Record<string, never>;
|
|
4501
|
+
PaypalAuthorizationV1CaptureSellerReceivableBreakdownDto: {
|
|
4502
|
+
/** @description Gross amount captured */
|
|
4503
|
+
gross_amount: components["schemas"]["PaypalAuthorizationV1CaptureAmountDto"];
|
|
4504
|
+
/** @description PayPal fee amount */
|
|
4505
|
+
paypal_fee: components["schemas"]["PaypalAuthorizationV1CaptureAmountDto"];
|
|
4506
|
+
/** @description Net amount after fees */
|
|
4507
|
+
net_amount: components["schemas"]["PaypalAuthorizationV1CaptureAmountDto"];
|
|
4508
|
+
/** @description Exchange rate details, present when currency conversion applies */
|
|
4509
|
+
exchange_rate: components["schemas"]["PaypalAuthorizationV1CaptureExchangeRateDto"];
|
|
4510
|
+
};
|
|
4511
|
+
PaypalAuthorizationV1CaptureLinkDto: {
|
|
4512
|
+
/**
|
|
4513
|
+
* @description Target URL for the action
|
|
4514
|
+
* @example https://api.sandbox.paypal.com/v2/payments/captures/0GR841716N089840Y
|
|
4515
|
+
*/
|
|
4516
|
+
href: string;
|
|
4517
|
+
/**
|
|
4518
|
+
* @description Relation of the link to the resource
|
|
4519
|
+
* @example self
|
|
4520
|
+
*/
|
|
4521
|
+
rel: string;
|
|
4522
|
+
/**
|
|
4523
|
+
* @description HTTP method to be used with the link
|
|
4524
|
+
* @example GET
|
|
4525
|
+
*/
|
|
4526
|
+
method: string;
|
|
4527
|
+
};
|
|
4528
|
+
PaypalAuthorizationV1CaptureResponseDto: {
|
|
4529
|
+
/**
|
|
4530
|
+
* @description Capture identifier
|
|
4531
|
+
* @example 0GR841716N089840Y
|
|
4532
|
+
*/
|
|
4533
|
+
id: string;
|
|
4534
|
+
/** @description Captured amount */
|
|
4535
|
+
amount: components["schemas"]["PaypalAuthorizationV1CaptureAmountDto"];
|
|
4536
|
+
/**
|
|
4537
|
+
* @description Whether this is the final capture for the authorization
|
|
4538
|
+
* @example true
|
|
4539
|
+
*/
|
|
4540
|
+
final_capture: boolean;
|
|
4541
|
+
/** @description Seller protection information */
|
|
4542
|
+
seller_protection: components["schemas"]["PaypalAuthorizationV1CaptureSellerProtectionDto"];
|
|
4543
|
+
/** @description Breakdown of the amounts receivable by the seller */
|
|
4544
|
+
seller_receivable_breakdown: components["schemas"]["PaypalAuthorizationV1CaptureSellerReceivableBreakdownDto"];
|
|
4545
|
+
/**
|
|
4546
|
+
* @description Invoice identifier associated with the capture
|
|
4547
|
+
* @example 2025-10-15-09-08
|
|
4548
|
+
*/
|
|
4549
|
+
invoice_id?: string;
|
|
4550
|
+
/**
|
|
4551
|
+
* @description Capture status
|
|
4552
|
+
* @example COMPLETED
|
|
4553
|
+
*/
|
|
4554
|
+
status: string;
|
|
4555
|
+
/**
|
|
4556
|
+
* @description Creation time in RFC 3339 format
|
|
4557
|
+
* @example 2025-10-25T06:11:19Z
|
|
4558
|
+
*/
|
|
4559
|
+
create_time: string;
|
|
4560
|
+
/**
|
|
4561
|
+
* @description Last update time in RFC 3339 format
|
|
4562
|
+
* @example 2025-10-25T06:11:19Z
|
|
4563
|
+
*/
|
|
4564
|
+
update_time: string;
|
|
4565
|
+
/**
|
|
4566
|
+
* @description HATEOAS links related to the capture
|
|
4567
|
+
* @example [
|
|
4568
|
+
* {
|
|
4569
|
+
* "href": "https://api.sandbox.paypal.com/v2/payments/captures/0GR841716N089840Y",
|
|
4570
|
+
* "rel": "self",
|
|
4571
|
+
* "method": "GET"
|
|
4572
|
+
* },
|
|
4573
|
+
* {
|
|
4574
|
+
* "href": "https://api.sandbox.paypal.com/v2/payments/captures/0GR841716N089840Y/refund",
|
|
4575
|
+
* "rel": "refund",
|
|
4576
|
+
* "method": "POST"
|
|
4577
|
+
* },
|
|
4578
|
+
* {
|
|
4579
|
+
* "href": "https://api.sandbox.paypal.com/v2/payments/authorizations/160816582U576121J",
|
|
4580
|
+
* "rel": "up",
|
|
4581
|
+
* "method": "GET"
|
|
4582
|
+
* }
|
|
4583
|
+
* ]
|
|
4584
|
+
*/
|
|
4585
|
+
links: components["schemas"]["PaypalAuthorizationV1CaptureLinkDto"][];
|
|
4586
|
+
};
|
|
4587
|
+
DisputesListResponseDto: {
|
|
4588
|
+
items: components["schemas"]["DisputeResponseDto"][];
|
|
4589
|
+
/** @example 1 */
|
|
4590
|
+
page: number;
|
|
4591
|
+
/** @example 20 */
|
|
4592
|
+
page_size: number;
|
|
4593
|
+
/** @example 50 */
|
|
4594
|
+
total_items: number;
|
|
4595
|
+
/** @example 3 */
|
|
4596
|
+
total_pages: number;
|
|
4597
|
+
};
|
|
4598
|
+
PaypalAuthorizationInfoResponseAmount: {
|
|
4599
|
+
/**
|
|
4600
|
+
* @description Currency code in ISO 4217 format
|
|
4601
|
+
* @example USD
|
|
4602
|
+
*/
|
|
4603
|
+
currency_code: string;
|
|
4604
|
+
/**
|
|
4605
|
+
* @description Authorized amount value
|
|
4606
|
+
* @example 50.00
|
|
4607
|
+
*/
|
|
4608
|
+
value: string;
|
|
4609
|
+
};
|
|
4610
|
+
PaypalAuthorizationInfoResponseDto: {
|
|
4611
|
+
/**
|
|
4612
|
+
* @description The PayPal authorization ID
|
|
4613
|
+
* @example AUTH-1234567890
|
|
4614
|
+
*/
|
|
4615
|
+
id: string;
|
|
4616
|
+
/**
|
|
4617
|
+
* @description Current status of the authorization (e.g., CREATED, VOIDED, REAUTHORIZED)
|
|
4618
|
+
* @example CREATED
|
|
4619
|
+
*/
|
|
4620
|
+
status: string;
|
|
4621
|
+
amount: components["schemas"]["PaypalAuthorizationInfoResponseAmount"];
|
|
4622
|
+
/**
|
|
4623
|
+
* @description Invoice ID associated with the authorization
|
|
4624
|
+
* @example 1234567890
|
|
4625
|
+
*/
|
|
4626
|
+
invoice_id?: string;
|
|
4627
|
+
/**
|
|
4628
|
+
* @description Invoice ID associated with the authorization
|
|
4629
|
+
* @example 1234567890
|
|
4630
|
+
*/
|
|
4631
|
+
custom_id?: string;
|
|
4632
|
+
/**
|
|
4633
|
+
* @description The time the authorization was created (ISO 8601 format)
|
|
4634
|
+
* @example 2025-09-10T12:00:00Z
|
|
4635
|
+
*/
|
|
4636
|
+
create_time: string;
|
|
4637
|
+
/**
|
|
4638
|
+
* @description The time the authorization will expire (ISO 8601 format)
|
|
4639
|
+
* @example 2025-09-15T12:00:00Z
|
|
4640
|
+
*/
|
|
4641
|
+
expiration_time: string;
|
|
4642
|
+
};
|
|
4643
|
+
PaypalMoneyDto: {
|
|
4644
|
+
currency_code: string;
|
|
4645
|
+
value: string;
|
|
4646
|
+
};
|
|
4647
|
+
PaypalSellerPayableBreakdownDto: {
|
|
4648
|
+
gross_amount: components["schemas"]["PaypalMoneyDto"];
|
|
4649
|
+
paypal_fee: components["schemas"]["PaypalMoneyDto"];
|
|
4650
|
+
net_amount: components["schemas"]["PaypalMoneyDto"];
|
|
4651
|
+
total_refunded_amount: components["schemas"]["PaypalMoneyDto"];
|
|
4652
|
+
};
|
|
4653
|
+
PaypalRefundPayerDto: {
|
|
4654
|
+
email_address: string;
|
|
4655
|
+
merchant_id: string;
|
|
4656
|
+
};
|
|
4657
|
+
PaypalLinkDto: {
|
|
4658
|
+
href: string;
|
|
4659
|
+
rel: string;
|
|
4660
|
+
method: string;
|
|
4661
|
+
};
|
|
4662
|
+
PaypalRefundV1ResponseDto: {
|
|
4663
|
+
id: string;
|
|
4664
|
+
amount: components["schemas"]["PaypalMoneyDto"];
|
|
4665
|
+
seller_payable_breakdown: components["schemas"]["PaypalSellerPayableBreakdownDto"];
|
|
4666
|
+
invoice_id: string;
|
|
4667
|
+
status: string;
|
|
4668
|
+
/** @description RFC3339 timestamp */
|
|
4669
|
+
create_time: string;
|
|
4670
|
+
/** @description RFC3339 timestamp */
|
|
4671
|
+
update_time: string;
|
|
4672
|
+
payer: components["schemas"]["PaypalRefundPayerDto"];
|
|
4673
|
+
links: components["schemas"]["PaypalLinkDto"][];
|
|
4674
|
+
};
|
|
4675
|
+
PaypalPaymentCaptureRequestDto: {
|
|
4676
|
+
/**
|
|
4677
|
+
* @description Amount to capture (if different from authorized amount)
|
|
4678
|
+
* @example {
|
|
4679
|
+
* "value": "1.00",
|
|
4680
|
+
* "currency_code": "USD"
|
|
4681
|
+
* }
|
|
4682
|
+
*/
|
|
4683
|
+
amount?: Record<string, never>;
|
|
4684
|
+
/**
|
|
4685
|
+
* @description Invoice ID for tracking purposes
|
|
4686
|
+
* @example CaptureInvoice-10142024
|
|
4687
|
+
*/
|
|
4688
|
+
invoice_id?: string;
|
|
4689
|
+
/**
|
|
4690
|
+
* @description Whether this is the final capture
|
|
4691
|
+
* @default false
|
|
4692
|
+
* @example false
|
|
4693
|
+
*/
|
|
4694
|
+
final_capture: boolean;
|
|
4695
|
+
};
|
|
4696
|
+
PaypalCapturedPaymentRealatedIds: {
|
|
4697
|
+
/** @description Order ID, when captured by order */
|
|
4698
|
+
order_id?: string;
|
|
4699
|
+
/** @description Authorization ID, when captured by payment authorization */
|
|
4700
|
+
authorization_id?: string;
|
|
4701
|
+
};
|
|
4702
|
+
PaypalCapturedPaymentSupplementaryData: {
|
|
4703
|
+
/** @description Related IDs */
|
|
4704
|
+
related_ids: components["schemas"]["PaypalCapturedPaymentRealatedIds"];
|
|
4705
|
+
};
|
|
4706
|
+
PaypalCapturedPaymentAmount: {
|
|
4707
|
+
/**
|
|
4708
|
+
* @description Currency code in ISO 4217 format
|
|
4709
|
+
* @example USD
|
|
4710
|
+
*/
|
|
4711
|
+
currency_code: string;
|
|
4712
|
+
/**
|
|
4713
|
+
* @description Authorized amount value
|
|
4714
|
+
* @example 50.00
|
|
4715
|
+
*/
|
|
4716
|
+
value: string;
|
|
4717
|
+
};
|
|
4718
|
+
PaypalCapturedPaymentResponseDto: {
|
|
4719
|
+
id: string;
|
|
4720
|
+
/** @description Order ID */
|
|
4721
|
+
custom_id?: string;
|
|
4722
|
+
/** @description Order ID */
|
|
4723
|
+
invoice_id?: string;
|
|
4724
|
+
/** @description Status */
|
|
4725
|
+
status: string;
|
|
4726
|
+
/** @description Related IDs */
|
|
4727
|
+
supplementary_data: components["schemas"]["PaypalCapturedPaymentSupplementaryData"];
|
|
4728
|
+
/** @description Amount */
|
|
4729
|
+
amount: components["schemas"]["PaypalCapturedPaymentAmount"];
|
|
4730
|
+
};
|
|
4731
|
+
PaypalPaymentSaleResponseDto: {
|
|
4732
|
+
/** @description Capture ID */
|
|
4733
|
+
id: string;
|
|
4734
|
+
/** @description Payment state */
|
|
4735
|
+
state: string;
|
|
4736
|
+
/** @description Invoice number */
|
|
4737
|
+
invoice_number: string;
|
|
4738
|
+
/** @description Billing Agreement ID */
|
|
4739
|
+
billing_agreement_id: string;
|
|
4740
|
+
};
|
|
4741
|
+
PaypalActionLogResponseDto: {
|
|
4742
|
+
/**
|
|
4743
|
+
* @description The ID of the action log.
|
|
4744
|
+
* @example 1
|
|
4745
|
+
*/
|
|
4746
|
+
id: number;
|
|
4747
|
+
/**
|
|
4748
|
+
* @description The reference ID of the action log.
|
|
4749
|
+
* @example some-reference-id
|
|
4750
|
+
*/
|
|
4751
|
+
referenceId: Record<string, never>;
|
|
4752
|
+
/**
|
|
4753
|
+
* @description The URL of the action.
|
|
4754
|
+
* @example /api/v1/some-action
|
|
4755
|
+
*/
|
|
4756
|
+
actionUrl: string;
|
|
4757
|
+
/**
|
|
4758
|
+
* @description The body of the action.
|
|
4759
|
+
* @example {
|
|
4760
|
+
* "key": "value"
|
|
4761
|
+
* }
|
|
4762
|
+
*/
|
|
4763
|
+
body: Record<string, never>;
|
|
4764
|
+
/**
|
|
4765
|
+
* @description The response of the action.
|
|
4766
|
+
* @example {
|
|
4767
|
+
* "success": true
|
|
4768
|
+
* }
|
|
4769
|
+
*/
|
|
4770
|
+
response: Record<string, never>;
|
|
4771
|
+
/**
|
|
4772
|
+
* Format: date-time
|
|
4773
|
+
* @description The creation date of the action log.
|
|
4774
|
+
* @example 2021-01-01T00:00:00.000Z
|
|
4775
|
+
*/
|
|
4776
|
+
createdAt: string;
|
|
4777
|
+
};
|
|
4778
|
+
PaypalActionLogPaginatedResponseDto: {
|
|
4779
|
+
data: components["schemas"]["PaypalActionLogResponseDto"][];
|
|
4780
|
+
/** @example 100 */
|
|
4781
|
+
total: number;
|
|
4782
|
+
/** @example 1 */
|
|
4783
|
+
page: number;
|
|
4784
|
+
/** @example 10 */
|
|
4785
|
+
limit: number;
|
|
4786
|
+
/** @example 10 */
|
|
4787
|
+
totalPages: number;
|
|
4788
|
+
};
|
|
4789
|
+
PaypalOrderRequestResponseDto: {
|
|
4790
|
+
/**
|
|
4791
|
+
* @description The ID of the order request.
|
|
4792
|
+
* @example 1
|
|
4793
|
+
*/
|
|
4794
|
+
id: number;
|
|
4795
|
+
/**
|
|
4796
|
+
* @description The UUID of the order request.
|
|
4797
|
+
* @example f47ac10b-58cc-4372-a567-0e02b2c3d479
|
|
4798
|
+
*/
|
|
4799
|
+
uuid: string;
|
|
4800
|
+
/**
|
|
4801
|
+
* @description The body of the order request.
|
|
4802
|
+
* @example {
|
|
4803
|
+
* "key": "value"
|
|
4804
|
+
* }
|
|
4805
|
+
*/
|
|
4806
|
+
body: Record<string, never>;
|
|
4807
|
+
/**
|
|
4808
|
+
* Format: date-time
|
|
4809
|
+
* @description The creation date of the order request.
|
|
4810
|
+
* @example 2021-01-01T00:00:00.000Z
|
|
4811
|
+
*/
|
|
4812
|
+
created_at: string;
|
|
4813
|
+
};
|
|
4814
|
+
PaypalOrderRequestPaginatedResponseDto: {
|
|
4815
|
+
data: components["schemas"]["PaypalOrderRequestResponseDto"][];
|
|
4816
|
+
/** @example 100 */
|
|
4817
|
+
total: number;
|
|
4818
|
+
/** @example 1 */
|
|
4819
|
+
page: number;
|
|
4820
|
+
/** @example 10 */
|
|
4821
|
+
limit: number;
|
|
4822
|
+
/** @example 10 */
|
|
4823
|
+
totalPages: number;
|
|
4824
|
+
};
|
|
4825
|
+
PaypalRefundsLogResponseDto: {
|
|
4826
|
+
/**
|
|
4827
|
+
* @description The ID of the refund log.
|
|
4828
|
+
* @example 1
|
|
4829
|
+
*/
|
|
4830
|
+
id: number;
|
|
4831
|
+
/**
|
|
4832
|
+
* @description The order ID of the refund log.
|
|
4833
|
+
* @example some-order-id
|
|
4834
|
+
*/
|
|
4835
|
+
orderId: string;
|
|
4836
|
+
/**
|
|
4837
|
+
* @description The transaction ID of the refund log.
|
|
4838
|
+
* @example some-transaction-id
|
|
4839
|
+
*/
|
|
4840
|
+
transactionId: string;
|
|
4841
|
+
/**
|
|
4842
|
+
* @description The amount of the refund.
|
|
4843
|
+
* @example 100
|
|
4844
|
+
*/
|
|
4845
|
+
amount: number;
|
|
4846
|
+
/**
|
|
4847
|
+
* @description The currency of the refund.
|
|
4848
|
+
* @example USD
|
|
4849
|
+
*/
|
|
4850
|
+
currency: string;
|
|
4851
|
+
/**
|
|
4852
|
+
* @description The status of the refund.
|
|
4853
|
+
* @example success
|
|
4854
|
+
*/
|
|
4855
|
+
status: string;
|
|
4856
|
+
/**
|
|
4857
|
+
* @description The message of the refund.
|
|
4858
|
+
* @example Refund successful
|
|
4859
|
+
*/
|
|
4860
|
+
message: string;
|
|
4861
|
+
/**
|
|
4862
|
+
* Format: date-time
|
|
4863
|
+
* @description The creation date of the refund log.
|
|
4864
|
+
* @example 2021-01-01T00:00:00.000Z
|
|
4865
|
+
*/
|
|
4866
|
+
createdAt: string;
|
|
4867
|
+
};
|
|
4868
|
+
PaypalRefundsLogPaginatedResponseDto: {
|
|
4869
|
+
data: components["schemas"]["PaypalRefundsLogResponseDto"][];
|
|
4870
|
+
/** @example 100 */
|
|
4871
|
+
total: number;
|
|
4872
|
+
/** @example 1 */
|
|
4873
|
+
page: number;
|
|
4874
|
+
/** @example 10 */
|
|
4875
|
+
limit: number;
|
|
4876
|
+
/** @example 10 */
|
|
4877
|
+
totalPages: number;
|
|
4878
|
+
};
|
|
4879
|
+
PaypalTransactionPaginatedResponseDto: {
|
|
4880
|
+
data: components["schemas"]["PaypalTransactionResponseDto"][];
|
|
4881
|
+
/** @example 100 */
|
|
4882
|
+
total: number;
|
|
4883
|
+
/** @example 1 */
|
|
4884
|
+
page: number;
|
|
4885
|
+
/** @example 10 */
|
|
4886
|
+
limit: number;
|
|
4887
|
+
/** @example 10 */
|
|
4888
|
+
totalPages: number;
|
|
4889
|
+
};
|
|
4890
|
+
PaypalDisputeDataResponseDto: {
|
|
4891
|
+
/** @example 1 */
|
|
4892
|
+
id: number;
|
|
4893
|
+
/** @example PP-D-208454 */
|
|
4894
|
+
disputeId: string;
|
|
4895
|
+
/** @example RESOLVED */
|
|
4896
|
+
state: Record<string, never> | null;
|
|
4897
|
+
/** @example CHARGEBACK */
|
|
4898
|
+
stage: Record<string, never> | null;
|
|
4899
|
+
/** @example 16 */
|
|
4900
|
+
disputedAmountValue: Record<string, never> | null;
|
|
4901
|
+
/** @example USD */
|
|
4902
|
+
disputedAmountCurrency: Record<string, never> | null;
|
|
4903
|
+
/** @example MERCHANDISE_OR_SERVICE_NOT_RECEIVED */
|
|
4904
|
+
reason: Record<string, never> | null;
|
|
4905
|
+
/** @description Original raw PayPal response payload */
|
|
4906
|
+
rawResponse: {
|
|
4907
|
+
[key: string]: unknown;
|
|
4908
|
+
} | null;
|
|
4909
|
+
/**
|
|
4910
|
+
* Format: date-time
|
|
4911
|
+
* @example 2025-09-25T17:34:47.000Z
|
|
4912
|
+
*/
|
|
4913
|
+
createdAt: string;
|
|
4914
|
+
/**
|
|
4915
|
+
* Format: date-time
|
|
4916
|
+
* @example 2025-09-25T17:34:47.000Z
|
|
4917
|
+
*/
|
|
4918
|
+
updatedAt: string;
|
|
4919
|
+
};
|
|
4920
|
+
PaypalDisputePaginatedResponseDto: {
|
|
4921
|
+
data: components["schemas"]["PaypalDisputeDataResponseDto"][];
|
|
4922
|
+
/** @example 100 */
|
|
4923
|
+
total: number;
|
|
4924
|
+
/** @example 1 */
|
|
4925
|
+
page: number;
|
|
4926
|
+
/** @example 10 */
|
|
4927
|
+
limit: number;
|
|
4928
|
+
/** @example 10 */
|
|
4929
|
+
totalPages: number;
|
|
4930
|
+
};
|
|
4931
|
+
PaypalAuthorizationCaptureLogDataResponseDto: {
|
|
4932
|
+
/** @example 1 */
|
|
4933
|
+
id: number;
|
|
4934
|
+
/**
|
|
4935
|
+
* Format: date-time
|
|
4936
|
+
* @example 2025-09-25T17:34:47.000Z
|
|
4937
|
+
*/
|
|
4938
|
+
createdAt: string;
|
|
4939
|
+
/** @example 9GS80322PL908563T */
|
|
4940
|
+
transactionId: string;
|
|
4941
|
+
/**
|
|
4942
|
+
* @description Log status: skip, success, error
|
|
4943
|
+
* @example success
|
|
4944
|
+
*/
|
|
4945
|
+
status: string;
|
|
4946
|
+
/**
|
|
4947
|
+
* @description Details about the capture attempt
|
|
4948
|
+
* @example {
|
|
4949
|
+
* "paypal_capture_id": "CAP-12345",
|
|
4950
|
+
* "message": "Capture successful"
|
|
4951
|
+
* }
|
|
4952
|
+
*/
|
|
4953
|
+
details: {
|
|
4954
|
+
[key: string]: unknown;
|
|
4955
|
+
} | null;
|
|
4956
|
+
};
|
|
4957
|
+
PaypalAuthorizationCaptureLogPaginatedResponseDto: {
|
|
4958
|
+
data: components["schemas"]["PaypalAuthorizationCaptureLogDataResponseDto"][];
|
|
4959
|
+
/** @example 100 */
|
|
4960
|
+
total: number;
|
|
4961
|
+
/** @example 1 */
|
|
4962
|
+
page: number;
|
|
4963
|
+
/** @example 10 */
|
|
4964
|
+
limit: number;
|
|
4965
|
+
/** @example 10 */
|
|
4966
|
+
totalPages: number;
|
|
4967
|
+
};
|
|
4968
|
+
MetaDto: {
|
|
4969
|
+
/**
|
|
4970
|
+
* @description Total number of items
|
|
4971
|
+
* @example 3
|
|
4972
|
+
*/
|
|
4973
|
+
total: number;
|
|
4974
|
+
/**
|
|
4975
|
+
* @description Total number of pages
|
|
4976
|
+
* @example 3
|
|
4977
|
+
*/
|
|
4978
|
+
pages: number;
|
|
4979
|
+
/**
|
|
4980
|
+
* @description Current page number
|
|
4981
|
+
* @example 1
|
|
4982
|
+
*/
|
|
4983
|
+
currentPage: number;
|
|
4984
|
+
};
|
|
4985
|
+
AuthorizationResponseDto: {
|
|
4986
|
+
/** @example 1 */
|
|
4987
|
+
id: number;
|
|
4988
|
+
/** @example auth_001 */
|
|
4989
|
+
externalId: string;
|
|
4990
|
+
/** @example {
|
|
4991
|
+
* "amount": 100,
|
|
4992
|
+
* "currency": "USD"
|
|
4993
|
+
* } */
|
|
4994
|
+
data: Record<string, never> | null;
|
|
4995
|
+
/**
|
|
4996
|
+
* Format: date-time
|
|
4997
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
4998
|
+
*/
|
|
4999
|
+
createdAt: string;
|
|
5000
|
+
/**
|
|
5001
|
+
* Format: date-time
|
|
5002
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
5003
|
+
*/
|
|
5004
|
+
updatedAt: string;
|
|
5005
|
+
};
|
|
5006
|
+
AuthorizationListResponseDto: {
|
|
5007
|
+
/** @example Authorizations retrieved successfully */
|
|
5008
|
+
message: string;
|
|
5009
|
+
meta: components["schemas"]["MetaDto"];
|
|
5010
|
+
items: components["schemas"]["AuthorizationResponseDto"][];
|
|
5011
|
+
};
|
|
5012
|
+
BillingAgreementResponseDto: {
|
|
5013
|
+
/** @example 1 */
|
|
5014
|
+
id: number;
|
|
5015
|
+
/** @example ba_001 */
|
|
5016
|
+
externalId: string;
|
|
5017
|
+
/** @example {
|
|
5018
|
+
* "plan": "monthly",
|
|
5019
|
+
* "status": "active"
|
|
5020
|
+
* } */
|
|
5021
|
+
data: Record<string, never> | null;
|
|
5022
|
+
/**
|
|
5023
|
+
* Format: date-time
|
|
5024
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
5025
|
+
*/
|
|
5026
|
+
createdAt: string;
|
|
5027
|
+
/**
|
|
5028
|
+
* Format: date-time
|
|
5029
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
5030
|
+
*/
|
|
5031
|
+
updatedAt: string;
|
|
5032
|
+
};
|
|
5033
|
+
BillingAgreementListResponseDto: {
|
|
5034
|
+
/** @example Billing agreements retrieved successfully */
|
|
5035
|
+
message: string;
|
|
5036
|
+
meta: components["schemas"]["MetaDto"];
|
|
5037
|
+
items: components["schemas"]["BillingAgreementResponseDto"][];
|
|
5038
|
+
};
|
|
5039
|
+
CaptureResponseDto: {
|
|
5040
|
+
/** @example 1 */
|
|
5041
|
+
id: number;
|
|
5042
|
+
/** @example capture_001 */
|
|
5043
|
+
externalId: string;
|
|
5044
|
+
/** @example {
|
|
5045
|
+
* "amount": 100,
|
|
5046
|
+
* "currency": "USD"
|
|
5047
|
+
* } */
|
|
5048
|
+
data: Record<string, never> | null;
|
|
5049
|
+
/**
|
|
5050
|
+
* Format: date-time
|
|
5051
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
5052
|
+
*/
|
|
5053
|
+
createdAt: string;
|
|
5054
|
+
/**
|
|
5055
|
+
* Format: date-time
|
|
5056
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
5057
|
+
*/
|
|
5058
|
+
updatedAt: string;
|
|
5059
|
+
};
|
|
5060
|
+
CaptureListResponseDto: {
|
|
5061
|
+
/** @example Captures retrieved successfully */
|
|
5062
|
+
message: string;
|
|
5063
|
+
meta: components["schemas"]["MetaDto"];
|
|
5064
|
+
items: components["schemas"]["CaptureResponseDto"][];
|
|
5065
|
+
};
|
|
5066
|
+
OrderResponseDto: {
|
|
5067
|
+
/** @example 1 */
|
|
5068
|
+
id: number;
|
|
5069
|
+
/** @example order_001 */
|
|
5070
|
+
externalId: string;
|
|
5071
|
+
/** @example {
|
|
5072
|
+
* "amount": 200,
|
|
5073
|
+
* "currency": "USD",
|
|
5074
|
+
* "status": "completed"
|
|
5075
|
+
* } */
|
|
5076
|
+
data: Record<string, never> | null;
|
|
5077
|
+
/**
|
|
5078
|
+
* Format: date-time
|
|
5079
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
5080
|
+
*/
|
|
5081
|
+
createdAt: string;
|
|
5082
|
+
/**
|
|
5083
|
+
* Format: date-time
|
|
5084
|
+
* @example 2025-10-27T09:22:26.835Z
|
|
5085
|
+
*/
|
|
5086
|
+
updatedAt: string;
|
|
5087
|
+
};
|
|
5088
|
+
OrderListResponseDto: {
|
|
5089
|
+
/** @example Orders retrieved successfully */
|
|
5090
|
+
message: string;
|
|
5091
|
+
meta: components["schemas"]["MetaDto"];
|
|
5092
|
+
items: components["schemas"]["OrderResponseDto"][];
|
|
5093
|
+
};
|
|
5094
|
+
RefundListResponseDto: {
|
|
5095
|
+
/** @example Refunds retrieved successfully */
|
|
5096
|
+
message: string;
|
|
5097
|
+
meta: components["schemas"]["MetaDto"];
|
|
5098
|
+
items: components["schemas"]["RefundResponseDto"][];
|
|
5099
|
+
};
|
|
5100
|
+
PaypalBillingAgreementV1CreateDto: {
|
|
5101
|
+
/**
|
|
5102
|
+
* @description The description of the billing agreement.
|
|
5103
|
+
* @example Billing agreement for order 123
|
|
5104
|
+
*/
|
|
5105
|
+
description: string;
|
|
5106
|
+
/**
|
|
5107
|
+
* @description Redirect URL after the user approves the billing agreement.
|
|
5108
|
+
* @example https://example.com/success
|
|
5109
|
+
*/
|
|
5110
|
+
returnUrl: string;
|
|
5111
|
+
/**
|
|
5112
|
+
* @description Redirect URL after the user cancels the billing agreement.
|
|
5113
|
+
* @example https://example.com/cancel
|
|
5114
|
+
*/
|
|
5115
|
+
cancelUrl: string;
|
|
5116
|
+
/**
|
|
5117
|
+
* @description Indicates whether to skip the shipping address.
|
|
5118
|
+
* @default false
|
|
5119
|
+
*/
|
|
5120
|
+
skipShippingAddress: boolean;
|
|
5121
|
+
};
|
|
5122
|
+
PaypalBillingAgreementLinkDto: {
|
|
5123
|
+
/**
|
|
5124
|
+
* @description Target URL for the related action.
|
|
5125
|
+
* @example https://www.sandbox.paypal.com/agreements/approve?ba_token=BA-7F476943VW515780U
|
|
5126
|
+
*/
|
|
5127
|
+
href: string;
|
|
5128
|
+
/**
|
|
5129
|
+
* @description The relation of the link to the resource.
|
|
5130
|
+
* @example approval_url
|
|
5131
|
+
*/
|
|
5132
|
+
rel: string;
|
|
5133
|
+
/**
|
|
5134
|
+
* @description HTTP method to be used with the link.
|
|
5135
|
+
* @example POST
|
|
5136
|
+
*/
|
|
5137
|
+
method: string;
|
|
5138
|
+
};
|
|
5139
|
+
PaypalBillingAgreementV1CreateResponseDto: {
|
|
5140
|
+
/**
|
|
5141
|
+
* @description Token identifier for the billing agreement approval.
|
|
5142
|
+
* @example BA-7F476943VW515780U
|
|
5143
|
+
*/
|
|
5144
|
+
token_id: string;
|
|
5145
|
+
/**
|
|
5146
|
+
* @description HATEOAS links relevant to the created billing agreement.
|
|
5147
|
+
* @example [
|
|
5148
|
+
* {
|
|
5149
|
+
* "href": "https://www.sandbox.paypal.com/agreements/approve?ba_token=BA-7F476943VW515780U",
|
|
5150
|
+
* "rel": "approval_url",
|
|
5151
|
+
* "method": "POST"
|
|
5152
|
+
* },
|
|
5153
|
+
* {
|
|
5154
|
+
* "href": "https://api-m.sandbox.paypal.com/v1/billing-agreements/BA-7F476943VW515780U/agreements",
|
|
5155
|
+
* "rel": "self",
|
|
5156
|
+
* "method": "POST"
|
|
5157
|
+
* }
|
|
5158
|
+
* ]
|
|
5159
|
+
*/
|
|
5160
|
+
links: components["schemas"]["PaypalBillingAgreementLinkDto"][];
|
|
5161
|
+
};
|
|
5162
|
+
PaypalPayeeInfoDto: {
|
|
5163
|
+
/**
|
|
5164
|
+
* @description Email of the payee (merchant).
|
|
5165
|
+
* @example sb-pfbjo24475123@business.example.com
|
|
5166
|
+
*/
|
|
5167
|
+
email: string;
|
|
5168
|
+
};
|
|
5169
|
+
PaypalMerchantDto: {
|
|
5170
|
+
payee_info: components["schemas"]["PaypalPayeeInfoDto"];
|
|
5171
|
+
};
|
|
5172
|
+
PaypalPayerDto: {
|
|
5173
|
+
payer_info: components["schemas"]["PaypalPayerInfoDto"];
|
|
5174
|
+
};
|
|
5175
|
+
PaypalShippingAddressDto: {
|
|
5176
|
+
/** @example John Doe */
|
|
5177
|
+
recipient_name: string;
|
|
5178
|
+
/** @example 1 Main St */
|
|
5179
|
+
line1: string;
|
|
5180
|
+
/** @example San Jose */
|
|
5181
|
+
city: string;
|
|
5182
|
+
/** @example CA */
|
|
5183
|
+
state: string;
|
|
5184
|
+
/** @example US */
|
|
5185
|
+
country_code: string;
|
|
5186
|
+
/** @example 95131 */
|
|
5187
|
+
postal_code: string;
|
|
5188
|
+
};
|
|
5189
|
+
PaypalPlanMerchantPreferencesDto: {
|
|
5190
|
+
/**
|
|
5191
|
+
* @description Webhook notification URL.
|
|
5192
|
+
* @example https://webhook.site/8ad1f0b0-1aed-46eb-a2c9-2ce345c3c7e6
|
|
5193
|
+
*/
|
|
5194
|
+
notify_url: string;
|
|
5195
|
+
/** @example INSTANT */
|
|
5196
|
+
accepted_pymt_type: string;
|
|
5197
|
+
/** @example false */
|
|
5198
|
+
multi_factor_activation: boolean;
|
|
5199
|
+
/** @example false */
|
|
5200
|
+
req_billing_address: boolean;
|
|
5201
|
+
};
|
|
5202
|
+
PaypalPlanDto: {
|
|
5203
|
+
/** @example MERCHANT_INITIATED_BILLING */
|
|
5204
|
+
type: string;
|
|
5205
|
+
merchant_preferences: components["schemas"]["PaypalPlanMerchantPreferencesDto"];
|
|
5206
|
+
};
|
|
5207
|
+
PaypalBillingAgreementV1ResponseDto: {
|
|
5208
|
+
/** @example B-18G27807A0987670C */
|
|
5209
|
+
id: string;
|
|
5210
|
+
/** @example ACTIVE */
|
|
5211
|
+
state: string;
|
|
5212
|
+
/** @example Billing agreement for order 123 */
|
|
5213
|
+
description: string;
|
|
5214
|
+
merchant: components["schemas"]["PaypalMerchantDto"];
|
|
5215
|
+
payer: components["schemas"]["PaypalPayerDto"];
|
|
5216
|
+
shipping_address?: components["schemas"]["PaypalShippingAddressDto"];
|
|
5217
|
+
plan: components["schemas"]["PaypalPlanDto"];
|
|
5218
|
+
/**
|
|
5219
|
+
* @description ISO 8601 creation timestamp.
|
|
5220
|
+
* @example 2025-10-24T15:50:16.000Z
|
|
5221
|
+
*/
|
|
5222
|
+
create_time: string;
|
|
5223
|
+
/**
|
|
5224
|
+
* @description ISO 8601 last update timestamp.
|
|
5225
|
+
* @example 2025-10-24T15:50:16.000Z
|
|
5226
|
+
*/
|
|
5227
|
+
update_time: string;
|
|
5228
|
+
/**
|
|
5229
|
+
* @description Additional agreement details provided by PayPal.
|
|
5230
|
+
* @example {}
|
|
5231
|
+
*/
|
|
5232
|
+
agreement_details: Record<string, never>;
|
|
5233
|
+
links: components["schemas"]["PaypalBillingAgreementLinkDto"][];
|
|
5234
|
+
};
|
|
5235
|
+
PaypalOrderV1CreateDto: {
|
|
5236
|
+
/**
|
|
5237
|
+
* @description The currency of the payment.
|
|
5238
|
+
* @example USD
|
|
5239
|
+
*/
|
|
5240
|
+
currency: string;
|
|
5241
|
+
/**
|
|
5242
|
+
* @description The total amount of the payment.
|
|
5243
|
+
* @example 100
|
|
5244
|
+
*/
|
|
5245
|
+
total: number;
|
|
5246
|
+
/**
|
|
5247
|
+
* @description The ID of the order.
|
|
5248
|
+
* @example O-1234567890
|
|
5249
|
+
*/
|
|
5250
|
+
orderId: string;
|
|
5251
|
+
/**
|
|
5252
|
+
* @description The URL to redirect to after the payment is canceled.
|
|
5253
|
+
* @example https://example.com/cancel
|
|
5254
|
+
*/
|
|
5255
|
+
cancelUrl: string;
|
|
5256
|
+
/**
|
|
5257
|
+
* @description The URL to redirect to after the payment is successful.
|
|
5258
|
+
* @example https://example.com/success
|
|
5259
|
+
*/
|
|
5260
|
+
successUrl: string;
|
|
5261
|
+
/**
|
|
5262
|
+
* @description The email of the customer.
|
|
5263
|
+
* @example artur+bot@netzet.com
|
|
5264
|
+
*/
|
|
5265
|
+
email: string;
|
|
5266
|
+
};
|
|
5267
|
+
PaypalOrderV1CreatePaymentSourcePaypalDto: {
|
|
5268
|
+
/**
|
|
5269
|
+
* @description The PayPal account email of the payer.
|
|
5270
|
+
* @example artur@netzet.com
|
|
5271
|
+
*/
|
|
5272
|
+
email_address: string;
|
|
5273
|
+
};
|
|
5274
|
+
PaypalOrderV1CreatePaymentSourceDto: {
|
|
5275
|
+
/** @description PayPal-specific payment source details. */
|
|
5276
|
+
paypal: components["schemas"]["PaypalOrderV1CreatePaymentSourcePaypalDto"];
|
|
5277
|
+
};
|
|
5278
|
+
PaypalOrderV1CreateAmountBreakdownDto: {
|
|
5279
|
+
/**
|
|
5280
|
+
* @description The total amount for all items in the order.
|
|
5281
|
+
* @example {
|
|
5282
|
+
* "currency_code": "USD",
|
|
5283
|
+
* "value": "100.00"
|
|
5284
|
+
* }
|
|
5285
|
+
*/
|
|
5286
|
+
item_total: components["schemas"]["PaypalCommonAmountDto"];
|
|
5287
|
+
};
|
|
5288
|
+
PaypalOrderV1CreateAmountDto: {
|
|
5289
|
+
/**
|
|
5290
|
+
* @description Currency code in ISO 4217 format
|
|
5291
|
+
* @example USD
|
|
5292
|
+
*/
|
|
5293
|
+
currency_code: string;
|
|
5294
|
+
/**
|
|
5295
|
+
* @description Monetary value for the purchase unit
|
|
5296
|
+
* @example 100.00
|
|
5297
|
+
*/
|
|
5298
|
+
value: string;
|
|
5299
|
+
/** @description Detailed breakdown of the amount. */
|
|
5300
|
+
breakdown?: components["schemas"]["PaypalOrderV1CreateAmountBreakdownDto"];
|
|
5301
|
+
};
|
|
5302
|
+
PaypalOrderV1CreatePayeeDto: {
|
|
5303
|
+
/**
|
|
5304
|
+
* @description Payee email address
|
|
5305
|
+
* @example sb-pfbjo24475123@business.example.com
|
|
5306
|
+
*/
|
|
5307
|
+
email_address: string;
|
|
5308
|
+
/**
|
|
5309
|
+
* @description PayPal merchant identifier
|
|
5310
|
+
* @example D6P9S9DKA57WS
|
|
5311
|
+
*/
|
|
5312
|
+
merchant_id: string;
|
|
5313
|
+
};
|
|
5314
|
+
PaypalOrderV1CreatePurchaseUnitDto: {
|
|
5315
|
+
/**
|
|
5316
|
+
* @description The API caller-provided external ID for the purchase unit.
|
|
5317
|
+
* @example 2025-10-25 10:11
|
|
5318
|
+
*/
|
|
5319
|
+
reference_id: string;
|
|
5320
|
+
/** @description The amount breakdown for this purchase unit. */
|
|
5321
|
+
amount: components["schemas"]["PaypalOrderV1CreateAmountDto"];
|
|
5322
|
+
/** @description Payee information for this purchase unit. */
|
|
5323
|
+
payee: components["schemas"]["PaypalOrderV1CreatePayeeDto"];
|
|
5324
|
+
/**
|
|
5325
|
+
* @description The API caller-provided custom ID for the purchase unit.
|
|
5326
|
+
* @example 2025-10-25 10:11
|
|
5327
|
+
*/
|
|
5328
|
+
custom_id: string;
|
|
5329
|
+
};
|
|
5330
|
+
PaypalOrderV1CreatePayerDto: {
|
|
5331
|
+
/**
|
|
5332
|
+
* @description The payer email address.
|
|
5333
|
+
* @example artur@netzet.com
|
|
5334
|
+
*/
|
|
5335
|
+
email_address: string;
|
|
5336
|
+
};
|
|
5337
|
+
PaypalOrderV1CreateLinkDto: {
|
|
5338
|
+
/**
|
|
5339
|
+
* @description Target URL for the related action.
|
|
5340
|
+
* @example https://api.sandbox.paypal.com/v2/checkout/orders/0LH51088WX0596135
|
|
5341
|
+
*/
|
|
5342
|
+
href: string;
|
|
5343
|
+
/**
|
|
5344
|
+
* @description The relation of the link to the resource.
|
|
5345
|
+
* @example self
|
|
5346
|
+
*/
|
|
5347
|
+
rel: string;
|
|
5348
|
+
/**
|
|
5349
|
+
* @description HTTP method to be used with the link.
|
|
5350
|
+
* @example GET
|
|
5351
|
+
*/
|
|
5352
|
+
method: string;
|
|
5353
|
+
};
|
|
5354
|
+
PaypalOrderV1CreateResponseDto: {
|
|
5355
|
+
/**
|
|
5356
|
+
* @description The ID of the created order.
|
|
5357
|
+
* @example 0LH51088WX0596135
|
|
5358
|
+
*/
|
|
5359
|
+
id: string;
|
|
5360
|
+
/**
|
|
5361
|
+
* @description The intent to either capture or authorize payment.
|
|
5362
|
+
* @example CAPTURE
|
|
5363
|
+
*/
|
|
5364
|
+
intent: string;
|
|
5365
|
+
/**
|
|
5366
|
+
* @description The status of the order.
|
|
5367
|
+
* @example PAYER_ACTION_REQUIRED
|
|
5368
|
+
*/
|
|
5369
|
+
status: string;
|
|
5370
|
+
/** @description Payment source information used for the order. */
|
|
5371
|
+
payment_source: components["schemas"]["PaypalOrderV1CreatePaymentSourceDto"];
|
|
5372
|
+
/**
|
|
5373
|
+
* @description An array of purchase units in the order.
|
|
5374
|
+
* @example [
|
|
5375
|
+
* {
|
|
5376
|
+
* "reference_id": "2025-10-25 10:11",
|
|
5377
|
+
* "amount": {
|
|
5378
|
+
* "currency_code": "USD",
|
|
5379
|
+
* "value": "100.00",
|
|
5380
|
+
* "breakdown": {
|
|
5381
|
+
* "item_total": {
|
|
5382
|
+
* "currency_code": "USD",
|
|
5383
|
+
* "value": "100.00"
|
|
5384
|
+
* }
|
|
5385
|
+
* }
|
|
5386
|
+
* },
|
|
5387
|
+
* "payee": {
|
|
5388
|
+
* "email_address": "sb-pfbjo24475123@business.example.com",
|
|
5389
|
+
* "merchant_id": "D6P9S9DKA57WS"
|
|
5390
|
+
* },
|
|
5391
|
+
* "custom_id": "2025-10-25 10:11"
|
|
5392
|
+
* }
|
|
5393
|
+
* ]
|
|
5394
|
+
*/
|
|
5395
|
+
purchase_units: components["schemas"]["PaypalOrderV1CreatePurchaseUnitDto"][];
|
|
5396
|
+
/** @description Information about the payer. */
|
|
5397
|
+
payer: components["schemas"]["PaypalOrderV1CreatePayerDto"];
|
|
5398
|
+
/**
|
|
5399
|
+
* @description HATEOAS links associated with the created order.
|
|
5400
|
+
* @example [
|
|
5401
|
+
* {
|
|
5402
|
+
* "href": "https://api.sandbox.paypal.com/v2/checkout/orders/0LH51088WX0596135",
|
|
5403
|
+
* "rel": "self",
|
|
5404
|
+
* "method": "GET"
|
|
5405
|
+
* },
|
|
5406
|
+
* {
|
|
5407
|
+
* "href": "https://www.sandbox.paypal.com/checkoutnow?token=0LH51088WX0596135",
|
|
5408
|
+
* "rel": "payer-action",
|
|
5409
|
+
* "method": "GET"
|
|
5410
|
+
* }
|
|
5411
|
+
* ]
|
|
5412
|
+
*/
|
|
5413
|
+
links: components["schemas"]["PaypalOrderV1CreateLinkDto"][];
|
|
5414
|
+
};
|
|
5415
|
+
PaypalOrderV1NameDto: {
|
|
5416
|
+
/**
|
|
5417
|
+
* @description Given name of the person.
|
|
5418
|
+
* @example John
|
|
5419
|
+
*/
|
|
5420
|
+
given_name: string;
|
|
5421
|
+
/**
|
|
5422
|
+
* @description Surname of the person.
|
|
5423
|
+
* @example Doe
|
|
5424
|
+
*/
|
|
5425
|
+
surname: string;
|
|
5426
|
+
};
|
|
5427
|
+
PaypalOrderV1AddressDto: {
|
|
5428
|
+
/**
|
|
5429
|
+
* @description Two-character ISO 3166-1 country code.
|
|
5430
|
+
* @example US
|
|
5431
|
+
*/
|
|
5432
|
+
country_code: string;
|
|
5433
|
+
};
|
|
5434
|
+
PaypalOrderV1VaultCustomerDto: {
|
|
5435
|
+
/**
|
|
5436
|
+
* @description Customer identifier in the merchant vault
|
|
5437
|
+
* @example DGqUAQaEJj
|
|
5438
|
+
*/
|
|
5439
|
+
id: string;
|
|
5440
|
+
};
|
|
5441
|
+
PaypalOrderV1VaultLinkDto: {
|
|
5442
|
+
/**
|
|
5443
|
+
* @description Target URL for the related action.
|
|
5444
|
+
* @example https://api.sandbox.paypal.com/v2/checkout/orders/9YF06214L58745748
|
|
5445
|
+
*/
|
|
5446
|
+
href: string;
|
|
5447
|
+
/**
|
|
5448
|
+
* @description The relation of the link to the resource.
|
|
5449
|
+
* @example self
|
|
5450
|
+
*/
|
|
5451
|
+
rel: string;
|
|
5452
|
+
/**
|
|
5453
|
+
* @description HTTP method to be used with the link.
|
|
5454
|
+
* @example GET
|
|
5455
|
+
*/
|
|
5456
|
+
method: string;
|
|
5457
|
+
};
|
|
5458
|
+
PaypalOrderV1VaultDto: {
|
|
5459
|
+
/**
|
|
5460
|
+
* @description Vaulted payment token identifier
|
|
5461
|
+
* @example 12k50287ff457874y
|
|
5462
|
+
*/
|
|
5463
|
+
id: string;
|
|
5464
|
+
/**
|
|
5465
|
+
* @description Vaulting status
|
|
5466
|
+
* @example VAULTED
|
|
5467
|
+
*/
|
|
5468
|
+
status: string;
|
|
5469
|
+
/** @description Customer information for the vaulted payment method */
|
|
5470
|
+
customer: components["schemas"]["PaypalOrderV1VaultCustomerDto"];
|
|
5471
|
+
/** @description Links related to the vaulted token */
|
|
5472
|
+
links: components["schemas"]["PaypalOrderV1VaultLinkDto"][];
|
|
5473
|
+
};
|
|
5474
|
+
PaypalOrderV1PaymentSourcePaypalAttributesDto: {
|
|
5475
|
+
/** @description Vault-related attributes */
|
|
5476
|
+
vault?: components["schemas"]["PaypalOrderV1VaultDto"];
|
|
5477
|
+
};
|
|
5478
|
+
PaypalOrderV1PaymentSourcePaypalDto: {
|
|
5479
|
+
/**
|
|
5480
|
+
* @description The PayPal account email of the payer.
|
|
5481
|
+
* @example sb-n7gbh24522527@personal.example.com
|
|
5482
|
+
*/
|
|
5483
|
+
email_address: string;
|
|
5484
|
+
/**
|
|
5485
|
+
* @description PayPal account identifier
|
|
5486
|
+
* @example 9WRTDKDR6GUT6
|
|
5487
|
+
*/
|
|
5488
|
+
account_id: string;
|
|
5489
|
+
/**
|
|
5490
|
+
* @description Status of the PayPal account
|
|
5491
|
+
* @example VERIFIED
|
|
5492
|
+
*/
|
|
5493
|
+
account_status: string;
|
|
5494
|
+
/** @description Account holder name */
|
|
5495
|
+
name: components["schemas"]["PaypalOrderV1NameDto"];
|
|
5496
|
+
/** @description Account holder address */
|
|
5497
|
+
address: components["schemas"]["PaypalOrderV1AddressDto"];
|
|
5498
|
+
/** @description Additional attributes for PayPal payment source */
|
|
5499
|
+
attributes?: components["schemas"]["PaypalOrderV1PaymentSourcePaypalAttributesDto"];
|
|
5500
|
+
};
|
|
5501
|
+
PaypalOrderV1PaymentSourceDto: {
|
|
5502
|
+
/** @description PayPal-specific payment source details. */
|
|
5503
|
+
paypal: components["schemas"]["PaypalOrderV1PaymentSourcePaypalDto"];
|
|
5504
|
+
};
|
|
5505
|
+
PaypalOrderV1AmountBreakdownDto: {
|
|
5506
|
+
/** @description The total amount for all items in the order. */
|
|
5507
|
+
item_total: components["schemas"]["PaypalCommonAmountDto"];
|
|
5508
|
+
};
|
|
5509
|
+
PaypalOrderV1AmountDto: {
|
|
5510
|
+
/**
|
|
5511
|
+
* @description Currency code in ISO 4217 format
|
|
5512
|
+
* @example USD
|
|
5513
|
+
*/
|
|
5514
|
+
currency_code: string;
|
|
5515
|
+
/**
|
|
5516
|
+
* @description Monetary value for the purchase unit
|
|
5517
|
+
* @example 100.00
|
|
5518
|
+
*/
|
|
5519
|
+
value: string;
|
|
5520
|
+
/** @description Detailed breakdown of the amount. */
|
|
5521
|
+
breakdown?: components["schemas"]["PaypalOrderV1AmountBreakdownDto"];
|
|
5522
|
+
};
|
|
5523
|
+
PaypalOrderV1PayeeDto: {
|
|
5524
|
+
/**
|
|
5525
|
+
* @description Payee email address
|
|
5526
|
+
* @example sb-pfbjo24475123@business.example.com
|
|
5527
|
+
*/
|
|
5528
|
+
email_address: string;
|
|
5529
|
+
/**
|
|
5530
|
+
* @description PayPal merchant identifier
|
|
5531
|
+
* @example D6P9S9DKA57WS
|
|
5532
|
+
*/
|
|
5533
|
+
merchant_id: string;
|
|
5534
|
+
};
|
|
5535
|
+
PaypalOrderV1SellerProtectionDto: {
|
|
5536
|
+
/**
|
|
5537
|
+
* @description Seller protection status
|
|
5538
|
+
* @example ELIGIBLE
|
|
5539
|
+
*/
|
|
5540
|
+
status: string;
|
|
5541
|
+
/**
|
|
5542
|
+
* @description Categories of disputes covered under seller protection
|
|
5543
|
+
* @example [
|
|
5544
|
+
* "ITEM_NOT_RECEIVED",
|
|
5545
|
+
* "UNAUTHORIZED_TRANSACTION"
|
|
5546
|
+
* ]
|
|
5547
|
+
*/
|
|
5548
|
+
dispute_categories: string[];
|
|
5549
|
+
};
|
|
5550
|
+
PaypalOrderV1SellerReceivableBreakdownDto: {
|
|
5551
|
+
/** @description Gross amount captured */
|
|
5552
|
+
gross_amount: components["schemas"]["PaypalCommonAmountDto"];
|
|
5553
|
+
/** @description PayPal fee amount */
|
|
5554
|
+
paypal_fee: components["schemas"]["PaypalCommonAmountDto"];
|
|
5555
|
+
/** @description Net amount after fees */
|
|
5556
|
+
net_amount: components["schemas"]["PaypalCommonAmountDto"];
|
|
5557
|
+
};
|
|
5558
|
+
PaypalOrderV1CaptureLinkDto: {
|
|
5559
|
+
/**
|
|
5560
|
+
* @description Target URL for the related action.
|
|
5561
|
+
* @example https://api.sandbox.paypal.com/v2/checkout/orders/9YF06214L58745748
|
|
5562
|
+
*/
|
|
5563
|
+
href: string;
|
|
5564
|
+
/**
|
|
5565
|
+
* @description The relation of the link to the resource.
|
|
5566
|
+
* @example self
|
|
5567
|
+
*/
|
|
5568
|
+
rel: string;
|
|
5569
|
+
/**
|
|
5570
|
+
* @description HTTP method to be used with the link.
|
|
5571
|
+
* @example GET
|
|
5572
|
+
*/
|
|
5573
|
+
method: string;
|
|
5574
|
+
};
|
|
5575
|
+
PaypalOrderV1CaptureDto: {
|
|
5576
|
+
/**
|
|
5577
|
+
* @description Capture identifier
|
|
5578
|
+
* @example 8VM2505118764460Y
|
|
5579
|
+
*/
|
|
5580
|
+
id: string;
|
|
5581
|
+
/**
|
|
5582
|
+
* @description Capture status
|
|
5583
|
+
* @example COMPLETED
|
|
5584
|
+
*/
|
|
5585
|
+
status: string;
|
|
5586
|
+
/** @description Captured amount */
|
|
5587
|
+
amount: components["schemas"]["PaypalCommonAmountDto"];
|
|
5588
|
+
/**
|
|
5589
|
+
* @description Whether this is the final capture
|
|
5590
|
+
* @example true
|
|
5591
|
+
*/
|
|
5592
|
+
final_capture: boolean;
|
|
5593
|
+
/** @description Seller protection information */
|
|
5594
|
+
seller_protection: components["schemas"]["PaypalOrderV1SellerProtectionDto"];
|
|
5595
|
+
/** @description Breakdown of the amounts receivable by the seller */
|
|
5596
|
+
seller_receivable_breakdown: components["schemas"]["PaypalOrderV1SellerReceivableBreakdownDto"];
|
|
5597
|
+
/**
|
|
5598
|
+
* @description The API caller-provided custom ID for the capture
|
|
5599
|
+
* @example 2025-10-251020
|
|
5600
|
+
*/
|
|
5601
|
+
custom_id?: string;
|
|
5602
|
+
/** @description HATEOAS links related to the capture */
|
|
5603
|
+
links: components["schemas"]["PaypalOrderV1CaptureLinkDto"][];
|
|
5604
|
+
/**
|
|
5605
|
+
* @description Creation time in RFC 3339 format
|
|
5606
|
+
* @example 2025-10-25T07:20:41Z
|
|
5607
|
+
*/
|
|
5608
|
+
create_time: string;
|
|
5609
|
+
/**
|
|
5610
|
+
* @description Last update time in RFC 3339 format
|
|
5611
|
+
* @example 2025-10-25T07:20:41Z
|
|
5612
|
+
*/
|
|
5613
|
+
update_time: string;
|
|
5614
|
+
};
|
|
5615
|
+
PaypalOrderV1PaymentsDto: {
|
|
5616
|
+
/** @description List of captures related to this purchase unit */
|
|
5617
|
+
captures: components["schemas"]["PaypalOrderV1CaptureDto"][];
|
|
5618
|
+
};
|
|
5619
|
+
PaypalOrderV1PurchaseUnitDto: {
|
|
5620
|
+
/**
|
|
5621
|
+
* @description The API caller-provided external ID for the purchase unit.
|
|
5622
|
+
* @example 2025-10-251020
|
|
5623
|
+
*/
|
|
5624
|
+
reference_id: string;
|
|
5625
|
+
/** @description The amount breakdown for this purchase unit. */
|
|
5626
|
+
amount: components["schemas"]["PaypalOrderV1AmountDto"];
|
|
5627
|
+
/** @description Payee information for this purchase unit. */
|
|
5628
|
+
payee: components["schemas"]["PaypalOrderV1PayeeDto"];
|
|
5629
|
+
/**
|
|
5630
|
+
* @description The API caller-provided custom ID for the purchase unit.
|
|
5631
|
+
* @example 2025-10-251020
|
|
5632
|
+
*/
|
|
5633
|
+
custom_id: string;
|
|
5634
|
+
/** @description Payments information including captures */
|
|
5635
|
+
payments?: components["schemas"]["PaypalOrderV1PaymentsDto"];
|
|
5636
|
+
};
|
|
5637
|
+
PaypalOrderV1PayerDto: {
|
|
5638
|
+
/** @description Payer name */
|
|
5639
|
+
name: components["schemas"]["PaypalOrderV1NameDto"];
|
|
5640
|
+
/**
|
|
5641
|
+
* @description The payer email address.
|
|
5642
|
+
* @example sb-n7gbh24522527@personal.example.com
|
|
5643
|
+
*/
|
|
5644
|
+
email_address: string;
|
|
5645
|
+
/**
|
|
5646
|
+
* @description The payer ID assigned by PayPal.
|
|
5647
|
+
* @example 9WRTDKDR6GUT6
|
|
5648
|
+
*/
|
|
5649
|
+
payer_id: string;
|
|
5650
|
+
/** @description Payer address */
|
|
5651
|
+
address: components["schemas"]["PaypalOrderV1AddressDto"];
|
|
5652
|
+
};
|
|
5653
|
+
PaypalOrderV1LinkDto: {
|
|
5654
|
+
/**
|
|
5655
|
+
* @description Target URL for the related action.
|
|
5656
|
+
* @example https://api.sandbox.paypal.com/v2/checkout/orders/9YF06214L58745748
|
|
5657
|
+
*/
|
|
5658
|
+
href: string;
|
|
5659
|
+
/**
|
|
5660
|
+
* @description The relation of the link to the resource.
|
|
5661
|
+
* @example self
|
|
5662
|
+
*/
|
|
5663
|
+
rel: string;
|
|
5664
|
+
/**
|
|
5665
|
+
* @description HTTP method to be used with the link.
|
|
5666
|
+
* @example GET
|
|
5667
|
+
*/
|
|
5668
|
+
method: string;
|
|
5669
|
+
};
|
|
5670
|
+
PaypalOrderV1ResponseDto: {
|
|
5671
|
+
/**
|
|
5672
|
+
* @description The ID of the order.
|
|
5673
|
+
* @example 9YF06214L58745748
|
|
5674
|
+
*/
|
|
5675
|
+
id: string;
|
|
5676
|
+
/**
|
|
5677
|
+
* @description The intent to either capture or authorize payment.
|
|
5678
|
+
* @example CAPTURE
|
|
5679
|
+
*/
|
|
5680
|
+
intent: string;
|
|
5681
|
+
/**
|
|
5682
|
+
* @description The status of the order.
|
|
5683
|
+
* @example COMPLETED
|
|
5684
|
+
*/
|
|
5685
|
+
status: string;
|
|
5686
|
+
/** @description Payment source information used for the order. */
|
|
5687
|
+
payment_source: components["schemas"]["PaypalOrderV1PaymentSourceDto"];
|
|
5688
|
+
/** @description An array of purchase units in the order. */
|
|
5689
|
+
purchase_units: components["schemas"]["PaypalOrderV1PurchaseUnitDto"][];
|
|
5690
|
+
/** @description Information about the payer. */
|
|
5691
|
+
payer: components["schemas"]["PaypalOrderV1PayerDto"];
|
|
5692
|
+
/**
|
|
5693
|
+
* @description Creation time in RFC 3339 format
|
|
5694
|
+
* @example 2025-10-25T07:20:41Z
|
|
5695
|
+
*/
|
|
5696
|
+
create_time: string;
|
|
5697
|
+
/**
|
|
5698
|
+
* @description Last update time in RFC 3339 format
|
|
5699
|
+
* @example 2025-10-25T07:20:41Z
|
|
5700
|
+
*/
|
|
5701
|
+
update_time: string;
|
|
5702
|
+
/** @description HATEOAS links associated with the order. */
|
|
5703
|
+
links: components["schemas"]["PaypalOrderV1LinkDto"][];
|
|
5704
|
+
};
|
|
5705
|
+
PaypalPaymentV1V1PaymentCreateDto: {
|
|
5706
|
+
/**
|
|
5707
|
+
* @description The intent of the payment.
|
|
5708
|
+
* @example sale
|
|
5709
|
+
*/
|
|
5710
|
+
intent?: string;
|
|
5711
|
+
/**
|
|
5712
|
+
* @description The ID of the billing agreement.
|
|
5713
|
+
* @example B-1234567890
|
|
5714
|
+
*/
|
|
5715
|
+
agreementId: string;
|
|
5716
|
+
/**
|
|
5717
|
+
* @description The currency of the payment.
|
|
5718
|
+
* @example USD
|
|
5719
|
+
*/
|
|
5720
|
+
currency: string;
|
|
5721
|
+
/**
|
|
5722
|
+
* @description The total amount of the payment.
|
|
5723
|
+
* @example 100
|
|
5724
|
+
*/
|
|
5725
|
+
total: number;
|
|
5726
|
+
/**
|
|
5727
|
+
* @description The description of the payment.
|
|
5728
|
+
* @example Payment for order 123
|
|
5729
|
+
*/
|
|
5730
|
+
description: string;
|
|
5731
|
+
/**
|
|
5732
|
+
* @description The ID of the order.
|
|
5733
|
+
* @example O-1234567890
|
|
5734
|
+
*/
|
|
5735
|
+
orderId: string;
|
|
5736
|
+
};
|
|
5737
|
+
FundingBillingDto: {
|
|
5738
|
+
billing_agreement_id: string;
|
|
5739
|
+
};
|
|
5740
|
+
FundingInstrumentDto: {
|
|
5741
|
+
/** @description Billing agreement details for the instrument. */
|
|
5742
|
+
billing: components["schemas"]["FundingBillingDto"];
|
|
5743
|
+
};
|
|
5744
|
+
PayerDto: {
|
|
5745
|
+
payment_method: string;
|
|
5746
|
+
status: string;
|
|
5747
|
+
payer_info: components["schemas"]["PayerInfoDto"];
|
|
5748
|
+
funding_instruments: components["schemas"]["FundingInstrumentDto"][];
|
|
5749
|
+
};
|
|
5750
|
+
AmountDetailsDto: {
|
|
5751
|
+
subtotal: string;
|
|
5752
|
+
shipping: string;
|
|
5753
|
+
insurance: string;
|
|
5754
|
+
handling_fee: string;
|
|
5755
|
+
shipping_discount: string;
|
|
5756
|
+
discount: string;
|
|
5757
|
+
};
|
|
5758
|
+
AmountDto: {
|
|
5759
|
+
total: string;
|
|
5760
|
+
currency: string;
|
|
5761
|
+
details: components["schemas"]["AmountDetailsDto"];
|
|
5762
|
+
};
|
|
5763
|
+
PayeeDto: {
|
|
5764
|
+
merchant_id: string;
|
|
5765
|
+
email: string;
|
|
5766
|
+
};
|
|
5767
|
+
ItemDto: {
|
|
5768
|
+
name: string;
|
|
5769
|
+
sku: string;
|
|
5770
|
+
description: string;
|
|
5771
|
+
price: string;
|
|
5772
|
+
currency: string;
|
|
5773
|
+
tax: string;
|
|
5774
|
+
quantity: number;
|
|
5775
|
+
image_url: string;
|
|
5776
|
+
};
|
|
5777
|
+
ItemListDto: {
|
|
5778
|
+
items: components["schemas"]["ItemDto"][];
|
|
5779
|
+
};
|
|
5780
|
+
SaleTransactionFeeDto: {
|
|
5781
|
+
value: string;
|
|
5782
|
+
currency: string;
|
|
5783
|
+
};
|
|
5784
|
+
SaleDto: {
|
|
5785
|
+
id: string;
|
|
5786
|
+
state: string;
|
|
5787
|
+
amount: components["schemas"]["AmountDto"];
|
|
5788
|
+
payment_mode: string;
|
|
5789
|
+
protection_eligibility: string;
|
|
5790
|
+
protection_eligibility_type: string;
|
|
5791
|
+
/** @description Present for completed sales; absent for authorizations. */
|
|
5792
|
+
transaction_fee?: components["schemas"]["SaleTransactionFeeDto"];
|
|
5793
|
+
billing_agreement_id: string;
|
|
5794
|
+
parent_payment: string;
|
|
5795
|
+
/** @description ISO-8601 creation time. */
|
|
5796
|
+
create_time: string;
|
|
5797
|
+
/** @description ISO-8601 update time. */
|
|
5798
|
+
update_time: string;
|
|
5799
|
+
links: components["schemas"]["PaypalLinkDto"][];
|
|
5800
|
+
};
|
|
5801
|
+
AuthorizationDto: {
|
|
5802
|
+
id: string;
|
|
5803
|
+
/** @description Optional sender transaction id for Payer-initiated requests. */
|
|
5804
|
+
sender_transaction_id?: string;
|
|
5805
|
+
state: string;
|
|
5806
|
+
amount: components["schemas"]["AmountDto"];
|
|
5807
|
+
payment_mode: string;
|
|
5808
|
+
reason_code?: string;
|
|
5809
|
+
protection_eligibility: string;
|
|
5810
|
+
protection_eligibility_type: string;
|
|
5811
|
+
billing_agreement_id: string;
|
|
5812
|
+
parent_payment: string;
|
|
5813
|
+
/** @description Authorization validity timestamp (ISO-8601). */
|
|
5814
|
+
valid_until?: string;
|
|
5815
|
+
/** @description ISO-8601 creation time. */
|
|
5816
|
+
create_time: string;
|
|
5817
|
+
/** @description ISO-8601 update time. */
|
|
5818
|
+
update_time: string;
|
|
5819
|
+
links: components["schemas"]["PaypalLinkDto"][];
|
|
5820
|
+
};
|
|
5821
|
+
RelatedResourceDto: {
|
|
5822
|
+
sale?: components["schemas"]["SaleDto"];
|
|
5823
|
+
authorization?: components["schemas"]["AuthorizationDto"];
|
|
5824
|
+
};
|
|
5825
|
+
PaypalPaymentV1V1PaymentCreateResponseDto: {
|
|
5826
|
+
/** @example PAYID-ND53H7Q6BD589953P7945052 */
|
|
5827
|
+
id: string;
|
|
5828
|
+
/** @example sale */
|
|
5829
|
+
intent: string;
|
|
5830
|
+
/** @example approved */
|
|
5831
|
+
state: string;
|
|
5832
|
+
payer: components["schemas"]["PayerDto"];
|
|
5833
|
+
transactions: components["schemas"]["TransactionDto"][];
|
|
5834
|
+
/** @description ISO-8601 creation time. */
|
|
5835
|
+
create_time: string;
|
|
5836
|
+
/** @description ISO-8601 update time. */
|
|
5837
|
+
update_time: string;
|
|
5838
|
+
links: components["schemas"]["PaypalLinkDto"][];
|
|
5839
|
+
};
|
|
5840
|
+
ConvertCurrencyDto: {
|
|
5841
|
+
/** @example EUR */
|
|
5842
|
+
from: string;
|
|
5843
|
+
/** @example USD */
|
|
5844
|
+
to: string;
|
|
5845
|
+
/** @example 100 */
|
|
5846
|
+
amount: number;
|
|
5847
|
+
};
|
|
5848
|
+
ConvertCurrencyResponseDto: {
|
|
5849
|
+
/**
|
|
5850
|
+
* @description Source currency
|
|
5851
|
+
* @example USD
|
|
5852
|
+
*/
|
|
5853
|
+
from: string;
|
|
5854
|
+
/**
|
|
5855
|
+
* @description Target currency
|
|
5856
|
+
* @example PKR
|
|
5857
|
+
*/
|
|
5858
|
+
to: string;
|
|
5859
|
+
/**
|
|
5860
|
+
* @description Original amount in source currency
|
|
5861
|
+
* @example 100
|
|
5862
|
+
*/
|
|
5863
|
+
amount: number;
|
|
5864
|
+
/**
|
|
5865
|
+
* @description Converted amount in target currency
|
|
5866
|
+
* @example 28140
|
|
5867
|
+
*/
|
|
5868
|
+
converted: number;
|
|
5869
|
+
/**
|
|
5870
|
+
* @description Conversion rate (target per source)
|
|
5871
|
+
* @example 281.4
|
|
5872
|
+
*/
|
|
5873
|
+
rate: number;
|
|
5874
|
+
/**
|
|
5875
|
+
* @description Base currency used for conversion
|
|
5876
|
+
* @example USD
|
|
5877
|
+
*/
|
|
5878
|
+
base_currency: string;
|
|
5879
|
+
};
|
|
5880
|
+
FbCapiCreatePixelDto: {
|
|
5881
|
+
/** @description Title (just for UI purposes) */
|
|
5882
|
+
title: string;
|
|
5883
|
+
/** @description Facebook Pixel ID */
|
|
5884
|
+
pixel: string;
|
|
5885
|
+
/** @description Facebook Pixel Token */
|
|
5886
|
+
token: string;
|
|
5887
|
+
/** @description Project */
|
|
5888
|
+
project: string;
|
|
5889
|
+
/** @description Active */
|
|
5890
|
+
active: boolean;
|
|
5891
|
+
};
|
|
5892
|
+
FbCapiPixelResponseDto: {
|
|
5893
|
+
/** @description Unique Record ID */
|
|
5894
|
+
id: number;
|
|
5895
|
+
/** @description Title (just for UI purposes) */
|
|
5896
|
+
title: string;
|
|
5897
|
+
/** @description Facebook Pixel ID */
|
|
5898
|
+
pixel: string;
|
|
5899
|
+
/** @description Facebook Pixel Token */
|
|
5900
|
+
token: string;
|
|
5901
|
+
/** @description Project */
|
|
5902
|
+
project: string;
|
|
5903
|
+
/** @description Active */
|
|
5904
|
+
active: boolean;
|
|
5905
|
+
};
|
|
5906
|
+
FbCapiUpdatePixelDto: {
|
|
5907
|
+
/** @description Title (just for UI purposes) */
|
|
5908
|
+
title?: string;
|
|
5909
|
+
/** @description Facebook Pixel ID */
|
|
5910
|
+
pixel?: string;
|
|
5911
|
+
/** @description Facebook Pixel Token */
|
|
5912
|
+
token?: string;
|
|
5913
|
+
/** @description Project */
|
|
5914
|
+
project?: string;
|
|
5915
|
+
/** @description Active */
|
|
5916
|
+
active?: boolean;
|
|
5917
|
+
};
|
|
5918
|
+
Event: Record<string, never>;
|
|
5919
|
+
SnapchatCapiEventFullResponseDto: {
|
|
5920
|
+
data: components["schemas"]["Event"][];
|
|
5921
|
+
total: number;
|
|
5922
|
+
page: number;
|
|
5923
|
+
limit: number;
|
|
5924
|
+
totalPages: number;
|
|
5925
|
+
};
|
|
5926
|
+
SnapChatClientDataDto: {
|
|
5927
|
+
/** @description Email */
|
|
5928
|
+
email: string;
|
|
5929
|
+
/** @description Client IP address */
|
|
5930
|
+
ip: string;
|
|
5931
|
+
/** @description Client user agent */
|
|
5932
|
+
user_agent: string;
|
|
5933
|
+
/** @description External IDs */
|
|
5934
|
+
external_id?: string;
|
|
5935
|
+
};
|
|
5936
|
+
SnapchatCapiDataDto: {
|
|
5937
|
+
/** @description Event ID */
|
|
5938
|
+
event_id: string;
|
|
5939
|
+
/** @description Event name */
|
|
5940
|
+
event_name: string;
|
|
5941
|
+
/** @description Event time (unix seconds) */
|
|
5942
|
+
event_time: number;
|
|
5943
|
+
/** @description Action source (e.g., WEB/web/website) */
|
|
5944
|
+
action_source: string;
|
|
5945
|
+
/** @description Event source URL where the event occurred */
|
|
5946
|
+
event_source_url: string;
|
|
5947
|
+
/** @description Access token */
|
|
5948
|
+
access_token: string;
|
|
5949
|
+
/** @description Pixel ID */
|
|
5950
|
+
pixelId: string;
|
|
5951
|
+
};
|
|
5952
|
+
SnapchatCapiPayloadDto: {
|
|
5953
|
+
/** @description Client data */
|
|
5954
|
+
clientData: components["schemas"]["SnapChatClientDataDto"];
|
|
5955
|
+
/** @description Event data */
|
|
5956
|
+
eventData: components["schemas"]["SnapChatEventDataDto"];
|
|
5957
|
+
/** @description General CAPI data */
|
|
5958
|
+
data: components["schemas"]["SnapchatCapiDataDto"];
|
|
5959
|
+
/** @description Optional postback URL */
|
|
5960
|
+
postback?: string;
|
|
5961
|
+
/** @description Optional test event code */
|
|
5962
|
+
test_event_code?: string;
|
|
5963
|
+
};
|
|
5964
|
+
SnapChatCreateEventDto: {
|
|
5965
|
+
/** @description Event name */
|
|
5966
|
+
event: string;
|
|
5967
|
+
/** @description Request data */
|
|
5968
|
+
request: components["schemas"]["SnapchatCapiPayloadDto"];
|
|
5969
|
+
/** @description Pixel ID */
|
|
5970
|
+
pixelId: number;
|
|
5971
|
+
};
|
|
5972
|
+
SnapChatEventCreateResponseDto: {
|
|
5973
|
+
id: number;
|
|
5974
|
+
};
|
|
5975
|
+
SnapChatUpdateEventDto: {
|
|
5976
|
+
/** @description Response data */
|
|
5977
|
+
response?: Record<string, never>;
|
|
5978
|
+
};
|
|
5979
|
+
FacebookCapiPixelDto: {
|
|
5980
|
+
/** @example 1234567890123456 */
|
|
5981
|
+
pixelId: string;
|
|
5982
|
+
/** @description Facebook CAPI Access Token */
|
|
5983
|
+
accessToken: string;
|
|
5984
|
+
};
|
|
5985
|
+
FacebookCapiClientDataDto: {
|
|
5986
|
+
/**
|
|
5987
|
+
* @description The user's email address.
|
|
5988
|
+
* @example joe@example.com
|
|
5989
|
+
*/
|
|
5990
|
+
email: string;
|
|
5991
|
+
/**
|
|
5992
|
+
* @description The user's IP address.
|
|
5993
|
+
* @example 123.123.123.123
|
|
5994
|
+
*/
|
|
5995
|
+
ip: string;
|
|
5996
|
+
/**
|
|
5997
|
+
* @description The user's browser user agent string.
|
|
5998
|
+
* @example Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...
|
|
5999
|
+
*/
|
|
6000
|
+
userAgent: string;
|
|
6001
|
+
/**
|
|
6002
|
+
* @description The Facebook click ID.
|
|
6003
|
+
* @example fb.1.1554763741205.AbCdEfGhIjKlMnOp
|
|
6004
|
+
*/
|
|
6005
|
+
fbc: string;
|
|
6006
|
+
/**
|
|
6007
|
+
* @description The Facebook browser ID.
|
|
6008
|
+
* @example fb.1.1558571054389.1098115397
|
|
6009
|
+
*/
|
|
6010
|
+
fbp: string;
|
|
6011
|
+
/**
|
|
6012
|
+
* @description The user country.
|
|
6013
|
+
* @example US
|
|
6014
|
+
*/
|
|
6015
|
+
country?: string;
|
|
6016
|
+
/**
|
|
6017
|
+
* @description The user state.
|
|
6018
|
+
* @example DE
|
|
6019
|
+
*/
|
|
6020
|
+
state?: string;
|
|
6021
|
+
/**
|
|
6022
|
+
* @description The user city.
|
|
6023
|
+
* @example Berlin
|
|
6024
|
+
*/
|
|
6025
|
+
city?: string;
|
|
6026
|
+
/**
|
|
6027
|
+
* @description The user zip code.
|
|
6028
|
+
* @example 19901
|
|
3326
6029
|
*/
|
|
3327
6030
|
zip?: string;
|
|
3328
6031
|
/**
|
|
@@ -3385,46 +6088,47 @@ interface components {
|
|
|
3385
6088
|
*/
|
|
3386
6089
|
title: string;
|
|
3387
6090
|
/**
|
|
3388
|
-
* @description
|
|
3389
|
-
* @example
|
|
6091
|
+
* @description External ID of the account
|
|
6092
|
+
* @example ext-123
|
|
3390
6093
|
*/
|
|
3391
|
-
|
|
6094
|
+
externalId: string;
|
|
3392
6095
|
/**
|
|
3393
|
-
* @description
|
|
6096
|
+
* @description Target source of the account
|
|
3394
6097
|
* @example Internal
|
|
3395
6098
|
*/
|
|
3396
|
-
|
|
6099
|
+
targetSource: string;
|
|
3397
6100
|
/**
|
|
3398
|
-
* @description
|
|
3399
|
-
* @
|
|
3400
|
-
* @example true
|
|
6101
|
+
* @description Access token for the account
|
|
6102
|
+
* @example abc123token
|
|
3401
6103
|
*/
|
|
3402
|
-
|
|
6104
|
+
accessToken: string;
|
|
3403
6105
|
};
|
|
3404
6106
|
AccountDetailDto: {
|
|
3405
6107
|
/** @example 1 */
|
|
3406
6108
|
id: number;
|
|
3407
6109
|
/** @example 2025-10-08T11:29:46.000Z */
|
|
3408
6110
|
createdAt: string;
|
|
3409
|
-
/** @example
|
|
6111
|
+
/** @example Development Account */
|
|
3410
6112
|
title: string;
|
|
3411
6113
|
/** @example Internal */
|
|
3412
|
-
|
|
6114
|
+
targetSource: string;
|
|
3413
6115
|
/**
|
|
3414
|
-
* @description
|
|
3415
|
-
* @example
|
|
6116
|
+
* @description External ID for the account
|
|
6117
|
+
* @example ext-123
|
|
3416
6118
|
*/
|
|
3417
|
-
|
|
6119
|
+
externalId: string;
|
|
3418
6120
|
/**
|
|
3419
|
-
* @description
|
|
3420
|
-
* @example
|
|
6121
|
+
* @description Access token for the account (sensitive, optional)
|
|
6122
|
+
* @example abc123token
|
|
3421
6123
|
*/
|
|
3422
|
-
|
|
6124
|
+
accessToken: string;
|
|
6125
|
+
/** @example 2025-10-08T11:29:46.000Z */
|
|
6126
|
+
updatedAt: string;
|
|
3423
6127
|
};
|
|
3424
6128
|
AccountResponseDto: {
|
|
3425
6129
|
account: components["schemas"]["AccountDetailDto"];
|
|
3426
6130
|
};
|
|
3427
|
-
|
|
6131
|
+
AccountResponseDto_POST_Single_Account_created_successfully_Default: {
|
|
3428
6132
|
/** @example true */
|
|
3429
6133
|
success: Record<string, never>;
|
|
3430
6134
|
/** @example POST */
|
|
@@ -3435,7 +6139,7 @@ interface components {
|
|
|
3435
6139
|
statusCode: Record<string, never>;
|
|
3436
6140
|
/** @example accounts */
|
|
3437
6141
|
path: Record<string, never>;
|
|
3438
|
-
/** @example 2025-10-
|
|
6142
|
+
/** @example 2025-10-23T11:28:19.135Z */
|
|
3439
6143
|
timestamp: Record<string, never>;
|
|
3440
6144
|
/** @example Account created successfully */
|
|
3441
6145
|
message: Record<string, never>;
|
|
@@ -3443,11 +6147,11 @@ interface components {
|
|
|
3443
6147
|
};
|
|
3444
6148
|
UpdateAccountDto: {
|
|
3445
6149
|
title?: string;
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
6150
|
+
externalId?: string;
|
|
6151
|
+
targetSource?: string;
|
|
6152
|
+
accessToken?: string;
|
|
3449
6153
|
};
|
|
3450
|
-
|
|
6154
|
+
AccountResponseDto_PATCH_Single_Account_updated_successful_Default: {
|
|
3451
6155
|
/** @example true */
|
|
3452
6156
|
success: Record<string, never>;
|
|
3453
6157
|
/** @example PATCH */
|
|
@@ -3458,13 +6162,13 @@ interface components {
|
|
|
3458
6162
|
statusCode: Record<string, never>;
|
|
3459
6163
|
/** @example accounts/{id} */
|
|
3460
6164
|
path: Record<string, never>;
|
|
3461
|
-
/** @example 2025-10-
|
|
6165
|
+
/** @example 2025-10-23T11:28:19.137Z */
|
|
3462
6166
|
timestamp: Record<string, never>;
|
|
3463
6167
|
/** @example Account updated successful */
|
|
3464
6168
|
message: Record<string, never>;
|
|
3465
6169
|
data?: components["schemas"]["AccountResponseDto"];
|
|
3466
6170
|
};
|
|
3467
|
-
|
|
6171
|
+
NoData_DELETE_Response_Account_deleted_successful_Default: {
|
|
3468
6172
|
/** @example true */
|
|
3469
6173
|
success: Record<string, never>;
|
|
3470
6174
|
/** @example DELETE */
|
|
@@ -3475,12 +6179,12 @@ interface components {
|
|
|
3475
6179
|
statusCode: Record<string, never>;
|
|
3476
6180
|
/** @example accounts/{id} */
|
|
3477
6181
|
path: Record<string, never>;
|
|
3478
|
-
/** @example 2025-10-
|
|
6182
|
+
/** @example 2025-10-23T11:28:19.139Z */
|
|
3479
6183
|
timestamp: Record<string, never>;
|
|
3480
6184
|
/** @example Account deleted successful */
|
|
3481
6185
|
message: Record<string, never>;
|
|
3482
6186
|
};
|
|
3483
|
-
|
|
6187
|
+
AccountResponseDto_GET_Single_Account_detail_retrieved_successful_Default: {
|
|
3484
6188
|
/** @example true */
|
|
3485
6189
|
success: Record<string, never>;
|
|
3486
6190
|
/** @example GET */
|
|
@@ -3491,7 +6195,7 @@ interface components {
|
|
|
3491
6195
|
statusCode: Record<string, never>;
|
|
3492
6196
|
/** @example accounts/{id} */
|
|
3493
6197
|
path: Record<string, never>;
|
|
3494
|
-
/** @example 2025-10-
|
|
6198
|
+
/** @example 2025-10-23T11:28:19.139Z */
|
|
3495
6199
|
timestamp: Record<string, never>;
|
|
3496
6200
|
/** @example Account detail retrieved successful */
|
|
3497
6201
|
message: Record<string, never>;
|
|
@@ -3506,28 +6210,11 @@ interface components {
|
|
|
3506
6210
|
*/
|
|
3507
6211
|
order?: "asc" | "desc";
|
|
3508
6212
|
};
|
|
3509
|
-
MetaDto: {
|
|
3510
|
-
/**
|
|
3511
|
-
* @description Total number of items
|
|
3512
|
-
* @example 3
|
|
3513
|
-
*/
|
|
3514
|
-
total: number;
|
|
3515
|
-
/**
|
|
3516
|
-
* @description Total number of pages
|
|
3517
|
-
* @example 3
|
|
3518
|
-
*/
|
|
3519
|
-
pages: number;
|
|
3520
|
-
/**
|
|
3521
|
-
* @description Current page number
|
|
3522
|
-
* @example 1
|
|
3523
|
-
*/
|
|
3524
|
-
currentPage: number;
|
|
3525
|
-
};
|
|
3526
6213
|
AccountListResponseDto: {
|
|
3527
6214
|
meta: components["schemas"]["MetaDto"];
|
|
3528
6215
|
accounts: components["schemas"]["AccountDetailDto"][];
|
|
3529
6216
|
};
|
|
3530
|
-
|
|
6217
|
+
AccountListResponseDto_GET_Array_Account_list_retrieved_successful_Default: {
|
|
3531
6218
|
/** @example true */
|
|
3532
6219
|
success: Record<string, never>;
|
|
3533
6220
|
/** @example GET */
|
|
@@ -3538,7 +6225,7 @@ interface components {
|
|
|
3538
6225
|
statusCode: Record<string, never>;
|
|
3539
6226
|
/** @example accounts */
|
|
3540
6227
|
path: Record<string, never>;
|
|
3541
|
-
/** @example 2025-10-
|
|
6228
|
+
/** @example 2025-10-23T11:28:19.140Z */
|
|
3542
6229
|
timestamp: Record<string, never>;
|
|
3543
6230
|
/** @example Account list retrieved successful */
|
|
3544
6231
|
message: Record<string, never>;
|
|
@@ -3549,10 +6236,10 @@ interface components {
|
|
|
3549
6236
|
id: number;
|
|
3550
6237
|
/** @example 2025-10-08T11:29:46.000Z */
|
|
3551
6238
|
createdAt: string;
|
|
3552
|
-
/** @example
|
|
6239
|
+
/** @example Development Account */
|
|
3553
6240
|
title: string;
|
|
3554
6241
|
/** @example Internal */
|
|
3555
|
-
|
|
6242
|
+
targetSource: string;
|
|
3556
6243
|
};
|
|
3557
6244
|
SpendListDto: {
|
|
3558
6245
|
/** @example 17 */
|
|
@@ -3565,8 +6252,6 @@ interface components {
|
|
|
3565
6252
|
date: string;
|
|
3566
6253
|
/** @example au */
|
|
3567
6254
|
country: string;
|
|
3568
|
-
/** @example en */
|
|
3569
|
-
language: string;
|
|
3570
6255
|
/** @example 158.93 */
|
|
3571
6256
|
spend: string;
|
|
3572
6257
|
/** @example 1 */
|
|
@@ -3577,7 +6262,7 @@ interface components {
|
|
|
3577
6262
|
meta: components["schemas"]["MetaDto"];
|
|
3578
6263
|
spends: components["schemas"]["SpendListDto"][];
|
|
3579
6264
|
};
|
|
3580
|
-
|
|
6265
|
+
SpendListResponseDto_GET_Array_Spend_list_retrieved_successful_Default: {
|
|
3581
6266
|
/** @example true */
|
|
3582
6267
|
success: Record<string, never>;
|
|
3583
6268
|
/** @example GET */
|
|
@@ -3588,7 +6273,7 @@ interface components {
|
|
|
3588
6273
|
statusCode: Record<string, never>;
|
|
3589
6274
|
/** @example spends */
|
|
3590
6275
|
path: Record<string, never>;
|
|
3591
|
-
/** @example 2025-10-
|
|
6276
|
+
/** @example 2025-10-23T11:28:19.205Z */
|
|
3592
6277
|
timestamp: Record<string, never>;
|
|
3593
6278
|
/** @example Spend list retrieved successful */
|
|
3594
6279
|
message: Record<string, never>;
|
|
@@ -3607,7 +6292,7 @@ interface components {
|
|
|
3607
6292
|
ErpDataResponsedDto: {
|
|
3608
6293
|
erpData: components["schemas"]["ErpDataDto"][];
|
|
3609
6294
|
};
|
|
3610
|
-
|
|
6295
|
+
ErpDataResponsedDto_GET_Single_ERP_data_retrieved_successful_Default: {
|
|
3611
6296
|
/** @example true */
|
|
3612
6297
|
success: Record<string, never>;
|
|
3613
6298
|
/** @example GET */
|
|
@@ -3618,7 +6303,7 @@ interface components {
|
|
|
3618
6303
|
statusCode: Record<string, never>;
|
|
3619
6304
|
/** @example spends/erp-data */
|
|
3620
6305
|
path: Record<string, never>;
|
|
3621
|
-
/** @example 2025-10-
|
|
6306
|
+
/** @example 2025-10-23T11:28:19.207Z */
|
|
3622
6307
|
timestamp: Record<string, never>;
|
|
3623
6308
|
/** @example ERP data retrieved successful */
|
|
3624
6309
|
message: Record<string, never>;
|
|
@@ -3635,8 +6320,6 @@ interface components {
|
|
|
3635
6320
|
date: string;
|
|
3636
6321
|
/** @example au */
|
|
3637
6322
|
country: string;
|
|
3638
|
-
/** @example en */
|
|
3639
|
-
language: string;
|
|
3640
6323
|
/** @example 158.93 */
|
|
3641
6324
|
spend: string;
|
|
3642
6325
|
/** @example 1 */
|
|
@@ -3646,7 +6329,7 @@ interface components {
|
|
|
3646
6329
|
SpendResponsedDto: {
|
|
3647
6330
|
spend: components["schemas"]["SpendDetailDto"];
|
|
3648
6331
|
};
|
|
3649
|
-
|
|
6332
|
+
SpendResponsedDto_GET_Single_Spend_detail_retrieved_successful_Default: {
|
|
3650
6333
|
/** @example true */
|
|
3651
6334
|
success: Record<string, never>;
|
|
3652
6335
|
/** @example GET */
|
|
@@ -3657,13 +6340,29 @@ interface components {
|
|
|
3657
6340
|
statusCode: Record<string, never>;
|
|
3658
6341
|
/** @example spends/{id} */
|
|
3659
6342
|
path: Record<string, never>;
|
|
3660
|
-
/** @example 2025-10-
|
|
6343
|
+
/** @example 2025-10-23T11:28:19.208Z */
|
|
3661
6344
|
timestamp: Record<string, never>;
|
|
3662
6345
|
/** @example Spend detail retrieved successful */
|
|
3663
6346
|
message: Record<string, never>;
|
|
3664
6347
|
data?: components["schemas"]["SpendResponsedDto"];
|
|
3665
6348
|
};
|
|
3666
|
-
|
|
6349
|
+
NoData_PATCH_Response_Spend_sync_triggered_successfully_sync_by_date: {
|
|
6350
|
+
/** @example true */
|
|
6351
|
+
success: Record<string, never>;
|
|
6352
|
+
/** @example PATCH */
|
|
6353
|
+
method: Record<string, never>;
|
|
6354
|
+
/** @example OK */
|
|
6355
|
+
status: Record<string, never>;
|
|
6356
|
+
/** @example 200 */
|
|
6357
|
+
statusCode: Record<string, never>;
|
|
6358
|
+
/** @example spends/sync/{id} */
|
|
6359
|
+
path: Record<string, never>;
|
|
6360
|
+
/** @example 2025-10-23T11:28:19.209Z */
|
|
6361
|
+
timestamp: Record<string, never>;
|
|
6362
|
+
/** @example Spend sync triggered successfully */
|
|
6363
|
+
message: Record<string, never>;
|
|
6364
|
+
};
|
|
6365
|
+
NoData_PATCH_Response_Spend_sync_triggered_successfully_sync_by_date_range: {
|
|
3667
6366
|
/** @example true */
|
|
3668
6367
|
success: Record<string, never>;
|
|
3669
6368
|
/** @example PATCH */
|
|
@@ -3674,11 +6373,242 @@ interface components {
|
|
|
3674
6373
|
statusCode: Record<string, never>;
|
|
3675
6374
|
/** @example spends/sync-date-range/{id} */
|
|
3676
6375
|
path: Record<string, never>;
|
|
3677
|
-
/** @example 2025-10-
|
|
6376
|
+
/** @example 2025-10-23T11:28:19.209Z */
|
|
3678
6377
|
timestamp: Record<string, never>;
|
|
3679
6378
|
/** @example Spend sync triggered successfully */
|
|
3680
6379
|
message: Record<string, never>;
|
|
3681
6380
|
};
|
|
6381
|
+
AccountResponseDto_POST_Single_Accountcreatedsuccessfully: {
|
|
6382
|
+
/** @example true */
|
|
6383
|
+
success: Record<string, never>;
|
|
6384
|
+
/** @example POST */
|
|
6385
|
+
method: Record<string, never>;
|
|
6386
|
+
/** @example CREATED */
|
|
6387
|
+
status: Record<string, never>;
|
|
6388
|
+
/** @example 201 */
|
|
6389
|
+
statusCode: Record<string, never>;
|
|
6390
|
+
/** @example accounts */
|
|
6391
|
+
path: Record<string, never>;
|
|
6392
|
+
/** @example 2025-10-21T13:32:46.602Z */
|
|
6393
|
+
timestamp: Record<string, never>;
|
|
6394
|
+
/** @example Account created successfully */
|
|
6395
|
+
message: Record<string, never>;
|
|
6396
|
+
data?: components["schemas"]["AccountResponseDto"];
|
|
6397
|
+
};
|
|
6398
|
+
AccountResponseDto_PATCH_Single_Accountupdatedsuccessful: {
|
|
6399
|
+
/** @example true */
|
|
6400
|
+
success: Record<string, never>;
|
|
6401
|
+
/** @example PATCH */
|
|
6402
|
+
method: Record<string, never>;
|
|
6403
|
+
/** @example OK */
|
|
6404
|
+
status: Record<string, never>;
|
|
6405
|
+
/** @example 200 */
|
|
6406
|
+
statusCode: Record<string, never>;
|
|
6407
|
+
/** @example accounts/{id} */
|
|
6408
|
+
path: Record<string, never>;
|
|
6409
|
+
/** @example 2025-10-21T13:32:46.605Z */
|
|
6410
|
+
timestamp: Record<string, never>;
|
|
6411
|
+
/** @example Account updated successful */
|
|
6412
|
+
message: Record<string, never>;
|
|
6413
|
+
data?: components["schemas"]["AccountResponseDto"];
|
|
6414
|
+
};
|
|
6415
|
+
NoData_DELETE_Response_Accountdeletedsuccessful: {
|
|
6416
|
+
/** @example true */
|
|
6417
|
+
success: Record<string, never>;
|
|
6418
|
+
/** @example DELETE */
|
|
6419
|
+
method: Record<string, never>;
|
|
6420
|
+
/** @example NO_CONTENT */
|
|
6421
|
+
status: Record<string, never>;
|
|
6422
|
+
/** @example 204 */
|
|
6423
|
+
statusCode: Record<string, never>;
|
|
6424
|
+
/** @example accounts/{id} */
|
|
6425
|
+
path: Record<string, never>;
|
|
6426
|
+
/** @example 2025-10-21T13:32:46.607Z */
|
|
6427
|
+
timestamp: Record<string, never>;
|
|
6428
|
+
/** @example Account deleted successful */
|
|
6429
|
+
message: Record<string, never>;
|
|
6430
|
+
};
|
|
6431
|
+
AccountResponseDto_GET_Single_Accountdetailretrievedsuccessful: {
|
|
6432
|
+
/** @example true */
|
|
6433
|
+
success: Record<string, never>;
|
|
6434
|
+
/** @example GET */
|
|
6435
|
+
method: Record<string, never>;
|
|
6436
|
+
/** @example OK */
|
|
6437
|
+
status: Record<string, never>;
|
|
6438
|
+
/** @example 200 */
|
|
6439
|
+
statusCode: Record<string, never>;
|
|
6440
|
+
/** @example accounts/{id} */
|
|
6441
|
+
path: Record<string, never>;
|
|
6442
|
+
/** @example 2025-10-21T13:32:46.608Z */
|
|
6443
|
+
timestamp: Record<string, never>;
|
|
6444
|
+
/** @example Account detail retrieved successful */
|
|
6445
|
+
message: Record<string, never>;
|
|
6446
|
+
data?: components["schemas"]["AccountResponseDto"];
|
|
6447
|
+
};
|
|
6448
|
+
AccountListResponseDto_GET_Array_Accountlistretrievedsuccessful: {
|
|
6449
|
+
/** @example true */
|
|
6450
|
+
success: Record<string, never>;
|
|
6451
|
+
/** @example GET */
|
|
6452
|
+
method: Record<string, never>;
|
|
6453
|
+
/** @example OK */
|
|
6454
|
+
status: Record<string, never>;
|
|
6455
|
+
/** @example 200 */
|
|
6456
|
+
statusCode: Record<string, never>;
|
|
6457
|
+
/** @example accounts */
|
|
6458
|
+
path: Record<string, never>;
|
|
6459
|
+
/** @example 2025-10-21T13:32:46.609Z */
|
|
6460
|
+
timestamp: Record<string, never>;
|
|
6461
|
+
/** @example Account list retrieved successful */
|
|
6462
|
+
message: Record<string, never>;
|
|
6463
|
+
data?: components["schemas"]["AccountListResponseDto"][];
|
|
6464
|
+
};
|
|
6465
|
+
SpendListResponseDto_GET_Array_Spendlistretrievedsuccessful: {
|
|
6466
|
+
/** @example true */
|
|
6467
|
+
success: Record<string, never>;
|
|
6468
|
+
/** @example GET */
|
|
6469
|
+
method: Record<string, never>;
|
|
6470
|
+
/** @example OK */
|
|
6471
|
+
status: Record<string, never>;
|
|
6472
|
+
/** @example 200 */
|
|
6473
|
+
statusCode: Record<string, never>;
|
|
6474
|
+
/** @example spends */
|
|
6475
|
+
path: Record<string, never>;
|
|
6476
|
+
/** @example 2025-10-21T13:32:46.671Z */
|
|
6477
|
+
timestamp: Record<string, never>;
|
|
6478
|
+
/** @example Spend list retrieved successful */
|
|
6479
|
+
message: Record<string, never>;
|
|
6480
|
+
data?: components["schemas"]["SpendListResponseDto"][];
|
|
6481
|
+
};
|
|
6482
|
+
SpendResponsedDto_GET_Single_Spenddetailretrievedsuccessful: {
|
|
6483
|
+
/** @example true */
|
|
6484
|
+
success: Record<string, never>;
|
|
6485
|
+
/** @example GET */
|
|
6486
|
+
method: Record<string, never>;
|
|
6487
|
+
/** @example OK */
|
|
6488
|
+
status: Record<string, never>;
|
|
6489
|
+
/** @example 200 */
|
|
6490
|
+
statusCode: Record<string, never>;
|
|
6491
|
+
/** @example spends/{id} */
|
|
6492
|
+
path: Record<string, never>;
|
|
6493
|
+
/** @example 2025-10-21T13:32:46.672Z */
|
|
6494
|
+
timestamp: Record<string, never>;
|
|
6495
|
+
/** @example Spend detail retrieved successful */
|
|
6496
|
+
message: Record<string, never>;
|
|
6497
|
+
data?: components["schemas"]["SpendResponsedDto"];
|
|
6498
|
+
};
|
|
6499
|
+
CreateSessionRequestDto: {
|
|
6500
|
+
/**
|
|
6501
|
+
* @description Transaction ID
|
|
6502
|
+
* @example txn_123456789
|
|
6503
|
+
*/
|
|
6504
|
+
transactionId: string;
|
|
6505
|
+
/**
|
|
6506
|
+
* @description User ID
|
|
6507
|
+
* @example user_123456789
|
|
6508
|
+
*/
|
|
6509
|
+
userId: string;
|
|
6510
|
+
};
|
|
6511
|
+
SessionDataResponseDto: {
|
|
6512
|
+
/** @description Session data */
|
|
6513
|
+
data: components["schemas"]["SessionResponseDto"];
|
|
6514
|
+
};
|
|
6515
|
+
SessionBadRequestErrorDto: {
|
|
6516
|
+
/** @example 400 */
|
|
6517
|
+
statusCode: number;
|
|
6518
|
+
/**
|
|
6519
|
+
* @description Array of validation error messages for session operations
|
|
6520
|
+
* @example [
|
|
6521
|
+
* "Transaction ID is required",
|
|
6522
|
+
* "User ID is required",
|
|
6523
|
+
* "Invalid status value",
|
|
6524
|
+
* "Trustpilot link must be a valid URL"
|
|
6525
|
+
* ]
|
|
6526
|
+
*/
|
|
6527
|
+
message: string[];
|
|
6528
|
+
/** @example Bad Request */
|
|
6529
|
+
error: string;
|
|
6530
|
+
};
|
|
6531
|
+
SessionInternalServerErrorDto: {
|
|
6532
|
+
/** @example 500 */
|
|
6533
|
+
statusCode: number;
|
|
6534
|
+
/**
|
|
6535
|
+
* @description An unexpected error occurred during session processing.
|
|
6536
|
+
* @example Error processing session data.
|
|
6537
|
+
*/
|
|
6538
|
+
message: string;
|
|
6539
|
+
/** @example Internal Server Error */
|
|
6540
|
+
error: string;
|
|
6541
|
+
};
|
|
6542
|
+
PatchSessionRequestDto: {
|
|
6543
|
+
/**
|
|
6544
|
+
* @description Trustpilot link
|
|
6545
|
+
* @example https://www.trustpilot.com/review/example.com
|
|
6546
|
+
*/
|
|
6547
|
+
trustpilotLink?: string;
|
|
6548
|
+
/**
|
|
6549
|
+
* @description Session status
|
|
6550
|
+
* @example completed
|
|
6551
|
+
* @enum {string}
|
|
6552
|
+
*/
|
|
6553
|
+
status?: "created" | "completed";
|
|
6554
|
+
};
|
|
6555
|
+
SessionNotFoundErrorDto: {
|
|
6556
|
+
/** @example 404 */
|
|
6557
|
+
statusCode: number;
|
|
6558
|
+
/**
|
|
6559
|
+
* @description Session with the specified criteria was not found
|
|
6560
|
+
* @example Session not found
|
|
6561
|
+
*/
|
|
6562
|
+
message: string;
|
|
6563
|
+
/** @example Not Found */
|
|
6564
|
+
error: string;
|
|
6565
|
+
};
|
|
6566
|
+
DataListResponseDto: {
|
|
6567
|
+
/** @description Array of sessions */
|
|
6568
|
+
data: {
|
|
6569
|
+
/** @example 1 */
|
|
6570
|
+
id?: number;
|
|
6571
|
+
/** @example 550e8400-e29b-41d4-a716-446655440000 */
|
|
6572
|
+
uuid?: string;
|
|
6573
|
+
/** @example txn_123456789 */
|
|
6574
|
+
transactionId?: string;
|
|
6575
|
+
/** @example user_123456789 */
|
|
6576
|
+
userId?: string;
|
|
6577
|
+
/** @example https://www.trustpilot.com/review/example.com */
|
|
6578
|
+
trustpilotLink?: string;
|
|
6579
|
+
/** @example https://jumptask.go2cloud.org/aff_lsr?transaction_id=txn_123456789&adv_sub=user_123456789 */
|
|
6580
|
+
postbackUrl?: string;
|
|
6581
|
+
/** @example created */
|
|
6582
|
+
status?: string;
|
|
6583
|
+
/** @example 2024-01-01T00:00:00.000Z */
|
|
6584
|
+
createdAt?: string;
|
|
6585
|
+
/** @example 2024-01-01T00:00:00.000Z */
|
|
6586
|
+
updatedAt?: string;
|
|
6587
|
+
}[];
|
|
6588
|
+
/**
|
|
6589
|
+
* @description Total count
|
|
6590
|
+
* @example 100
|
|
6591
|
+
*/
|
|
6592
|
+
total: number;
|
|
6593
|
+
/**
|
|
6594
|
+
* @description Current page
|
|
6595
|
+
* @example 1
|
|
6596
|
+
*/
|
|
6597
|
+
page: number;
|
|
6598
|
+
/**
|
|
6599
|
+
* @description Items per page
|
|
6600
|
+
* @example 10
|
|
6601
|
+
*/
|
|
6602
|
+
limit: number;
|
|
6603
|
+
};
|
|
6604
|
+
InternalServerErrorDto: {
|
|
6605
|
+
/** @example 500 */
|
|
6606
|
+
statusCode: number;
|
|
6607
|
+
/** @example Internal server error */
|
|
6608
|
+
message: string;
|
|
6609
|
+
/** @example Internal Server Error */
|
|
6610
|
+
error: string;
|
|
6611
|
+
};
|
|
3682
6612
|
};
|
|
3683
6613
|
responses: never;
|
|
3684
6614
|
parameters: never;
|
|
@@ -3721,6 +6651,8 @@ declare const server: {
|
|
|
3721
6651
|
};
|
|
3722
6652
|
session: {
|
|
3723
6653
|
get: (uuid: string) => Promise<components["schemas"]["SessionResponseDto"]>;
|
|
6654
|
+
append: (uuid: string, body: components["schemas"]["AppendSessionDto"]) => Promise<components["schemas"]["SessionResponseDto"]>;
|
|
6655
|
+
getByEmail: (email: string) => Promise<components["schemas"]["SessionResponseDto"]>;
|
|
3724
6656
|
};
|
|
3725
6657
|
capi: {
|
|
3726
6658
|
snapchat: (data: components["schemas"]["SnapchatCapiBridgeDto"]) => Promise<{
|