(PureBasic) PayPal - Find Captures

Finds captures for previous authorizations. (A capture is when the funds from an authorization are captured. There can be more than one capture, where the sum adds to the full authorization amount or an amount lower than the authorized amount.)

Note: This example requires Chilkat v9.5.0.65 or greater.

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

    ; 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.i = 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..
    ; ----------------------------------------------------------------------------------------------

    ; Clear the REST object of any headers or query params from previous requests.
    CkRest::ckClearAllHeaders(rest)
    CkRest::ckClearAllQueryParams(rest)

    CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))

    ; To find captured payments, we list payments and look for those
    ; containing a "capture" resource.
    CkRest::ckAddQueryParam(rest,"count","100")
    CkRest::ckAddQueryParam(rest,"start_index","0")
    CkRest::ckAddQueryParam(rest,"sort_by","update_time")
    CkRest::ckAddQueryParam(rest,"sort_order","asc")

    ; Send the GET request and get the JSON response.
    sbJsonResponse.i = CkStringBuilder::ckCreate()
    If sbJsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/v1/payments/payment",sbJsonResponse)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        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)

    ; (optional) Save the entire JSON response to a file to examine if desired..
    sbTemp.i = CkStringBuilder::ckCreate()
    If sbTemp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbTemp)
    CkStringBuilder::ckWriteFile(sbTemp,"qa_output/paypal_payments.json","utf-8",0)

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

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

    ; We are looking for "capture" resources .
    ; As shown below, we are looking in the "transactions" for "related_resources"
    ; containing "capture" JSON objects. 

    ; 	{ 
    ; 	  "payments": [
    ; 	    { 
    ; 	      "id": "PAY-2CY489250W145633HLA3DK3Y",
    ; 	      "create_time": "2016-11-24T00:33:51Z",
    ; 	      "update_time": "2016-11-24T00:40:54Z",
    ; 	      "state": "approved",
    ; 	      "intent": "authorize",
    ; 	      "payer": { 
    ; 	        "payment_method": "credit_card",
    ; 	        "funding_instruments": [
    ; 	          { 
    ; 	            ...
    ; 	          }
    ; 	        ]
    ; 	      },
    ; 	      "transactions": [
    ; 	        { 
    ; 	          "amount": { 
    ; 	            ...
    ; 	          },
    ; 	          "description": "This is the payment transaction description.",
    ; 	          "related_resources": [
    ; 	            { 
    ; 	              "authorization": { 
    ; 	                ...
    ; 	              }
    ; 	            },
    ; 	            { 
    ; 	              "capture": { 
    ; 	                "id": "1LY5310469661362J",
    ; 	                "create_time": "2016-11-24T00:40:50Z",
    ; 	                "update_time": "2016-11-24T00:40:54Z",
    ; 	                "amount": { 
    ; 	                  "total": "4.54",
    ; 	                  "currency": "USD"
    ; 	                },
    ; 	                "state": "completed",
    ; 	                "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
    ; 	                "transaction_fee": { 
    ; 	                  "value": "0.43",
    ; 	                  "currency": "USD"
    ; 	                },
    ; 			...
    ; 

    ; Iterate over the payments and show each capture
    numPayments.i = CkJsonObject::ckSizeOfArray(json,"payments")
    i.i = 0
    While i < numPayments
        CkJsonObject::setCkI(json, i)
        j.i = 0
        numTransactions.i = CkJsonObject::ckSizeOfArray(json,"payments[i].transactions")
        While j < numTransactions
            CkJsonObject::setCkJ(json, j)
            numRelatedResources.i = CkJsonObject::ckSizeOfArray(json,"payments[i].transactions[j].related_resources")
            k.i = 0
            While k < numRelatedResources
                CkJsonObject::setCkK(json, k)
                If CkJsonObject::ckHasMember(json,"payments[i].transactions[j].related_resources[k].capture") = 1
                    jsonCapture.i = CkJsonObject::ckObjectOf(json,"payments[i].transactions[j].related_resources[k].capture")
                    Debug "capture id: " + CkJsonObject::ckStringOf(jsonCapture,"id")
                    Debug "state: " + CkJsonObject::ckStringOf(jsonCapture,"state")
                    Debug "total: " + CkJsonObject::ckStringOf(jsonCapture,"amount.total")
                    Debug "----"
                    CkJsonObject::ckDispose(jsonCapture)

                EndIf

                k = k + 1
            Wend
            j = j + 1
        Wend
        i = i + 1
    Wend

    Debug "success"


    CkJsonObject::ckDispose(jsonToken)
    CkStringBuilder::ckDispose(sbAuth)
    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbJsonResponse)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbTemp)


    ProcedureReturn
EndProcedure