Transfers API v2024-06-01 reference

Initiate payouts using the Transfers API v2024-06-01.

The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.

Version information

Version : 2024-06-01

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

application/json

Produces

application/json

Operations

initiatePayout
getPaymentMethods

Paths

POST /finances/transfers/2024-06-01/payouts

Operation: initiatePayout

Description

Initiates an on-demand payout to the seller's default deposit method in Seller Central for the given marketplaceId and accountType, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period.

Usage Plan:

Rate (requests per second)	Burst
0.017	2

The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

Parameters

Type	Name	Description	Schema
Body	body required	The request body for the `initiatePayout` operation.	InitiatePayoutRequest

Responses

HTTP Code	Description	Schema
200	Success. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	InitiatePayoutResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Example HTTP request

Request body

{
  "marketplaceId" : "APJ6JRA9NG5V4",
  "accountType" : "Standard Orders"
}

Example HTTP response

Response 200

{
  "payoutReferenceId" : "3DM7DQi8DPAMOLOSaN5HxT0q2waNwH95fopx3AD2Lgc"
}

GET /finances/transfers/2024-06-01/paymentMethods

Operation: getPaymentMethods

Description

Returns the list of payment methods for the seller, which can be filtered by method type.

Usage Plan:

Rate (requests per second)	Burst
.5	30

Parameters

Type	Name	Description	Schema
Query	marketplaceId required	The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to Marketplace IDs.	string
Query	paymentMethodTypes optional	A comma-separated list of the payment method types you want to include in the response. Min count : 1	< enum (PaymentMethodTypes) > array(csv)

Responses

HTTP Code	Description	Schema
200	Success. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	GetPaymentMethodsResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Example HTTP response

Response 200

{
  "paymentMethods" : [ {
    "accountHolderName" : "John Doe",
    "paymentMethodId" : "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
    "paymentMethodType" : "BANK_ACCOUNT",
    "tail" : "677",
    "assignmentType" : "DEFAULT_DEPOSIT_METHOD"
  }, {
    "countryCode" : "US",
    "accountHolderName" : "John Doe",
    "paymentMethodId" : "0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d",
    "paymentMethodType" : "CARD",
    "expiryDate" : {
      "month" : "3",
      "year" : "2029"
    },
    "tail" : "677"
  } ]
}

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP Code	Description	Schema
400	Request has missing or invalid parameters and cannot be parsed. Headers: `x-amzn-RateLimit-Limit` (string):Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
404	The resource specified does not exist. Headers: `x-amzn-RateLimit-Limit` (string):Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
413	The request size exceeded the maximum accepted size. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
415	The request payload is in an unsupported format. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
429	The frequency of requests was greater than allowed. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList
503	Temporary overloading or maintenance of the server. Headers: `x-amzn-RequestId` (string):Unique request reference identifier.	ErrorList

Definitions

InitiatePayoutRequest

The request schema for the initiatePayout operation.

Name	Description	Schema
marketplaceId required	The identifier of the Amazon marketplace. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE. For a list of possible marketplace IDs, refer to Marketplace IDs.	MarketplaceId
accountType required	The account type in the selected marketplace for which a payout must be initiated. For supported EU marketplaces, the only account type is `Standard Orders`.	string

InitiatePayoutResponse

The response schema for the initiatePayout operation.

Name	Description	Schema
payoutReferenceId required	The financial event group ID for a successfully initiated payout. You can use this ID to track payout information.	string

GetPaymentMethodsResponse

The response schema for the getPaymentMethods operation.

Name	Description	Schema
paymentMethods optional	The list of payment methods with payment method details.	PaymentMethodList

PaymentMethodList

The list of payment methods with payment method details.

Type : < PaymentMethodDetails > array

PaymentMethodDetails

The details of a payment method.

Name	Description	Schema
accountHolderName optional	The name of the account holder who is registered for the payment method.	string
paymentMethodId optional	The payment method identifier. Example : `"0h_TU_CUS_4058fe2a-da6b-4b82-8e48-b20ff2eb4f6d"`	string
tail optional	The last three or four digits of the payment method. Example : `"321"`	string
expiryDate optional	The expiration date of the card used for payment.	ExpiryDate
countryCode optional	The two-letter country code in ISO 3166-1 alpha-2 format. For payment methods in the `card` category, the code is for the country where the card was issued. For payment methods in the `bank account` category, the code is for the country where the account is located. Example : `"US"`	string
paymentMethodType optional	The payment method type.	PaymentMethodType
assignmentType optional	The payment method assignment type, whether it is assigned as default to the given marketplace or not.	AssignmentType

ExpiryDate

The expiration date of the card used for payment. If the payment method is not card, the expiration date is null.

Name	Description	Schema
month optional	The month the card expires expressed as a number from `1` to `12`. Example : `"3"`	string
year optional	Year Example : `"2024"`	string

PaymentMethodType

The type of payment method.

Type : enum

Value	Description
BANK_ACCOUNT	The payment is from a bank account.
CARD	The payment is from a card.
SELLER_WALLET	The payment is from a Seller Wallet virtual bank account.

AssignmentType

The default payment method type.

Type : enum

Value	Description
DEFAULT_DEPOSIT_METHOD	The default deposit method.

MarketplaceId

The identifier of the Amazon marketplace. For the list of all marketplace IDs, refer to Marketplace IDs.

Type : string

ErrorList

A list of error responses returned when a request is unsuccessful.

Name	Description	Schema
errors required	array of errors Example : `[ {<br> "code" : "InvalidInput",<br> "message" : "The input request had one or more invalid input parameters."<br>} ]`	< Error > array

Error

Error response returned when the request is unsuccessful.

Name	Description	Schema
code required	An error code that identifies the type of error that occurred. Example : `"InvalidInput"`	string
message required	A message that describes the error condition. Example : `"The input request had one or more invalid input parameters."`	string
details optional	Additional details that can help the caller understand or fix the issue. Example : `"The following input parameters are invalid : [ marketplaceId ]."`	string

PaymentMethodTypes

Type : enum

Value	Description
BANK_ACCOUNT	The payment is from a bank account.
CARD	The payment is from a card.
SELLER_WALLET	The payment is from a Seller Wallet virtual bank account.

Updated 3 days ago