PayPal REST API Samples

1. Create Third Party Invoice

Invoice with ID: INV2-TQJ7-2KE9-5USZ-E69S

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-06-27 PDT"
    },
    "id": "INV2-TQJ7-2KE9-5USZ-E69S",
    "number": "8223",
    "template_id": "TEMP-74V34217FK810934T",
    "status": "DRAFT",
    "invoice_date": "2025-05-13 PDT",
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "total_amount": {
        "currency": "USD",
        "value": "0.00"
    },
    "metadata": {
        "created_date": "2025-05-13 22:11:32 PDT"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/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-06-27 PDT"
    },
    "id": "INV2-TQJ7-2KE9-5USZ-E69S",
    "number": "8223",
    "template_id": "TEMP-74V34217FK810934T",
    "status": "DRAFT",
    "invoice_date": "2025-05-13 PDT",
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "total_amount": {
        "currency": "USD",
        "value": "0.00"
    },
    "metadata": {
        "created_date": "2025-05-13 22:11:32 PDT"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/record-payment",
            "method": "POST"
        }
    ]
}

Deprecated: Use of "self" in callables is deprecated in /mnt/VenusReview/review/lyrasoft/dva/master/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 153

Deprecated: Use of "self" in callables is deprecated in /mnt/VenusReview/review/lyrasoft/dva/master/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 153

Deprecated: Use of "self" in callables is deprecated in /mnt/VenusReview/review/lyrasoft/dva/master/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 153

Deprecated: Use of "self" in callables is deprecated in /mnt/VenusReview/review/lyrasoft/dva/master/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 153

2. Send Third Party Invoice

Invoice with ID: INV2-TQJ7-2KE9-5USZ-E69S

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-TQJ7-2KE9-5USZ-E69S",
    "number": "8223",
    "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-05-13 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-06-27 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-05-13 22:11:32 PDT",
        "first_sent_date": "2025-05-13 22:11:33 PDT",
        "last_sent_date": "2025-05-13 22:11:33 PDT",
        "payer_view_url": "https://www.sandbox.paypal.com/invoice/p/#INV2-TQJ7-2KE9-5USZ-E69S"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S",
            "method": "GET"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/update",
            "method": "PUT"
        },
        {
            "rel": "cancel",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/cancel",
            "method": "POST"
        },
        {
            "rel": "remind",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/remind",
            "method": "POST"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/record-payment",
            "method": "POST"
        },
        {
            "rel": "qr-code",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/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-TQJ7-2KE9-5USZ-E69S",
    "number": "8223",
    "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-05-13 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-06-27 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-05-13 22:11:32 PDT",
        "first_sent_date": "2025-05-13 22:11:33 PDT",
        "last_sent_date": "2025-05-13 22:11:33 PDT",
        "payer_view_url": "https://www.sandbox.paypal.com/invoice/p/#INV2-TQJ7-2KE9-5USZ-E69S"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S",
            "method": "GET"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/update",
            "method": "PUT"
        },
        {
            "rel": "cancel",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/cancel",
            "method": "POST"
        },
        {
            "rel": "remind",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/remind",
            "method": "POST"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/record-payment",
            "method": "POST"
        },
        {
            "rel": "qr-code",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/qr-code",
            "method": "GET"
        }
    ]
}

3. Get Third Party Invoice

Invoice with ID: INV2-TQJ7-2KE9-5USZ-E69S

Request Object

INV2-TQJ7-2KE9-5USZ-E69S

Response Object

{
    "id": "INV2-TQJ7-2KE9-5USZ-E69S",
    "number": "8223",
    "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-05-13 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-06-27 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-05-13 22:11:32 PDT",
        "first_sent_date": "2025-05-13 22:11:33 PDT",
        "last_sent_date": "2025-05-13 22:11:33 PDT",
        "payer_view_url": "https://www.sandbox.paypal.com/invoice/p/#INV2-TQJ7-2KE9-5USZ-E69S"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S",
            "method": "GET"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/update",
            "method": "PUT"
        },
        {
            "rel": "cancel",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/cancel",
            "method": "POST"
        },
        {
            "rel": "remind",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/remind",
            "method": "POST"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/record-payment",
            "method": "POST"
        },
        {
            "rel": "qr-code",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/qr-code",
            "method": "GET"
        }
    ]
}

Request
Response

Request Object

INV2-TQJ7-2KE9-5USZ-E69S

Response Object

{
    "id": "INV2-TQJ7-2KE9-5USZ-E69S",
    "number": "8223",
    "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-05-13 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-06-27 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-05-13 22:11:32 PDT",
        "first_sent_date": "2025-05-13 22:11:33 PDT",
        "last_sent_date": "2025-05-13 22:11:33 PDT",
        "payer_view_url": "https://www.sandbox.paypal.com/invoice/p/#INV2-TQJ7-2KE9-5USZ-E69S"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S",
            "method": "GET"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/update",
            "method": "PUT"
        },
        {
            "rel": "cancel",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/cancel",
            "method": "POST"
        },
        {
            "rel": "remind",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/remind",
            "method": "POST"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/record-payment",
            "method": "POST"
        },
        {
            "rel": "qr-code",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-TQJ7-2KE9-5USZ-E69S/qr-code",
            "method": "GET"
        }
    ]
}

❮❮ Back to Samples

1. Create Third Party Invoice

Request Object

Response Object

Request Object

Response Object

2. Send Third Party Invoice

Request Object

Response Object

Request Object

Response Object

3. Get Third Party Invoice

Request Object

Response Object

Request Object

Response Object