Xbase++
Xbase++
PayPal Search for Invoices
See more PayPal Examples
Search PayPal invoices.See also SearchInvoices
Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oJsonToken
LOCAL oSbAuth
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL oJson
LOCAL oSbRequestBody
LOCAL oSbResponseBody
LOCAL oJsonResponse
LOCAL nNumInvoices
LOCAL i
LOCAL j
LOCAL nNumBillingInfo
LOCAL nNumLinks
nSuccess := 0
// Note: Requires Chilkat v9.5.0.64 or greater.
// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// Load our previously obtained access token. (see PayPal OAuth2 Access Token)
oJsonToken := CreateObject("Chilkat.JsonObject")
oJsonToken:LoadFile("qa_data/tokens/paypal.json")
// Build the Authorization request header field value.
oSbAuth := CreateObject("Chilkat.StringBuilder")
// token_type should be "Bearer"
oSbAuth:Append(oJsonToken:StringOf("token_type"))
oSbAuth:Append(" ")
oSbAuth:Append(oJsonToken:StringOf("access_token"))
// Make the initial connection.
// A single REST object, once connected, can be used for many PayPal REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
oRest := CreateObject("Chilkat.Rest")
nBAutoReconnect := 1
nSuccess := oRest:Connect("api.sandbox.paypal.com", 443, 1, nBAutoReconnect)
IF (nSuccess != 1)
? oRest:LastErrorText
oJsonToken:destroy()
oSbAuth:destroy()
oRest:destroy()
RETURN
ENDIF
// ----------------------------------------------------------------------------------------------
// The code above this comment could be placed inside a function/subroutine within the application
// because the connection does not need to be made for every request. Once the connection is made
// the app may send many requests..
// ----------------------------------------------------------------------------------------------
// Create JSON to specify the search
oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0
oJson:AppendString("start_invoice_date", "2016-01-01 PST")
oJson:AppendString("end_invoice_date", "2016-11-16 PST")
oJson:AppendInt("page", 0)
oJson:AppendInt("page_size", 10)
oJson:AppendBool("total_count_required", 1)
? oJson:Emit()
// The JSON by the above code:
// {
// "start_invoice_date": "2016-01-01 PST",
// "end_invoice_date": "2016-11-16 PST",
// "page": 0,
// "page_size": 10,
// "total_count_required": true
// }
// Send the POST equivalent to this CURL command:
// curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/search/ \
// -H "Content-Type:application/json" \
// -H "Authorization: Bearer Access-Token" \
// -d '{ invoice JSON goes here }'
oJson:EmitCompact := 1
oSbRequestBody := CreateObject("Chilkat.StringBuilder")
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
oRest:AddHeader("Content-Type", "application/json")
oRest:AddHeader("Authorization", oSbAuth:GetAsString())
oJson:EmitSb(oSbRequestBody)
nSuccess := oRest:FullRequestSb("POST", "/v1/invoicing/search", oSbRequestBody, oSbResponseBody)
IF (nSuccess != 1)
? oRest:LastErrorText
oJsonToken:destroy()
oSbAuth:destroy()
oRest:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
RETURN
ENDIF
// We should have some sort of JSON response. It could be successful, or an error.
oJsonResponse := CreateObject("Chilkat.JsonObject")
oJsonResponse:EmitCompact := 0
oJsonResponse:LoadSb(oSbResponseBody)
? "Response Status Code = " + Str(oRest:ResponseStatusCode)
// Did we get a 200 success response?
IF (oRest:ResponseStatusCode != 200)
// Show the JSON response body
? oJsonResponse:Emit()
? "Failed."
oJsonToken:destroy()
oSbAuth:destroy()
oRest:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
oJsonResponse:destroy()
RETURN
ENDIF
// Sample response JSON is shown below.
// Iterate over each invoice and get some information from each..
nNumInvoices := oJsonResponse:SizeOfArray("invoices")
i := 0
DO WHILE i < nNumInvoices
oJsonResponse:I := i
? "Invoice ID: " + oJsonResponse:StringOf("invoices[i].id")
? "Shipping First Name: " + oJsonResponse:StringOf("invoices[i].shipping_info.first_name")
j := 0
nNumBillingInfo := oJsonResponse:SizeOfArray("invoices[i].billing_info")
DO WHILE j < nNumBillingInfo
oJsonResponse:J := j
? "billing_info email: " + oJsonResponse:StringOf("invoices[i].billing_info[j].email")
j := j + 1
ENDDO
nNumLinks := oJsonResponse:SizeOfArray("invoices[i].links")
j := 0
DO WHILE j < nNumLinks
oJsonResponse:J := j
? "link: " + oJsonResponse:StringOf("invoices[i].links[j].href")
j := j + 1
ENDDO
? "----"
i := i + 1
ENDDO
? "Success."
// A successful response looks like this:
// {
// "total_count": 2,
// "invoices": [
// {
// "id": "INV2-XV4B-736P-PLVN-SZCE",
// "number": "0002",
// "status": "DRAFT",
// "merchant_info": {
// "email": "smith-facilitator@chilkatsoft.com"
// },
// "billing_info": [
// {
// "email": "smith-buyer@chilkatsoft.com"
// }
// ],
// "shipping_info": {
// "email": "smith-buyer@chilkatsoft.com",
// "first_name": "Sally",
// "last_name": "Patient",
// "business_name": "Not applicable"
// },
// "invoice_date": "2016-11-15 PST",
// "payment_term": {
// "due_date": "2016-12-30 PST"
// },
// "note": "Medical Invoice 16 Jul, 2013 PST",
// "total_amount": {
// "currency": "USD",
// "value": "500.00"
// },
// "metadata": {
// "created_date": "2016-11-15 08:09:21 PST"
// },
// "paid_amount": {
// "paypal": {
// "currency": "USD",
// "value": "0.00"
// },
// "other": {
// "currency": "USD",
// "value": "0.00"
// }
// },
// "refunded_amount": {
// "paypal": {
// "currency": "USD",
// "value": "0.00"
// },
// "other": {
// "currency": "USD",
// "value": "0.00"
// }
// },
// "links": [
// {
// "rel": "self",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
// "method": "GET"
// },
// {
// "rel": "send",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/send",
// "method": "POST"
// },
// {
// "rel": "update",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE/update",
// "method": "PUT"
// },
// {
// "rel": "delete",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-XV4B-736P-PLVN-SZCE",
// "method": "DELETE"
// }
// ]
// },
// {
// "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
// "number": "0001",
// "status": "SENT",
// "merchant_info": {
// "email": "smith-facilitator@chilkatsoft.com"
// },
// "billing_info": [
// {
// "email": "smith-buyer@chilkatsoft.com"
// }
// ],
// "shipping_info": {
// "email": "smith-buyer@chilkatsoft.com",
// "first_name": "Sally",
// "last_name": "Patient",
// "business_name": "Not applicable"
// },
// "invoice_date": "2016-11-15 PST",
// "payment_term": {
// "due_date": "2016-12-30 PST"
// },
// "note": "Medical Invoice 16 Jul, 2013 PST",
// "total_amount": {
// "currency": "USD",
// "value": "500.00"
// },
// "metadata": {
// "created_date": "2016-11-15 06:17:03 PST",
// "payer_view_url": "https://www.sandbox.paypal.com/cgi_bin/webscr?cmd=_pay-inv&viewtype=altview&id=INV2-ZG2H-HKAW-PMWU-N6ZR"
// },
// "paid_amount": {
// "paypal": {
// "currency": "USD",
// "value": "0.00"
// },
// "other": {
// "currency": "USD",
// "value": "0.00"
// }
// },
// "refunded_amount": {
// "paypal": {
// "currency": "USD",
// "value": "0.00"
// },
// "other": {
// "currency": "USD",
// "value": "0.00"
// }
// },
// "links": [
// {
// "rel": "self",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
// "method": "GET"
// },
// {
// "rel": "update",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
// "method": "PUT"
// },
// {
// "rel": "cancel",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/remind",
// "method": "POST"
// },
// {
// "rel": "remind",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/cancel",
// "method": "POST"
// },
// {
// "rel": "record-payment",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/record-payment",
// "method": "POST"
// },
// {
// "rel": "qr-code",
// "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/qr-code",
// "method": "GET"
// }
// ]
// }
// ]
// }
//
oJsonToken:destroy()
oSbAuth:destroy()
oRest:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
oJsonResponse:destroy()