PayPal REST API Samples

1. Create Invoice

Invoice with ID: INV2-2SLY-MQYC-MLSH-5MFJ

Request Object

{
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.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"
    },
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": "100",
            "unit_price": {
                "currency": "USD",
                "value": "5"
            },
            "tax": {
                "percent": "1",
                "name": "Local Tax on Sutures"
            }
        },
        {
            "name": "Injection",
            "quantity": "5",
            "discount": {
                "percent": "3.00"
            },
            "unit_price": {
                "currency": "USD",
                "value": "5"
            },
            "tax": {
                "percent": "3",
                "name": "Local Tax on Injection"
            }
        }
    ],
    "discount": {
        "percent": "2.00"
    },
    "logo_url": "https://www.paypalobjects.com/webstatic/i/logo/rebrand/ppcom.svg"
}

Response Object

{
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.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": "2026-06-28 PDT"
    },
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": "100",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Sutures",
                "percent": "1",
                "amount": {
                    "currency": "USD",
                    "value": "5.00"
                }
            }
        },
        {
            "name": "Injection",
            "quantity": "5",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Injection",
                "percent": "3",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            },
            "discount": {
                "percent": "3.00",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            }
        }
    ],
    "discount": {
        "percent": "2.00",
        "amount": {
            "currency": "USD",
            "value": "10.49"
        }
    },
    "logo_url": "https://www.paypalobjects.com/webstatic/i/logo/rebrand/ppcom.svg",
    "id": "INV2-2SLY-MQYC-MLSH-5MFJ",
    "number": "PNR-TEST-20180727274457",
    "template_id": "TEMP-10394883S32914143",
    "status": "DRAFT",
    "invoice_date": "2026-05-14 PDT",
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "total_amount": {
        "currency": "USD",
        "value": "519.51"
    },
    "metadata": {
        "created_date": "2026-05-14 00:13:40 PDT"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/record-payment",
            "method": "POST"
        }
    ]
}

Request
Response

Request Object

{
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.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"
    },
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": "100",
            "unit_price": {
                "currency": "USD",
                "value": "5"
            },
            "tax": {
                "percent": "1",
                "name": "Local Tax on Sutures"
            }
        },
        {
            "name": "Injection",
            "quantity": "5",
            "discount": {
                "percent": "3.00"
            },
            "unit_price": {
                "currency": "USD",
                "value": "5"
            },
            "tax": {
                "percent": "3",
                "name": "Local Tax on Injection"
            }
        }
    ],
    "discount": {
        "percent": "2.00"
    },
    "logo_url": "https://www.paypalobjects.com/webstatic/i/logo/rebrand/ppcom.svg"
}

Response Object

{
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.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": "2026-06-28 PDT"
    },
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": "100",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Sutures",
                "percent": "1",
                "amount": {
                    "currency": "USD",
                    "value": "5.00"
                }
            }
        },
        {
            "name": "Injection",
            "quantity": "5",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Injection",
                "percent": "3",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            },
            "discount": {
                "percent": "3.00",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            }
        }
    ],
    "discount": {
        "percent": "2.00",
        "amount": {
            "currency": "USD",
            "value": "10.49"
        }
    },
    "logo_url": "https://www.paypalobjects.com/webstatic/i/logo/rebrand/ppcom.svg",
    "id": "INV2-2SLY-MQYC-MLSH-5MFJ",
    "number": "PNR-TEST-20180727274457",
    "template_id": "TEMP-10394883S32914143",
    "status": "DRAFT",
    "invoice_date": "2026-05-14 PDT",
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "total_amount": {
        "currency": "USD",
        "value": "519.51"
    },
    "metadata": {
        "created_date": "2026-05-14 00:13:40 PDT"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/record-payment",
            "method": "POST"
        }
    ]
}

Deprecated: Use of "self" in callables is deprecated in /home/techpcbm/bank.techdoc.com.ng/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

Deprecated: Use of "self" in callables is deprecated in /home/techpcbm/bank.techdoc.com.ng/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

Deprecated: Use of "self" in callables is deprecated in /home/techpcbm/bank.techdoc.com.ng/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

Deprecated: Use of "self" in callables is deprecated in /home/techpcbm/bank.techdoc.com.ng/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

Deprecated: Use of "self" in callables is deprecated in /home/techpcbm/bank.techdoc.com.ng/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

Deprecated: Use of "self" in callables is deprecated in /home/techpcbm/bank.techdoc.com.ng/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

Deprecated: Use of "self" in callables is deprecated in /home/techpcbm/bank.techdoc.com.ng/vendor/paypal/rest-api-sdk-php/lib/PayPal/Common/ReflectionUtil.php on line 152

2. Get Invoice

Invoice with ID: INV2-2SLY-MQYC-MLSH-5MFJ

Request Object

INV2-2SLY-MQYC-MLSH-5MFJ

Response Object

{
    "id": "INV2-2SLY-MQYC-MLSH-5MFJ",
    "number": "PNR-TEST-20180727274457",
    "template_id": "TEMP-10394883S32914143",
    "status": "DRAFT",
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.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"
        }
    ],
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": "100",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Sutures",
                "percent": "1",
                "amount": {
                    "currency": "USD",
                    "value": "5.00"
                }
            }
        },
        {
            "name": "Injection",
            "quantity": "5",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Injection",
                "percent": "3",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            },
            "discount": {
                "percent": "3.00",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            }
        }
    ],
    "invoice_date": "2026-05-14 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2026-06-28 PDT"
    },
    "discount": {
        "percent": "2.00",
        "amount": {
            "currency": "USD",
            "value": "10.49"
        }
    },
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "logo_url": "https://www.paypalobjects.com/webstatic/i/logo/rebrand/ppcom.svg",
    "total_amount": {
        "currency": "USD",
        "value": "519.51"
    },
    "metadata": {
        "created_date": "2026-05-14 00:13:40 PDT"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/record-payment",
            "method": "POST"
        }
    ]
}

Request
Response

Request Object

INV2-2SLY-MQYC-MLSH-5MFJ

Response Object

{
    "id": "INV2-2SLY-MQYC-MLSH-5MFJ",
    "number": "PNR-TEST-20180727274457",
    "template_id": "TEMP-10394883S32914143",
    "status": "DRAFT",
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.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"
        }
    ],
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": "100",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Sutures",
                "percent": "1",
                "amount": {
                    "currency": "USD",
                    "value": "5.00"
                }
            }
        },
        {
            "name": "Injection",
            "quantity": "5",
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            },
            "tax": {
                "name": "Local Tax on Injection",
                "percent": "3",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            },
            "discount": {
                "percent": "3.00",
                "amount": {
                    "currency": "USD",
                    "value": "0.75"
                }
            }
        }
    ],
    "invoice_date": "2026-05-14 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2026-06-28 PDT"
    },
    "discount": {
        "percent": "2.00",
        "amount": {
            "currency": "USD",
            "value": "10.49"
        }
    },
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "logo_url": "https://www.paypalobjects.com/webstatic/i/logo/rebrand/ppcom.svg",
    "total_amount": {
        "currency": "USD",
        "value": "519.51"
    },
    "metadata": {
        "created_date": "2026-05-14 00:13:40 PDT"
    },
    "allow_tip": false,
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-2SLY-MQYC-MLSH-5MFJ/record-payment",
            "method": "POST"
        }
    ]
}

❮❮ Back to Samples

1. Create Invoice

Request Object

Response Object

Request Object

Response Object

2. Get Invoice

Request Object

Response Object

Request Object

Response Object