23

On my webpage I'm trying to implement a PayPal checkout using JavaScript following the manual: https://developer.paypal.com/docs/checkout/
Everything works great with the standard options. For example this works just fine:

paypal.Buttons({
    createOrder: function(data, actions) {
        return actions.order.create({
            purchase_units: [{
                amount: {
                    currency_code: 'EUR',
                    value: '120.16'
                },
                description: 'Purchase Unit test description',
                custom_id: '64735',
            }]
        })
    },
    onApprove: function(data, actions) {
        return actions.order.capture().then(function(details) {
            alert('Transaction completed by ' +
                  details.payer.name.given_name)
            // Call your server to save the transaction
            return fetch('/api/paypal-transaction-complete', {
                method: 'post',
                headers: {
                    'content-type': 'application/json'
                },
                body: JSON.stringify({
                    orderID: data.orderID
                })
            })
        })
    }
}).render('#paypal-button-container')

But when I try to be more specific about the order details it gives me an error:

Error: "Order Api response error: 
{ 
    "name": "INVALID_REQUEST", 
    "message": "Request is not well-formed, syntactically incorrect, or violates schema.", 
    "debug_id": "1ed03d18530c1", 
    "details": [ 
        { 
            "location": "body", 
            "issue": "INVALID_SYNTAX", 
            "description": "Cannot deserialize instance of `com.paypal.api.platform.checkout.orders.v2.model.AmountBreakdown` out of START_ARRAY token line: 1, column: 82" 
            } 
            ], 
            "links": [ 
                { 
                    "href": "https://developer.paypal.com/docs/api/orders/v2/#error-INVALID_SYNTAX", "rel": "information_link", "encType": "application/json" 
                } 
            ] 
        }"
}

This is my code:

paypal.Buttons({
    createOrder: function(data, actions) {
        return actions.order.create({
            purchase_units: [{
                amount: {
                    currency_code: 'EUR',
                    value: '120.16',
                    breakdown: [{
                                    item_total: {
                                        unit_amount: 7,
                                        currency_code: 'EUR',
                                        value: '120.16'
                                    }
                                    }]

                },
                description: 'Purchase Unit test description',
                custom_id: '64735',
                items: [{
                    name: 'Test item 1',
                    unit_amount: {
                        currency_code: 'EUR',
                        value: '60.12'
                    },
                    quantity: 2,
                    description: 'Uaua item 1 description'
                }, {
                    name: 'Test item 2',
                    unit_amount: {
                        currency_code: 'EUR',
                        value: '60.00'
                    },
                    quantity: 5,
                    description: 'Test item 2 description'
                }]
            }]
        })
    },
    onApprove: function(data, actions) {
        return actions.order.capture().then(function(details) {
            alert('Transaction completed by ' +
                  details.payer.name.given_name)
            // Call your server to save the transaction
            return fetch('/api/paypal-transaction-complete', {
                method: 'post',
                headers: {
                    'content-type': 'application/json'
                },
                body: JSON.stringify({
                    orderID: data.orderID
                })
            })
        })
    }
}).render('#paypal-button-container')

Does anyone know where the problem is? The PayPal documentation is not very informative...

Rob Kwasowski
  • 2,690
  • 3
  • 13
  • 32
Kornel
  • 4,184
  • 4
  • 28
  • 30

1 Answers1

66

After some more digging I have found the correct format:

paypal.Buttons({
    createOrder: function(data, actions) {
        return actions.order.create({
            purchase_units: [
            {
                reference_id: "PUHF",
                description: "Some description",

                custom_id: "Something7364",
                soft_descriptor: "Great description 1",
                amount: {
                    currency_code: "EUR",
                    value: "200.00",
                    breakdown: {
                        item_total: {
                            currency_code: "EUR",
                            value: "200.00"
                        }
                    }
                },
                items: [
                    {
                        name: "Item 1",
                        description: "The best item ever",
                        sku: "xyz-2654",
                        unit_amount: {
                            currency_code: "EUR",
                            value: "100.00"
                        },
                        quantity: "1"
                    },
                    {
                        name: "Item 2",
                        description: "Not bad too",
                        sku: "zdc-3942",
                        unit_amount: {
                            currency_code: "EUR",
                            value: "50.00"
                        },
                        quantity: "2"
                    }
                ],

            }
        ]
    });
},
onApprove: function(data, actions) {
    return actions.order.capture().then(function(details) {
        alert('Transaction completed by ' + details.payer.name.given_name);
        // Call your server to save the transaction
        return fetch('/api/paypal-transaction-complete', {
            method: 'post',
            headers: {
                'content-type': 'application/json'
            },
            body: JSON.stringify({
                orderID: data.orderID
            })
        });
    });
}
}).render('#paypal-button-container');

