PowerShell Requires Chilkat v11.0.0+
PowerShell
PayPal - Show Payment Details
See more PayPal Examples
Shows details for a payment by ID.Chilkat PowerShell Downloads
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 payment ID is added to the path.
$sbPath = New-Object Chilkat.StringBuilder
$sbPath.Append("/v1/payments/payment/payment_id")
$numReplaced = $sbPath.Replace("payment_id","PAY-62106714J93631829LA44NWI")
# 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": "PAY-2CY489250W145633HLA3DK3Y",
# "create_time": "2016-11-24T00:33:51Z",
# "update_time": "2016-11-24T00:40:54Z",
# "state": "approved",
# "intent": "authorize",
# "payer": {
# "payment_method": "credit_card",
# "funding_instruments": [
# {
# "credit_card_token": {
# "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
# "payer_id": "user12345",
# "last4": "9974",
# "type": "visa",
# "expire_month": "9",
# "expire_year": "2021"
# }
# }
# ]
# },
# "transactions": [
# {
# "amount": {
# "total": "6.70",
# "currency": "USD",
# "details": {
# "subtotal": "6.70"
# }
# },
# "description": "This is the payment transaction description.",
# "related_resources": [
# {
# "authorization": {
# "id": "7X8332687A4929542",
# "create_time": "2016-11-24T00:33:51Z",
# "update_time": "2016-11-24T00:33:58Z",
# "amount": {
# "total": "6.70",
# "currency": "USD",
# "details": {
# "subtotal": "6.70"
# }
# },
# "state": "captured",
# "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
# "valid_until": "2016-12-23T00:33:51Z",
# "links": [
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542",
# "rel": "self",
# "method": "GET"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "parent_payment",
# "method": "GET"
# }
# ]
# }
# },
# {
# "capture": {
# "id": "1LY5310469661362J",
# "create_time": "2016-11-24T00:40:50Z",
# "update_time": "2016-11-24T00:40:54Z",
# "amount": {
# "total": "4.54",
# "currency": "USD"
# },
# "state": "completed",
# "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
# "transaction_fee": {
# "value": "0.43",
# "currency": "USD"
# },
# "links": [
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
# "rel": "self",
# "method": "GET"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J/refund",
# "rel": "refund",
# "method": "POST"
# },
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "parent_payment",
# "method": "GET"
# }
# ]
# }
# }
# ]
# }
# ],
# "links": [
# {
# "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
# "rel": "self",
# "method": "GET"
# }
# ]
# }