{ "openapi": "3.0.1", "info": { "title": "The Selling Partner API for Amazon Seller Wallet Open Banking API Spec.\n\nFor more information, refer to the [Seller Wallet Open Banking API Use Case Guide](doc:seller-wallet-open-banking-api-v2024-03-01-use-case-guide).", "description": "The Selling Partner API for Seller Wallet (Seller Wallet API) provides financial information that is relevant to a seller's Seller Wallet account. You can obtain financial events, balances, and transfer schedules for Seller Wallet accounts. You can also schedule and initiate transactions.", "termsOfService": "http://spectrum.Amazon.com/terms/", "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" }, "version": "2024-03-01" }, "servers": [ { "url": "https://sellingpartnerapi-na.amazon.com/" } ], "tags": [ { "name": "Accounts", "description": "Everything about Amazon SW customer accounts" }, { "name": "Transfer Preview", "description": "Access to all transfers with fees and the final amount with FX details in Amazon SW" }, { "name": "Transactions", "description": "Access to all transactions in Amazon SW account" }, { "name": "Transfer Schedule", "description": "Access to all transfer schedules in Amazon SW account" } ], "paths": { "/finances/transfers/wallet/2024-03-01/accounts": { "get": { "tags": [ "SellerWalletV20240301" ], "summary": "Get all Amazon SW accounts for the seller", "description": "Get Seller Wallet accounts for a seller.", "operationId": "listAccounts", "parameters": [ { "name": "marketplaceId", "in": "query", "description": "A marketplace identifier. Specifies the marketplace for which items are returned.", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountListing" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "marketplaceIdCase200" } } }, "response": { "accounts": [ { "accountId": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ", "bankAccountNumberFormat": "BBAN", "bankName": "Amazon Seller Wallet", "bankAccountOwnershipType": "SELF", "routingNumber": "000000000", "bankNumberFormat": "BASIC", "accountCountryCode": "US", "accountCurrency": "USD", "bankAccountNumberTail": "000", "bankAccountHolderStatus": "ACTIVE" } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "marketplaceIdCase400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing digitalSignature.", "details": "Digital Signature is missing for the request" }, { "code": "InvalidInput", "message": "Invalid or Missing wacCertificate.", "details": "WAC Certificate is missing for the request" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "marketplaceIdCase403" } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "marketplaceIdCase404" } } }, "response": { "errors": [ { "code": "NotFound", "message": "BankAccount not found.", "details": "BankAccount doesn't exists for USMarketplace" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "marketplaceIdCase408" } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond within given SLA" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "marketplaceIdCase429" } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server Throttled Request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "marketplaceIdCase500" } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "marketplaceIdCase503" } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } } } }, "/finances/transfers/wallet/2024-03-01/accounts/{accountId}": { "get": { "tags": [ "SellerWalletV20240301" ], "summary": "Find particular Amazon SW account by Amazon account identifier", "description": "Retrieve a Seller Wallet bank account by Amazon account identifier.", "operationId": "getAccount", "parameters": [ { "name": "accountId", "in": "path", "description": "ID of the Amazon SW account", "required": true, "schema": { "type": "string" }, "example": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccount" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase200" }, "marketplaceId": { "value": "A1RKKUPIHCS9HS" } } }, "response": { "accountId": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ", "bankAccountNumberFormat": "BBAN", "bankName": "Amazon Seller Wallet", "bankAccountOwnershipType": "SELF", "routingNumber": "000000000", "bankNumberFormat": "BASIC", "accountCountryCode": "US", "accountCurrency": "USD", "bankAccountNumberTail": "000", "bankAccountHolderStatus": "ACTIVE" } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing digitalSignature.", "details": "Digital Signature is missing for the request" }, { "code": "InvalidInput", "message": "Invalid or Missing wacCertificate.", "details": "WAC certificate is missing for the request" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase403" } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase404" } } }, "response": { "errors": [ { "code": "NotFound", "message": "BankAccount not found.", "details": "BankAccount doesn't exists for InvalidAccountId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase408" } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond within given SLA" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase429" } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server Throttled Request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase500" } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase503" } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } } } }, "/finances/transfers/wallet/2024-03-01/accounts/{accountId}/balance": { "get": { "tags": [ "SellerWalletV20240301" ], "summary": "Find balance in particular Amazon SW account by Amazon account identifier", "description": "Retrieve the balance in a given Seller Wallet bank account.", "operationId": "listAccountBalances", "parameters": [ { "name": "accountId", "in": "path", "description": "ID of the Amazon SW account", "required": true, "schema": { "type": "string" }, "example": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceListing" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase200" }, "marketplaceId": { "value": "A1RKKUPIHCS9HS" } } }, "response": { "balances": [ { "accountId": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ", "balanceType": "AVAILABLE", "balanceAmount": 123.45, "balanceCurrency": "USD", "lastUpdateDate": "2024-03-01T10:30:00Z" }, { "accountId": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ", "balanceType": "LOCKED_IN", "balanceAmount": 500, "balanceCurrency": "USD", "lastUpdateDate": "2024-03-01T10:30:00Z" }, { "accountId": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ", "balanceType": "TOTAL", "balanceAmount": 623.45, "balanceCurrency": "USD", "lastUpdateDate": "2024-03-01T10:30:00Z" } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing wacCertificate.", "details": "WAC certificate is missing for the request" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase403" } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase404" } } }, "response": { "errors": [ { "code": "NotFound", "message": "BankAccount not found.", "details": "BankAccount doesn't exists for InvalidAccountId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase408" } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond within given SLA" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase429" } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server Throttled Request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase500" } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "accountIdCase503" } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } } } }, "/finances/transfers/wallet/2024-03-01/transferPreview": { "get": { "tags": [ "SellerWalletV20240301" ], "summary": "Fetch potential fees that could be applied on a transaction on the basis of the source and destination country currency code", "description": "Returns list of potential fees on a transaction based on the source and destination country currency code", "operationId": "getTransferPreview", "parameters": [ { "name": "sourceCountryCode", "in": "query", "description": "Represents 2 character country code of source transaction account in ISO 3166 standard format.", "required": true, "schema": { "type": "string" }, "example": "US" }, { "name": "sourceCurrencyCode", "in": "query", "description": "Represents 3 letter currency code in ISO 4217 standard format of the source transaction country.", "required": true, "schema": { "type": "string" }, "example": "USD" }, { "name": "destinationCountryCode", "in": "query", "description": "Represents 2 character country code of destination transaction account in ISO 3166 standard format.", "required": true, "schema": { "type": "string" }, "example": "FR" }, { "name": "destinationCurrencyCode", "in": "query", "description": "Represents 3 letter currency code in ISO 4217 standard format of the destination transaction country.", "required": true, "schema": { "type": "string" }, "example": "EUR" }, { "name": "baseAmount", "in": "query", "description": "Represents the base transaction amount without any markup fees, rates that will be used to get the transfer preview.", "required": true, "schema": { "type": "number" }, "example": 1000 }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferRatePreview" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "sourceCountryCode": { "value": "EU" }, "sourceCurrencyCode": { "value": "EUR" }, "destinationCountryCode": { "value": "CN" }, "destinationCurrencyCode": { "value": "CNY" }, "baseAmount": { "value": 500 }, "marketplaceId": { "value": "A1RKKUPIHCS9HS" } } }, "response": { "baseAmount": { "currencyCode": "EUR", "currencyAmount": 500 }, "fxRateDetails": { "fxRateId": "UNIQUE_FX_RATE_ID_1", "baseRate": 7.6915, "effectiveFxRate": 7.6084, "rateDirection": "BUY" }, "transferAmount": { "currencyCode": "CNY", "currencyAmount": 3804.2 }, "fees": [ { "feeId": "Unique_FeeId_001", "feeType": "TRANSACTION_FEE", "feeRateValue": "0.9", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 4.5 } }, { "feeId": "Unique_FeeId_002", "feeType": "TAX", "feeRateValue": "20.0", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 0.9 } } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "sourceCountryCode": { "value": "AP" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing Input Parameter.", "details": "Invalid sourceCountryCode" }, { "code": "InvalidInput", "message": "Invalid or Missing Input Parameter.", "details": "Missing destinationCurrencyCode" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "sourceCountryCode": { "value": "US" }, "destinationCountryCode": { "value": "US" } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "sourceCountryCode": { "value": "US" }, "sourceCurrencyCode": { "value": "USD" }, "destinationCountryCode": { "value": "US" }, "destinationCurrencyCode": { "value": "USD" } } }, "response": { "errors": [ { "code": "NotFound", "message": "BankAccount not found.", "details": "BankAccount doesn't exists for InvalidAccountId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "sourceCountryCode": { "value": "US" }, "destinationCountryCode": { "value": "HK" } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond in time" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "sourceCountryCode": { "value": "HK" }, "destinationCountryCode": { "value": "HK" } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server throttled the request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "sourceCountryCode": { "value": "EU" }, "destinationCountryCode": { "value": "EU" } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "sourceCountryCode": { "value": "CN" }, "destinationCountryCode": { "value": "CN" } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } } } }, "/finances/transfers/wallet/2024-03-01/transactions": { "get": { "tags": [ "SellerWalletV20240301" ], "summary": "The API will return all the transactions for a given Amazon SW account sorted by the transaction request date", "description": "Retrieve a list of transactions for a given Seller Wallet bank account.", "operationId": "listAccountTransactions", "parameters": [ { "name": "accountId", "in": "query", "description": "ID of the Amazon SW account", "required": true, "schema": { "type": "string" }, "example": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ" }, { "name": "nextPageToken", "in": "query", "description": "Pagination token to retrieve a specific page of results.", "schema": { "type": "string" }, "example": "Next Page Token" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionListing" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase200" }, "marketplaceId": { "value": "A1RKKUPIHCS9HS" } } }, "response": { "nextPageToken": "3493805734095308457308475", "transactions": [ { "accountId": "amzn1.account.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "transactionId": "amzn.transaction.AKJBNEFNL23R84V", "transactionType": "DEBIT", "transactionStatus": "IN_PROGRESS", "transactionRequestDate": "2023-09-26T02:32:59.787Z", "expectedCompletionDate": "2023-09-26T02:32:59.787Z", "transactionActualCompletionDate": "2023-09-26T02:32:59.787Z", "lastUpdateDate": "2023-09-26T02:32:59.787Z", "requesterName": "TppOrgId", "transactionRequesterSource": "TPP", "transactionDescription": "Test transaction request", "transactionSourceAccount": { "accountId": "sourceAccountIdCase200", "bankAccountHolderName": "John Doe", "bankName": "Amazon Seller Wallet", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "123", "bankAccountCurrency": "GBP" }, "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "UK" }, "transactionRequestAmount": { "currencyCode": "EUR", "currencyAmount": 500 }, "transferRateDetails": { "baseAmount": { "currencyCode": "EUR", "currencyAmount": 500 }, "fxRateDetails": { "fxRateId": "UNIQUE_FX_RATE_ID_1", "baseRate": 7.6915, "effectiveFxRate": 7.6084, "rateDirection": "BUY" }, "transferAmount": { "currencyCode": "CNY", "currencyAmount": 3804.2 }, "fees": [ { "feeId": "Unique_FeeId_001", "feeType": "TRANSACTION_FEE", "feeRateValue": "0.9", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 4.5 } }, { "feeId": "Unique_FeeId_002", "feeType": "TAX", "feeRateValue": "20.0", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 0.9 } } ] }, "transactionFinalAmount": { "currencyCode": "CNY", "currencyAmount": 3804.2 } } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing wacCertificate.", "details": "WAC certificate is missing for the request" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase403" } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase404" } } }, "response": { "errors": [ { "code": "NotFound", "message": "BankAccount not found.", "details": "BankAccount doesn't exists for InvalidAccountId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase408" } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond in time" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase429" } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server throttled the request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase500" } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase503" } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } } }, "post": { "tags": [ "SellerWalletV20240301" ], "summary": "Create a transaction request from Amazon SW account to another customer provided account", "description": "Create a transaction request from a Seller Wallet account to another customer-provided account.", "operationId": "createTransaction", "parameters": [ { "name": "destAccountDigitalSignature", "in": "header", "description": "Digital signature for the destination bank account details. For more information, refer to [Third-Party Provider Signature Guidance](https://developer-docs.amazon.com/sp-api/docs/tpp-registration-signature-guidance).", "required": true, "schema": { "type": "string" }, "example": "U8AsRXdh5fvjozFIv6vRUal1EHdFHhrCArIgmWbPtW0HuTlN_LPteg8G8tbvF4QmoRekOO84nQxg8j4gs0wEyAktg2Sm80a_FaTswv-U8XUXGHZ1UBagGD9zEPrGBbia_N5gm4fCOW-V3mSieblwBiUyq8frUYL606WtuStHtE3zJgaj9-B1ObhudxxQALuBKjPeksc7-qyrT8lwchdkiaprNwsqpv3aKid7Ux3uwEzxiEedO3QWvv6nCZnNNxK-zz2Zj6tPDE_mgQk5tJv4xRgMxtcTMmr7_ce4A9wqRxQqwBerIHpOIzpZizmXAG56uG8-hJojmPwnsPif7ihMuw" }, { "name": "amountDigitalSignature", "in": "header", "description": "Digital signature for the source currency transaction amount. Sign in the order of the request definitions. You can omit empty or optional fields. For more information, refer to [Third-Party Provider Signature Guidance](https://developer-docs.amazon.com/sp-api/docs/tpp-registration-signature-guidance).", "required": true, "schema": { "type": "string" }, "example": "1EHdFHhrCArIgmWbPtW0HuTlN_LPteg8G8tbvF4QmoRekOO84nQxg8j4gs0wEyAktg2Sm80a_FaTswv-U8XUXGHZ1UBagGD9zEPrGBbia_N5gm4fCOW-qyrT8lwchdkiaprNwsqpv3aKid7Ux3uwEzxiEedO3QWvv6nCZnNNxK-zz2Zj6tPDE_mgQk5tJv4xRgMxtcTMmr7" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "requestBody": { "description": "Defines the actual payload of the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionInitiationRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransactionResponse" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "A1RKKUPIHCS9HS" }, "body": { "value": { "sourceAccountId": "sourceAccountIdCase200", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankName": "Royal Bank of Scotland", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "RBOSGB2L", "bankNumberFormat": "BASIC", "accountCountryCode": "GB", "accountCurrency": "GBP", "bankAccountNumberTail": "819" }, "accountHolderName": "John Doe", "bankAccountNumber": "GB29RBOS60161331926819" }, "transactionDescription": "BG999999999", "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "sourceAmount": { "currencyCode": "EUR", "currencyAmount": 1000 }, "requestTime": "2023-09-26T01:21:53.002Z" } } } }, "response": { "transaction": { "accountId": "amzn1.account.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "transactionId": "amzn.transaction.ALNR19JCVWLN3E", "transactionType": "DEBIT", "transactionStatus": "IN_PROGRESS", "transactionRequestDate": "2023-09-26T02:32:59.787Z", "expectedCompletionDate": "2023-09-26T02:32:59.787Z", "transactionActualCompletionDate": "2023-09-30T02:32:59.787Z", "lastUpdateDate": "2023-09-26T02:32:59.787Z", "requesterName": "TppOrgId", "transactionRequesterSource": "TPP", "transactionDescription": "Test transaction request", "transactionSourceAccount": { "accountId": "sourceAccountIdCase200", "bankAccountHolderName": "John Doe", "bankName": "Amazon Seller Wallet", "bankAccountNumberFormat": "IBAN", "bankAccountCurrency": "GBP" }, "transactionDestinationAccount": { "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transactionRequestAmount": { "currencyCode": "EUR", "currencyAmount": 500 }, "transferRateDetails": { "baseAmount": { "currencyCode": "EUR", "currencyAmount": 500 }, "fxRateDetails": { "fxRateId": "UNIQUE_FX_RATE_ID_1", "baseRate": 7.6915, "effectiveFxRate": 7.6084, "rateDirection": "BUY" }, "transferAmount": { "currencyCode": "CNY", "currencyAmount": 3804.2 }, "fees": [ { "feeId": "Unique_FeeId_001", "feeType": "TRANSACTION_FEE", "feeRateValue": "0.9", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 4.5 } }, { "feeId": "Unique_FeeId_002", "feeType": "TAX", "feeRateValue": "20.0", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 0.9 } } ] }, "transactionFinalAmount": { "currencyCode": "CNY", "currencyAmount": 3804.2 } }, "callBackURL": "https://www.example.com/callback/transaction_id" } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase400", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankName": "Royal Bank of Scotland", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "RBOSGB2L", "bankNumberFormat": "BASIC", "accountCountryCode": "GB", "accountCurrency": "GBP", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "sourceAmount": { "currencyCode": "EUR", "currencyAmount": 1000 }, "requestTime": "2023-09-26T01:21:53.002Z" } } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing signature.", "details": "Missing addressDigitalSignature" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase403", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankName": "Royal Bank of Scotland", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "RBOSGB2L", "bankNumberFormat": "BASIC", "accountCountryCode": "GB", "accountCurrency": "GBP", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "sourceAmount": { "currencyCode": "EUR", "currencyAmount": 1000 }, "requestTime": "2023-09-26T01:21:53.002Z" } } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase404", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankName": "Royal Bank of Scotland", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "RBOSGB2L", "bankNumberFormat": "BASIC", "accountCountryCode": "GB", "accountCurrency": "GBP", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "sourceAmount": { "currencyCode": "EUR", "currencyAmount": 1000 }, "requestTime": "2023-09-26T01:21:53.002Z" } } } }, "response": { "errors": [ { "code": "NotFound", "message": "BankAccount not found.", "details": "BankAccount doesn't exists for invalid SourceAccountId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase408", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankName": "Royal Bank of Scotland", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "RBOSGB2L", "bankNumberFormat": "BASIC", "accountCountryCode": "GB", "accountCurrency": "GBP", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "sourceAmount": { "currencyCode": "EUR", "currencyAmount": 1000 }, "requestTime": "2023-09-26T01:21:53.002Z" } } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond in time" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "422": { "description": "The request was well-formed (i.e., syntactically correct) but could not be processed because of some restrictions like insufficient funds, transaction limit breach, etc.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase422", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankName": "Royal Bank of Scotland", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "RBOSGB2L", "bankNumberFormat": "BASIC", "accountCountryCode": "GB", "accountCurrency": "GBP", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "sourceAmount": { "currencyCode": "EUR", "currencyAmount": 1000 }, "requestTime": "2023-09-26T01:21:53.002Z" } } } }, "response": { "errors": [ { "code": "InsufficientBalance", "message": "Insufficient Balance", "details": "Insufficient Balance" } ] } } ] } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase429", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankName": "Royal Bank of Scotland", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "RBOSGB2L", "bankNumberFormat": "BASIC", "accountCountryCode": "GB", "accountCurrency": "GBP", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "sourceAmount": { "currencyCode": "EUR", "currencyAmount": 1000 }, "requestTime": "2023-09-26T01:21:53.002Z" } } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server throttled the request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase500", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankName": "Royal Bank of Scotland", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "RBOSGB2L", "bankNumberFormat": "BASIC", "accountCountryCode": "GB", "accountCurrency": "GBP", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "sourceAmount": { "currencyCode": "EUR", "currencyAmount": 1000 }, "requestTime": "2023-09-26T01:21:53.002Z" } } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase503", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankName": "Royal Bank of Scotland", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "RBOSGB2L", "bankNumberFormat": "BASIC", "accountCountryCode": "GB", "accountCurrency": "GBP", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "sourceAmount": { "currencyCode": "EUR", "currencyAmount": 1000 }, "requestTime": "2023-09-26T01:21:53.002Z" } } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } }, "x-codegen-request-body-name": "body" } }, "/finances/transfers/wallet/2024-03-01/transactions/{transactionId}": { "get": { "tags": [ "SellerWalletV20240301" ], "summary": "Find particular Amazon SW account transaction by Amazon transaction identifier", "description": "Returns a transaction", "operationId": "getTransaction", "parameters": [ { "name": "transactionId", "in": "path", "description": "ID of the Amazon SW transaction", "required": true, "schema": { "type": "string" }, "example": "amzn1.transaction.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transactionId": { "value": "transactionIdCase200" }, "marketplaceId": { "value": "A1RKKUPIHCS9HS" } } }, "response": { "accountId": "amzn1.account.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "transactionId": "amzn.transaction.AKJBNEFNL23R84V", "transactionType": "DEBIT", "transactionStatus": "IN_PROGRESS", "transactionRequestDate": "2023-09-26T02:32:59.787Z", "expectedCompletionDate": "2023-09-26T02:32:59.787Z", "transactionActualCompletionDate": "2023-09-26T02:32:59.787Z", "lastUpdateDate": "2023-09-26T02:32:59.787Z", "requesterName": "TppOrgId", "transactionRequesterSource": "TPP", "transactionDescription": "Test transaction request", "transactionSourceAccount": { "accountId": "sourceAccountIdCase200", "bankAccountHolderName": "John Doe", "bankName": "Amazon Seller Wallet", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "123", "bankAccountCurrency": "GBP" }, "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transactionRequestAmount": { "currencyCode": "EUR", "currencyAmount": 500 }, "transferRateDetails": { "baseAmount": { "currencyCode": "EUR", "currencyAmount": 500 }, "fxRateDetails": { "fxRateId": "UNIQUE_FX_RATE_ID_1", "baseRate": 7.6915, "effectiveFxRate": 7.6084, "rateDirection": "BUY" }, "transferAmount": { "currencyCode": "CNY", "currencyAmount": 3804.2 }, "fees": [ { "feeId": "Unique_FeeId_001", "feeType": "TRANSACTION_FEE", "feeRateValue": "0.9", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 4.5 } }, { "feeId": "Unique_FeeId_002", "feeType": "TAX", "feeRateValue": "20.0", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 0.9 } } ] }, "transactionFinalAmount": { "currencyCode": "CNY", "currencyAmount": 3804.2 } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transactionId": { "value": "transactionIdCase400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing wacCertificate.", "details": "WAC certificate is missing for the request" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transactionId": { "value": "transactionIdCase403" } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transactionId": { "value": "transactionIdCase404" } } }, "response": { "errors": [ { "code": "NotFound", "message": "BankAccount not found.", "details": "BankAccount doesn't exists for InvalidAccountId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transactionId": { "value": "transactionIdCase408" } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond in time" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transactionId": { "value": "transactionIdCase429" } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server throttled the request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transactionId": { "value": "transactionIdCase500" } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transactionId": { "value": "transactionIdCase503" } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } } } }, "/finances/transfers/wallet/2024-03-01/transferSchedules": { "get": { "tags": [ "SellerWalletV20240301" ], "summary": "The API will return all the transfer schedules for a given Amazon SW account", "description": "Retrieve transfer schedules of a Seller Wallet bank account.", "operationId": "listTransferSchedules", "parameters": [ { "name": "accountId", "in": "query", "description": "ID of the Amazon SW account", "required": true, "schema": { "type": "string" }, "example": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" }, { "name": "nextPageToken", "in": "query", "description": "Pagination token to retrieve a specific page of results.", "schema": { "type": "string" }, "example": "Next Page Token" } ], "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferScheduleListing" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase200" }, "marketplaceId": { "value": "A1RKKUPIHCS9HS" } } }, "response": { "nextPageToken": "3493805734095308457308475", "transferSchedules": [ { "transferScheduleId": "amzn1.transferschedule.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "transactionType": "DEBIT", "transactionSourceAccount": { "accountId": "sourceAccountIdCase200", "bankAccountHolderName": "John Doe", "bankName": "Amazon Seller Wallet", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "123", "bankAccountCurrency": "GBP" }, "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing wacCertificate.", "details": "WAC certificate is missing for the request" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase403" } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase404" } } }, "response": { "errors": [ { "code": "NotFound", "message": "Account not found.", "details": "Account doesn't exists for InvalidAccountId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase408" } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond in time" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase429" } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server throttled the request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase500" } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "accountId": { "value": "sourceAccountIdCase503" } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } } }, "put": { "tags": [ "SellerWalletV20240301" ], "summary": "Update a transfer schedule information. Only fields (i.e; transferScheduleInformation, paymentPreference, transferScheduleStatus) in the request body can be updated.", "description": "Returns a transfer belonging to the updated scheduled transfer request", "operationId": "updateTransferSchedule", "parameters": [ { "name": "destAccountDigitalSignature", "in": "header", "description": "Digital signature for the destination bank account details.", "required": true, "schema": { "type": "string" }, "example": "U8AsRXdh5fvjozFIv6vRUal1EHdFHhrCArIgmWbPtW0HuTlN_LPteg8G8tbvF4QmoRekOO84nQxg8j4gs0wEyAktg2Sm80a_FaTswv-U8XUXGHZ1UBagGD9zEPrGBbia_N5gm4fCOW-V3mSieblwBiUyq8frUYL606WtuStHtE3zJgaj9-B1ObhudxxQALuBKjPeksc7-qyrT8lwchdkiaprNwsqpv3aKid7Ux3uwEzxiEedO3QWvv6nCZnNNxK-zz2Zj6tPDE_mgQk5tJv4xRgMxtcTMmr7_ce4A9wqRxQqwBerIHpOIzpZizmXAG56uG8-hJojmPwnsPif7ihMuw" }, { "name": "amountDigitalSignature", "in": "header", "description": "Digital signature for the source currency transaction amount.", "required": true, "schema": { "type": "string" }, "example": "1EHdFHhrCArIgmWbPtW0HuTlN_LPteg8G8tbvF4QmoRekOO84nQxg8j4gs0wEyAktg2Sm80a_FaTswv-U8XUXGHZ1UBagGD9zEPrGBbia_N5gm4fCOW-qyrT8lwchdkiaprNwsqpv3aKid7Ux3uwEzxiEedO3QWvv6nCZnNNxK-zz2Zj6tPDE_mgQk5tJv4xRgMxtcTMmr7" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "requestBody": { "description": "Defines the actual payload of the scheduled transfer request that is to be updated.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferSchedule" } } }, "required": true }, "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferSchedule" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "A1RKKUPIHCS9HS" }, "body": { "value": { "transferScheduleId": "transferScheduleIdCase200", "transactionType": "DEBIT", "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } } }, "response": { "transferScheduleId": "amzn1.transferschedule.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "transactionType": "DEBIT", "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "transferScheduleId": "transferScheduleIdCase400", "transactionType": "DEBIT", "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing signature.", "details": "Missing addressDigitalSignature" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "transferScheduleId": "transferScheduleIdCase403", "transactionType": "DEBIT", "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid request.", "details": "Request body provided is invalid." } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "transferScheduleId": "transferScheduleIdCase404", "transactionType": "DEBIT", "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } } }, "response": { "errors": [ { "code": "NotFound", "message": "Transfer Schedule not found.", "details": "Transfer schedule id doesn't exists for invalid TransferScheduleId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "transferScheduleId": "transferScheduleIdCase408", "transactionType": "DEBIT", "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond in time" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "transferScheduleId": "transferScheduleIdCase429", "transactionType": "DEBIT", "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server throttled the request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "transferScheduleId": "transferScheduleIdCase500", "transactionType": "DEBIT", "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "transferScheduleId": "transferScheduleIdCase503", "transactionType": "DEBIT", "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } }, "x-codegen-request-body-name": "body" }, "post": { "tags": [ "SellerWalletV20240301" ], "summary": "Create a transfer schedule request from Amazon SW account to another customer provided account", "description": "Create a transfer schedule request from a Seller Wallet account to another customer-provided account.", "operationId": "createTransferSchedule", "parameters": [ { "name": "destAccountDigitalSignature", "in": "header", "description": "Digital signature for the destination bank account details.", "required": true, "schema": { "type": "string" }, "example": "U8AsRXdh5fvjozFIv6vRUal1EHdFHhrCArIgmWbPtW0HuTlN_LPteg8G8tbvF4QmoRekOO84nQxg8j4gs0wEyAktg2Sm80a_FaTswv-U8XUXGHZ1UBagGD9zEPrGBbia_N5gm4fCOW-V3mSieblwBiUyq8frUYL606WtuStHtE3zJgaj9-B1ObhudxxQALuBKjPeksc7-qyrT8lwchdkiaprNwsqpv3aKid7Ux3uwEzxiEedO3QWvv6nCZnNNxK-zz2Zj6tPDE_mgQk5tJv4xRgMxtcTMmr7_ce4A9wqRxQqwBerIHpOIzpZizmXAG56uG8-hJojmPwnsPif7ihMuw" }, { "name": "amountDigitalSignature", "in": "header", "description": "Digital signature for the source currency transaction amount.", "required": true, "schema": { "type": "string" }, "example": "1EHdFHhrCArIgmWbPtW0HuTlN_LPteg8G8tbvF4QmoRekOO84nQxg8j4gs0wEyAktg2Sm80a_FaTswv-U8XUXGHZ1UBagGD9zEPrGBbia_N5gm4fCOW-qyrT8lwchdkiaprNwsqpv3aKid7Ux3uwEzxiEedO3QWvv6nCZnNNxK-zz2Zj6tPDE_mgQk5tJv4xRgMxtcTMmr7" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "requestBody": { "description": "Defines the actual payload of the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferScheduleRequest" } } }, "required": true }, "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferSchedule" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "marketplaceId": { "value": "A1RKKUPIHCS9HS" }, "body": { "value": { "sourceAccountId": "amzn1.account.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "destinationTransactionInstrument": { "bankAccount": { "bankNumberFormat": "IBAN", "bankAccountOwnershipType": "SELF_ACCOUNT", "routingNumber": "HBUKGB4B", "accountCountryCode": "EU", "accountCurrency": "EUR", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } } } }, "response": { "transferScheduleId": "amzn1.transferschedule.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "transactionType": "DEBIT", "transactionSourceAccount": { "accountId": "amzn.account.AAJKBWEF193EUBKWDVCS", "bankAccountHolderName": "John Doe", "bankName": "Amazon Seller Wallet", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "123", "bankAccountCurrency": "GBP" }, "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase400", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "destinationTransactionInstrument": { "bankAccount": { "bankNumberFormat": "IBAN", "bankAccountOwnershipType": "SELF_ACCOUNT", "routingNumber": "HBUKGB4B", "accountCountryCode": "EU", "accountCurrency": "EUR", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing signature.", "details": "Missing addressDigitalSignature" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase403", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "destinationTransactionInstrument": { "bankAccount": { "bankNumberFormat": "IBAN", "bankAccountOwnershipType": "SELF_ACCOUNT", "routingNumber": "HBUKGB4B", "accountCountryCode": "EU", "accountCurrency": "EUR", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase404", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "destinationTransactionInstrument": { "bankAccount": { "bankNumberFormat": "IBAN", "bankAccountOwnershipType": "SELF_ACCOUNT", "routingNumber": "HBUKGB4B", "accountCountryCode": "EU", "accountCurrency": "EUR", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } } } }, "response": { "errors": [ { "code": "NotFound", "message": "Account not found.", "details": "Account doesn't exists for invalid SourceAccountId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase408", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "destinationTransactionInstrument": { "bankAccount": { "bankNumberFormat": "IBAN", "bankAccountOwnershipType": "SELF_ACCOUNT", "routingNumber": "HBUKGB4B", "accountCountryCode": "EU", "accountCurrency": "EUR", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond in time" } ] } } ] } }, "409": { "description": "Transfer schedule already exists for same source and destination account combination.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase409", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "destinationTransactionInstrument": { "bankAccount": { "bankNumberFormat": "IBAN", "bankAccountOwnershipType": "SELF_ACCOUNT", "routingNumber": "HBUKGB4B", "accountCountryCode": "EU", "accountCurrency": "EUR", "bankAccountNumberTail": "919" }, "bankAccountNumber": "GB29RBOS60161331926919", "accountHolderName": "John Doe" }, "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2025-03-01T00:00:00Z", "scheduleEndDate": "2026-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } } } }, "response": { "errors": [ { "code": "RequestConflict", "message": "Request Conflict", "details": "Transfer schedule already exists for same source and destination account combination." } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase429", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "destinationTransactionInstrument": { "bankAccount": { "bankNumberFormat": "IBAN", "bankAccountOwnershipType": "SELF_ACCOUNT", "routingNumber": "HBUKGB4B", "accountCountryCode": "EU", "accountCurrency": "EUR", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server throttled the request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase500", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "sourceAccountId": "sourceAccountIdCase503", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "destinationTransactionInstrument": { "bankAccount": { "bankNumberFormat": "IBAN", "bankAccountOwnershipType": "SELF_ACCOUNT", "routingNumber": "HBUKGB4B", "accountCountryCode": "EU", "accountCurrency": "EUR", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } }, "x-codegen-request-body-name": "body" } }, "/finances/transfers/wallet/2024-03-01/transferSchedules/{transferScheduleId}": { "get": { "tags": [ "SellerWalletV20240301" ], "summary": "Find particular Amazon Seller Wallet account transfer schedule by Amazon transfer schedule identifier", "description": "Find a particular Amazon Seller Wallet account transfer schedule.", "operationId": "getTransferSchedule", "parameters": [ { "name": "transferScheduleId", "in": "path", "description": "The schedule ID of the Amazon Seller Wallet transfer.", "required": true, "schema": { "type": "string" }, "example": "amzn1.transferschedule.AKNWCDNVP3FNJDCLK876" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "responses": { "200": { "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferSchedule" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdcase200" }, "marketplaceId": { "value": "A1RKKUPIHCS9HS" } } }, "response": { "transferScheduleId": "amzn1.transferschedule.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "transactionType": "DEBIT", "transactionSourceAccount": { "accountId": "sourceAccountIdCase200", "bankAccountHolderName": "John Doe", "bankName": "Amazon Seller Wallet", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "123", "bankAccountCurrency": "GBP" }, "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing wacCertificate.", "details": "WAC certificate is missing for the request" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase403" } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase404" } } }, "response": { "errors": [ { "code": "NotFound", "message": "Transfer Schedule not found.", "details": "Transfer schedule id doesn't exists for invalid TransferScheduleId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase408" } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond in time" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase429" } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server throttled the request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase500" } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase503" } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } } }, "delete": { "tags": [ "SellerWalletV20240301" ], "summary": "Delete a transaction request that is scheduled from Amazon Seller Wallet account to another customer-provided account", "description": "Delete a transaction request that is scheduled from Amazon Seller Wallet account to another customer-provided account.", "operationId": "deleteScheduleTransaction", "parameters": [ { "name": "transferScheduleId", "in": "path", "description": "A unique reference ID for a scheduled transfer.", "required": true, "schema": { "type": "string" }, "example": "amzn1.scheduletransfer.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace for which items are returned. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" }, "example": "A1RKKUPIHCS9HS" } ], "responses": { "200": { "description": "Successfully deleted the transfer schedule.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTransferSchedule" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase200" }, "marketplaceId": { "value": "A1RKKUPIHCS9HS" } } }, "response": { "code": "Successful", "message": "Deleted transfer schedule", "details": "Deleted transfer schedule for ID transferScheduleIdCase200" } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase400" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid or Missing signature.", "details": "Missing addressDigitalSignature" } ] } } ] } }, "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.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase403" } } }, "response": { "errors": [ { "code": "UnauthorizedRequest", "message": "Invalid WAC certificate.", "details": "NCA Status for the certificate is invalid" } ] } } ] } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase404" } } }, "response": { "errors": [ { "code": "NotFound", "message": "Transfer Schedule not found.", "details": "Transfer schedule id doesn't exists for invalid TransferScheduleId" } ] } } ] } }, "408": { "description": "Request Timed Out.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase408" } } }, "response": { "errors": [ { "code": "RequestTimedOut", "message": "Request Timed Out", "details": "Server did not respond in time" } ] } } ] } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase429" } } }, "response": { "errors": [ { "code": "RequestThrottled", "message": "Request Throttled", "details": "Server throttled the request" } ] } } ] } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase500" } } }, "response": { "errors": [ { "code": "InternalServerError", "message": "Internal Server Error", "details": "Internal Server Error Occurred" } ] } } ] } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "transferScheduleId": { "value": "transferScheduleIdCase503" } } }, "response": { "errors": [ { "code": "ServiceUnavailable", "message": "Server Unavailable", "details": "Server is not accepting request" } ] } } ] } } } } } }, "components": { "schemas": { "PayeeContactInformation": { "required": [ "addressLine1", "city", "countryCode", "emailAddress", "payeeEntityType", "payeeFirstName", "payeeLastName", "phoneNumber", "postalCode", "state" ], "type": "object", "properties": { "payeeFirstName": { "type": "string", "description": "First name of the payee. There is a 50 character limit.", "example": "John" }, "payeeMiddleName": { "type": "string", "description": "Middle name of the payee. There is a 50 character limit.", "example": "Henry" }, "payeeLastName": { "type": "string", "description": "Last name of the payee. There is a 50 character limit.", "example": "Doe" }, "addressLine1": { "type": "string", "description": "Address Line 1 of the public address\n", "example": "678 JFK Street" }, "addressLine2": { "type": "string", "description": "Address Line 2 of the public address\n", "example": "Unit 415" }, "city": { "type": "string", "description": "City name of the public address\n", "example": "Seattle" }, "state": { "type": "string", "description": "State name of the public address. This is the state or region for China-based addresses.", "example": "WA" }, "postalCode": { "type": "string", "description": "Postal code of the public address\n", "example": "98109" }, "country": { "type": "string", "description": "Country name of the public address\n", "example": "United States" }, "countryCode": { "type": "string", "description": "The two digit country code, in ISO 3166 format.\n", "example": "US" }, "emailAddress": { "type": "string", "description": "Email address of the payee.", "example": "johndoe@gmail.com" }, "phoneNumber": { "type": "string", "description": "Valid phone number of the payee.", "example": "1234567890" }, "payeeEntityType": { "$ref": "#/components/schemas/PayeeEntityType" } }, "description": "The contact information of the payee. This field is required when the request `bankAccountOwnershipType` is `THIRD_PARTY`. The contact information is used for payee verification and registration purposes.", "example": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "678 JFK Street", "city": "Seattle", "state": "WA", "postalCode": "98109", "countryCode": "US", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" } }, "BankAccount": { "required": [ "accountCountryCode", "accountCurrency", "bankAccountNumberTail", "bankAccountOwnershipType" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique bank account identifier provided by Amazon. To initiate a `SELF` transaction with Seller Wallet, you must choose `BANK_ACCOUNT` as the payment method type in the [getPaymentMethod](https://developer-docs.amazon.com/sp-api/reference/getpaymentmethods) request. Your Amazon Seller Wallet bank account identifier should match the `paymentMethodId` in the response. This field is required.", "example": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ" }, "accountHolderName": { "type": "string", "description": "The bank account holder's name (expected to be an Amazon customer). There is a 50 character limit.", "example": "John Doe" }, "bankAccountNumberFormat": { "$ref": "#/components/schemas/BankAccountNumberFormat" }, "bankName": { "type": "string", "description": "The name of the bank. This value is Amazon Seller Wallet for Amazon Seller Wallet accounts.", "example": "DEUTSCHE BANK AG" }, "bankAccountOwnershipType": { "$ref": "#/components/schemas/BankAccountOwnershipType" }, "routingNumber": { "type": "string", "description": "Routing number for automated clearing house transfers for `THIRD_PARTY` transaction requests. This value is nine consecutive zeros for Amazon Seller Wallet accounts.", "example": "026009593" }, "bankNumberFormat": { "$ref": "#/components/schemas/BankNumberFormat" }, "accountCountryCode": { "type": "string", "description": "The two digit country code, in ISO 3166 format.\n", "example": "US" }, "accountCurrency": { "type": "string", "description": "BankAccount currency code in ISO 4217 format\n", "example": "USD" }, "bankAccountNumberTail": { "type": "string", "description": "Last 3 digit of the bank account number, for all Amazon Seller Wallet account the value will be three consecutive 0's\n", "example": "666" }, "bankAccountHolderStatus": { "$ref": "#/components/schemas/BankAccountHolderStatus" } }, "description": "Details of an Amazon Seller Wallet bank account. This account is used to hold the money that a Seller Wallet customer earns by selling items." }, "BankAccountListing": { "required": [ "accounts" ], "type": "object", "properties": { "accounts": { "type": "array", "description": "Collection that holds BankAccount\n", "items": { "$ref": "#/components/schemas/BankAccount" } } }, "description": "Struct that holds collection of accounts." }, "Balance": { "required": [ "accountId", "balanceAmount", "balanceCurrency", "lastUpdateDate" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique identifier provided by Amazon to identify the account\n", "example": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ" }, "balanceType": { "$ref": "#/components/schemas/BalanceType" }, "balanceAmount": { "$ref": "#/components/schemas/BigDecimal" }, "balanceCurrency": { "type": "string", "description": "The Amazon SW bank account currency code in ISO 4217 format\n", "example": "USD" }, "lastUpdateDate": { "type": "string", "description": "The last update date on the account balance\n", "format": "date-time" } }, "description": "Specifies the balance amount in the Amazon SW bank account", "example": { "accountId": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ", "balanceType": "AVAILABLE", "balanceAmount": 123.45, "balanceCurrency": "USD", "lastUpdateDate": "2024-03-01T10:30:00Z" } }, "BalanceListing": { "type": "object", "properties": { "balances": { "type": "array", "description": "Collection that holds list of balances on the account\n", "items": { "$ref": "#/components/schemas/Balance" } } }, "description": "Struct that holds list of balances on the seller account.", "example": { "balances": [ { "accountId": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ", "balanceType": "AVAILABLE", "balanceAmount": 123.45, "balanceCurrency": "USD", "lastUpdateDate": "2024-03-01T10:30:00Z" }, { "accountId": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ", "balanceType": "LOCKED_IN", "balanceAmount": 500, "balanceCurrency": "USD", "lastUpdateDate": "2024-03-01T10:30:00Z" }, { "accountId": "amzn1.account.AGUGL2EM3ZHYSRJWH2UCRPIM5JFQ", "balanceType": "TOTAL", "balanceAmount": 623.45, "balanceCurrency": "USD", "lastUpdateDate": "2024-03-01T10:30:00Z" } ] } }, "BalanceType": { "type": "string", "description": "Represent a bank account balance type.", "enum": [ "AVAILABLE", "LOCKED_IN", "LOCKED_OUT", "TOTAL" ], "x-docgen-enum-table-extension": [ { "value": "AVAILABLE", "description": "Available balance that is accessible to the seller." }, { "value": "LOCKED_IN", "description": "The incoming balance in sellers account." }, { "value": "LOCKED_OUT", "description": "The outgoing balance from sellers account" }, { "value": "TOTAL", "description": "Total balance in the sellers account." } ] }, "BankAccountNumberFormat": { "type": "string", "description": "The format of the bank account number.", "enum": [ "IBAN", "BBAN" ], "x-docgen-enum-table-extension": [ { "value": "IBAN", "description": "International Bank BankAccount Number." }, { "value": "BBAN", "description": "Basic Bank BankAccount Number which is Domestic bank accounts." } ] }, "BankAccountHolderStatus": { "type": "string", "description": "Represents status of the Amazon Seller Wallet accountholder", "enum": [ "ACTIVE", "INACTIVE", "UNDER_REVIEW", "VERIFICATION_FAILED" ], "x-docgen-enum-table-extension": [ { "value": "ACTIVE", "description": "BankAccount holder is Active." }, { "value": "INACTIVE", "description": "BankAccount holder is Inactive and cannot be used for transactions." }, { "value": "UNDER_REVIEW", "description": "BankAccount holder is currently under review." }, { "value": "VERIFICATION_FAILED", "description": "BankAccount holder KYC(Know Your Customer) verification has failed." } ] }, "BankAccountOwnershipType": { "type": "string", "description": "Represents destination bank account's ownership type.", "enum": [ "THIRD_PARTY", "SELF" ], "x-docgen-enum-table-extension": [ { "value": "THIRD_PARTY", "description": "BankAccount is not officially owned by the Payment Service User who is viewing the account and initiating the transaction." }, { "value": "SELF", "description": "The account is officially owned by the Payment Service User who is viewing the account and initiating the transaction." } ] }, "BankNumberFormat": { "type": "string", "description": "Represents a format of a bank number also called routing number type", "enum": [ "BIC", "BASIC" ], "x-docgen-enum-table-extension": [ { "value": "BIC", "description": "Business Identifier Code. In ISO 9362 format." }, { "value": "BASIC", "description": "Basic means the bank number has a special format specific to the country code provided, such as ABA routing number." } ] }, "BigDecimal": { "type": "number", "description": "A decimal number such as amount or FX rate." }, "CreateTransactionResponse": { "required": [ "callBackURL", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/Transaction" }, "callBackURL": { "type": "string", "description": "The callback URL for the transaction which the user have to click to approve/consent the transaction", "example": "https://www.example.com/callback/transaction_id/" } }, "description": "The transaction response and historical details related to it." }, "Currency": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The three-digit currency code in ISO 4217 format." }, "currencyAmount": { "$ref": "#/components/schemas/BigDecimal" } }, "description": "A currency type and amount." }, "DeleteTransferSchedule": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "A success code that specifies the delete operation was successful. eg:HTTP 200." }, "message": { "type": "string", "description": "A message that describes the success condition of the delete schedule transaction." }, "details": { "type": "string", "description": "Additional details that can help the caller understand the operation execution." } }, "description": "Response returned when the schedule transfer's delete request is successful." }, "Error": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "description": "Error response returned when the request is unsuccessful." }, "ErrorList": { "required": [ "errors" ], "type": "object", "properties": { "errors": { "type": "array", "description": "List of errors\n", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "A list of error responses returned when a request is unsuccessful." }, "FxRateDetails": { "required": [ "baseRate", "effectiveFxRate", "fxRateId", "rateDirection" ], "type": "object", "properties": { "fxRateId": { "type": "string", "description": "Unique identifier assigned to the fees/foreign exchange Rate of a transaction.\n" }, "baseRate": { "$ref": "#/components/schemas/BigDecimal" }, "effectiveFxRate": { "$ref": "#/components/schemas/BigDecimal" }, "rateDirection": { "$ref": "#/components/schemas/RateDirection" } }, "description": "Foreign exchange rate details displayed when transfer preview is requested.\n", "example": { "fxRateId": "UNIQUE_FX_RATE_ID_1", "baseRate": 7.2, "effectiveFxRate": 7.25, "rateDirection": "BUY" } }, "Fee": { "required": [ "feeAmount", "feeId", "feeRateValue", "feeType" ], "type": "object", "properties": { "feeId": { "type": "string", "description": "Unique identifier assigned to the Fee.\n" }, "feeType": { "$ref": "#/components/schemas/FeeType" }, "feeRateValue": { "type": "string", "description": "The value of the fee in percentage format." }, "feeAmount": { "$ref": "#/components/schemas/Currency" } }, "description": "If the fees is in baseAmount (sourceAccount) currency, effectiveRate = (baseAmount - sum(fees.feeAmount.currencyAmount)) * baseRate) / baseAmount. If the fees is in transferAmount (destinationAccount) currency, effectiveRate = (( baseAmount * baseRate ) - sum(fees.feeAmount.currencyAmount )) / baseAmount\n" }, "FeeType": { "type": "string", "description": "Represents different types of fees that can be applied on a transaction.", "enum": [ "MISCELLANEOUS_FEE", "TAX", "TRANSACTION_FEE" ], "x-docgen-enum-table-extension": [ { "value": "MISCELLANEOUS_FEE", "description": "Represents any other service charges or additional fee applied by a transaction executor service." }, { "value": "TAX", "description": "Represents tax fees if applied on any transaction." }, { "value": "TRANSACTION_FEE", "description": "Represents a per transaction fee that can be applied by a transaction executor service. This can be both INTERNATIONAL and DOMESTIC fees" } ] }, "RateDirection": { "type": "string", "description": "Represents the rate direction at which the transaction is performed.", "enum": [ "BUY", "SELL" ], "x-docgen-enum-table-extension": [ { "value": "BUY", "description": "Buy value represents the rate if customer is buying the destination currency." }, { "value": "SELL", "description": "Sell value represents the rate if customer is selling the destination currency." } ] }, "PayeeEntityType": { "type": "string", "description": "The entity type of the transaction payee when the bank account ownership type is `THIRD_PARTY`.", "enum": [ "INDIVIDUAL", "BUSINESS", "TAX_AUTHORITY" ], "x-docgen-enum-table-extension": [ { "value": "INDIVIDUAL", "description": "The entity type if the payee is an individual." }, { "value": "BUSINESS", "description": "The entity type if the payee is a business." }, { "value": "TAX_AUTHORITY", "description": "The entity type if the payee is a tax authority,for example, in a Value Added Tax (VAT) payment." } ] }, "PaymentPreference": { "required": [ "paymentPreferencePaymentType", "value" ], "type": "object", "properties": { "paymentPreferencePaymentType": { "$ref": "#/components/schemas/PaymentPreferencePaymentType" }, "value": { "$ref": "#/components/schemas/BigDecimal" } }, "description": "Payment preference type in which transfer is being scheduled\n" }, "PaymentPreferencePaymentType": { "type": "string", "description": "Represent a type of payment preference.", "enum": [ "PERCENTAGE", "AMOUNT" ], "x-docgen-enum-table-extension": [ { "value": "PERCENTAGE", "description": "The schedule transfer in percentage." }, { "value": "AMOUNT", "description": "The schedule transfer in amount value." } ] }, "RecurringFrequency": { "type": "string", "description": "Represent parameters to specify recurrence of the scheduled transfer.", "enum": [ "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY" ], "x-docgen-enum-table-extension": [ { "value": "DAILY", "description": "The transfer repeats every day." }, { "value": "WEEKLY", "description": "The transfer will repeat every week." }, { "value": "BIWEEKLY", "description": "The transfer will repeat every two weeks." }, { "value": "MONTHLY", "description": "The transfer will repeat every month." } ] }, "TransferScheduleInformation": { "type": "object", "properties": { "scheduleStartDate": { "type": "string", "description": "Field to specify start date of the scheduled transfer\n", "format": "date-time", "example": "2024-03-01T00:00:00Z" }, "scheduleEndDate": { "type": "string", "description": "Field to specify end date of the scheduled transfer\n", "format": "date-time", "example": "2027-03-01T00:00:00Z" }, "scheduleExpression": { "$ref": "#/components/schemas/ScheduleExpression" }, "scheduleType": { "$ref": "#/components/schemas/ScheduleTransferType" } }, "description": "Parameters containing information required for initiating a schedule transfer\n", "example": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" } }, "ScheduleExpression": { "required": [ "scheduleExpressionType" ], "type": "object", "properties": { "scheduleExpressionType": { "$ref": "#/components/schemas/ScheduleExpressionType" }, "recurringFrequency": { "$ref": "#/components/schemas/RecurringFrequency" } }, "description": "Parameters containing information of the expression that defines when the schedule runs. The following formats are supported.\n" }, "ScheduleExpressionType": { "type": "string", "description": "Represent a type of schedule transfer expression.", "enum": [ "RECURRING", "ONE_TIME" ], "x-docgen-enum-table-extension": [ { "value": "RECURRING", "description": "The schedule transfer is a recurring event. example: monthly schedule transfer." }, { "value": "ONE_TIME", "description": "Creates a one-time schedule transfer." } ] }, "ScheduleTransferType": { "type": "string", "description": "Defines the type of schedule trigger used for executing transfers. Schedule based on time patterns using EventBridge.\n", "enum": [ "TIME_BASED" ], "x-docgen-enum-table-extension": [ { "value": "TIME_BASED", "description": "Schedule based on time patterns using EventBridge. Supports recurring patterns (daily, weekly, biweekly, monthly) and one-time future executions. \n" } ] }, "TransactionInitiationRequest": { "required": [ "destinationTransactionInstrument", "requestTime", "sourceAccountId", "sourceAmount" ], "type": "object", "properties": { "sourceAccountId": { "type": "string", "description": "The unique identifier of the source Amazon SW bank account from where the money needs to be debited\n", "example": "amzn1.account.SMUGN2EN3ZHWSRJKH2KCJPII5JEI" }, "destinationAccountId": { "type": "string", "description": "Optional field to specify the unique identifier of the destination bank account where the money needs to be deposited\n", "example": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN" }, "destinationTransactionInstrument": { "$ref": "#/components/schemas/TransactionInstrumentDetails" }, "transactionDescription": { "type": "string", "description": "A description of the transaction." }, "customerPaymentReference": { "type": "string", "description": "If the payment is for VAT (Value-Added-Tax) then enter VAT identification number in this field which will be mandatory. The length constraint is 140 characters and do not allow user to enter any sensitive information other than VAT-ID.", "example": "BG999999999" }, "payeeContactInformation": { "$ref": "#/components/schemas/PayeeContactInformation" }, "sourceAmount": { "$ref": "#/components/schemas/Currency" }, "transferRateDetails": { "$ref": "#/components/schemas/TransferRatePreview" }, "requestTime": { "type": "string", "description": "The transaction initiation request time in date-time format\n", "format": "date-time", "example": "2024-03-26T02:32:59.787Z" } }, "description": "Request body to initiate a transaction from a SW bank account to another customer defined bank account\n", "example": { "sourceAccountId": "amzn1.account.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "sourceAmount": { "amount": 100, "currency": "USD" }, "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "BBAN", "bankAccountOwnershipType": "SELF", "routingNumber": "HBUKGB4B", "bankNumberFormat": "BASIC", "accountCountryCode": "CN", "accountCurrency": "CNY", "bankAccountNumberTail": "819" }, "accountHolderName": "John Doe", "bankAccountNumber": "GB29RBOS60161331926819" }, "transactionDescription": "This is transaction to partner", "customerPaymentReference": "BG999999999", "payeeContactInformation": { "payeeFirstName": "John", "payeeLastName": "Doe", "payeeEntityType": "PERSON", "addressLine1": "Avenue John F. Kennedy 38", "city": "Luxembourg", "state": "LUXEMBOURG", "postalCode": "1855", "countryCode": "LU", "emailAddress": "johndoe@gmail.com", "phoneNumber": "3450987121" }, "transferRateDetails": { "baseAmount": { "currencyCode": "EUR", "currencyAmount": 500 }, "fxRateDetails": { "fxRateId": "UNIQUE_FX_RATE_ID_1", "baseRate": 7.6915, "effectiveFxRate": 7.6084, "rateDirection": "BUY" }, "transferAmount": { "currencyCode": "CNY", "currencyAmount": 3804.2 }, "fees": [ { "feeId": "Unique_FeeId_001", "feeType": "TRANSACTION_FEE", "feeRateValue": "0.9", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 4.5 } }, { "feeId": "Unique_FeeId_002", "feeType": "TAX", "feeRateValue": "20.0", "feeAmount": { "currencyCode": "EUR", "currencyAmount": 0.9 } } ] }, "requestTime": "2024-03-26T02:32:59.787Z" } }, "TransactionInstrumentDetails": { "required": [ "accountHolderName", "bankAccount", "bankAccountNumber" ], "type": "object", "properties": { "bankAccount": { "$ref": "#/components/schemas/BankAccount" }, "bankAccountNumber": { "type": "string", "description": "This field would be used to populate the bank account number of the destination payment method. The field is intentionally not included in any other Schemas since Amazon internal systems will never receive it in unencrypted format, so field won't be part of the request signature\n", "example": "GB29RBOS60161331926819" }, "accountHolderName": { "type": "string", "description": "The bank account holder's name (expected to be an Amazon customer).\n\n**Note:** This field is encrypted before Amazon receives it, so should not be used to generate `destAccountDigitalSignature`, and should not be included in the request signature.", "example": "John Doe" } }, "description": "Request body to create transaction instrument, Amazon performs validation and screening (anti-money laundering measuers) on all the transaction instruments before executing a transaction thus it requires transaction instrument holder's contact details as well\n", "example": { "bankAccount": { "bankAccountNumberFormat": "IBAN", "bankAccountOwnershipType": "THIRD_PARTY", "routingNumber": "HBUKGB4B", "bankNumberFormat": "BASIC", "accountCountryCode": "EU", "accountCurrency": "EUR", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" } }, "Transaction": { "required": [ "accountId", "lastUpdateDate", "transactionDescription", "transactionDestinationAccount", "transactionId", "transactionRequestAmount", "transactionRequestDate", "transactionRequesterSource", "transactionStatus", "transactionType", "transferRateDetails" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique identifier of the Amazon Seller Wallet bank account from which the money is debited.", "example": "amzn1.account.SMUGN2EN3ZHWSRJKH2KCJPII5JEI" }, "transactionId": { "type": "string", "description": "The unique identifier provided by Amazon to the transaction\n" }, "transactionType": { "$ref": "#/components/schemas/TransactionType" }, "transactionStatus": { "$ref": "#/components/schemas/TransactionStatus" }, "transactionRequestDate": { "type": "string", "description": "The date when the transaction was initiated.", "format": "date-time" }, "expectedCompletionDate": { "type": "string", "description": "Expected completion date of a transaction, for existing active Payees (Trusted Beneficiaries) it will be 24 hours but for new destination bank accounts the value could go up to 5 days\n", "format": "date-time", "example": "2023-09-26T02:32:59.787Z" }, "transactionActualCompletionDate": { "type": "string", "description": "Transaction completion date\n", "format": "date-time" }, "lastUpdateDate": { "type": "string", "description": "The last update date on the transaction\n", "format": "date-time" }, "requesterName": { "type": "string", "description": "Amazon SW customer who requested the transaction\n", "example": "TPPOrgId" }, "transactionRequesterSource": { "type": "string", "description": "The transaction initiation source. This value is either the Amazon portal or PISP name that the customer used to start the transaction." }, "transactionDescription": { "type": "string", "description": "A description of the transaction that the requester provides when they initiate the transaction." }, "transactionSourceAccount": { "$ref": "#/components/schemas/TransactionAccount" }, "transactionDestinationAccount": { "$ref": "#/components/schemas/TransactionAccount" }, "transactionRequestAmount": { "$ref": "#/components/schemas/Currency" }, "transferRateDetails": { "$ref": "#/components/schemas/TransferRatePreview" }, "transactionFinalAmount": { "$ref": "#/components/schemas/Currency" }, "transactionFailureReason": { "type": "string", "description": "Description in case the transaction fails before completion\n", "example": "Insufficient Balance" } }, "description": "The current transaction status and related historical details." }, "TransactionAccount": { "required": [ "bankAccountCurrency", "bankAccountNumberFormat", "bankName" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique identifier provided by Amazon to identify the account\n" }, "bankAccountHolderName": { "type": "string", "description": "BankAccount holder's name\n" }, "bankName": { "type": "string", "description": "The name of the bank\n" }, "bankAccountNumberFormat": { "$ref": "#/components/schemas/BankAccountNumberFormat" }, "bankAccountNumberTail": { "type": "string", "description": "Last 3 digit of the bank account number\n" }, "bankAccountCountryCode": { "type": "string", "description": "The two digit country code, in ISO 3166 format. This field is OPTIONAL for transactionSourceAccount object but is MANDATORY field for transactionDestinationAccount\n" }, "bankAccountCurrency": { "type": "string", "description": "The currency code in ISO 4217 format\n" } }, "description": "Details of the bank account involved in the transaction." }, "TransactionListing": { "required": [ "transactions" ], "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "If present, use this pagination token to retrieve the next page of supply sources, if not provided the API will return same response. The field will only be provided when the list is greater than 100.", "example": "3493805734095308457308475" }, "transactions": { "type": "array", "description": "Collection that holds Transaction\n", "items": { "$ref": "#/components/schemas/Transaction" } } }, "description": "Struct that holds collection of transactions." }, "TransactionStatus": { "type": "string", "description": "Represents current status of the transaction.", "enum": [ "EXPIRED", "FAILED", "FAILED_CREDITS_APPLIED", "IN_PROGRESS", "PENDING_USER_APPROVAL", "SUCCESSFUL" ], "x-docgen-enum-table-extension": [ { "value": "EXPIRED", "description": "The transaction has expired due to missing approval/consent." }, { "value": "FAILED", "description": "Transaction failed before completion." }, { "value": "FAILED_CREDITS_APPLIED", "description": "Transaction failed after debit and credit has been applied back to the balance." }, { "value": "IN_PROGRESS", "description": "Transaction is in progress." }, { "value": "PENDING_USER_APPROVAL", "description": "The transaction has been created, but pending approval from the user via dynamic linking." }, { "value": "SUCCESSFUL", "description": "Transaction is successfully processed." } ] }, "TransactionType": { "type": "string", "description": "Represent type of transaction.", "enum": [ "CREDIT", "DEBIT" ], "x-docgen-enum-table-extension": [ { "value": "CREDIT", "description": "Money is deposited into the Seller Wallet account." }, { "value": "DEBIT", "description": "Money is taken out of the Seller Wallet account." } ] }, "TransferRatePreview": { "required": [ "baseAmount", "fees", "fxRateDetails", "transferAmount" ], "type": "object", "properties": { "baseAmount": { "$ref": "#/components/schemas/Currency" }, "fxRateDetails": { "$ref": "#/components/schemas/FxRateDetails" }, "transferAmount": { "$ref": "#/components/schemas/Currency" }, "fees": { "type": "array", "description": "List of fees\n", "items": { "$ref": "#/components/schemas/Fee" } } }, "description": "The fees and foreign exchange rates that apply to the transaction.\n\nIf the fees are in terms of the `baseAmount` (source account) currency, then the effective rate is equal to **1 - (fees * `baseRate` / `baseAmount`)**.\n\nIf the fees are in terms of the `transferAmount` (destination account) currency, then the effective rate is equal to **`baseRate` - (fees / `baseAmount`)**.\n\nIn the preceding expressions, **fees** is equal to the sum of all `feeAmount.currencyAmount` values in the `fees` array." }, "TransferSchedule": { "required": [ "transactionDestinationAccount", "transactionType", "transferScheduleFailures", "transferScheduleId", "transferScheduleInformation", "transferScheduleStatus" ], "type": "object", "properties": { "transferScheduleId": { "type": "string", "description": "The unique identifier provided by Amazon to the scheduled transfer\n" }, "transactionType": { "$ref": "#/components/schemas/TransactionType" }, "transactionSourceAccount": { "$ref": "#/components/schemas/TransactionAccount" }, "transactionDestinationAccount": { "$ref": "#/components/schemas/TransactionAccount" }, "transferScheduleStatus": { "$ref": "#/components/schemas/TransferScheduleStatus" }, "transferScheduleInformation": { "$ref": "#/components/schemas/TransferScheduleInformation" }, "paymentPreference": { "$ref": "#/components/schemas/PaymentPreference" }, "transferScheduleFailures": { "type": "array", "description": "Collection that holds Transfer Schedules that has been cancelled or failed due to certain reasons.\n", "items": { "$ref": "#/components/schemas/TransferScheduleFailures" } } }, "description": "Transfer schedule details and related historical details.", "example": { "transferScheduleId": "amzn1.transferschedule.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "transactionType": "DEBIT", "transactionSourceAccount": { "accountId": "sourceAccountIdCase200", "bankAccountHolderName": "John Doe", "bankName": "Amazon Seller Wallet", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "123", "bankAccountCurrency": "GBP" }, "transactionDestinationAccount": { "bankAccountHolderName": "Dane Shipping", "bankName": "Royal Bank of Scotland", "bankAccountNumberFormat": "IBAN", "bankAccountNumberTail": "819", "bankAccountCurrency": "GBP", "bankAccountCountryCode": "EU" }, "transferScheduleStatus": "ENABLED", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleFailures": [ { "transferScheduleFailureDate": "2024-04-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } ] } }, "TransferScheduleFailures": { "required": [ "transferScheduleFailureDate", "transferScheduleFailureReason" ], "type": "object", "properties": { "transferScheduleFailureDate": { "type": "string", "description": "The transfer schedule cancellation date\n", "format": "date-time" }, "transferScheduleFailureReason": { "type": "string", "description": "The statement/reasoning listed for the cancellation of the transfer schedule\n", "example": "INSUFFICIENT_BALANCE" } }, "description": "Specifies the balance amount in the Amazon SW bank account", "example": { "transferScheduleFailureDate": "2024-03-01T10:30:00Z", "transferScheduleFailureReason": "INSUFFICIENT_BALANCE" } }, "TransferScheduleListing": { "required": [ "transferSchedules" ], "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "If present, use this pagination token to retrieve the next page of supply sources, if not provided the API will return same response. The field will only be provided when the list is greater than 100.", "example": "3493805734095308457308475" }, "transferSchedules": { "type": "array", "description": "Collection that holds list of Transfer Schedules\n", "items": { "$ref": "#/components/schemas/TransferSchedule" } } }, "description": "Struct that holds collection of transfer schedules." }, "TransferScheduleRequest": { "required": [ "destinationAccountId", "destinationTransactionInstrument", "paymentPreference", "sourceAccountId", "sourceCurrencyCode", "transactionType", "transferScheduleInformation" ], "type": "object", "properties": { "sourceAccountId": { "type": "string", "description": "The unique identifier of the source Amazon SW bank account from where the money needs to be debited\n", "example": "amzn1.account.SMUGN2EN3ZHWSRJKH2KCJPII5JEI" }, "sourceCurrencyCode": { "type": "string", "description": "Represents 3 letter currency code in ISO 4217 standard format of the source payment method country\n", "example": "GBP" }, "destinationAccountId": { "type": "string", "description": "Optional field to specify the unique identifier of the destination bank account where the money needs to be deposited\n", "example": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN" }, "destinationTransactionInstrument": { "$ref": "#/components/schemas/TransactionInstrumentDetails" }, "transactionType": { "$ref": "#/components/schemas/TransactionType" }, "transferScheduleInformation": { "$ref": "#/components/schemas/TransferScheduleInformation" }, "paymentPreference": { "$ref": "#/components/schemas/PaymentPreference" }, "transferScheduleStatus": { "$ref": "#/components/schemas/TransferScheduleStatus" } }, "description": "Request body to initiate a scheduled transfer from a SW bank account to another customer defined bank account\n", "example": { "sourceAccountId": "amzn1.account.SMUGN2EN3ZHWSRJKH2KCJPII5JEI", "destinationAccountId": "amzn1.account.AJKBFWEJFBNH2KCJPII5FBN", "sourceCurrencyCode": "USD", "destinationTransactionInstrument": { "bankAccount": { "bankAccountNumberFormat": "BBAN", "bankAccountOwnershipType": "SELF", "routingNumber": "HBUKGB4B", "bankNumberFormat": "BASIC", "accountCountryCode": "CN", "accountCurrency": "CNY", "bankAccountNumberTail": "819" }, "bankAccountNumber": "GB29RBOS60161331926819", "accountHolderName": "John Doe" }, "transactionType": "DEBIT", "transferScheduleInformation": { "scheduleStartDate": "2024-03-01T00:00:00Z", "scheduleEndDate": "2027-03-01T00:00:00Z", "scheduleExpression": { "scheduleExpressionType": "RECURRING", "recurringFrequency": "WEEKLY" }, "scheduleType": "TIME_BASED" }, "paymentPreference": { "paymentPreferencePaymentType": "PERCENTAGE", "value": 25.5 }, "transferScheduleStatus": "ENABLED" } }, "TransferScheduleStatus": { "type": "string", "description": "Represents the schedule status of the transfer.", "enum": [ "ENABLED", "DISABLED", "EXPIRED", "DELETED" ], "x-docgen-enum-table-extension": [ { "value": "ENABLED", "description": "Represents the status of the transfer schedule that is enabled." }, { "value": "DISABLED", "description": "Represents the status of the transfer schedule that is disabled." }, { "value": "EXPIRED", "description": "Represents the status of the transfer that has expired and not scheduled anymore." }, { "value": "DELETED", "description": "Represents the status of the transfer that was scheduled but has been deleted." } ] } } }, "x-original-swagger-version": "2.0" }