Chilkat HOME .NET Core C# Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi ActiveX Delphi DLL Go Java Lianja Mono C# Node.js Objective-C PHP ActiveX PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift 2 Swift 3,4,5... Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(Visual FoxPro) PayPal Search for InvoicesSearch PayPal invoices. See also SearchInvoices
LOCAL loJsonToken LOCAL loSbAuth LOCAL loRest LOCAL lnBAutoReconnect LOCAL lnSuccess LOCAL loJson LOCAL loSbRequestBody LOCAL loSbResponseBody LOCAL loJsonResponse LOCAL lnNumInvoices LOCAL i LOCAL j LOCAL lnNumBillingInfo LOCAL lnNumLinks * 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) * For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject') loJsonToken = CreateObject('Chilkat.JsonObject') loJsonToken.LoadFile("qa_data/tokens/paypal.json") * Build the Authorization request header field value. * For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder') loSbAuth = CreateObject('Chilkat.StringBuilder') * token_type should be "Bearer" loSbAuth.Append(loJsonToken.StringOf("token_type")) loSbAuth.Append(" ") loSbAuth.Append(loJsonToken.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. * For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest') loRest = CreateObject('Chilkat.Rest') lnBAutoReconnect = 1 lnSuccess = loRest.Connect("api.sandbox.paypal.com",443,1,lnBAutoReconnect) IF (lnSuccess <> 1) THEN ? loRest.LastErrorText RELEASE loJsonToken RELEASE loSbAuth RELEASE loRest CANCEL 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 * For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject') loJson = CreateObject('Chilkat.JsonObject') loJson.EmitCompact = 0 loJson.AppendString("start_invoice_date","2016-01-01 PST") loJson.AppendString("end_invoice_date","2016-11-16 PST") loJson.AppendInt("page",0) loJson.AppendInt("page_size",10) loJson.AppendBool("total_count_required",1) ? loJson.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 }' loJson.EmitCompact = 1 * For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder') loSbRequestBody = CreateObject('Chilkat.StringBuilder') * For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder') loSbResponseBody = CreateObject('Chilkat.StringBuilder') loRest.AddHeader("Content-Type","application/json") loRest.AddHeader("Authorization",loSbAuth.GetAsString()) loJson.EmitSb(loSbRequestBody) lnSuccess = loRest.FullRequestSb("POST","/v1/invoicing/search",loSbRequestBody,loSbResponseBody) IF (lnSuccess <> 1) THEN ? loRest.LastErrorText RELEASE loJsonToken RELEASE loSbAuth RELEASE loRest RELEASE loJson RELEASE loSbRequestBody RELEASE loSbResponseBody CANCEL ENDIF * We should have some sort of JSON response. It could be successful, or an error. * For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject') loJsonResponse = CreateObject('Chilkat.JsonObject') loJsonResponse.EmitCompact = 0 loJsonResponse.LoadSb(loSbResponseBody) ? "Response Status Code = " + STR(loRest.ResponseStatusCode) * Did we get a 200 success response? IF (loRest.ResponseStatusCode <> 200) THEN * Show the JSON response body ? loJsonResponse.Emit() ? "Failed." RELEASE loJsonToken RELEASE loSbAuth RELEASE loRest RELEASE loJson RELEASE loSbRequestBody RELEASE loSbResponseBody RELEASE loJsonResponse CANCEL ENDIF * Sample response JSON is shown below. * Iterate over each invoice and get some information from each.. lnNumInvoices = loJsonResponse.SizeOfArray("invoices") i = 0 DO WHILE i < lnNumInvoices loJsonResponse.I = i ? "Invoice ID: " + loJsonResponse.StringOf("invoices[i].id") ? "Shipping First Name: " + loJsonResponse.StringOf("invoices[i].shipping_info.first_name") j = 0 lnNumBillingInfo = loJsonResponse.SizeOfArray("invoices[i].billing_info") DO WHILE j < lnNumBillingInfo loJsonResponse.J = j ? "billing_info email: " + loJsonResponse.StringOf("invoices[i].billing_info[j].email") j = j + 1 ENDDO lnNumLinks = loJsonResponse.SizeOfArray("invoices[i].links") j = 0 DO WHILE j < lnNumLinks loJsonResponse.J = j ? "link: " + loJsonResponse.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" * } * ] * } * ] * } * RELEASE loJsonToken RELEASE loSbAuth RELEASE loRest RELEASE loJson RELEASE loSbRequestBody RELEASE loSbResponseBody RELEASE loJsonResponse |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.