This is an example of complete set of options:

paypal.Buttons({
    createOrder: function(data, actions) {
        return actions.order.create({
            purchase_units: [{
                reference_id: "PUHF",
                description: "Sporting Goods",

                custom_id: "CUST-HighFashions",
                soft_descriptor: "HighFashions",
                amount: {
                    currency_code: "USD",
                    value: "230.00",
                    breakdown: {
                        item_total: {
                            currency_code: "USD",
                            value: "180.00"
                        },
                        shipping: {
                            currency_code: "USD",
                            value: "30.00"
                        },
                        handling: {
                            currency_code: "USD",
                            value: "10.00"
                        },
                        tax_total: {
                            currency_code: "USD",
                            value: "20.00"
                        },
                        shipping_discount: {
                            currency_code: "USD",
                            value: "10"
                        }
                    }
                },
                items: [{
                    name: "T-Shirt",
                    description: "Green XL",
                    sku: "sku01",
                    unit_amount: {
                         currency_code: "USD",
                         value: "90.00"
                    },
                    tax: {
                        currency_code: "USD",
                        value: "10.00"
                    },
                    quantity: "1",
                    category: "PHYSICAL_GOODS"
                },
                    {
                    name: "Shoes",
                    description: "Running, Size 10.5",
                    sku: "sku02",
                    unit_amount: {
                         currency_code: "USD",
                         value: "45.00"
                    },
                    tax: {
                        currency_code: "USD",
                        value: "5.00"
                    },
                    quantity: "2",
                    category: "PHYSICAL_GOODS"
                }
                ],
                shipping: {
                    method: "United States Postal Service",
                    address: {
                        name: {
                            full_name: "John",
                            surname: "Doe"
                        },
                        address_line_1: "123 Townsend St",
                        address_line_2: "Floor 6",
                        admin_area_2: "San Francisco",
                        admin_area_1: "CA",
                        postal_code: "94107",
                        country_code: "US"
                    }
                }
            }]
        })
    },
    onApprove: function(data, actions) {
        return actions.order.capture().then(function(details) {
            alert('Transaction completed by ' + details.payer.name.given_name)
            // Call your server to save the transaction
            return fetch('/api/paypal-transaction-complete', {
                method: 'post',
                headers: {
                    'content-type': 'application/json'
                },
                body: JSON.stringify({
                    orderID: data.orderID
                })
            })
        })
    }
}).render('#paypal-button-container')
Rob Kwasowski
  • 2,690
  • 3
  • 13
  • 32
Kornel
  • 4,184
  • 4
  • 28
  • 30
  • 16
    Thank you! It just works. With all the frustration with PayPal, your code is the best documentation available online. PayPal should hire you to update their docs. <3 Copied to my gists. Every time I need PayPal to work is a nightmare. – Lukas Liesis Aug 09 '19 at 09:42
  • 2
    Glad it helped :) If you like it up-vote it please. – Kornel Aug 10 '19 at 11:41
  • Works! It was hard to find such an actual example for this. – eyal_katz Dec 17 '19 at 23:07
  • 1
    I agree with Lukas - best documentation I found. Thank you! – Steve Lloyd Jun 02 '20 at 13:15
  • I do have one question. When you "Call your server to save the transaction" you are passing it data.orderID but I do not see that in the createOrder. Is that the reference_id or the custom_id? – Steve Lloyd Jun 02 '20 at 14:39
  • @Kornel, hi i was wondering if you could help me with this here: https://stackoverflow.com/questions/62796406/paypal-400-response-not-getting-json-correct – redoc01 Jul 08 '20 at 16:54
  • @all one more thing that I have noticed here. The total amount is equal to the total of our items. It is a normal thing but if some mistake in our math formula then the Paypal popup auto closed after opened. That type of error does not show in the console. – Bhavin Thummar Oct 29 '20 at 08:59
  • Thank you so much for the clean example. I was wondering if once we get a sucessful `then` `response` from the `capture( )` method it's 100% sure that the transaction was successful, right? and so, we are free to call more logic for the back-end. Did you add any catch method for that same `capture ( )` method? – Fer Toasted Mar 11 '21 at 04:31
  • No, sorry. I didn't. – Kornel Mar 12 '21 at 18:40
  • Thank you for this response. I had suffered – Alfred Samanga Jan 16 '22 at 07:35
  • hi, does anyone know how to use application_context within createOrder: function(data, actions) block while using return fetch() – Ariful Haque Feb 01 '22 at 19:20
  • Upvoted, so good to have a working reference. For what it's worth, my issue was the classic mistake of an extra `,` when building the items array. I was getting an unhelpful 500 Internal Error. Removed it, and it worked. Thank you. – Nagev Jun 03 '22 at 08:39