AWaws-samples
Seller Wallet v2024-03-01

listTransferSchedules

Retrieve transfer schedules of a Seller Wallet bank account.

get/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

Query parameters

accountIdstring required

The ID of the Amazon Seller Wallet account.

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.

nextPageTokenstring

A token that you use to retrieve the next page of results. The response includes nextPageToken when the number of results exceeds the specified pageSize value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextPageToken is null. Note that this operation can return empty pages.

Response

Success

nextPageTokenstring

A token that you use to retrieve the next page of results. The response includes nextPageToken when the number of results exceeds 100. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextPageToken is null. Note that this operation can return empty pages.

Example response

{
  "nextPageToken": "3493805734095308457308475",
  "transferSchedules": [
    {
      "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.