Visual FoxPro

PayPal - Get Refund Details

See more PayPal Examples

Shows details for a refund, by ID.

Note: This example requires Chilkat v9.5.0.65 or greater.

Visual FoxPro

LOCAL lnSuccess
LOCAL loJsonToken
LOCAL loSbAuth
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL loSbPath
LOCAL lnNumReplaced
LOCAL loSbJsonResponse
LOCAL loJson

lnSuccess = 0

* Note: Requires Chilkat v9.5.0.65 or greater.

* 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)
loJsonToken = CreateObject('Chilkat.JsonObject')
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

* Build the Authorization request header field value.
loSbAuth = CreateObject('Chilkat.StringBuilder')
* token_type should be "Bearer"
loSbAuth.Append(loJsonToken.StringOf("token_type"))
loSbAuth.Append(" ")
loSbAuth.Append(loJsonToken.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.
loRest = CreateObject('Chilkat.Rest')
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("api.sandbox.paypal.com",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    CANCEL
ENDIF

* ----------------------------------------------------------------------------------------------
* 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.
loRest.ClearAllHeaders()
loRest.ClearAllQueryParams()

loRest.AddHeader("Authorization",loSbAuth.GetAsString())

* The refund ID is added to the path.
* To list your refunds, Find Completed Sales. 
* Refunds in the list have a sale object with a state of "refunded" and a refund object with a state of "completed".
loSbPath = CreateObject('Chilkat.StringBuilder')
loSbPath.Append("/v1/payments/refund/refund_id")
lnNumReplaced = loSbPath.Replace("refund_id","7NE550583A133505U")

* Send the GET request and get the JSON response.
loSbJsonResponse = CreateObject('Chilkat.StringBuilder')
lnSuccess = loRest.FullRequestNoBodySb("GET",loSbPath.GetAsString(),loSbJsonResponse)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loSbPath
    RELEASE loSbJsonResponse
    CANCEL
ENDIF

loJson = CreateObject('Chilkat.JsonObject')
loJson.EmitCompact = 0
loJson.LoadSb(loSbJsonResponse)

? "Response Status Code = " + STR(loRest.ResponseStatusCode)

* Did we get a 200 success response?
IF (loRest.ResponseStatusCode <> 200) THEN
    ? loJson.Emit()
    ? "Failed."
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loSbPath
    RELEASE loSbJsonResponse
    RELEASE loJson
    CANCEL
ENDIF

* Sample JSON response is shown below.
? loJson.Emit()
? "----------------------"

? "success"

* ------------------------------------------------
* A sample JSON response:

* 	{ 
* 	  "id": "7NE550583A133505U",
* 	  "create_time": "2016-11-26T16:38:27Z",
* 	  "update_time": "2016-11-26T16:38:27Z",
* 	  "state": "completed",
* 	  "amount": { 
* 	    "total": "-289.00",
* 	    "currency": "USD"
* 	  },
* 	  "sale_id": "1XC17935MN507400J",
* 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
* 	  "links": [
* 	    { 
* 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
* 	      "rel": "self",
* 	      "method": "GET"
* 	    },
* 	    { 
* 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
* 	      "rel": "parent_payment",
* 	      "method": "GET"
* 	    },
* 	    { 
* 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
* 	      "rel": "sale",
* 	      "method": "GET"
* 	    }
* 	  ]
* 	}

RELEASE loJsonToken
RELEASE loSbAuth
RELEASE loRest
RELEASE loSbPath
RELEASE loSbJsonResponse
RELEASE loJson