(PureBasic) PayPal - Create Order

Creates a PayPal order.

"Creating a PayPal order indicates that the buyer has consented to the purchase but does not place the funds on hold. After you create an order, you can capture the order directly without any additional authorization or you can make an authorization API call to place funds on hold until you are ready to capture. Because the order does not place funds on hold, create an authorization instead of capturing an order directly.

Merchants often use this technique to accept orders for items that are not available for shipment when the order is placed. For example, when a merchant ships items from multiple distribution centers and needs separate authorizations for each shipment. Another example would be delayed shipping on items that are not in stock."

See PayPal Order Process for more information.

Note: This example requires Chilkat v9.5.0.65 or greater.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    ; 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.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..
    ; ----------------------------------------------------------------------------------------------

    ; 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","order")
    CkJsonObject::ckUpdateString(json,"payer.payment_method","paypal")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.total","30.11")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.currency","USD")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.details.subtotal","30.00")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.details.tax","0.07")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.details.shipping","0.03")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.details.handling_fee","1.00")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.details.shipping_discount","-1.00")
    CkJsonObject::ckUpdateString(json,"transactions[0].amount.details.insurance","0.01")
    CkJsonObject::ckUpdateString(json,"transactions[0].description","This is the payment transaction description.")
    CkJsonObject::ckUpdateString(json,"transactions[0].custom","EBAY_EMS_90048630024435")
    CkJsonObject::ckUpdateString(json,"transactions[0].invoice_number","48787589673")
    CkJsonObject::ckUpdateString(json,"transactions[0].payment_options.allowed_payment_method","INSTANT_FUNDING_SOURCE")
    CkJsonObject::ckUpdateString(json,"transactions[0].soft_descriptor","ECHI5786786")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[0].name","hat")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[0].description","Brown color hat")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[0].quantity","5")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[0].price","3")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[0].tax","0.01")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[0].sku","1")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[0].currency","USD")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[1].name","handbag")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[1].description","Black color hand bag")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[1].quantity","1")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[1].price","15")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[1].tax","0.02")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[1].sku","product34")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.items[1].currency","USD")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.shipping_address.recipient_name","Hello World")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.shipping_address.line1","4thFloor")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.shipping_address.line2","unit#34")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.shipping_address.city","SAn Jose")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.shipping_address.country_code","US")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.shipping_address.postal_code","95131")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.shipping_address.phone","011862212345678")
    CkJsonObject::ckUpdateString(json,"transactions[0].item_list.shipping_address.state","CA")
    CkJsonObject::ckUpdateString(json,"note_to_payer","Contact us for any questions on your order.")
    CkJsonObject::ckUpdateString(json,"redirect_urls.return_url","http://www.amazon.com")
    CkJsonObject::ckUpdateString(json,"redirect_urls.cancel_url","http://www.hawaii.com")

    Debug CkJsonObject::ckEmit(json)

    ; The JSON created by the above code:

    ; 	{ 
    ; 	  "intent": "order",
    ; 	  "payer": { 
    ; 	    "payment_method": "paypal"
    ; 	  },
    ; 	  "transactions": [
    ; 	    { 
    ; 	      "amount": { 
    ; 	        "total": "30.11",
    ; 	        "currency": "USD",
    ; 	        "details": { 
    ; 	          "subtotal": "30.00",
    ; 	          "tax": "0.07",
    ; 	          "shipping": "0.03",
    ; 	          "handling_fee": "1.00",
    ; 	          "shipping_discount": "-1.00",
    ; 	          "insurance": "0.01"
    ; 	        }
    ; 	      },
    ; 	      "description": "This is the payment transaction description.",
    ; 	      "custom": "EBAY_EMS_90048630024435",
    ; 	      "invoice_number": "48787589673",
    ; 	      "payment_options": { 
    ; 	        "allowed_payment_method": "INSTANT_FUNDING_SOURCE"
    ; 	      },
    ; 	      "soft_descriptor": "ECHI5786786",
    ; 	      "item_list": { 
    ; 	        "items": [
    ; 	          { 
    ; 	            "name": "hat",
    ; 	            "description": "Brown color hat",
    ; 	            "quantity": "5",
    ; 	            "price": "3",
    ; 	            "tax": "0.01",
    ; 	            "sku": "1",
    ; 	            "currency": "USD"
    ; 	          },
    ; 	          { 
    ; 	            "name": "handbag",
    ; 	            "description": "Black color hand bag",
    ; 	            "quantity": "1",
    ; 	            "price": "15",
    ; 	            "tax": "0.02",
    ; 	            "sku": "product34",
    ; 	            "currency": "USD"
    ; 	          }
    ; 	        ],
    ; 	        "shipping_address": { 
    ; 	          "recipient_name": "Hello World",
    ; 	          "line1": "4thFloor",
    ; 	          "line2": "unit#34",
    ; 	          "city": "SAn Jose",
    ; 	          "country_code": "US",
    ; 	          "postal_code": "95131",
    ; 	          "phone": "011862212345678",
    ; 	          "state": "CA"
    ; 	        }
    ; 	      }
    ; 	    }
    ; 	  ],
    ; 	  "note_to_payer": "Contact us for any questions on your order.",
    ; 	  "redirect_urls": { 
    ; 	    "return_url": "http://www.amazon.com",
    ; 	    "cancel_url": "http://www.hawaii.com"
    ; 	  }
    ; 	}
    ; 
    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-4G829619WD096761LLA3DYAQ",
    ; 	  "intent": "order",
    ; 	  "state": "created",
    ; 	  "payer": { 
    ; 	    "payment_method": "paypal",
    ; 	    "use_vendor_currency_conversion": false
    ; 	  },
    ; 	  "transactions": [
    ; 	    { 
    ; 	      "amount": { 
    ; 	        "total": "30.11",
    ; 	        "currency": "USD",
    ; 	        "details": { 
    ; 	          "subtotal": "30.00",
    ; 	          "tax": "0.07",
    ; 	          "shipping": "0.03",
    ; 	          "insurance": "0.01",
    ; 	          "handling_fee": "1.00",
    ; 	          "shipping_discount": "-1.00"
    ; 	        }
    ; 	      },
    ; 	      "description": "This is the payment transaction description.",
    ; 	      "custom": "EBAY_EMS_90048630024435",
    ; 	      "invoice_number": "48787589673",
    ; 	      "soft_descriptor": "ECHI5786786",
    ; 	      "payment_options": { 
    ; 	        "allowed_payment_method": "INSTANT_FUNDING_SOURCE",
    ; 	        "recurring_flag": false,
    ; 	        "skip_fmf": false
    ; 	      },
    ; 	      "item_list": { 
    ; 	        "items": [
    ; 	          { 
    ; 	            "name": "hat",
    ; 	            "sku": "1",
    ; 	            "description": "Brown color hat",
    ; 	            "price": "3.00",
    ; 	            "currency": "USD",
    ; 	            "tax": "0.01",
    ; 	            "quantity": 5
    ; 	          },
    ; 	          { 
    ; 	            "name": "handbag",
    ; 	            "sku": "product34",
    ; 	            "description": "Black color hand bag",
    ; 	            "price": "15.00",
    ; 	            "currency": "USD",
    ; 	            "tax": "0.02",
    ; 	            "quantity": 1
    ; 	          }
    ; 	        ],
    ; 	        "shipping_address": { 
    ; 	          "recipient_name": "Hello World",
    ; 	          "line1": "4thFloor",
    ; 	          "line2": "unit#34",
    ; 	          "city": "SAn Jose",
    ; 	          "state": "CA",
    ; 	          "postal_code": "95131",
    ; 	          "country_code": "US",
    ; 	          "phone": "011862212345678"
    ; 	        }
    ; 	      },
    ; 	      "related_resources": [
    ; 	      ]
    ; 	    }
    ; 	  ],
    ; 	  "note_to_payer": "Contact us for any questions on your order.",
    ; 	  "create_time": "2016-11-24T01:01:54Z",
    ; 	  "links": [
    ; 	    { 
    ; 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-4G829619WD096761LLA3DYAQ",
    ; 	      "rel": "self",
    ; 	      "method": "GET"
    ; 	    },
    ; 	    { 
    ; 	      "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-0LS838292T986021B",
    ; 	      "rel": "approval_url",
    ; 	      "method": "REDIRECT"
    ; 	    },
    ; 	    { 
    ; 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-4G829619WD096761LLA3DYAQ/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