DataFlex
DataFlex
PayPal - Create Order
See more PayPal Examples
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 DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Token Handle hoJsonToken
Handle hoSbAuth
Handle hoRest
Boolean iBAutoReconnect
Handle hoJson
Variant vSbJsonRequest
Handle hoSbJsonRequest
Variant vSbJsonResponse
Handle hoSbJsonResponse
String sTemp1
Integer iTemp1
Move False To iSuccess
// 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)
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
If (Not(IsComObjectCreated(hoJsonToken))) Begin
Send CreateComObject of hoJsonToken
End
Get ComLoadFile Of hoJsonToken "qa_data/tokens/paypal.json" To iSuccess
// Build the Authorization request header field value.
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbAuth
If (Not(IsComObjectCreated(hoSbAuth))) Begin
Send CreateComObject of hoSbAuth
End
// token_type should be "Bearer"
Get ComStringOf Of hoJsonToken "token_type" To sTemp1
Get ComAppend Of hoSbAuth sTemp1 To iSuccess
Get ComAppend Of hoSbAuth " " To iSuccess
Get ComStringOf Of hoJsonToken "access_token" To sTemp1
Get ComAppend Of hoSbAuth sTemp1 To iSuccess
// 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.
Get Create (RefClass(cComChilkatRest)) To hoRest
If (Not(IsComObjectCreated(hoRest))) Begin
Send CreateComObject of hoRest
End
Move True To iBAutoReconnect
Get ComConnect Of hoRest "api.sandbox.paypal.com" 443 True iBAutoReconnect To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
// ----------------------------------------------------------------------------------------------
// 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.
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Set ComEmitCompact Of hoJson To False
Get ComUpdateString Of hoJson "intent" "order" To iSuccess
Get ComUpdateString Of hoJson "payer.payment_method" "paypal" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].amount.total" "30.11" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].amount.currency" "USD" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].amount.details.subtotal" "30.00" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].amount.details.tax" "0.07" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].amount.details.shipping" "0.03" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].amount.details.handling_fee" "1.00" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].amount.details.shipping_discount" "-1.00" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].amount.details.insurance" "0.01" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].description" "This is the payment transaction description." To iSuccess
Get ComUpdateString Of hoJson "transactions[0].custom" "EBAY_EMS_90048630024435" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].invoice_number" "48787589673" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].payment_options.allowed_payment_method" "INSTANT_FUNDING_SOURCE" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].soft_descriptor" "ECHI5786786" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[0].name" "hat" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[0].description" "Brown color hat" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[0].quantity" "5" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[0].price" "3" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[0].tax" "0.01" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[0].sku" "1" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[0].currency" "USD" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[1].name" "handbag" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[1].description" "Black color hand bag" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[1].quantity" "1" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[1].price" "15" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[1].tax" "0.02" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[1].sku" "product34" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.items[1].currency" "USD" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.shipping_address.recipient_name" "Hello World" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.shipping_address.line1" "4thFloor" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.shipping_address.line2" "unit#34" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.shipping_address.city" "SAn Jose" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.shipping_address.country_code" "US" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.shipping_address.postal_code" "95131" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.shipping_address.phone" "011862212345678" To iSuccess
Get ComUpdateString Of hoJson "transactions[0].item_list.shipping_address.state" "CA" To iSuccess
Get ComUpdateString Of hoJson "note_to_payer" "Contact us for any questions on your order." To iSuccess
Get ComUpdateString Of hoJson "redirect_urls.return_url" "http://www.amazon.com" To iSuccess
Get ComUpdateString Of hoJson "redirect_urls.cancel_url" "http://www.hawaii.com" To iSuccess
Get ComEmit Of hoJson To sTemp1
Showln sTemp1
// 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"
// }
// }
//
Get ComGetAsString Of hoSbAuth To sTemp1
Get ComAddHeader Of hoRest "Authorization" sTemp1 To iSuccess
Get ComAddHeader Of hoRest "Content-Type" "application/json" To iSuccess
// Send the POST request containign the JSON in the request body, and get the JSON response.
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJsonRequest
If (Not(IsComObjectCreated(hoSbJsonRequest))) Begin
Send CreateComObject of hoSbJsonRequest
End
Set ComEmitCompact Of hoJson To True
Get pvComObject of hoSbJsonRequest to vSbJsonRequest
Get ComEmitSb Of hoJson vSbJsonRequest To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJsonResponse
If (Not(IsComObjectCreated(hoSbJsonResponse))) Begin
Send CreateComObject of hoSbJsonResponse
End
Get pvComObject of hoSbJsonRequest to vSbJsonRequest
Get pvComObject of hoSbJsonResponse to vSbJsonResponse
Get ComFullRequestSb Of hoRest "POST" "/v1/payments/payment" vSbJsonRequest vSbJsonResponse To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
Set ComEmitCompact Of hoJson To False
Get pvComObject of hoSbJsonResponse to vSbJsonResponse
Get ComLoadSb Of hoJson vSbJsonResponse To iSuccess
Get ComResponseStatusCode Of hoRest To iTemp1
Showln "Response Status Code = " iTemp1
// Did we get a 201 success response?
Get ComResponseStatusCode Of hoRest To iTemp1
If (iTemp1 <> 201) Begin
Get ComEmit Of hoJson To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response is shown below.
Get ComEmit Of hoJson To sTemp1
Showln sTemp1
Showln "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"
// }
// ]
// }
End_Procedure