PureBasic

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.

PureBasic

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkDateTime.pb"

Procedure ChilkatExample()

    success.i = 0

    ; 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)
    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..
    ; ----------------------------------------------------------------------------------------------

    ; Build the JSON request body containing the reminder information:
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)
    dtNow.i = CkDateTime::ckCreate()
    If dtNow.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromCurrentSystemTime(dtNow)
    sbDt.i = CkStringBuilder::ckCreate()
    If sbDt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbDt,CkDateTime::ckGetAsTimestamp(dtNow,0))
    numReplaced.i = CkStringBuilder::ckReplace(sbDt,"T"," ")
    numReplaced = CkStringBuilder::ckReplace(sbDt,"Z"," UTC")
    CkJsonObject::ckUpdateString(json,"date",CkStringBuilder::ckGetAsString(sbDt))
    CkJsonObject::ckUpdateString(json,"note","Refunded by credit card!")
    CkJsonObject::ckUpdateString(json,"amount.currency","USD")
    CkJsonObject::ckUpdateString(json,"amount.value","500.00")
    Debug CkJsonObject::ckEmit(json)

    ; 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.
    sbPath.i = CkStringBuilder::ckCreate()
    If sbPath.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbPath,"/v1/invoicing/invoices/invoice_id/record-refund")
    numReplacements.i = CkStringBuilder::ckReplace(sbPath,"invoice_id","INV2-QCHR-QHSD-M2VU-AVXC")

    CkJsonObject::setCkEmitCompact(json, 1)
    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkRest::ckAddHeader(rest,"Content-Type","application/json")
    CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
    CkJsonObject::ckEmitSb(json,sbRequestBody)

    success = CkRest::ckFullRequestSb(rest,"POST",CkStringBuilder::ckGetAsString(sbPath),sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkDateTime::ckDispose(dtNow)
        CkStringBuilder::ckDispose(sbDt)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))

    ; Check for a success response.
    If CkRest::ckResponseStatusCode(rest) <> 204
        Debug CkStringBuilder::ckGetAsString(sbResponseBody)
        Debug "Failed."
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkDateTime::ckDispose(dtNow)
        CkStringBuilder::ckDispose(sbDt)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; For a success response, the response body is empty.
    Debug "Success."


    CkJsonObject::ckDispose(jsonToken)
    CkStringBuilder::ckDispose(sbAuth)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkDateTime::ckDispose(dtNow)
    CkStringBuilder::ckDispose(sbDt)
    CkStringBuilder::ckDispose(sbPath)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure