PowerShell Requires Chilkat v11.0.0+

PayPal - Get Sale Details

See more PayPal Examples

Shows details for a sale transaction, by ID. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

#  This requires the Chilkat API to have been previously unlocked.
#  See Global Unlock Sample for sample code.

#  Load our previously obtained access token. (see PayPal OAuth2 Access Token)
$jsonToken = New-Object Chilkat.JsonObject
$jsonToken.LoadFile("qa_data/tokens/paypal.json")

#  Build the Authorization request header field value.
$sbAuth = New-Object Chilkat.StringBuilder
#  token_type should be "Bearer"
$sbAuth.Append($jsonToken.StringOf("token_type"))
$sbAuth.Append(" ")
$sbAuth.Append($jsonToken.StringOf("access_token"))

#  Make the initial connection.
#  A single REST object, once connected, can be used for many PayPal REST API calls.
#  The auto-reconnect indicates that if the already-established HTTPS connection is closed,
#  then it will be automatically re-established as needed.
$rest = New-Object Chilkat.Rest
$bAutoReconnect = $true
$success = $rest.Connect("api.sandbox.paypal.com",443,$true,$bAutoReconnect)
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

#  ----------------------------------------------------------------------------------------------
#  The code above this comment could be placed inside a function/subroutine within the application
#  because the connection does not need to be made for every request.  Once the connection is made
#  the app may send many requests..
#  ----------------------------------------------------------------------------------------------

#  Clear the REST object of any headers or query params from previous requests.
$rest.ClearAllHeaders()
$rest.ClearAllQueryParams()

$rest.AddHeader("Authorization",$sbAuth.GetAsString())

#  The sale ID is added to the path.
#  The sale ID is obtained from payment records as shown here: Find Completed Sales
$sbPath = New-Object Chilkat.StringBuilder
$sbPath.Append("/v1/payments/sale/sale_id")
$numReplaced = $sbPath.Replace("sale_id","1XC17935MN507400J")

#  Send the GET request and get the JSON response.
$sbJsonResponse = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("GET",$sbPath.GetAsString(),$sbJsonResponse)
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

$json = New-Object Chilkat.JsonObject
$json.EmitCompact = $false
$json.LoadSb($sbJsonResponse)

$("Response Status Code = " + $rest.ResponseStatusCode)

#  Did we get a 200 success response?
if ($rest.ResponseStatusCode -ne 200) {
    $($json.Emit())
    $("Failed.")
    exit
}

#  Sample JSON response is shown below.
$($json.Emit())
$("----------------------")

#  Show how to get a timestamp, such as update_time.
$dateTime = New-Object Chilkat.CkDateTime
$success = $dateTime.SetFromTimestamp($json.StringOf("update_time"))
$("utc update_time: " + $dateTime.GetAsTimestamp($false))
$("local update_time: " + $dateTime.GetAsTimestamp($true))
$("utc rfc822: " + $dateTime.GetAsRfc822($false))
$("local rfc822: " + $dateTime.GetAsRfc822($true))

$dtUtc = New-Object Chilkat.DtObj
$dateTime.ToDtObj($false,$dtUtc)

$([string]$dtUtc.Month + "/" + $dtUtc.Day + "/" + $dtUtc.Year)

$("success")

#  ------------------------------------------------
#  A sample JSON response:

#  	{ 
#  	  "id": "1XC17935MN507400J",
#  	  "create_time": "2016-11-25T15:42:50Z",
#  	  "update_time": "2016-11-25T15:42:56Z",
#  	  "amount": { 
#  	    "total": "289.00",
#  	    "currency": "USD"
#  	  },
#  	  "payment_mode": "INSTANT_TRANSFER",
#  	  "state": "completed",
#  	  "protection_eligibility": "ELIGIBLE",
#  	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
#  	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
#  	  "transaction_fee": { 
#  	    "value": "8.68",
#  	    "currency": "USD"
#  	  },
#  	  "links": [
#  	    { 
#  	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
#  	      "rel": "self",
#  	      "method": "GET"
#  	    },
#  	    { 
#  	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
#  	      "rel": "refund",
#  	      "method": "POST"
#  	    },
#  	    { 
#  	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
#  	      "rel": "parent_payment",
#  	      "method": "GET"
#  	    }
#  	  ]
#  	}