DataFlex
DataFlex
PayPal - Refund Sale
See more PayPal Examples
Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoJsonToken
Handle hoSbAuth
Handle hoRest
Boolean iBAutoReconnect
Handle hoJsonPartial
Handle hoSbPath
Integer iNumReplaced
Variant vSbJsonRequest
Handle hoSbJsonRequest
Variant vSbJsonResponse
Handle hoSbJsonResponse
Boolean iBFullRefund
Handle hoJson
String sTemp1
Integer iTemp1
Move False To iSuccess
// 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)
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..
// ----------------------------------------------------------------------------------------------
// To refund a particular amount, build JSON such as this:
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonPartial
If (Not(IsComObjectCreated(hoJsonPartial))) Begin
Send CreateComObject of hoJsonPartial
End
Set ComEmitCompact Of hoJsonPartial To False
Get ComUpdateString Of hoJsonPartial "amount.total" "2.34" To iSuccess
Get ComUpdateString Of hoJsonPartial "amount.currency" "USD" To iSuccess
// invoice_number is optional..
Get ComUpdateString Of hoJsonPartial "invoice_number" "INV-1234567" To iSuccess
Get ComEmit Of hoJsonPartial To sTemp1
Showln sTemp1
// The JSON for a partial refund:
// {
// "amount": {
// "total": "2.34",
// "currency": "USD"
// },
// "invoice_number": "INV-1234567"
// }
Get ComGetAsString Of hoSbAuth To sTemp1
Get ComAddHeader Of hoRest "Authorization" sTemp1 To iSuccess
Get ComAddHeader Of hoRest "Content-Type" "application/json" To iSuccess
// The sale ID is added to the path.
// The sale ID is obtained from payment records as shown here: Find Completed Sales
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbPath
If (Not(IsComObjectCreated(hoSbPath))) Begin
Send CreateComObject of hoSbPath
End
Get ComAppend Of hoSbPath "/v1/payments/sale/sale_id/refund" To iSuccess
Get ComReplace Of hoSbPath "sale_id" "1XC17935MN507400J" To iNumReplaced
// Send the POST request containign the JSON in the request body, and get the JSON response.
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJsonRequest
If (Not(IsComObjectCreated(hoSbJsonRequest))) Begin
Send CreateComObject of hoSbJsonRequest
End
Set ComEmitCompact Of hoJsonPartial To True
Get pvComObject of hoSbJsonRequest to vSbJsonRequest
Get ComEmitSb Of hoJsonPartial vSbJsonRequest To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJsonResponse
If (Not(IsComObjectCreated(hoSbJsonResponse))) Begin
Send CreateComObject of hoSbJsonResponse
End
Move True To iBFullRefund
// To send a full refund, send an empty request body:
If (iBFullRefund = True) Begin
Send ComClear To hoSbJsonRequest
Get ComAppend Of hoSbJsonRequest "{}" To iSuccess
End
Get ComGetAsString Of hoSbPath To sTemp1
Get pvComObject of hoSbJsonRequest to vSbJsonRequest
Get pvComObject of hoSbJsonResponse to vSbJsonResponse
Get ComFullRequestSb Of hoRest "POST" sTemp1 vSbJsonRequest vSbJsonResponse To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Set ComEmitCompact Of hoJson To False
Get pvComObject of hoSbJsonResponse to vSbJsonResponse
Get ComLoadSb Of hoJson vSbJsonResponse To iSuccess
Get ComResponseStatusCode Of hoRest To iTemp1
Showln "Response Status Code = " iTemp1
// Did we get a 201 success response?
Get ComResponseStatusCode Of hoRest To iTemp1
If (iTemp1 <> 201) Begin
Get ComEmit Of hoJson To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
Get ComEmit Of hoJson To sTemp1
Showln sTemp1
Showln "Success."
// A successful JSON response:
// The "id" is the refund_id.
// {
// "id": "7NE550583A133505U",
// "create_time": "2016-11-26T16:38:27Z",
// "update_time": "2016-11-26T16:38:27Z",
// "state": "completed",
// "amount": {
// "total": "289.00",
// "currency": "USD"
// },
// "sale_id": "1XC17935MN507400J",
// "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
// "links": [
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
// "rel": "self",
// "method": "GET"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
// "rel": "parent_payment",
// "method": "GET"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
// "rel": "sale",
// "method": "GET"
// }
// ]
// }
End_Procedure