--- title: "createTransferSchedule" method: POST path: "/finances/transfers/wallet/2024-03-01/transferSchedules" tags: ["Seller Wallet v2024-03-01"] --- # createTransferSchedule `POST /finances/transfers/wallet/2024-03-01/transferSchedules` Create a transfer schedule request from a Seller Wallet account to another customer-provided account. ## Query parameters - `marketplaceId` string, required ## Headers - `destAccountDigitalSignature` string, required - `amountDigitalSignature` string, required ## Request body - TransferScheduleRequest — Request body to initiate a scheduled transfer from a Seller Wallet bank account to another customer-defined bank account. - `sourceAccountId` string, required — The unique identifier of the source Amazon Seller Wallet bank account from which money is debited. - `sourceCurrencyCode` string, required — The three-letter currency code of the source payment method country, in ISO 4217 format. - `destinationAccountId` string, required — The unique identifier of the destination bank account where the money is deposited. - `destinationTransactionInstrument` TransactionInstrumentDetails, required — Details of the destination bank account in the transaction request. - `bankAccount` BankAccount, required — 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. - `accountId` string — 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. - `accountHolderName` string — The bank account holder's name (expected to be an Amazon customer). There is a 50 character limit. - `bankAccountNumberFormat` 'IBAN' | 'BBAN' — The format of the bank account number. - `bankName` string — The name of the bank. This value is Amazon Seller Wallet for Amazon Seller Wallet accounts. - `bankAccountOwnershipType` 'THIRD_PARTY' | 'SELF', required — The destination bank account's ownership type. - `routingNumber` string — Routing number for automated clearing house transfers for `THIRD_PARTY` transaction requests. This value is nine consecutive zeros for Amazon Seller Wallet accounts. - `bankNumberFormat` 'BIC' | 'BASIC' — The format of the bank number. Also known as the routing number type. - `accountCountryCode` string, required — The two-digit country code in ISO 3166 format. - `accountCurrency` string, required — Bank account currency code in ISO 4217 format. - `bankAccountNumberTail` string, required — The last 3 digit of the bank account number. This value is three consecutive zeros for Amazon Seller Wallet accounts. - `bankAccountHolderStatus` 'ACTIVE' | 'INACTIVE' | 'UNDER_REVIEW' | 'VERIFICATION_FAILED' — The status of the Amazon Seller Wallet account holder. - `bankAccountNumber` string, required — The bank account number of the destination payment method. **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. - `accountHolderName` string, required — The bank account holder's name (expected to be an Amazon customer). **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. - `transactionType` 'CREDIT' | 'DEBIT', required — The type of transaction. - `transferScheduleInformation` TransferScheduleInformation, required — Mandatory information for initiating a schedule transfer. - `scheduleStartDate` string, date-time — The start date of the scheduled transfer. - `scheduleEndDate` string, date-time — The end date of the scheduled transfer. - `scheduleExpression` ScheduleExpression — The configuration of the schedule. - `scheduleExpressionType` 'RECURRING' | 'ONE_TIME', required — The type of scheduled transfer expression. - `recurringFrequency` 'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' — The frequency at which the transaction is repeated. - `scheduleType` 'TIME_BASED' — The type of schedule the transfer is on. Schedules based on time patterns use EventBridge. - `paymentPreference` PaymentPreference, required — The type of payment preference in which the transfer is being scheduled. - `paymentPreferencePaymentType` 'PERCENTAGE' | 'AMOUNT', required — The type of payment preference. - `value` number, required — A decimal number, such as an amount or FX rate. - `transferScheduleStatus` 'ENABLED' | 'DISABLED' | 'EXPIRED' | 'DELETED' — The schedule status of the transfer. ## Response `200` Success - TransferSchedule — Transfer schedule details and related historical details. - `transferScheduleId` string, required — The unique identifier provided by Amazon to the scheduled transfer. - `transactionType` 'CREDIT' | 'DEBIT', required — The type of transaction. - `transactionSourceAccount` TransactionAccount — Details of the bank account involved in the transaction. - `accountId` string — The unique identifier provided by Amazon to identify the account. - `bankAccountHolderName` string — The account holder's name. - `bankName` string, required — The name of the bank. - `bankAccountNumberFormat` 'IBAN' | 'BBAN', required — The format of the bank account number. - `bankAccountNumberTail` string — The last three digits of the bank account number. - `bankAccountCountryCode` string — The two-digit country code, in ISO 3166 format. This field is optional for `transactionSourceAccount`, but is mandatory for `transactionDestinationAccount`. - `bankAccountCurrency` string, required — The currency code in ISO 4217 format. - `transactionDestinationAccount` TransactionAccount, required — Details of the bank account involved in the transaction. - `accountId` string — The unique identifier provided by Amazon to identify the account. - `bankAccountHolderName` string — The account holder's name. - `bankName` string, required — The name of the bank. - `bankAccountNumberFormat` 'IBAN' | 'BBAN', required — The format of the bank account number. - `bankAccountNumberTail` string — The last three digits of the bank account number. - `bankAccountCountryCode` string — The two-digit country code, in ISO 3166 format. This field is optional for `transactionSourceAccount`, but is mandatory for `transactionDestinationAccount`. - `bankAccountCurrency` string, required — The currency code in ISO 4217 format. - `transferScheduleStatus` 'ENABLED' | 'DISABLED' | 'EXPIRED' | 'DELETED', required — The schedule status of the transfer. - `transferScheduleInformation` TransferScheduleInformation, required — Mandatory information for initiating a schedule transfer. - `scheduleStartDate` string, date-time — The start date of the scheduled transfer. - `scheduleEndDate` string, date-time — The end date of the scheduled transfer. - `scheduleExpression` ScheduleExpression — The configuration of the schedule. - `scheduleExpressionType` 'RECURRING' | 'ONE_TIME', required — The type of scheduled transfer expression. - `recurringFrequency` 'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' — The frequency at which the transaction is repeated. - `scheduleType` 'TIME_BASED' — The type of schedule the transfer is on. Schedules based on time patterns use EventBridge. - `paymentPreference` PaymentPreference — The type of payment preference in which the transfer is being scheduled. - `paymentPreferencePaymentType` 'PERCENTAGE' | 'AMOUNT', required — The type of payment preference. - `value` number, required — A decimal number, such as an amount or FX rate. - `transferScheduleFailures` TransferScheduleFailures[], required — A list of transfer schedule failures. - `transferScheduleFailureDate` string, date-time, required — The transfer schedule failure date. - `transferScheduleFailureReason` string, required — The reason listed for the failure of the transfer schedule. ## Other responses - `400` — Request has missing or invalid parameters and cannot be parsed. - `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. - `404` — The resource specified does not exist. - `408` — Request Timed Out. - `409` — Transfer schedule already exists for same source and destination account combination. - `413` — The request size exceeded the maximum accepted size. - `415` — The request payload is in an unsupported format. - `429` — The frequency of requests was greater than allowed. - `500` — An unexpected condition occurred that prevented the server from fulfilling the request. - `503` — Temporary overloading or maintenance of the server. --- [API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/revisions/815a5b6dbaa6/schema)