B4X

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.

B4X

Dim success As Boolean = False

'  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)
Dim jsonToken As ChilkatJsonObject
jsonToken.Initialize
jsonToken.LoadFile("qa_data/tokens/paypal.json")

'  Build the Authorization request header field value.
Dim sbAuth As ChilkatStringBuilder
sbAuth.Initialize
'  token_type should be "Bearer"
sbAuth.Append(jsonToken.StringOf("token_type"))
sbAuth.Append(" ")
sbAuth.Append(jsonToken.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.
Dim rest As ChilkatRest
rest.Initialize("rest")
Dim bAutoReconnect As Boolean = True
success = rest.Connect("api.sandbox.paypal.com", 443, True, bAutoReconnect)
If success <> True Then
    Log(rest.LastErrorText)
    Return
End If


'  ----------------------------------------------------------------------------------------------
'  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:
Dim json As ChilkatJsonObject
json.Initialize
json.EmitCompact = False
Dim dtNow As ChilkatDateTime
dtNow.Initialize
dtNow.SetFromCurrentSystemTime
Dim sbDt As ChilkatStringBuilder
sbDt.Initialize
sbDt.Append(dtNow.GetAsTimestamp(False))
Dim numReplaced As Int = sbDt.Replace("T", " ")
numReplaced = sbDt.Replace("Z", " UTC")
json.UpdateString("date", sbDt.GetAsString)
json.UpdateString("note", "Refunded by credit card!")
json.UpdateString("amount.currency", "USD")
json.UpdateString("amount.value", "500.00")
Log(json.Emit)

'  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.
Dim sbPath As ChilkatStringBuilder
sbPath.Initialize
sbPath.Append("/v1/invoicing/invoices/invoice_id/record-refund")
Dim numReplacements As Int = sbPath.Replace("invoice_id", "INV2-QCHR-QHSD-M2VU-AVXC")

json.EmitCompact = True
Dim sbRequestBody As ChilkatStringBuilder
sbRequestBody.Initialize
Dim sbResponseBody As ChilkatStringBuilder
sbResponseBody.Initialize

rest.AddHeader("Content-Type", "application/json")
rest.AddHeader("Authorization", sbAuth.GetAsString)
json.EmitSb(sbRequestBody)

success = rest.FullRequestSb("POST", sbPath.GetAsString, sbRequestBody, sbResponseBody)
If success <> True Then
    Log(rest.LastErrorText)
    Return
End If


Log("Response Status Code = " & rest.ResponseStatusCode)

'  Check for a success response.
If rest.ResponseStatusCode <> 204 Then
    Log(sbResponseBody.GetAsString)
    Log("Failed.")
    Return
End If


'  For a success response, the response body is empty.
Log("Success.")