DataFlex
DataFlex
PayPal - Mark Invoice as Refunded
See more PayPal Examples
Mark an invoice as refunded.Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Token Handle hoJsonToken
Handle hoSbAuth
Handle hoRest
Boolean iBAutoReconnect
Handle hoJson
Handle hoDtNow
Handle hoSbDt
Integer iNumReplaced
Handle hoSbPath
Integer iNumReplacements
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vSbResponseBody
Handle hoSbResponseBody
String sTemp1
Integer iTemp1
Move False To iSuccess
// 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)
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
If (Not(IsComObjectCreated(hoJsonToken))) Begin
Send CreateComObject of hoJsonToken
End
Get ComLoadFile Of hoJsonToken "qa_data/tokens/paypal.json" To iSuccess
// Build the Authorization request header field value.
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbAuth
If (Not(IsComObjectCreated(hoSbAuth))) Begin
Send CreateComObject of hoSbAuth
End
// token_type should be "Bearer"
Get ComStringOf Of hoJsonToken "token_type" To sTemp1
Get ComAppend Of hoSbAuth sTemp1 To iSuccess
Get ComAppend Of hoSbAuth " " To iSuccess
Get ComStringOf Of hoJsonToken "access_token" To sTemp1
Get ComAppend Of hoSbAuth sTemp1 To iSuccess
// 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.
Get Create (RefClass(cComChilkatRest)) To hoRest
If (Not(IsComObjectCreated(hoRest))) Begin
Send CreateComObject of hoRest
End
Move True To iBAutoReconnect
Get ComConnect Of hoRest "api.sandbox.paypal.com" 443 True iBAutoReconnect To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
// ----------------------------------------------------------------------------------------------
// 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 request body containing the reminder information:
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Set ComEmitCompact Of hoJson To False
Get Create (RefClass(cComCkDateTime)) To hoDtNow
If (Not(IsComObjectCreated(hoDtNow))) Begin
Send CreateComObject of hoDtNow
End
Get ComSetFromCurrentSystemTime Of hoDtNow To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbDt
If (Not(IsComObjectCreated(hoSbDt))) Begin
Send CreateComObject of hoSbDt
End
Get ComGetAsTimestamp Of hoDtNow False To sTemp1
Get ComAppend Of hoSbDt sTemp1 To iSuccess
Get ComReplace Of hoSbDt "T" " " To iNumReplaced
Get ComReplace Of hoSbDt "Z" " UTC" To iNumReplaced
Get ComGetAsString Of hoSbDt To sTemp1
Get ComUpdateString Of hoJson "date" sTemp1 To iSuccess
Get ComUpdateString Of hoJson "note" "Refunded by credit card!" To iSuccess
Get ComUpdateString Of hoJson "amount.currency" "USD" To iSuccess
Get ComUpdateString Of hoJson "amount.value" "500.00" To iSuccess
Get ComEmit Of hoJson To sTemp1
Showln sTemp1
// The JSON created by the above code:
// {
// "date": "2016-11-28 21:05:38 UTC",
// "note": "Refunded by credit card!",
// "amount": {
// "currency": "USD",
// "value": "500.00"
// }
// }
// Build a path using a previously-sent invoice ID.
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbPath
If (Not(IsComObjectCreated(hoSbPath))) Begin
Send CreateComObject of hoSbPath
End
Get ComAppend Of hoSbPath "/v1/invoicing/invoices/invoice_id/record-refund" To iSuccess
Get ComReplace Of hoSbPath "invoice_id" "INV2-QCHR-QHSD-M2VU-AVXC" To iNumReplacements
Set ComEmitCompact Of hoJson To True
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get ComAddHeader Of hoRest "Content-Type" "application/json" To iSuccess
Get ComGetAsString Of hoSbAuth To sTemp1
Get ComAddHeader Of hoRest "Authorization" sTemp1 To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get ComGetAsString Of hoSbPath To sTemp1
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComFullRequestSb Of hoRest "POST" sTemp1 vSbRequestBody vSbResponseBody To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComResponseStatusCode Of hoRest To iTemp1
Showln "Response Status Code = " iTemp1
// Check for a success response.
Get ComResponseStatusCode Of hoRest To iTemp1
If (iTemp1 <> 204) Begin
Get ComGetAsString Of hoSbResponseBody To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// For a success response, the response body is empty.
Showln "Success."
End_Procedure