Withdraw a transfer

Article
05/23/2024

Note

This topic applies only to traditional license-based services and not to new commerce experiences. For more information about transferring new commerce license-based subscriptions, see the new commerce transfer topic.

Prerequisites

Credentials as described in Partner Center authentication. This scenario supports authentication with both standalone App and App+User credentials.
A customer ID (customer-tenant-id). If you don't know the customer's ID, you can look it up in Partner Center by selecting the Customers workspace, then the customer from the customer list, then Account. On the customer's Account page, look for the Microsoft ID in the Customer Account Info section. The Microsoft ID is the same as the customer ID (customer-tenant-id).
A transfer identifier for an existing transfer.

REST request

Request syntax

Method	Request URI
DELETE	{baseURL}/v1/customers/{customer-id}/transfers/{transfer-id} HTTP/1.1

URI parameter

Use the following path parameter to identify the customer.

Name	Type	Required	Description
customer-id	string	Yes	A GUID formatted customer-id that identifies the customer.
transfer-id	string	Yes	A GUID formatted transfer-id that identifies the transfer.

Request headers

For more information, see Partner Center REST headers.

Request example

DELETE /v1/customers/d6bf25b7-e0a8-4f2d-a31b-97b55cfc774d/transfers/67c5b05b-09b5-47ba-9047-5056fe2afa4f HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: cdf6e25c-7b32-4cc3-d8bc-53e0b37eebd8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Connection: keep-alive

REST response

If successful, this method returns No Content (204).

Response success and error codes

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. For the full list, see Error Codes.

Response example

HTTP/1.1 204 No Content
Content-Length: 0
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: cdf6e25c-7b32-4cc3-d8bc-53e0b37eebd8
Date: Tue, 24 Mar 2020 23:44:06 GMT

Share via