Visual FoxPro

PayPal - Refund Captured Payment

See more PayPal Examples

Refunds a captured payment, by ID. Include an amount object in the JSON request body.

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

Visual FoxPro

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

lnSuccess = 0

* Note: Requires Chilkat v9.5.0.64 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..
* ----------------------------------------------------------------------------------------------

* To refund a particular amount, build JSON such as this:
loJson = CreateObject('Chilkat.JsonObject')
loJson.EmitCompact = 0
loJson.UpdateString("amount.total","4.54")
loJson.UpdateString("amount.currency","USD")
loJson.UpdateString("description","Athletic socks")
loJson.UpdateString("reason","Refunding because color was incorrect")
? loJson.Emit()

* The JSON:

* 	{ 
* 	  "amount": { 
* 	    "total": "4.54",
* 	    "currency": "USD"
* 	  },
* 	  "description": "Athletic socks",
* 	  "reason": "Refunding because color was incorrect"
* 	}
* 
loRest.AddHeader("Authorization",loSbAuth.GetAsString())
loRest.AddHeader("Content-Type","application/json")

* The capture ID is added to the path.
* To list your captures: Find Captures. 
loSbPath = CreateObject('Chilkat.StringBuilder')
loSbPath.Append("/v1/payments/capture/capture_id/refund")
lnNumReplaced = loSbPath.Replace("capture_id","1LY5310469661362J")

* Send the POST request containign the JSON in the request body, and get the JSON response.
loSbJsonRequest = CreateObject('Chilkat.StringBuilder')
loJson.EmitCompact = 1
loJson.EmitSb(loSbJsonRequest)
loSbJsonResponse = CreateObject('Chilkat.StringBuilder')

lnSuccess = loRest.FullRequestSb("POST",loSbPath.GetAsString(),loSbJsonRequest,loSbJsonResponse)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loSbAuth
    RELEASE loRest
    RELEASE loJson
    RELEASE loSbPath
    RELEASE loSbJsonRequest
    RELEASE loSbJsonResponse
    CANCEL
ENDIF

loJson.EmitCompact = 0
loJson.LoadSb(loSbJsonResponse)

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

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

? loJson.Emit()
? "Success."

* A successful JSON response:
* The "id" is the refund_id.

* 	{ 
* 	  "id": "77B77607RR7243500",
* 	  "create_time": "2016-11-27T01:38:25Z",
* 	  "update_time": "2016-11-27T01:38:25Z",
* 	  "state": "completed",
* 	  "amount": { 
* 	    "total": "4.54",
* 	    "currency": "USD"
* 	  },
* 	  "capture_id": "1LY5310469661362J",
* 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
* 	  "links": [
* 	    { 
* 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/77B77607RR7243500",
* 	      "rel": "self",
* 	      "method": "GET"
* 	    },
* 	    { 
* 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
* 	      "rel": "parent_payment",
* 	      "method": "GET"
* 	    },
* 	    { 
* 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
* 	      "rel": "capture",
* 	      "method": "GET"
* 	    }
* 	  ]
* 	}

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