Visual FoxPro

PayPal - Capture a Previously Authorized Payment

See more PayPal Examples

Captures a previously authorized payment.

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 lnNumReplacements
LOCAL loSbJsonRequest
LOCAL loSbJsonResponse

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..
* ----------------------------------------------------------------------------------------------

* Build the JSON containing the transaction information.
loJson = CreateObject('Chilkat.JsonObject')
loJson.EmitCompact = 0
loJson.UpdateString("amount.currency","USD")
loJson.UpdateString("amount.total","4.54")
loJson.UpdateBool("is_final_capture",1)
? loJson.Emit()

* The JSON created by the above code:

* 	{ 
* 	  "amount": { 
* 	    "currency": "USD",
* 	    "total": "4.54"
* 	  },
* 	  "is_final_capture": true
* 	}

loRest.AddHeader("Authorization",loSbAuth.GetAsString())
loRest.AddHeader("Content-Type","application/json")

* To capture payment, make a call to /v1/payments/authorization/[authorization_id]/capture with the authorization ID in the URI.
* See PayPal Authorize Payment for sample code to create the authorization.
* The "7X8332687A4929542" comes from the "transactions[0].related_resources[0].authorization.id" part of the authorization response.

loSbPath = CreateObject('Chilkat.StringBuilder')
loSbPath.Append("/v1/payments/authorization/[authorization_id]/capture")
lnNumReplacements = loSbPath.Replace("[authorization_id]","7X8332687A4929542")

* 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)

* IMPORTANT: In most PayPal examples, the return status code is 201.
* For this particular call, PayPal returns status code 200.

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

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

? "success"

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

* 	{ 
* 	  "id": "1LY5310469661362J",
* 	  "create_time": "2016-11-24T00:40:50Z",
* 	  "update_time": "2016-11-24T00:40:54Z",
* 	  "amount": { 
* 	    "total": "4.54",
* 	    "currency": "USD"
* 	  },
* 	  "is_final_capture": true,
* 	  "state": "completed",
* 	  "reasonCode": "None",
* 	  "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/authorization/7X8332687A4929542",
* 	      "rel": "authorization",
* 	      "method": "GET"
* 	    },
* 	    { 
* 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
* 	      "rel": "parent_payment",
* 	      "method": "GET"
* 	    }
* 	  ]
* 	

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