PureBasic
PureBasic
PayPal - Create a PayPal Payment
See more PayPal Examples
Creates a payment to be paid from a PayPal account (as opposed to being funded by a credit card).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 transaction information.
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckUpdateString(json,"intent","sale")
CkJsonObject::ckUpdateString(json,"redirect_urls.return_url","http://www.example.com/return_url")
CkJsonObject::ckUpdateString(json,"redirect_urls.cancel_url","http://www.example.com/cancel_url")
CkJsonObject::ckUpdateString(json,"payer.payment_method","paypal")
CkJsonObject::ckUpdateString(json,"transactions[0].amount.total","7.47")
CkJsonObject::ckUpdateString(json,"transactions[0].amount.currency","USD")
CkJsonObject::ckUpdateString(json,"transactions[0].description","This is the payment transaction description.")
Debug CkJsonObject::ckEmit(json)
; The JSON created by the above code is this:
; {
; "intent": "sale",
; "redirect_urls": {
; "return_url": "http://www.example.com/return_url",
; "cancel_url": "http://www.example.com/cancel_url"
; },
; "payer": {
; "payment_method": "paypal"
; },
; "transactions": [
; {
; "amount": {
; "total": "7.47",
; "currency": "USD"
; },
; "description": "This is the payment transaction description."
; }
; ]
; }
CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
CkRest::ckAddHeader(rest,"Content-Type","application/json")
; 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","/v1/payments/payment",sbJsonRequest,sbJsonResponse)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
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 201 success response?
If CkRest::ckResponseStatusCode(rest) <> 201
Debug CkJsonObject::ckEmit(json)
Debug "Failed."
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
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-1XK50350XV338620BLA3CZGI",
; "intent": "sale",
; "state": "created",
; "payer": {
; "payment_method": "paypal",
; "use_vendor_currency_conversion": false
; },
; "transactions": [
; {
; "amount": {
; "total": "7.47",
; "currency": "USD"
; },
; "description": "This is the payment transaction description.",
; "related_resources": [
; ]
; }
; ],
; "create_time": "2016-11-23T23:56:09Z",
; "links": [
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI",
; "rel": "self",
; "method": "GET"
; },
; {
; "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-0BG932459F977083J",
; "rel": "approval_url",
; "method": "REDIRECT"
; },
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-1XK50350XV338620BLA3CZGI/execute",
; "rel": "execute",
; "method": "POST"
; }
; ]
; }
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndProcedure