PayPal REST API Samples

1. Create Invoice

Invoice with ID: INV2-ZFND-J2A3-XNG6-GQ7L

Request Object

{
    "merchant_info": {
        "email": "developer@sample.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "sample@buy.com",
            "business_name": "Jay Inc",
            "additional_info": "This is the billing Info",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            }
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45"
    }
}

Response Object

{
    "merchant_info": {
        "email": "developer@sample.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "sample@buy.com",
            "business_name": "Jay Inc",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            },
            "additional_info": "This is the billing Info"
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-08-24 PDT"
    },
    "id": "INV2-ZFND-J2A3-XNG6-GQ7L",
    "number": "8384",
    "template_id": "TEMP-74V34217FK810934T",
    "status": "DRAFT",
    "invoice_date": "2025-07-10 PDT",
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "total_amount": {
        "currency": "USD",
        "value": "0.00"
    },
    "metadata": {
        "created_date": "2025-07-10 22:25:05 PDT"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/record-payment",
            "method": "POST"
        }
    ]
}

Request
Response

Request Object

{
    "merchant_info": {
        "email": "developer@sample.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "sample@buy.com",
            "business_name": "Jay Inc",
            "additional_info": "This is the billing Info",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            }
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45"
    }
}

Response Object

{
    "merchant_info": {
        "email": "developer@sample.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "sample@buy.com",
            "business_name": "Jay Inc",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            },
            "additional_info": "This is the billing Info"
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-08-24 PDT"
    },
    "id": "INV2-ZFND-J2A3-XNG6-GQ7L",
    "number": "8384",
    "template_id": "TEMP-74V34217FK810934T",
    "status": "DRAFT",
    "invoice_date": "2025-07-10 PDT",
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "total_amount": {
        "currency": "USD",
        "value": "0.00"
    },
    "metadata": {
        "created_date": "2025-07-10 22:25:05 PDT"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/record-payment",
            "method": "POST"
        }
    ]
}

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

Warning: error_log(../PayPal.log): failed to open stream: Permission denied in /var/www/webandad.com/app/vendor/paypal/rest-api-sdk-php/lib/PayPal/Log/PayPalLogger.php on line 80

2. Send Invoice

Invoice with ID: INV2-ZFND-J2A3-XNG6-GQ7L

Request Object

{
    "merchant_info": {
        "email": "developer@sample.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "sample@buy.com",
            "business_name": "Jay Inc",
            "additional_info": "This is the billing Info",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            }
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45"
    }
}

Response Object

{
    "id": "INV2-ZFND-J2A3-XNG6-GQ7L",
    "number": "8384",
    "template_id": "TEMP-74V34217FK810934T",
    "status": "SENT",
    "merchant_info": {
        "email": "developer@sample.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "sample@buy.com",
            "business_name": "Jay Inc",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            },
            "additional_info": "This is the billing Info"
        }
    ],
    "invoice_date": "2025-07-10 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-08-24 PDT"
    },
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "total_amount": {
        "currency": "USD",
        "value": "0.00"
    },
    "metadata": {
        "created_date": "2025-07-10 22:25:05 PDT",
        "first_sent_date": "2025-07-10 22:25:06 PDT",
        "last_sent_date": "2025-07-10 22:25:06 PDT",
        "payer_view_url": "https://www.sandbox.paypal.com/invoice/p/#INV2-ZFND-J2A3-XNG6-GQ7L"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L",
            "method": "GET"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/update",
            "method": "PUT"
        },
        {
            "rel": "cancel",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/cancel",
            "method": "POST"
        },
        {
            "rel": "remind",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/remind",
            "method": "POST"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/record-payment",
            "method": "POST"
        },
        {
            "rel": "qr-code",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/qr-code",
            "method": "GET"
        }
    ]
}

Request
Response

Request Object

{
    "merchant_info": {
        "email": "developer@sample.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "sample@buy.com",
            "business_name": "Jay Inc",
            "additional_info": "This is the billing Info",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            }
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45"
    }
}

Response Object

{
    "id": "INV2-ZFND-J2A3-XNG6-GQ7L",
    "number": "8384",
    "template_id": "TEMP-74V34217FK810934T",
    "status": "SENT",
    "merchant_info": {
        "email": "developer@sample.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "sample@buy.com",
            "business_name": "Jay Inc",
            "address": {
                "line1": "1234 Main St.",
                "city": "Portland",
                "state": "OR",
                "postal_code": "97217",
                "country_code": "US"
            },
            "additional_info": "This is the billing Info"
        }
    ],
    "invoice_date": "2025-07-10 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-08-24 PDT"
    },
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "total_amount": {
        "currency": "USD",
        "value": "0.00"
    },
    "metadata": {
        "created_date": "2025-07-10 22:25:05 PDT",
        "first_sent_date": "2025-07-10 22:25:06 PDT",
        "last_sent_date": "2025-07-10 22:25:06 PDT",
        "payer_view_url": "https://www.sandbox.paypal.com/invoice/p/#INV2-ZFND-J2A3-XNG6-GQ7L"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L",
            "method": "GET"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/update",
            "method": "PUT"
        },
        {
            "rel": "cancel",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/cancel",
            "method": "POST"
        },
        {
            "rel": "remind",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/remind",
            "method": "POST"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/record-payment",
            "method": "POST"
        },
        {
            "rel": "qr-code",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZFND-J2A3-XNG6-GQ7L/qr-code",
            "method": "GET"
        }
    ]
}

❮❮ Back to Samples

1. Create Invoice

Request Object

Response Object

Request Object

Response Object

2. Send Invoice

Request Object

Response Object

Request Object

Response Object