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

PayPal: Get a payable invoice link for your own email

See more PayPal Examples

Use a draft dated today or earlier. Make it payable with customer email suppressed, then retrieve the recipient view URL for the merchant's email. Future-dated invoices are scheduled for delivery and should use a different workflow.

PayPal documentation

Chilkat PureBasic Downloads

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

    CkHttp::ckSetUrlVar(http,"id","INVOICE_ID")

    success = CkHttp::ckHttpNoBody(http,"GET","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}",resp)
    If success <> 1
        Debug "No HTTP response: " + CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        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)
        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)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        ProcedureReturn
    EndIf

    If CkJsonObject::ckStringOfEquals(result,"status","DRAFT",1) <> 1
        Debug "Select an unsent draft."
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        ProcedureReturn
    EndIf

    ;  Compare the ISO calendar dates at UTC midnight before asking PayPal to send.
    now.i = CkDateTime::ckCreate()
    If now.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromCurrentSystemTime(now)
    stamp.i = CkStringBuilder::ckCreate()
    If stamp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(stamp,CkJsonObject::ckStringOf(result,"detail.invoice_date"))
    CkStringBuilder::ckAppend(stamp,"T00:00:00Z")
    issue.i = CkDateTime::ckCreate()
    If issue.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    validDate.i = CkDateTime::ckSetFromTimestamp(issue,CkStringBuilder::ckGetAsString(stamp))
    If (validDate <> 1) OR (CkDateTime::ckDiffSeconds(now,issue) < 0)
        Debug "Select a draft with an issue date of today or earlier."
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        CkDateTime::ckDispose(now)
        CkStringBuilder::ckDispose(stamp)
        CkDateTime::ckDispose(issue)
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckUpdateBool(body,"send_to_recipient",0)
    CkJsonObject::ckUpdateBool(body,"send_to_invoicer",0)
    success = CkHttp::ckHttpJson(http,"POST","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}/send",body,"application/json",resp)
    If success <> 1
        Debug "No HTTP response: " + CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        CkDateTime::ckDispose(now)
        CkStringBuilder::ckDispose(stamp)
        CkDateTime::ckDispose(issue)
        CkJsonObject::ckDispose(body)
        ProcedureReturn
    EndIf

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

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

    ;  Read back the invoice: acceptance of the send alone does not guarantee it is payable.
    success = CkHttp::ckHttpNoBody(http,"GET","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}",resp)
    If success <> 1
        Debug "No HTTP response: " + CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        CkDateTime::ckDispose(now)
        CkStringBuilder::ckDispose(stamp)
        CkDateTime::ckDispose(issue)
        CkJsonObject::ckDispose(body)
        CkJsonObject::ckDispose(sendError)
        ProcedureReturn
    EndIf

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

        CkJsonObject::ckLoad(invoiceError,CkHttpResponse::ckBodyStr(resp))
        Debug "HTTP " + Str(CkHttpResponse::ckStatusCode(resp)) + " " + CkJsonObject::ckStringOf(invoiceError,"name") + " " + CkJsonObject::ckStringOf(invoiceError,"details[0].issue")
        Debug "PayPal debug ID: " + CkJsonObject::ckStringOf(invoiceError,"debug_id")
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        CkDateTime::ckDispose(now)
        CkStringBuilder::ckDispose(stamp)
        CkDateTime::ckDispose(issue)
        CkJsonObject::ckDispose(body)
        CkJsonObject::ckDispose(sendError)
        CkJsonObject::ckDispose(invoiceError)
        ProcedureReturn
    EndIf

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

    parsedInvoice.i = CkJsonObject::ckLoad(invoice,CkHttpResponse::ckBodyStr(resp))
    If parsedInvoice <> 1
        Debug "Expected a JSON response; HTTP " + Str(CkHttpResponse::ckStatusCode(resp))
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        CkDateTime::ckDispose(now)
        CkStringBuilder::ckDispose(stamp)
        CkDateTime::ckDispose(issue)
        CkJsonObject::ckDispose(body)
        CkJsonObject::ckDispose(sendError)
        CkJsonObject::ckDispose(invoiceError)
        CkJsonObject::ckDispose(invoice)
        ProcedureReturn
    EndIf

    If ((CkJsonObject::ckStringOfEquals(invoice,"status","SENT",1) = 1) OR (CkJsonObject::ckStringOfEquals(invoice,"status","UNPAID",1) = 1) OR (CkJsonObject::ckStringOfEquals(invoice,"status","SHARED",1) = 1)) AND (CkJsonObject::ckHasMember(invoice,"detail.metadata.recipient_view_url") = 1)
        Debug "Customer payment page: " + CkJsonObject::ckStringOf(invoice,"detail.metadata.recipient_view_url")
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        CkJsonObject::ckDispose(errorInfo)
        CkJsonObject::ckDispose(result)
        CkDateTime::ckDispose(now)
        CkStringBuilder::ckDispose(stamp)
        CkDateTime::ckDispose(issue)
        CkJsonObject::ckDispose(body)
        CkJsonObject::ckDispose(sendError)
        CkJsonObject::ckDispose(invoiceError)
        CkJsonObject::ckDispose(invoice)
        ProcedureReturn
    EndIf

    Debug "Invoice is " + CkJsonObject::ckStringOf(invoice,"status") + ". Retrieve it again when payable."


    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)
    CkJsonObject::ckDispose(errorInfo)
    CkJsonObject::ckDispose(result)
    CkDateTime::ckDispose(now)
    CkStringBuilder::ckDispose(stamp)
    CkDateTime::ckDispose(issue)
    CkJsonObject::ckDispose(body)
    CkJsonObject::ckDispose(sendError)
    CkJsonObject::ckDispose(invoiceError)
    CkJsonObject::ckDispose(invoice)


    ProcedureReturn
EndProcedure