PureBasic
PureBasic
PayPal - Execute Approved PayPal Payment
See more PayPal Examples
Executes an approved PayPal payment. (This is for executing an approved PayPal payment, not a credit card payment.)Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat PureBasic Downloads
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"
Procedure ChilkatExample()
success.i = 0
; Note: Requires Chilkat v9.5.0.65 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 = 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..
; ----------------------------------------------------------------------------------------------
; Build the JSON containing the payer_id
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckAppendString(json,"payer_id","RRCYJUTFJGZTA")
Debug CkJsonObject::ckEmit(json)
; The JSON created by the above code:
; {
; "payer_id": "RRCYJUTFJGZTA"
; }
CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
CkRest::ckAddHeader(rest,"Content-Type","application/json")
; The payment ID is passed in the path.
sbPath.i = CkStringBuilder::ckCreate()
If sbPath.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbPath,"/v1/payments/payment/payment_id/execute")
numReplaced.i = CkStringBuilder::ckReplace(sbPath,"payment_id","PAY-4N746561P0587231SKQQK6MY")
; Send the POST request containign the JSON in the request body, and get the JSON response.
sbJsonRequest.i = CkStringBuilder::ckCreate()
If sbJsonRequest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 1)
CkJsonObject::ckEmitSb(json,sbJsonRequest)
sbJsonResponse.i = CkStringBuilder::ckCreate()
If sbJsonResponse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST",CkStringBuilder::ckGetAsString(sbPath),sbJsonRequest,sbJsonResponse)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckLoadSb(json,sbJsonResponse)
Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))
; Did we get a 200 success response?
If CkRest::ckResponseStatusCode(rest) <> 200
Debug CkJsonObject::ckEmit(json)
Debug "Failed."
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndIf
; Sample JSON response is shown below.
Debug CkJsonObject::ckEmit(json)
Debug "success"
; ------------------------------------------------
; A sample JSON response:
; {
; "id": "PAY-4N746561P0587231SKQQK6MY",
; "create_time": "2014-09-22T23:22:27Z",
; "update_time": "2014-09-22T23:31:13Z",
; "state": "approved",
; "intent": "sale",
; "payer": {
; "payment_method": "paypal",
; "payer_info": {
; "email": "npurayil-uspr-60@paypal.com",
; "first_name": "Brian",
; "last_name": "Robinson",
; "payer_id": "JMKDKJ4D7DG7G",
; "shipping_address": {
; "line1": "4thFloor",
; "line2": "unit#34",
; "city": "SAn Jose",
; "state": "CA",
; "postal_code": "95131",
; "country_code": "US",
; "phone": "011862212345678",
; "recipient_name": "HelloWorld"
; }
; }
; },
; "transactions": [
; {
; "amount": {
; "total": "30.11",
; "currency": "USD",
; "details": {
; "subtotal": "30.00",
; "tax": "0.07",
; "shipping": "0.03",
; "handling_fee": "1.00",
; "insurance": "0.01",
; "shipping_discount": "-1.00"
; }
; },
; "description": "This is the payment transaction description.",
; "item_list": {
; "items": [
; {
; "name": "hat",
; "sku": "1",
; "price": "3.00",
; "currency": "USD",
; "quantity": "5",
; "description": "Brown color hat",
; "tax": "0.01"
; },
; {
; "name": "handbag",
; "sku": "product34",
; "price": "15.00",
; "currency": "USD",
; "quantity": "1",
; "description": "Black color handbag",
; "tax": "0.02"
; }
; ],
; "shipping_address": {
; "recipient_name": "HelloWorld",
; "line1": "4thFloor",
; "line2": "unit#34",
; "city": "SAn Jose",
; "state": "CA",
; "phone": "011862212345678",
; "postal_code": "95131",
; "country_code": "US"
; }
; },
; "related_resources": [
; {
; "sale": {
; "id": "4XP56210M0797192Y",
; "create_time": "2014-09-22T23:22:27Z",
; "update_time": "2014-09-22T23:31:13Z",
; "amount": {
; "total": "30.11",
; "currency": "USD"
; },
; "payment_mode": "INSTANT_TRANSFER",
; "state": "completed",
; "protection_eligibility": "ELIGIBLE",
; "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",
; "transaction_fee": {
; "value": "1.75",
; "currency": "USD"
; },
; "parent_payment": "PAY-4N746561P0587231SKQQK6MY",
; "links": [
; {
; "href": "https://api.paypal.com/v1/payments/sale/4XP56210M0797192Y",
; "rel": "self",
; "method": "GET"
; },
; {
; "href": "https://api.paypal.com/v1/payments/sale/4XP56210M0797192Y/refund",
; "rel": "refund",
; "method": "POST"
; },
; {
; "href": "https://api.paypal.com/v1/payments/payment/PAY-4N746561P0587231SKQQK6MY",
; "rel": "parent_payment",
; "method": "GET"
; }
; ]
; }
; }
; ]
; }
; ],
; "links": [
; {
; "href": "https://api.paypal.com/v1/payments/payment/PAY-4N746561P0587231SKQQK6MY",
; "rel": "self",
; "method": "GET"
; }
; ]
; }
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndProcedure