updateTransferSchedule

Update transfer schedule information. Returns a transfer belonging to the updated scheduled transfer request.

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.

destAccountDigitalSignaturestring required

Digital signature for the destination bank account details.

amountDigitalSignaturestring required

Digital signature for the source currency transaction amount.

Request body

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 request

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

Response

Success