AWaws-samples
Seller Wallet v2024-03-01

createTransferSchedule

Create a transfer schedule request from a Seller Wallet account to another customer-provided account.

post/finances/transfers/wallet/2024-03-01/transferSchedules

Request

  • Base URL
    https://sellingpartnerapi-na.amazon.com
  • URL
    https://sellingpartnerapi-na.amazon.com/finances/transfers/wallet/2024-03-01/transferSchedules
  • Auth
    none declared. Required headers: destAccountDigitalSignature, amountDigitalSignature

Query parameters

marketplaceIdstring required

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.

Headers

destAccountDigitalSignaturestring required

Digital signature for the destination bank account details.

amountDigitalSignaturestring required

Digital signature for the source currency transaction amount.

Request body

sourceAccountIdstring required

The unique identifier of the source Amazon Seller Wallet bank account from which money is debited.

sourceCurrencyCodestring required

The three-letter currency code of the source payment method country, in ISO 4217 format.

destinationAccountIdstring required

The unique identifier of the destination bank account where the money is deposited.

transactionType'CREDIT' | 'DEBIT' required

The type of transaction.

transferScheduleStatus'ENABLED' | 'DISABLED' | 'EXPIRED' | 'DELETED'

The schedule status of the transfer.

Example request

{
  "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"
}

Response

Success

transferScheduleIdstring required

The unique identifier provided by Amazon to the scheduled transfer.

transactionType'CREDIT' | 'DEBIT' required

The type of transaction.

transferScheduleStatus'ENABLED' | 'DISABLED' | 'EXPIRED' | 'DELETED' required

The schedule status of the transfer.

Example 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-04-01T10:30:00Z",
      "transferScheduleFailureReason": "INSUFFICIENT_BALANCE"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.