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

PayPal: Export a day of balance activity to CSV

See more PayPal Examples

Create a UTF-8 ledger export for the previous UTC day. Preserve signed amounts and separate currencies, and leave absent fees blank. The file is written after all pages have been read. Transaction Search can lag by several hours.

PayPal documentation

Chilkat PureBasic Downloads

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

    ;  Export yesterday in UTC; choose an earlier date if the report is still refreshing.
    day.i = CkDateTime::ckCreate()
    If day.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromCurrentSystemTime(day)
    CkDateTime::ckAddDays(day,-1)
    utcDate.s = CkDateTime::ckGetAsIso8601(day,"YYYY-MM-DD",0)
    startTime.i = CkStringBuilder::ckCreate()
    If startTime.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(startTime,utcDate)
    CkStringBuilder::ckAppend(startTime,"T00:00:00Z")
    endTime.i = CkStringBuilder::ckCreate()
    If endTime.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(endTime,utcDate)
    CkStringBuilder::ckAppend(endTime,"T23:59:59.999Z")
    query.i = CkJsonObject::ckCreate()
    If query.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(query,"start_date",CkStringBuilder::ckGetAsString(startTime))
    CkJsonObject::ckUpdateString(query,"end_date",CkStringBuilder::ckGetAsString(endTime))
    CkJsonObject::ckUpdateString(query,"balance_affecting_records_only","Y")
    CkJsonObject::ckUpdateString(query,"fields","transaction_info")
    CkJsonObject::ckUpdateInt(query,"page_size",100)
    csv.i = CkCsv::ckCreate()
    If csv.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkCsv::setCkHasColumnNames(csv, 1)
    CkCsv::ckSetColumnName(csv,0,"transaction_id")
    CkCsv::ckSetColumnName(csv,1,"event_code")
    CkCsv::ckSetColumnName(csv,2,"status")
    CkCsv::ckSetColumnName(csv,3,"currency")
    CkCsv::ckSetColumnName(csv,4,"amount")
    CkCsv::ckSetColumnName(csv,5,"fee_currency")
    CkCsv::ckSetColumnName(csv,6,"fee")
    row.i = 0
    page.i = 1
    lastPage.i = 1
    While (page <= lastPage)
        CkJsonObject::ckUpdateInt(query,"page",page)
        success = CkHttp::ckHttpParams(http,"GET","https://api-m.sandbox.paypal.com/v1/reporting/transactions",query,resp)
        If success <> 1
            Debug "No HTTP response: " + CkHttp::ckLastErrorText(http)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(resp)
            CkDateTime::ckDispose(day)
            CkStringBuilder::ckDispose(startTime)
            CkStringBuilder::ckDispose(endTime)
            CkJsonObject::ckDispose(query)
            CkCsv::ckDispose(csv)
            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)
            CkDateTime::ckDispose(day)
            CkStringBuilder::ckDispose(startTime)
            CkStringBuilder::ckDispose(endTime)
            CkJsonObject::ckDispose(query)
            CkCsv::ckDispose(csv)
            CkJsonObject::ckDispose(errorInfo)
            ProcedureReturn
        EndIf

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

        parsedResult.i = CkJsonObject::ckLoad(result,CkHttpResponse::ckBodyStr(resp))
        If parsedResult <> 1
            Debug "Expected a JSON response; HTTP " + Str(CkHttpResponse::ckStatusCode(resp))
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(resp)
            CkDateTime::ckDispose(day)
            CkStringBuilder::ckDispose(startTime)
            CkStringBuilder::ckDispose(endTime)
            CkJsonObject::ckDispose(query)
            CkCsv::ckDispose(csv)
            CkJsonObject::ckDispose(errorInfo)
            CkJsonObject::ckDispose(result)
            ProcedureReturn
        EndIf

        i.i = 0
        count.i = CkJsonObject::ckSizeOfArray(result,"transaction_details")
        While (i < count)
            CkJsonObject::setCkI(result, i)
            CkCsv::ckSetCell(csv,row,0,CkJsonObject::ckStringOf(result,"transaction_details[i].transaction_info.transaction_id"))
            CkCsv::ckSetCell(csv,row,1,CkJsonObject::ckStringOf(result,"transaction_details[i].transaction_info.transaction_event_code"))
            CkCsv::ckSetCell(csv,row,2,CkJsonObject::ckStringOf(result,"transaction_details[i].transaction_info.transaction_status"))
            CkCsv::ckSetCell(csv,row,3,CkJsonObject::ckStringOf(result,"transaction_details[i].transaction_info.transaction_amount.currency_code"))
            CkCsv::ckSetCell(csv,row,4,CkJsonObject::ckStringOf(result,"transaction_details[i].transaction_info.transaction_amount.value"))
            CkCsv::ckSetCell(csv,row,5,CkJsonObject::ckStringOf(result,"transaction_details[i].transaction_info.fee_amount.currency_code"))
            CkCsv::ckSetCell(csv,row,6,CkJsonObject::ckStringOf(result,"transaction_details[i].transaction_info.fee_amount.value"))
            row = row + 1
            i = i + 1
        Wend
        lastPage = CkJsonObject::ckIntOf(result,"total_pages")
        page = page + 1
    Wend
    filename.i = CkStringBuilder::ckCreate()
    If filename.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(filename,"paypal-activity-")
    CkStringBuilder::ckAppend(filename,utcDate)
    CkStringBuilder::ckAppend(filename,".csv")
    saved.i = CkCsv::ckSaveFile2(csv,CkStringBuilder::ckGetAsString(filename),"utf-8")
    If saved <> 1
        Debug CkCsv::ckLastErrorText(csv)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkDateTime::ckDispose(day)
        CkStringBuilder::ckDispose(startTime)
        CkStringBuilder::ckDispose(endTime)
        CkJsonObject::ckDispose(query)
        CkCsv::ckDispose(csv)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        CkStringBuilder::ckDispose(filename)
        ProcedureReturn
    EndIf

    Debug "Exported " + Str(row) + " rows to " + CkStringBuilder::ckGetAsString(filename)


    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)
    CkDateTime::ckDispose(day)
    CkStringBuilder::ckDispose(startTime)
    CkStringBuilder::ckDispose(endTime)
    CkJsonObject::ckDispose(query)
    CkCsv::ckDispose(csv)
    CkJsonObject::ckDispose(errorInfo)
    CkJsonObject::ckDispose(result)
    CkStringBuilder::ckDispose(filename)


    ProcedureReturn
EndProcedure