PureBasic

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.

PureBasic

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

Procedure ChilkatExample()

    success.i = 0

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

    ; To refund a particular amount, build JSON such as this:
    jsonPartial.i = CkJsonObject::ckCreate()
    If jsonPartial.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(jsonPartial, 0)
    CkJsonObject::ckUpdateString(jsonPartial,"amount.total","2.34")
    CkJsonObject::ckUpdateString(jsonPartial,"amount.currency","USD")
    ; invoice_number is optional..
    CkJsonObject::ckUpdateString(jsonPartial,"invoice_number","INV-1234567")
    Debug CkJsonObject::ckEmit(jsonPartial)

    ; The JSON for a partial refund:

    ; 	{ 
    ; 	  "amount": { 
    ; 	    "total": "2.34",
    ; 	    "currency": "USD"
    ; 	  },
    ; 	  "invoice_number": "INV-1234567"
    ; 	}

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

    ; The sale ID is added to the path.
    ; The sale ID is obtained from payment records as shown here: Find Completed Sales
    sbPath.i = CkStringBuilder::ckCreate()
    If sbPath.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbPath,"/v1/payments/sale/sale_id/refund")
    numReplaced.i = CkStringBuilder::ckReplace(sbPath,"sale_id","1XC17935MN507400J")

    ; Send the POST request containign the JSON in the request body, and get the JSON response.
    sbJsonRequest.i = CkStringBuilder::ckCreate()
    If sbJsonRequest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(jsonPartial, 1)
    CkJsonObject::ckEmitSb(jsonPartial,sbJsonRequest)
    sbJsonResponse.i = CkStringBuilder::ckCreate()
    If sbJsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bFullRefund.i = 1
    ; To send a full refund, send an empty request body:
    If bFullRefund = 1
        CkStringBuilder::ckClear(sbJsonRequest)
        CkStringBuilder::ckAppend(sbJsonRequest,"{}")
    EndIf

    success = CkRest::ckFullRequestSb(rest,"POST",CkStringBuilder::ckGetAsString(sbPath),sbJsonRequest,sbJsonResponse)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonPartial)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbJsonRequest)
        CkStringBuilder::ckDispose(sbJsonResponse)
        ProcedureReturn
    EndIf

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

    CkJsonObject::setCkEmitCompact(json, 0)
    CkJsonObject::ckLoadSb(json,sbJsonResponse)

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

    ; Did we get a 201 success response?
    If CkRest::ckResponseStatusCode(rest) <> 201
        Debug CkJsonObject::ckEmit(json)
        Debug "Failed."
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(jsonPartial)
        CkStringBuilder::ckDispose(sbPath)
        CkStringBuilder::ckDispose(sbJsonRequest)
        CkStringBuilder::ckDispose(sbJsonResponse)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug CkJsonObject::ckEmit(json)
    Debug "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"
    ; 	    }
    ; 	  ]
    ; 	}


    CkJsonObject::ckDispose(jsonToken)
    CkStringBuilder::ckDispose(sbAuth)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(jsonPartial)
    CkStringBuilder::ckDispose(sbPath)
    CkStringBuilder::ckDispose(sbJsonRequest)
    CkStringBuilder::ckDispose(sbJsonResponse)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure