Comprar item

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.

Error codes

This operation may return the following PlayFab errors:

Error	Code
CharacterNotFound	1135
InsufficientFunds	1059
InvalidVirtualCurrency	1051
ItemNotFound	1047
OperationNotSupportedForPlatform	1219
ProductDisabledForTitle	1609
StoreNotFound	1221
WrongPrice	1053
WrongVirtualCurrency	1052

POST

Client

PurchaseItem

Purchase Item

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/PurchaseItem \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "ItemId": "shield_level_5",
  "VirtualCurrency": "GV",
  "Price": 25
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/PurchaseItem"

payload = {
    "ItemId": "shield_level_5",
    "VirtualCurrency": "GV",
    "Price": 25
}
headers = {
    "X-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ItemId: 'shield_level_5', VirtualCurrency: 'GV', Price: 25})
};

fetch('https://{titleId}.playfabapi.com/Client/PurchaseItem', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/PurchaseItem",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ItemId' => 'shield_level_5',
    'VirtualCurrency' => 'GV',
    'Price' => 25
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/PurchaseItem"

	payload := strings.NewReader("{\n  \"ItemId\": \"shield_level_5\",\n  \"VirtualCurrency\": \"GV\",\n  \"Price\": 25\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/PurchaseItem")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ItemId\": \"shield_level_5\",\n  \"VirtualCurrency\": \"GV\",\n  \"Price\": 25\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/PurchaseItem")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ItemId\": \"shield_level_5\",\n  \"VirtualCurrency\": \"GV\",\n  \"Price\": 25\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "Items": [
      {
        "ItemId": "shield_level_5",
        "ItemInstanceId": "123456789ABC",
        "PurchaseDate": "2014-03-07T00:00:00",
        "CatalogVersion": "5",
        "DisplayName": "Level 5 Shield",
        "UnitCurrency": "GV",
        "UnitPrice": 25
      }
    ]
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Autorizações

X-Authorization

string

header

obrigatório

This API requires a client session ticket, available from any Client Login function.

Corpo

application/json

Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation (with each item in a bundle being a distinct add).

ItemId

string

obrigatório

Unique identifier of the item to purchase.

Price

number

obrigatório

Price the client expects to pay for the item (in case a new catalog or store was uploaded, with new prices).

VirtualCurrency

string

obrigatório

Virtual currency to use to purchase the item.

CatalogVersion

string

Catalog version for the items to be purchased (defaults to most recent version.

CharacterId

string

Unique PlayFab assigned ID for a specific character owned by a user

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

StoreId

string

Store to buy this item through. If not set, prices default to those in the catalog.

Resposta

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Exemplo:

{
  "Items": [
    {
      "ItemId": "shield_level_5",
      "ItemInstanceId": "123456789ABC",
      "PurchaseDate": "2014-03-07T00:00:00",
      "CatalogVersion": "5",
      "DisplayName": "Level 5 Shield",
      "UnitCurrency": "GV",
      "UnitPrice": 25
    }
  ]
}

Última modificação em 6 de outubro de 2026

⌘I

Purchase Item

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/PurchaseItem \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "ItemId": "shield_level_5",
  "VirtualCurrency": "GV",
  "Price": 25
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/PurchaseItem"

payload = {
    "ItemId": "shield_level_5",
    "VirtualCurrency": "GV",
    "Price": 25
}
headers = {
    "X-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ItemId: 'shield_level_5', VirtualCurrency: 'GV', Price: 25})
};

fetch('https://{titleId}.playfabapi.com/Client/PurchaseItem', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/PurchaseItem",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ItemId' => 'shield_level_5',
    'VirtualCurrency' => 'GV',
    'Price' => 25
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/PurchaseItem"

	payload := strings.NewReader("{\n  \"ItemId\": \"shield_level_5\",\n  \"VirtualCurrency\": \"GV\",\n  \"Price\": 25\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/PurchaseItem")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ItemId\": \"shield_level_5\",\n  \"VirtualCurrency\": \"GV\",\n  \"Price\": 25\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/PurchaseItem")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ItemId\": \"shield_level_5\",\n  \"VirtualCurrency\": \"GV\",\n  \"Price\": 25\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "Items": [
      {
        "ItemId": "shield_level_5",
        "ItemInstanceId": "123456789ABC",
        "PurchaseDate": "2014-03-07T00:00:00",
        "CatalogVersion": "5",
        "DisplayName": "Level 5 Shield",
        "UnitCurrency": "GV",
        "UnitPrice": 25
      }
    ]
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Comprar item

Error codes

Autorizações

Corpo

Resposta