|
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
(PureBasic) PayPal Search for InvoicesSearch PayPal invoices. See also SearchInvoices
IncludeFile "CkStringBuilder.pb" IncludeFile "CkJsonObject.pb" IncludeFile "CkRest.pb" Procedure ChilkatExample() ; 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) jsonToken.i = CkJsonObject::ckCreate() If jsonToken.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/paypal.json") ; Build the Authorization request header field value. sbAuth.i = CkStringBuilder::ckCreate() If sbAuth.i = 0 Debug "Failed to create object." ProcedureReturn EndIf ; token_type should be "Bearer" CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"token_type")) CkStringBuilder::ckAppend(sbAuth," ") CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"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. rest.i = CkRest::ckCreate() If rest.i = 0 Debug "Failed to create object." ProcedureReturn EndIf bAutoReconnect.i = 1 success.i = CkRest::ckConnect(rest,"api.sandbox.paypal.com",443,1,bAutoReconnect) If success <> 1 Debug CkRest::ckLastErrorText(rest) CkJsonObject::ckDispose(jsonToken) CkStringBuilder::ckDispose(sbAuth) CkRest::ckDispose(rest) ProcedureReturn 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 json.i = CkJsonObject::ckCreate() If json.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkJsonObject::setCkEmitCompact(json, 0) CkJsonObject::ckAppendString(json,"start_invoice_date","2016-01-01 PST") CkJsonObject::ckAppendString(json,"end_invoice_date","2016-11-16 PST") CkJsonObject::ckAppendInt(json,"page",0) CkJsonObject::ckAppendInt(json,"page_size",10) CkJsonObject::ckAppendBool(json,"total_count_required",1) Debug CkJsonObject::ckEmit(json) ; 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 }' CkJsonObject::setCkEmitCompact(json, 1) sbRequestBody.i = CkStringBuilder::ckCreate() If sbRequestBody.i = 0 Debug "Failed to create object." ProcedureReturn EndIf sbResponseBody.i = CkStringBuilder::ckCreate() If sbResponseBody.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkRest::ckAddHeader(rest,"Content-Type","application/json") CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth)) CkJsonObject::ckEmitSb(json,sbRequestBody) success = CkRest::ckFullRequestSb(rest,"POST","/v1/invoicing/search",sbRequestBody,sbResponseBody) If success <> 1 Debug CkRest::ckLastErrorText(rest) CkJsonObject::ckDispose(jsonToken) CkStringBuilder::ckDispose(sbAuth) CkRest::ckDispose(rest) CkJsonObject::ckDispose(json) CkStringBuilder::ckDispose(sbRequestBody) CkStringBuilder::ckDispose(sbResponseBody) ProcedureReturn EndIf ; We should have some sort of JSON response. It could be successful, or an error. jsonResponse.i = CkJsonObject::ckCreate() If jsonResponse.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkJsonObject::setCkEmitCompact(jsonResponse, 0) CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody) Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest)) ; Did we get a 200 success response? If CkRest::ckResponseStatusCode(rest) <> 200 ; Show the JSON response body Debug CkJsonObject::ckEmit(jsonResponse) Debug "Failed." CkJsonObject::ckDispose(jsonToken) CkStringBuilder::ckDispose(sbAuth) CkRest::ckDispose(rest) CkJsonObject::ckDispose(json) CkStringBuilder::ckDispose(sbRequestBody) CkStringBuilder::ckDispose(sbResponseBody) CkJsonObject::ckDispose(jsonResponse) ProcedureReturn EndIf ; Sample response JSON is shown below. ; Iterate over each invoice and get some information from each.. numInvoices.i = CkJsonObject::ckSizeOfArray(jsonResponse,"invoices") i.i = 0 While i < numInvoices CkJsonObject::setCkI(jsonResponse, i) Debug "Invoice ID: " + CkJsonObject::ckStringOf(jsonResponse,"invoices[i].id") Debug "Shipping First Name: " + CkJsonObject::ckStringOf(jsonResponse,"invoices[i].shipping_info.first_name") j.i = 0 numBillingInfo.i = CkJsonObject::ckSizeOfArray(jsonResponse,"invoices[i].billing_info") While j < numBillingInfo CkJsonObject::setCkJ(jsonResponse, j) Debug "billing_info email: " + CkJsonObject::ckStringOf(jsonResponse,"invoices[i].billing_info[j].email") j = j + 1 Wend numLinks.i = CkJsonObject::ckSizeOfArray(jsonResponse,"invoices[i].links") j = 0 While j < numLinks CkJsonObject::setCkJ(jsonResponse, j) Debug "link: " + CkJsonObject::ckStringOf(jsonResponse,"invoices[i].links[j].href") j = j + 1 Wend Debug "----" i = i + 1 Wend Debug "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" ; } ; ] ; } ; ] ; } ; CkJsonObject::ckDispose(jsonToken) CkStringBuilder::ckDispose(sbAuth) CkRest::ckDispose(rest) CkJsonObject::ckDispose(json) CkStringBuilder::ckDispose(sbRequestBody) CkStringBuilder::ckDispose(sbResponseBody) CkJsonObject::ckDispose(jsonResponse) ProcedureReturn EndProcedure |
||||
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.