-
Notifications
You must be signed in to change notification settings - Fork 755
/
Copy pathtransfers_2024-06-01.json
712 lines (712 loc) · 25.3 KB
/
transfers_2024-06-01.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
{
"swagger": "2.0",
"info": {
"title": "The Selling Partner API for Transfers.",
"description": "The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.",
"version": "2024-06-01",
"contact": {
"name": "Selling Partner API Developer Support",
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
},
"license": {
"name": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"host": "sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/finances/transfers/2024-06-01/payouts": {
"post": {
"description": "Initiates an on-demand payout to the seller's default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.017 | 2 |\n\nThe `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "initiatePayout",
"parameters": [
{
"name": "body",
"in": "body",
"description": "The request body for the `initiatePayout` operation.",
"required": true,
"schema": {
"$ref": "#/definitions/InitiatePayoutRequest"
}
}
],
"responses": {
"200": {
"description": "Success.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/InitiatePayoutResponse"
},
"examples": {
"application/json": {
"payoutReferenceId": "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3AD2Lgc"
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"marketplaceId": "A1PA6795UKMFR9",
"accountType": "Standard Orders"
}
}
}
},
"response": {
"payoutReferenceId": "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3AD2Lgc"
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
},
"examples": {
"application/json": {
"errors": [
{
"code": "NoDepositMethod",
"message": "No deposit method found for the selling partner. Add a valid deposit method and try again."
}
]
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"marketplaceId": "A1F83G8C2ARO7P",
"accountType": "Standard Orders"
}
}
}
},
"response": {
"errors": [
{
"code": "NoDepositMethod",
"message": "No deposit method found for the selling partner. Add a valid deposit method and try again."
},
{
"code": "InsufficientPayoutAmount",
"message": "The available balance is less than the minimum permissible payout amount. No payout will be initiated."
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/finances/transfers/2024-06-01/paymentMethods": {
"get": {
"description": "Returns the list of payment methods for the seller, which can be filtered by method type.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| .5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getPaymentMethods",
"parameters": [
{
"name": "marketplaceId",
"in": "query",
"required": true,
"description": "The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).",
"type": "string",
"x-example": "ATVPDKIKX0DER"
},
{
"name": "paymentMethodTypes",
"in": "query",
"required": false,
"description": "A comma-separated list of the payment method types you want to include in the response.",
"type": "array",
"items": {
"type": "string",
"enum": [
"BANK_ACCOUNT",
"CARD",
"SELLER_WALLET"
],
"x-docgen-enum-table-extension": [
{
"value": "BANK_ACCOUNT",
"description": "The payment is from a bank account."
},
{
"value": "CARD",
"description": "The payment is from a card."
},
{
"value": "SELLER_WALLET",
"description": "The payment is from a [Seller Wallet](https://sell.amazon.com/tools/seller-wallet) virtual bank account."
}
]
},
"collectionFormat": "csv",
"minItems": 1,
"uniqueItems": true,
"x-example": "BANK_ACCOUNT,CARD"
}
],
"responses": {
"200": {
"description": "Success.",
"schema": {
"$ref": "#/definitions/GetPaymentMethodsResponse"
},
"examples": {
"application/json": {
"paymentMethods": [
{
"accountHolderName": "John Doe",
"paymentMethodId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentMethodType": "BANK_ACCOUNT",
"tail": "677",
"assignmentType": "DEFAULT_DEPOSIT_METHOD"
},
{
"countryCode": "US",
"accountHolderName": "John Doe",
"paymentMethodId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentMethodType": "CARD",
"expiryDate": {
"month": "3",
"year": "2029"
},
"tail": "677"
}
]
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"marketplaceId": {
"value": "ATVPDKIKX0DER"
}
}
},
"response": {
"paymentMethods": [
{
"countryCode": "US",
"accountHolderName": "John Doe",
"paymentMethodId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentMethodType": "BANK_ACCOUNT",
"tail": "677"
}
]
}
}
]
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
},
"examples": {
"application/json": {
"errors": [
{
"code": "InvalidInput",
"message": "Validation failed for obfuscatedId:ACUULBDVZHYZ1"
}
]
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"marketplaceId": {
"value": "ABCMARKET"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Validation failed for: ABCMARKET"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
}
},
"definitions": {
"InitiatePayoutRequest": {
"type": "object",
"required": [
"marketplaceId",
"accountType"
],
"properties": {
"marketplaceId": {
"description": "The identifier of the Amazon marketplace. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE. For a list of possible marketplace IDs, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).",
"$ref": "#/definitions/MarketplaceId"
},
"accountType": {
"description": "The account type in the selected marketplace for which a payout must be initiated. For supported EU marketplaces, the only account type is `Standard Orders`.",
"type": "string"
}
},
"description": "The request schema for the `initiatePayout` operation.",
"example": {
"marketplaceId": "APJ6JRA9NG5V4",
"accountType": "Standard Orders"
}
},
"InitiatePayoutResponse": {
"type": "object",
"required": [
"payoutReferenceId"
],
"properties": {
"payoutReferenceId": {
"description": "The financial event group ID for a successfully initiated payout. You can use this ID to track payout information.",
"type": "string"
}
},
"description": "The response schema for the `initiatePayout` operation.",
"example": {
"payoutReferenceId": "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3AD2Lgc"
}
},
"GetPaymentMethodsResponse": {
"description": "The response schema for the `getPaymentMethods` operation.",
"type": "object",
"example": {
"paymentMethods": [
{
"accountHolderName": "John Doe",
"paymentMethodId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentMethodType": "BANK_ACCOUNT",
"tail": "677",
"assignmentType": "DEFAULT_DEPOSIT_METHOD"
},
{
"countryCode": "US",
"accountHolderName": "John Doe",
"paymentMethodId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentMethodType": "CARD",
"expiryDate": {
"month": "3",
"year": "2029"
},
"tail": "677"
}
]
},
"properties": {
"paymentMethods": {
"$ref": "#/definitions/PaymentMethodList"
}
}
},
"PaymentMethodList": {
"description": "The list of payment methods with payment method details.",
"type": "array",
"items": {
"$ref": "#/definitions/PaymentMethodDetails"
}
},
"PaymentMethodDetails": {
"description": "The details of a payment method.",
"type": "object",
"properties": {
"accountHolderName": {
"description": "The name of the account holder who is registered for the payment method.",
"type": "string"
},
"paymentMethodId": {
"description": "The payment method identifier.",
"type": "string",
"example": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d"
},
"tail": {
"description": "The last three or four digits of the payment method.",
"type": "string",
"example": "321"
},
"expiryDate": {
"description": "The expiration date of the card used for payment.",
"$ref": "#/definitions/ExpiryDate"
},
"countryCode": {
"description": "The two-letter country code in ISO 3166-1 alpha-2 format. For payment methods in the `card` category, the code is for the country where the card was issued. For payment methods in the `bank account` category, the code is for the country where the account is located.",
"type": "string",
"example": "US"
},
"paymentMethodType": {
"description": "The payment method type.",
"$ref": "#/definitions/PaymentMethodType"
},
"assignmentType": {
"description": "The payment method assignment type, whether it is assigned as default to the given marketplace or not.",
"$ref": "#/definitions/AssignmentType"
}
}
},
"ExpiryDate": {
"description": "The expiration date of the card used for payment. If the payment method is not `card`, the expiration date is `null`.",
"type": "object",
"properties": {
"month": {
"description": "The month the card expires expressed as a number from `1` to `12`.",
"type": "string",
"example": "3"
},
"year": {
"description": "Year",
"type": "string",
"example": "2024"
}
}
},
"PaymentMethodTypeList": {
"type": "array",
"example": [
"BANK_ACCOUNT, CARD"
],
"description": "The list of payment method types that are present.",
"items": {
"$ref": "#/definitions/PaymentMethodType"
}
},
"PaymentMethodType": {
"description": "The type of payment method.",
"type": "string",
"enum": [
"BANK_ACCOUNT",
"CARD",
"SELLER_WALLET"
],
"x-docgen-enum-table-extension": [
{
"value": "BANK_ACCOUNT",
"description": "The payment is from a bank account."
},
{
"value": "CARD",
"description": "The payment is from a card."
},
{
"value": "SELLER_WALLET",
"description": "The payment is from a [Seller Wallet](https://sell.amazon.com/tools/seller-wallet) virtual bank account."
}
]
},
"AssignmentType": {
"description": "The default payment method type.",
"type": "string",
"enum": [
"DEFAULT_DEPOSIT_METHOD"
],
"x-docgen-enum-table-extension": [
{
"value": "DEFAULT_DEPOSIT_METHOD",
"description": "The default deposit method."
}
]
},
"MarketplaceId": {
"description": "The identifier of the Amazon marketplace. For the list of all marketplace IDs, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).",
"type": "string",
"example": "A1PA6795UKMFR9"
},
"ErrorList": {
"type": "object",
"description": "A list of error responses returned when a request is unsuccessful.",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"description": "array of errors",
"items": {
"$ref": "#/definitions/Error"
},
"example": [
{
"code": "InvalidInput",
"message": "The input request had one or more invalid input parameters."
}
]
}
}
},
"Error": {
"description": "Error response returned when the request is unsuccessful.",
"properties": {
"code": {
"description": "An error code that identifies the type of error that occurred.",
"type": "string",
"example": "InvalidInput"
},
"message": {
"description": "A message that describes the error condition.",
"type": "string",
"example": "The input request had one or more invalid input parameters."
},
"details": {
"description": "Additional details that can help the caller understand or fix the issue.",
"type": "string",
"example": "The following input parameters are invalid : [ marketplaceId ]."
}
},
"required": [
"code",
"message"
],
"type": "object",
"example": {
"code": "InvalidInput",
"message": "The input request had one or more invalid input parameters."
}
}
}
}