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

PayPal: List merchant invoices across pages

See more PayPal Examples

List invoices for the authenticated merchant. Request totals, iterate every page, and keep the PayPal ID alongside the human-readable number and current status.

PayPal documentation

Chilkat PureBasic Downloads

PureBasic
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.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

    ;  Request total_pages so a merchant with more than one page sees every invoice.
    page.i = 1
    lastPage.i = 1
    While (page <= lastPage)
        url.i = CkStringBuilder::ckCreate()
        If url.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        CkStringBuilder::ckAppend(url,"https://api-m.sandbox.paypal.com/v2/invoicing/invoices?total_required=true&page_size=20&page=")
        CkStringBuilder::ckAppendInt(url,page)
        success = CkHttp::ckHttpNoBody(http,"GET",CkStringBuilder::ckGetAsString(url),resp)
        If success <> 1
            Debug "No HTTP response: " + CkHttp::ckLastErrorText(http)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(resp)
            CkStringBuilder::ckDispose(url)
            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)
            CkStringBuilder::ckDispose(url)
            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)
            CkStringBuilder::ckDispose(url)
            CkJsonObject::ckDispose(errorInfo)
            CkJsonObject::ckDispose(result)
            ProcedureReturn
        EndIf

        i.i = 0
        count.i = CkJsonObject::ckSizeOfArray(result,"items")
        While (i < count)
            CkJsonObject::setCkI(result, i)
            Debug CkJsonObject::ckStringOf(result,"items[i].id") + "  " + CkJsonObject::ckStringOf(result,"items[i].detail.invoice_number") + "  " + CkJsonObject::ckStringOf(result,"items[i].status")
            i = i + 1
        Wend
        lastPage = CkJsonObject::ckIntOf(result,"total_pages")
        page = page + 1
    Wend


    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)
    CkStringBuilder::ckDispose(url)
    CkJsonObject::ckDispose(errorInfo)
    CkJsonObject::ckDispose(result)


    ProcedureReturn
EndProcedure