Pay For Purchase

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Selects a payment option for purchase order created via StartPurchase

Error codes

This operation may return the following PlayFab errors:

Error	Code
DuplicatePurchaseTransactionId	1489
FailedByPaymentProvider	1015
InsufficientFunds	1059
InvalidPaymentProvider	1063
InvalidPurchaseTransactionStatus	1081
ProductDisabledForTitle	1609
PurchaseDoesNotExist	1080
PurchaseInitializationFailure	1064

POST

Client

PayForPurchase

Pay For Purchase

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/PayForPurchase \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "OrderId": "8853591446005860822",
  "ProviderName": "PayPal",
  "Currency": "RM"
}
'

import requests

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

payload = {
    "OrderId": "8853591446005860822",
    "ProviderName": "PayPal",
    "Currency": "RM"
}
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({OrderId: '8853591446005860822', ProviderName: 'PayPal', Currency: 'RM'})
};

fetch('https://{titleId}.playfabapi.com/Client/PayForPurchase', 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/PayForPurchase",
  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([
    'OrderId' => '8853591446005860822',
    'ProviderName' => 'PayPal',
    'Currency' => 'RM'
  ]),
  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/PayForPurchase"

	payload := strings.NewReader("{\n  \"OrderId\": \"8853591446005860822\",\n  \"ProviderName\": \"PayPal\",\n  \"Currency\": \"RM\"\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/PayForPurchase")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"OrderId\": \"8853591446005860822\",\n  \"ProviderName\": \"PayPal\",\n  \"Currency\": \"RM\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"OrderId\": \"8853591446005860822\",\n  \"ProviderName\": \"PayPal\",\n  \"Currency\": \"RM\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "OrderId": "8853591446005860822",
    "Status": "Init",
    "PurchaseCurrency": "RM",
    "PurchasePrice": 199
  }
}

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

Authorizations

X-Authorization

string

header

required

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

Body

application/json

This is the second step in the purchasing process, initiating the purchase transaction with the payment provider (if applicable). For payment provider scenarios, the title should next present the user with the payment provider'sinterface for payment. Once the player has completed the payment with the provider, the title should call ConfirmPurchase tofinalize the process and add the appropriate items to the player inventory.

Currency

string

required

Currency to use to fund the purchase.

OrderId

string

required

Purchase order identifier returned from StartPurchase.

ProviderName

string

required

Payment provider to use to fund the purchase.

CustomTags

object

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

ProviderTransactionId

string

Payment provider transaction identifier. Required for Facebook Payments.

Response

For web-based payment providers, this operation returns the URL to which the user should be directed inorder to approve the purchase. Items added to the user inventory as a result of this operation will be marked as unconfirmed.

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

Example:

{
  "OrderId": "8853591446005860822",
  "Status": "Init",
  "PurchaseCurrency": "RM",
  "PurchasePrice": 199
}

Last modified on October 1, 2026

⌘I

Pay For Purchase

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/PayForPurchase \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "OrderId": "8853591446005860822",
  "ProviderName": "PayPal",
  "Currency": "RM"
}
'

import requests

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

payload = {
    "OrderId": "8853591446005860822",
    "ProviderName": "PayPal",
    "Currency": "RM"
}
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({OrderId: '8853591446005860822', ProviderName: 'PayPal', Currency: 'RM'})
};

fetch('https://{titleId}.playfabapi.com/Client/PayForPurchase', 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/PayForPurchase",
  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([
    'OrderId' => '8853591446005860822',
    'ProviderName' => 'PayPal',
    'Currency' => 'RM'
  ]),
  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/PayForPurchase"

	payload := strings.NewReader("{\n  \"OrderId\": \"8853591446005860822\",\n  \"ProviderName\": \"PayPal\",\n  \"Currency\": \"RM\"\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/PayForPurchase")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"OrderId\": \"8853591446005860822\",\n  \"ProviderName\": \"PayPal\",\n  \"Currency\": \"RM\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"OrderId\": \"8853591446005860822\",\n  \"ProviderName\": \"PayPal\",\n  \"Currency\": \"RM\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "OrderId": "8853591446005860822",
    "Status": "Init",
    "PurchaseCurrency": "RM",
    "PurchasePrice": 199
  }
}

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

PlayFab API

PlayFab REST API References

Pay For Purchase

Error codes

Authorizations

Body

Response