Transfers API v2024-06-01 model
Swagger model for Transfers API v2024-06-01.
{
"swagger": "2.0",
"info": {
"title": "The Selling Partner API for Transfers.",
"description": "Use the Transfers API v2024-06-01 to initiate payouts for your seller accounts. This API is available in private beta only.",
"version": "2024-06-01",
"contact": {
"name": "Selling Partner API Developer Support",
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
},
"license": {
"name": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"host": "sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/finances/transfers/2024-06-01/payouts": {
"post": {
"description": "Initiates an on-demand payout to the seller's default deposit method in Seller Central for the given `marketplaceId` and `accountType` (if eligible). Only one on-demand payout can be initiated for each marketplace and account type within a 24-hour period. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation. The preceding table shows the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may yield higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "initiatePayout",
"parameters": [
{
"name": "body",
"in": "body",
"description": "The request body for the `initiatePayout` operation.",
"required": true,
"schema": {
"$ref": "#/definitions/InitiatePayoutRequest"
}
}
],
"responses": {
"200": {
"description": "Success.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/InitiatePayoutResponse"
},
"examples": {
"application/json": {
"payoutReferenceId": "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3AD2Lgc"
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"marketplaceId": "A1PA6795UKMFR9",
"accountType": "Standard Orders"
}
}
}
},
"response": {
"payoutReferenceId": "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3AD2Lgc"
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed. Possible values include:\n\nINVALID_INPUT: The marketplaceId/accountType provided in the input is invalid.\n\nNOT_ELIGIBLE_FOR_ON_DEMAND_PAYOUT: The seller is not eligible for On-Demand Payouts. Retries would most likely fail.\n\nNO_DEPOSIT_METHOD: No deposit method found for the selling partner. Please add a valid deposit method and try again.\n\nINSUFFICIENT_PAYOUT_AMOUNT: The outstanding balance is less than the minimum permissible payout amount, hence no payout will be initiated.\n\nPAYOUT_FREQUENCY_EXCEEDED: This occurs if there has already been a payout initiated for the given marketplace and accountType in the last 24 hours. A selling partner can request payout once in every 24 hours for a given marketplace and accountType.\n\nNote: The error codes listed here are not an exhaustive representation. The API's error handling is subject to change, and additional error codes may be introduced in the future.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
},
"examples": {
"application/json": {
"errors": [
{
"code": "NO_DEPOSIT_METHOD",
"message": "No deposit method found for the selling partner. Add a valid deposit method and try again."
}
]
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"marketplaceId": "A1F83G8C2ARO7P",
"accountType": "Standard Orders"
}
}
}
},
"response": {
"errors": [
{
"code": "NO_DEPOSIT_METHOD",
"message": "No deposit method found for the selling partner. Add a valid deposit method and try again."
},
{
"code": "INSUFFICIENT_PAYOUT_AMOUNT",
"message": "The available balance is less than the minimum permissible payout amount. No payout will be initiated."
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
}
},
"/finances/transfers/2024-06-01/paymentmethods": {
"post" : {
"description": "The list of payment methods added for a particular seller. These payment methods can be used for payouts.",
"operationId" : "getPaymentMethods",
"parameters" : [ {
"name" : "body",
"in" : "body",
"required" : true,
"description" : "The request schema of the `getPaymentMethods` operation.",
"schema" : {
"$ref" : "#/definitions/GetPaymentMethodsRequest"
}
} ],
"responses" : {
"200" : {
"description" : "Success.",
"schema" : {
"$ref" : "#/definitions/GetPaymentMethodsResponse"
},
"examples": {
"application/json": {
"piDetails": [
{
"countryCode": "US",
"defaultMarketplaces": ["ATVPDKIKX0DER"],
"encryptedAccountHolderName": "?SIEGE|Rufus!00AAAAAAYIARAAGgAAAAAADgjowvyyBhAAGAAgADIAAAAAkQAAAAAAAAAA1goTnyZO5d+yqPgsktNT/nEAAAAAAAAAP0MonpF3YDVi4nembq6SlQ+4vdiDYdw3yAQnHXMw7xQtF7vzrLY/MJPd3nisz3cIf8mXj5Q6OLDmVukyrqBS0ZDq12OuNAqwh3O1w/tAba31f7UBWfhg3XJFwflqHOX028hd7wmGl72o9NNk6ylY18g=!EGEIS?",
"paymentInstrumentId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentInstrumentType": "BANK_ACCOUNT",
"tail": "677"
}
]
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"owningCustomerId": "ACUULBDVZHYZZ",
"marketplaceId": "ATVPDKIKX0DER",
"requestId": "Rufus",
"paymentMethodFilter": {
"subscribedMarketplaces": [
"ATVPDKIKX0DER","A2EUQ1WTGCTBG2"
],
"assignmentFilter": {
"assignmentTypes": [
"DEFAULT"
]
}
}
}
}
}
},
"response": {
"piDetails": [
{
"countryCode": "US",
"defaultMarketplaces": ["ATVPDKIKX0DER", "A2EUQ1WTGCTBG2"],
"encryptedAccountHolderName": "?SIEGE|Rufus!00AAAAAAYIARAAGgAAAAAADgjowvyyBhAAGAAgADIAAAAAkQAAAAAAAAAA1goTnyZO5d+yqPgsktNT/nEAAAAAAAAAP0MonpF3YDVi4nembq6SlQ+4vdiDYdw3yAQnHXMw7xQtF7vzrLY/MJPd3nisz3cIf8mXj5Q6OLDmVukyrqBS0ZDq12OuNAqwh3O1w/tAba31f7UBWfhg3XJFwflqHOX028hd7wmGl72o9NNk6ylY18g=!EGEIS?",
"paymentInstrumentId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentInstrumentType": "BANK_ACCOUNT",
"tail": "677"
}
]
}
}
]
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"400" : {
"description" : "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
},
"examples": {
"application/json": {
"errors": [
{
"code": "400",
"message": "Validation failed for obfuscatedId:ACUULBDVZHYZ1"
}
]
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"owningCustomerId": "ACUULBDVZHYZ1",
"marketplaceId": "ATVPDKIKX0DER",
"requestId": "Rufus",
"paymentMethodFilter": {
"subscribedMarketplaces": [
"ATVPDKIKX0DER"
],
"assignmentFilter": {
"assignmentTypes": [
"DEFAULT"
]
}
}
}
}
}
},
"response": {
"errors": [
{
"code": "400",
"message": "Validation failed for obfuscatedId:ACUULBDVZHYZ1"
}
]
}
}
]
}
},
"403" : {
"description" : "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404" : {
"description" : "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"413" : {
"description" : "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415" : {
"description" : "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429" : {
"description" : "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500" : {
"description" : "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503" : {
"description" : "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
}
},
"definitions": {
"InitiatePayoutRequest": {
"type": "object",
"required": [
"marketplaceId",
"accountType"
],
"properties": {
"marketplaceId": {
"description": "A marketplace identifier. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).",
"type": "string"
},
"accountType": {
"description": "The account type in the selected marketplace for which a payout has to be initiated. For the supported EU marketplaces, the only account type is `Standard Orders`.",
"type": "string"
}
},
"description": "The request schema for the `initiatePayout` operation.",
"example": {
"marketplaceId": "APJ6JRA9NG5V4",
"accountType": "Standard Orders"
}
},
"InitiatePayoutResponse": {
"type": "object",
"required": [
"payoutReferenceId"
],
"properties": {
"payoutReferenceId": {
"description": "The financial event group ID for a successfully initiated payout. You can use this ID to track payout information.",
"type": "string"
}
},
"description": "The response schema for the `initiatePayout` operation.",
"example": {
"payoutReferenceId": "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3AD2Lgc"
}
},
"GetPaymentMethodsRequest" : {
"description": "The request schema for the `getPaymentMethods` operation.",
"type" : "object",
"example": {
"owningCustomerId": "ACUULBDVZHYZZ",
"marketplaceId": "ATVPDKIKX0DER",
"requestId": "Rufus",
"paymentMethodFilter": {
"subscribedMarketplaces": [ "ATVPDKIKX0DER"
],
"assignmentFilter": {
"assignmentTypes": [
"DEFAULT"
]
}
}
},
"properties" : {
"owningCustomerId" : {
"description": "The customer ID of the seller.",
"$ref" : "#/definitions/StringWithNoWhiteSpace"
},
"marketplaceId" : {
"description": "The marketplace identifier.",
"$ref" : "#/definitions/StringWithNoWhiteSpace"
},
"requestId" : {
"description": "The marketplace identifier.",
"$ref" : "#/definitions/StringWithNoWhiteSpace"
},
"paymentMethodFilter" : {
"description": "The object used to filter payment methods based on different factors.",
"$ref" : "#/definitions/PaymentMethodFilter"
}
}
},
"GetPaymentMethodsResponse" : {
"description": "The response schema for the `getPaymentMethodsResponse` operation.",
"type" : "object",
"example": {
"piDetails": [
{
"countryCode": "US",
"defaultMarketplaces": ["ATVPDKIKX0DER"],
"encryptedAccountHolderName": "?SIEGE|Rufus!00AAAAAAYIARAAGgAAAAAADgjowvyyBhAAGAAgADIAAAAAkQAAAAAAAAAA1goTnyZO5d+yqPgsktNT/nEAAAAAAAAAP0MonpF3YDVi4nembq6SlQ+4vdiDYdw3yAQnHXMw7xQtF7vzrLY/MJPd3nisz3cIf8mXj5Q6OLDmVukyrqBS0ZDq12OuNAqwh3O1w/tAba31f7UBWfhg3XJFwflqHOX028hd7wmGl72o9NNk6ylY18g=!EGEIS?",
"paymentInstrumentId": "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
"paymentInstrumentType": "CARD",
"expiryDate": {
"month": "3",
"year": "2029"
},
"tail": "677"
}
]
},
"properties" : {
"piDetails" : {
"$ref" : "#/definitions/ListOfPIDetails"
}
}
},
"PaymentMethodFilter" : {
"description": "The object used to filter payment methods based on different factors.",
"type" : "object",
"example": {
"paymentInstrumentId":"0h_PU_CUS_da62b97f-8629-46a1-8f8b-6f7fde4b5751",
"paymentInstrumentTypes": [ "BANK_ACCOUNT"]
},
"properties" : {
"paymentInstrumentId" : {
"description": "The payment instrument identifier.",
"$ref" : "#/definitions/StringWithNoWhiteSpace"
},
"subscribedMarketplaces" : {
"description": "The payment instrument identifier.",
"$ref" : "#/definitions/ListOfStrings"
},
"assignmentFilter" : {
"description": "The filter that returns the default payment instrument(s).",
"$ref" : "#/definitions/AssignmentFilter"
},
"paymentInstrumentTypes" : {
"description": "The list of payment instrument types.",
"$ref" : "#/definitions/ListOfPaymentInstrumentType"
}
}
},
"AssignmentFilter" : {
"type" : "object",
"description": "The list of default payment instruments that are returned when you use the `assignmentFilter`.",
"properties" : {
"assignmentTypes" : {
"$ref" : "#/definitions/ListOfAssignmentType"
}
}
},
"ListOfAssignmentType" : {
"description": "The list of assignment types.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/AssignmentType"
}
},
"AssignmentType" : {
"type" : "string",
"description": "The filter that returns payment methods based on the type of assignment.",
"enum" : [ "DEFAULT" ],
"x-docgen-enum-table-extension": [
{
"value": "DEFAULT",
"description": "The payment instrument that is used as the primary payout method."
}
]
},
"ListOfPIDetails" : {
"description": "The list of payment instruments.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/PIDetails"
}
},
"PIDetails" : {
"description": "The details of a payment instrument.",
"type" : "object",
"properties" : {
"encryptedAccountHolderName" : {
"description": "The encrypted account holder name that is registered for the payment instrument.",
"$ref" : "#/definitions/StringWithNoWhiteSpace"
},
"paymentInstrumentId" : {
"description": "The payment instrument identifier.",
"$ref" : "#/definitions/StringWithNoWhiteSpace"
},
"tail" : {
"description": "The last three or four digits of the payment instrument.",
"$ref" : "#/definitions/StringWithDigits"
},
"expiryDate" : {
"description": "The expiration date of a card used for payment.",
"$ref" : "#/definitions/ExpiryDate"
},
"countryCode" : {
"description": "The two-letter country code that follows the ISO 3166-1 alpha-2 standard. For payment methods in the `card` category, the code is for the country where the card was issued. For payment methods in the `bank account` category, the code is for the country where the account is located.",
"$ref" : "#/definitions/StringWithNoWhiteSpace"
},
"defaultMarketplaces" : {
"description": "The list of marketplaces where the the payment instrument is marked as `default`. The selected payment instrument activates payouts for these marketplaces.",
"$ref" : "#/definitions/ListOfStrings"
},
"paymentInstrumentType" : {
"description": "The payment instrument type.",
"$ref" : "#/definitions/PaymentInstrumentType"
}
}
},
"ExpiryDate" : {
"description": "The expiration date of a card used for payment. If the payment instrument is not a card, the expiration date is null.",
"type" : "object",
"properties" : {
"month" : {
"description": "Month",
"$ref" : "#/definitions/StringWithDigits"
},
"year" : {
"description": "Year",
"$ref" : "#/definitions/StringWithDigits"
}
}
},
"ListOfPaymentInstrumentType" : {
"type" : "array",
"example": ["BANK_ACCOUNT, CARD"],
"description": "The list of payment instrument types that are present.",
"items" : {
"$ref" : "#/definitions/PaymentInstrumentType"
}
},
"PaymentInstrumentType" : {
"description": "The payment instrument type.",
"type" : "string",
"enum" : [ "BANK_ACCOUNT", "CARD", "SELLER_WALLET" ],
"x-docgen-enum-table-extension": [
{
"value": "BANK_ACCOUNT",
"description": "Bank Account."
},
{
"value": "CARD",
"description": "Card"
},
{
"value": "SELLER_WALLET",
"description": "Seller Wallet Virtual Bank Account."
}
]
},
"ListOfStrings" : {
"description": "A list of strings.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/StringWithNoWhiteSpace"
}
},
"StringWithDigits" : {
"description": "A string with digits",
"type" : "string",
"example": "ATVPDKIKX0DER",
"pattern" : "^[0-9]*"
},
"StringWithNoWhiteSpace" : {
"description": "A string with no white spaces.",
"type" : "string",
"example": "ATVPDKIKX0DER",
"pattern" : "\\S+"
},
"ErrorList": {
"type": "object",
"description": "A list of error responses returned when a request is unsuccessful.",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"description": "array of errors",
"items": {
"$ref": "#/definitions/Error"
},
"example": [
{
"code": "InvalidInput",
"message": "The input request had one or more invalid input parameters."
}
]
}
}
},
"Error": {
"description": "Error response returned when the request is unsuccessful.",
"properties": {
"code": {
"description": "An error code that identifies the type of error that occurred.",
"type": "string",
"example": "InvalidInput"
},
"message": {
"description": "A message that describes the error condition.",
"type": "string",
"example": "The input request had one or more invalid input parameters."
},
"details": {
"description": "Additional details that can help the caller understand or fix the issue.",
"type": "string",
"example": "The following input parameters are invalid : [ marketplaceId ]."
}
},
"required": [
"code",
"message"
],
"type": "object",
"example": {
"code": "InvalidInput",
"message": "The input request had one or more invalid input parameters."
}
}
}
}
Updated 4 months ago