❮❮ Back to Samples

Request Object

{
    "intent": "sale",
    "payer": {
        "payment_method": "paypal"
    },
    "redirect_urls": {
        "return_url": "https://streameworld.com/vendor/paypal/rest-api-sdk-php/sample/payments/ExecutePayment.php?success=true",
        "cancel_url": "https://streameworld.com/vendor/paypal/rest-api-sdk-php/sample/payments/ExecutePayment.php?success=false"
    },
    "transactions": [
        {
            "amount": {
                "currency": "USD",
                "total": "20",
                "details": {
                    "shipping": "1.20",
                    "tax": "1.30",
                    "subtotal": "17.50"
                }
            },
            "item_list": {
                "items": [
                    {
                        "name": "Ground Coffee 40 oz",
                        "currency": "USD",
                        "quantity": 1,
                        "sku": "123123",
                        "price": "7.50"
                    },
                    {
                        "name": "Granola bars",
                        "currency": "USD",
                        "quantity": 5,
                        "sku": "321321",
                        "price": "2"
                    }
                ]
            },
            "description": "Payment description",
            "invoice_number": "6820d51ab592f"
        }
    ]
}

Response Object

{
    "intent": "sale",
    "payer": {
        "payment_method": "paypal"
    },
    "redirect_urls": {
        "return_url": "https://streameworld.com/vendor/paypal/rest-api-sdk-php/sample/payments/ExecutePayment.php?success=true",
        "cancel_url": "https://streameworld.com/vendor/paypal/rest-api-sdk-php/sample/payments/ExecutePayment.php?success=false"
    },
    "transactions": [
        {
            "amount": {
                "total": "20.00",
                "currency": "USD",
                "details": {
                    "subtotal": "17.50",
                    "tax": "1.30",
                    "shipping": "1.20"
                }
            },
            "description": "Payment description",
            "invoice_number": "6820d51ab592f",
            "item_list": {
                "items": [
                    {
                        "name": "Ground Coffee 40 oz",
                        "sku": "123123",
                        "price": "7.50",
                        "currency": "USD",
                        "quantity": 1
                    },
                    {
                        "name": "Granola bars",
                        "sku": "321321",
                        "price": "2.00",
                        "currency": "USD",
                        "quantity": 5
                    }
                ]
            },
            "related_resources": []
        }
    ],
    "id": "PAYID-NAQNKEA4MJ057879N765954D",
    "state": "created",
    "create_time": "2025-05-11T16:49:19Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAYID-NAQNKEA4MJ057879N765954D",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-8VN514373N4469114",
            "rel": "approval_url",
            "method": "REDIRECT"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAYID-NAQNKEA4MJ057879N765954D/execute",
            "rel": "execute",
            "method": "POST"
        }
    ]
}

Request Object

[
    {
        "op": "replace",
        "path": "/transactions/0/amount",
        "value": {
            "total": "25.00",
            "currency": "USD",
            "details": {
                "subtotal": "17.50",
                "shipping": "6.20",
                "tax": "1.30"
            }
        }
    },
    {
        "op": "add",
        "path": "/transactions/0/item_list/shipping_address",
        "value": {
            "recipient_name": "Gruneberg, Anna",
            "line1": "52 N Main St",
            "city": "San Jose",
            "state": "CA",
            "postal_code": "95112",
            "country_code": "US"
        }
    }
]

Response Object

Request Object

Response Object

{
    "id": "PAYID-NAQNKEA4MJ057879N765954D",
    "intent": "sale",
    "state": "created",
    "cart": "8VN514373N4469114",
    "transactions": [
        {
            "amount": {
                "total": "25.00",
                "currency": "USD",
                "details": {
                    "subtotal": "17.50",
                    "tax": "1.30",
                    "shipping": "6.20"
                }
            },
            "payee": {
                "merchant_id": "2BP3WP8PK6566",
                "email": "jaypatel512-facilitator@hotmail.com"
            },
            "description": "Payment description",
            "invoice_number": "6820d51ab592f",
            "item_list": {
                "items": [
                    {
                        "name": "Ground Coffee 40 oz",
                        "sku": "123123",
                        "price": "7.50",
                        "currency": "USD",
                        "quantity": 1
                    },
                    {
                        "name": "Granola bars",
                        "sku": "321321",
                        "price": "2.00",
                        "currency": "USD",
                        "quantity": 5
                    }
                ],
                "shipping_address": {
                    "recipient_name": "Gruneberg, Anna",
                    "line1": "52 N Main St",
                    "city": "San Jose",
                    "state": "CA",
                    "postal_code": "95112",
                    "country_code": "US"
                }
            },
            "related_resources": []
        }
    ],
    "redirect_urls": {
        "return_url": "https://streameworld.com/vendor/paypal/rest-api-sdk-php/sample/payments/ExecutePayment.php?success=true&paymentId=PAYID-NAQNKEA4MJ057879N765954D",
        "cancel_url": "https://streameworld.com/vendor/paypal/rest-api-sdk-php/sample/payments/ExecutePayment.php?success=false"
    },
    "create_time": "2025-05-11T16:49:19Z",
    "update_time": "2025-05-11T16:49:20Z",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAYID-NAQNKEA4MJ057879N765954D",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAYID-NAQNKEA4MJ057879N765954D/execute",
            "rel": "execute",
            "method": "POST"
        },
        {
            "href": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-8VN514373N4469114",
            "rel": "approval_url",
            "method": "REDIRECT"
        }
    ]
}