Documentation

GetPurchase

Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that are still active.

Request Details

GetPurchaseRequest
Request Properties
OrderId (required) String

Purchase order identifier.

POST https://{{TitleID}}.playfabapi.com/Client/GetPurchase
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "OrderId": "8853591446005860822"
}
        

Response Details

GetPurchaseResult
Result Properties
OrderId String

Purchase order identifier.

PaymentProvider String

Payment provider used for transaction (If not VC)

PurchaseDate (required) DateTime

Date and time of the purchase.

TransactionId String

Provider transaction ID (If not VC)

TransactionStatus String

PlayFab transaction status

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "OrderId": "123",
    "PaymentProvider": "Steam",
    "TransactionStatus": "Succeeded",
    "PurchaseDate": "2017-03-02T00:00:00Z"
  }
}

Authentication

SessionTicket

Possible Error Codes

Name Code
PurchaseDoesNotExist 1080