PureBasic

CardConnect Settlement Status

See more CardConnect Examples

Demonstrates how to get the status of transactions which have been submitted to the processor for settlement.

The settlement status service returns the status of transactions which have been submitted to the processor for settlement. The transaction’s setlstatus is updated appropriately when CardConnect’s receives a response from the processor. You can either specify a batchid to return a specific batch of transactions, or use a date to return all transactions settled for that date. ...

See https://developer.cardconnect.com/cardconnect-api#settlement-status

PureBasic

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

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

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "API_USERNAME")
    CkHttp::setCkPassword(http, "API_PASSWORD")

    url.s = "https://<site>.cardconnect.com:<port>/cardconnect/rest/settlestat?merchid=<merchid>&batchid=<batchid>"
    responseStr.s = CkHttp::ckQuickGetStr(http,url)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    ; A response status of 200 indicates potential success.  The JSON response body
    ; must be examined to determine if it was truly successful or an error.
    Debug "response status code = " + Str(CkHttp::ckLastStatus(http))

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

    CkJsonObject::ckLoad(jsonResp,responseStr)
    CkJsonObject::setCkEmitCompact(jsonResp, 0)

    Debug "response JSON:"
    Debug CkJsonObject::ckEmit(jsonResp)

    ; A successful response looks like this:

    ; {
    ;   "respproc": "FNOR",
    ;   "hostbatch": "",
    ;   "refundtotal": "0.00",
    ;   "batchid": "1900942291",
    ;   "chargetotal": "0.00",
    ;   "hoststat": "",
    ;   "merchid": "MERCHANT_ID",
    ;   "txns": [
    ;     {
    ;       "setlamount": "13.28",
    ;       "setlstat": "R",
    ;       "salesdoc": "rosedale_1555412201_392",
    ;       "retref": "106631225001"
    ;     },
    ;     {
    ;       "setlamount": "13.28",
    ;       "setlstat": "R",
    ;       "salesdoc": "rosedale_1555412353_392",
    ;       "retref": "106731125153"
    ;     },
    ;     {
    ;       "setlamount": "7.64",
    ;       "setlstat": "R",
    ;       "salesdoc": "rosedale_1555414960_393",
    ;       "retref": "106008227760"
    ;     }
    ;   ]
    ; }

    ; Use this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    setlamount.s
    setlstat.s
    salesdoc.s
    retref.s

    respproc.s = CkJsonObject::ckStringOf(jsonResp,"respproc")
    hostbatch.s = CkJsonObject::ckStringOf(jsonResp,"hostbatch")
    refundtotal.s = CkJsonObject::ckStringOf(jsonResp,"refundtotal")
    batchid.s = CkJsonObject::ckStringOf(jsonResp,"batchid")
    chargetotal.s = CkJsonObject::ckStringOf(jsonResp,"chargetotal")
    hoststat.s = CkJsonObject::ckStringOf(jsonResp,"hoststat")
    merchid.s = CkJsonObject::ckStringOf(jsonResp,"merchid")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jsonResp,"txns")
    While i < count_i
        CkJsonObject::setCkI(jsonResp, i)
        setlamount = CkJsonObject::ckStringOf(jsonResp,"txns[i].setlamount")
        setlstat = CkJsonObject::ckStringOf(jsonResp,"txns[i].setlstat")
        salesdoc = CkJsonObject::ckStringOf(jsonResp,"txns[i].salesdoc")
        retref = CkJsonObject::ckStringOf(jsonResp,"txns[i].retref")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(jsonResp)


    ProcedureReturn
EndProcedure