B4X
B4X
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 B4X Downloads
Dim success As Boolean = False
' 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)
Dim jsonToken As ChilkatJsonObject
jsonToken.Initialize
jsonToken.LoadFile("qa_data/tokens/paypal.json")
' Build the Authorization request header field value.
Dim sbAuth As ChilkatStringBuilder
sbAuth.Initialize
' token_type should be "Bearer"
sbAuth.Append(jsonToken.StringOf("token_type"))
sbAuth.Append(" ")
sbAuth.Append(jsonToken.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.
Dim rest As ChilkatRest
rest.Initialize("rest")
Dim bAutoReconnect As Boolean = True
success = rest.Connect("api.sandbox.paypal.com", 443, True, bAutoReconnect)
If success <> True Then
Log(rest.LastErrorText)
Return
End If
' ----------------------------------------------------------------------------------------------
' 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
Dim json As ChilkatJsonObject
json.Initialize
json.EmitCompact = False
json.AppendString("payer_id", "RRCYJUTFJGZTA")
Log(json.Emit)
' The JSON created by the above code:
' {
' "payer_id": "RRCYJUTFJGZTA"
' }
rest.AddHeader("Authorization", sbAuth.GetAsString)
rest.AddHeader("Content-Type", "application/json")
' The payment ID is passed in the path.
Dim sbPath As ChilkatStringBuilder
sbPath.Initialize
sbPath.Append("/v1/payments/payment/payment_id/execute")
Dim numReplaced As Int = sbPath.Replace("payment_id", "PAY-4N746561P0587231SKQQK6MY")
' Send the POST request containign the JSON in the request body, and get the JSON response.
Dim sbJsonRequest As ChilkatStringBuilder
sbJsonRequest.Initialize
json.EmitCompact = True
json.EmitSb(sbJsonRequest)
Dim sbJsonResponse As ChilkatStringBuilder
sbJsonResponse.Initialize
success = rest.FullRequestSb("POST", sbPath.GetAsString, sbJsonRequest, sbJsonResponse)
If success <> True Then
Log(rest.LastErrorText)
Return
End If
json.EmitCompact = False
json.LoadSb(sbJsonResponse)
Log("Response Status Code = " & rest.ResponseStatusCode)
' Did we get a 200 success response?
If rest.ResponseStatusCode <> 200 Then
Log(json.Emit)
Log("Failed.")
Return
End If
' Sample JSON response is shown below.
Log(json.Emit)
Log("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"
' }
' ]
' }