Sample code for 30+ languages & platforms
PureBasic Requires Chilkat v11.0.0+

PayPal: Capture a buyer-approved order

See more PayPal Examples

After approval, match the order to the checkout in your merchant records. Read each capture ID and status. Fulfill only when the expected amount and currency are captured and the capture is COMPLETED.

PayPal documentation

Chilkat PureBasic Downloads

PureBasic
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkCrypt2.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  See Unlock Chilkat before making requests.
    ;  For the merchant's internal backoffice application. Load the sandbox token
    ;  from the merchant's credential store. Keep it out of publicly distributed apps.
    ;  See Get a PayPal access token.
    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, "SANDBOX_ACCESS_TOKEN")
    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  Use the order ID you stored before redirecting the buyer, associated with this cart
    ;  and session.

    ;  Use the approved order created with intent CAPTURE.
    CkHttp::ckSetUrlVar(http,"id","ORDER_ID")
    ;  Create and persist this key once per business operation. On a timeout,
    ;  retry the same request with its saved key, not a newly generated one.
    crypt.i = CkCrypt2::ckCreate()
    If crypt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    requestId.s = CkCrypt2::ckGenerateUuid(crypt)
    CkHttp::ckSetRequestHeader(http,"PayPal-Request-Id",requestId)
    CkHttp::ckSetRequestHeader(http,"Prefer","return=representation")
    body.i = CkJsonObject::ckCreate()
    If body.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpJson(http,"POST","https://api-m.sandbox.paypal.com/v2/checkout/orders/{$id}/capture",body,"application/json",resp)
    If success <> 1
        Debug "No HTTP response: " + CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkCrypt2::ckDispose(crypt)
        CkJsonObject::ckDispose(body)
        ProcedureReturn
    EndIf

    If (CkHttpResponse::ckStatusCode(resp) < 200) OR (CkHttpResponse::ckStatusCode(resp) >= 300)
        errorInfo.i = CkJsonObject::ckCreate()
        If errorInfo.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        CkJsonObject::ckLoad(errorInfo,CkHttpResponse::ckBodyStr(resp))
        Debug "HTTP " + Str(CkHttpResponse::ckStatusCode(resp)) + " " + CkJsonObject::ckStringOf(errorInfo,"name") + " " + CkJsonObject::ckStringOf(errorInfo,"details[0].issue")
        Debug "PayPal debug ID: " + CkJsonObject::ckStringOf(errorInfo,"debug_id")
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkCrypt2::ckDispose(crypt)
        CkJsonObject::ckDispose(body)
        CkJsonObject::ckDispose(errorInfo)
        ProcedureReturn
    EndIf

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

    parsed.i = CkJsonObject::ckLoad(result,CkHttpResponse::ckBodyStr(resp))
    If parsed <> 1
        Debug "Expected a JSON response; HTTP " + Str(CkHttpResponse::ckStatusCode(resp))
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkCrypt2::ckDispose(crypt)
        CkJsonObject::ckDispose(body)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        ProcedureReturn
    EndIf

    Debug "ID: " + CkJsonObject::ckStringOf(result,"id")
    Debug "Status: " + CkJsonObject::ckStringOf(result,"status")
    ;  A purchase unit may have no captures yet, or more than one.
    i.i = 0
    While (i < CkJsonObject::ckSizeOfArray(result,"purchase_units"))
        CkJsonObject::setCkI(result, i)
        j.i = 0
        While (j < CkJsonObject::ckSizeOfArray(result,"purchase_units[i].payments.captures"))
            CkJsonObject::setCkJ(result, j)
            Debug "Unit: " + CkJsonObject::ckStringOf(result,"purchase_units[i].reference_id") + "  capture: " + CkJsonObject::ckStringOf(result,"purchase_units[i].payments.captures[j].id")
            Debug "  " + CkJsonObject::ckStringOf(result,"purchase_units[i].payments.captures[j].status") + "  " + CkJsonObject::ckStringOf(result,"purchase_units[i].payments.captures[j].amount.value") + " " + CkJsonObject::ckStringOf(result,"purchase_units[i].payments.captures[j].amount.currency_code")
            j = j + 1
        Wend
        i = i + 1
    Wend
    ;  When a buyer opted to save a card, the token may arrive separately from capture.
    If CkJsonObject::ckStringOfEquals(result,"payment_source.card.attributes.vault.status","VAULTED",1)
        cardToken.s = CkJsonObject::ckStringOf(result,"payment_source.card.attributes.vault.id")
        customerId.s = CkJsonObject::ckStringOf(result,"payment_source.card.attributes.vault.customer.id")
        ;  Store cardToken and customerId with this buyer in the merchant credential store.
    EndIf

    If CkJsonObject::ckStringOfEquals(result,"payment_source.card.attributes.vault.status","APPROVED",1)
        Debug "Await the verified VAULT.PAYMENT-TOKEN.CREATED webhook for the token."
    EndIf



    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)
    CkCrypt2::ckDispose(crypt)
    CkJsonObject::ckDispose(body)
    CkJsonObject::ckDispose(errorInfo)
    CkJsonObject::ckDispose(result)


    ProcedureReturn
EndProcedure