Reject a transfer

Article
09/20/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.

Appropriate roles: Admin agent | Sales agent

REST request

Request syntax

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

URI parameter

Use the following path parameter to identify the customer and specify the transfer to be accepted.

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 body

This table describes the TransferEntity properties in the request body.

Property	Type	Required	Description
id	string	No	A transferEntity identifier that is supplied upon successful creation of the transferEntity.
status	string	No	The status of the transferEntity. To reject a transfer, the value is to be set as "reject"

Request example

PATCH /v1/customers/b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0/transfers/ac4a9d22-ba07-444e-890f-cfe084eed498 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 5b46e795-b661-428e-a2e7-f208b8d0d25c
Connection: keep-alive
Content-Length: 63

{"id":"ac4a9d22-ba07-444e-890f-cfe084eed498","status":"reject"}

REST response

If successful, this method returns the populated TransferEntity resource in the response body.

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 200 OK
Content-Length: 1069
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 5b46e795-b661-428e-a2e7-f208b8d0d25c
X-Locale: en-US
Date: Fri, 27 Mar 2020 17:50:33 GMT

{
  "id": "ac4a9d22-ba07-444e-890f-cfe084eed498",
  "status": "Reject",
  "createdTime": "2020-03-25T22:05:25.1057725Z",
  "lastModifiedTime": "2020-03-27T17:50:32Z",
  "customerTenantId": "b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0",
  "partnertenantid": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
  "sourcePartnerName": "Test_Test_09092019GBL",
  "sourcePartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
  "targetPartnerName": "Test_Test_09032019GBL",
  "targetPartnerTenantId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
  "lastModifiedUser": "01a7548d-1136-4cf0-ba9a-300f921ffb22",
  "lineItems": [
    {
      "id": 0,
      "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
      "offerId": "13D32E13-A1B0-400D-96C0-4EAAA14DCED5",
      "billingCycle": "monthly",
      "friendlyName": "Dynamics 365 for Supply Chain Management Attach to Qualifying Dynamics 365 Base Offer (Qualified Offer)",
      "quantity": 20,
      "partnerIdOnRecord": "5139005",
      "addonItems": [

      ]
    }
  ],
  "links": {
    "self": {
      "uri": "/customers/b67f0b00-f9e8-4c57-bcb5-0b8b95c6ccf0/transfers/ac4a9d22-ba07-444e-890f-cfe084eed498",
      "method": "GET",
      "headers": [

      ]
    }
  },
  "attributes": {
    "objectType": "TransferEntity"
  }
}

Share via