PureBasic
PureBasic
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.
Chilkat PureBasic Downloads
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"
Procedure ChilkatExample()
success.i = 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)
jsonToken.i = CkJsonObject::ckCreate()
If jsonToken.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/paypal.json")
; Build the Authorization request header field value.
sbAuth.i = CkStringBuilder::ckCreate()
If sbAuth.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; token_type should be "Bearer"
CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"token_type"))
CkStringBuilder::ckAppend(sbAuth," ")
CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"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.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
bAutoReconnect.i = 1
success = CkRest::ckConnect(rest,"api.sandbox.paypal.com",443,1,bAutoReconnect)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
ProcedureReturn
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:
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckUpdateString(json,"amount.total","4.54")
CkJsonObject::ckUpdateString(json,"amount.currency","USD")
CkJsonObject::ckUpdateString(json,"description","Athletic socks")
CkJsonObject::ckUpdateString(json,"reason","Refunding because color was incorrect")
Debug CkJsonObject::ckEmit(json)
; The JSON:
; {
; "amount": {
; "total": "4.54",
; "currency": "USD"
; },
; "description": "Athletic socks",
; "reason": "Refunding because color was incorrect"
; }
;
CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
CkRest::ckAddHeader(rest,"Content-Type","application/json")
; The capture ID is added to the path.
; To list your captures: Find Captures.
sbPath.i = CkStringBuilder::ckCreate()
If sbPath.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbPath,"/v1/payments/capture/capture_id/refund")
numReplaced.i = CkStringBuilder::ckReplace(sbPath,"capture_id","1LY5310469661362J")
; Send the POST request containign the JSON in the request body, and get the JSON response.
sbJsonRequest.i = CkStringBuilder::ckCreate()
If sbJsonRequest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 1)
CkJsonObject::ckEmitSb(json,sbJsonRequest)
sbJsonResponse.i = CkStringBuilder::ckCreate()
If sbJsonResponse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST",CkStringBuilder::ckGetAsString(sbPath),sbJsonRequest,sbJsonResponse)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckLoadSb(json,sbJsonResponse)
Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))
; Did we get a 201 success response?
If CkRest::ckResponseStatusCode(rest) <> 201
Debug CkJsonObject::ckEmit(json)
Debug "Failed."
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndIf
Debug CkJsonObject::ckEmit(json)
Debug "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"
; }
; ]
; }
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndProcedure