PureBasic Requires Chilkat v11.0.0+
PureBasic
PayPal: Partially refund a capture
See more PayPal Examples
Return USD 5 against a specific capture. Use its original currency and check the refundable amount. Store the returned refund ID and inspect its status.
Chilkat PureBasic Downloads
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkCrypt2.pb"
Procedure ChilkatExample()
success.i = 0
; See Unlock Chilkat before making requests.
; For the merchant's internal backoffice application. Load the sandbox token
; from the merchant's credential store. Keep it out of publicly distributed apps.
; See Get a PayPal access token.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttp::setCkAuthToken(http, "SANDBOX_ACCESS_TOKEN")
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Use the capture ID and currency of the original transaction, even if the order has
; several captures.
CkHttp::ckSetUrlVar(http,"id","CAPTURE_ID")
; Create and persist this key once per business operation. On a timeout,
; retry the same request with its saved key, not a newly generated one.
crypt.i = CkCrypt2::ckCreate()
If crypt.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
requestId.s = CkCrypt2::ckGenerateUuid(crypt)
CkHttp::ckSetRequestHeader(http,"PayPal-Request-Id",requestId)
CkHttp::ckSetRequestHeader(http,"Prefer","return=representation")
body.i = CkJsonObject::ckCreate()
If body.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(body,"amount.currency_code","USD")
CkJsonObject::ckUpdateString(body,"amount.value","5.00")
success = CkHttp::ckHttpJson(http,"POST","https://api-m.sandbox.paypal.com/v2/payments/captures/{$id}/refund",body,"application/json",resp)
If success <> 1
Debug "No HTTP response: " + CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkHttpResponse::ckDispose(resp)
CkCrypt2::ckDispose(crypt)
CkJsonObject::ckDispose(body)
ProcedureReturn
EndIf
If (CkHttpResponse::ckStatusCode(resp) < 200) OR (CkHttpResponse::ckStatusCode(resp) >= 300)
errorInfo.i = CkJsonObject::ckCreate()
If errorInfo.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoad(errorInfo,CkHttpResponse::ckBodyStr(resp))
Debug "HTTP " + Str(CkHttpResponse::ckStatusCode(resp)) + " " + CkJsonObject::ckStringOf(errorInfo,"name") + " " + CkJsonObject::ckStringOf(errorInfo,"details[0].issue")
Debug "PayPal debug ID: " + CkJsonObject::ckStringOf(errorInfo,"debug_id")
CkHttp::ckDispose(http)
CkHttpResponse::ckDispose(resp)
CkCrypt2::ckDispose(crypt)
CkJsonObject::ckDispose(body)
CkJsonObject::ckDispose(errorInfo)
ProcedureReturn
EndIf
result.i = CkJsonObject::ckCreate()
If result.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
parsed.i = CkJsonObject::ckLoad(result,CkHttpResponse::ckBodyStr(resp))
If parsed <> 1
Debug "Expected a JSON response; HTTP " + Str(CkHttpResponse::ckStatusCode(resp))
CkHttp::ckDispose(http)
CkHttpResponse::ckDispose(resp)
CkCrypt2::ckDispose(crypt)
CkJsonObject::ckDispose(body)
CkJsonObject::ckDispose(errorInfo)
CkJsonObject::ckDispose(result)
ProcedureReturn
EndIf
Debug "ID: " + CkJsonObject::ckStringOf(result,"id")
Debug "Status: " + CkJsonObject::ckStringOf(result,"status")
Debug "Amount: " + CkJsonObject::ckStringOf(result,"amount.value")
Debug "Currency: " + CkJsonObject::ckStringOf(result,"amount.currency_code")
CkHttp::ckDispose(http)
CkHttpResponse::ckDispose(resp)
CkCrypt2::ckDispose(crypt)
CkJsonObject::ckDispose(body)
CkJsonObject::ckDispose(errorInfo)
CkJsonObject::ckDispose(result)
ProcedureReturn
EndProcedure