Paypal API
  1. Invoices
Paypal API
  • Authorization
    • Generate access_token
      POST
    • Terminate access_token
      POST
    • User Info
      GET
    • Generate client_token
      POST
  • Orders
    • Create order
      POST
    • Show order details
      GET
    • Update order
      PATCH
    • Authorize payment for order
      POST
    • Capture payment for order
      POST
  • Payments
    • Show details for authorized payment
      GET
    • Reauthorize authorized payment
      POST
    • Void authorized payment
      POST
    • Capture authorized payment
      POST
    • Show captured payment details
      GET
    • Refund captured payment
      POST
    • Show refund details
      GET
  • Invoices
    • Invoices
      • Generate invoice number
        POST
      • Create draft invoice
        POST
      • Show invoice details
        GET
      • List invoices
        GET
      • Generate QR code
        POST
      • Fully update invoice
        PUT
      • Send invoice
        POST
      • Send invoice reminder
        POST
      • Cancel sent invoice
        POST
      • Delete invoice
        DELETE
      • Search for invoices
        POST
      • Record payment for invoice
        POST
      • Delete external payment
        DELETE
      • Record refund for invoice
        POST
      • Delete external refund
        DELETE
    • Templates
      • List templates
      • Create template
      • Show template details
      • Fully update template
      • Delete template
  • Subscriptions
    • Catalog Products
      • Create product
      • List products
      • Show product details
      • Update product
    • Plans
      • Create plan
      • List plans
      • Show plan details
      • Update plan
      • Deactivate plan
      • Activate plan
      • Update pricing
    • Subscriptions
      • Create subscription
      • Show subscription details
      • Update subscription
      • Revise plan or quantity of subscription
      • Suspend subscription
      • Activate subscription
      • Cancel subscription
      • Capture authorized payment on subscription
      • List transactions for subscription
  • Payouts
    • Create batch payout
    • Show payout batch details
    • Show payout item details
    • Cancel unclaimed payout item
  • Webhooks
    • List available events
    • Create webhook
    • List webhooks
    • Show webhook details
    • List event notifications
    • List event subscriptions for webhook
    • Show event notification details
    • Trigger a sample event
    • Verify webhook signature
    • Resend event notification
    • Simulate webhook event
    • Update webhook
    • Delete webhook
  • Shipment Tracking
    • Add tracking information for multiple PayPal transactions
    • Show tracking information
    • Update or cancel tracking information for PayPal transaction
  • Transaction Search
    • List transactions
    • List all balances
  • Disputes
    • List disputes
    • Show dispute details
    • Accept claim
    • Appeal dispute
    • Settle dispute
    • Update dispute status
    • Make offer to resolve dispute
    • Provide evidence
    • Acknowledge returned item
    • Provide supporting information for dispute
    • Escalate dispute to claim
    • Accept offer to resolve dispute
    • Send message about dispute to other party
    • Deny offer to resolve dispute
    • Partially update dispute
  • Onboarding (Limited Release)
    • Manage Accounts
      • Create managed account
      • Search managed account through external id
      • Search managed account by Seller Id
      • Partially updates information for a managed account
      • Shows collection of registered wallet domains
  1. Invoices

Show invoice details

GET
/v2/invoicing/invoices/{invoice_id}
Shows details for an invoice, by ID.

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Path 参数
invoice_id
string 
必需
(Required) The ID of the invoice for which to show details.
示例值:
{{invoice_id}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{{invoice_id}}' \
--header 'Authorization: Basic Og=='

返回响应

🟢200200 - Show Invoice Details
application/json
Body
id
string 
必需
status
string 
必需
detail
object 
必需
reference
string 
必需
currency_code
string 
必需
note
string 
必需
terms_and_conditions
string 
必需
memo
string 
必需
additional_data
string 
必需
category_code
string 
必需
invoice_number
string 
必需
invoice_date
string 
必需
payment_term
object 
必需
viewed_by_recipient
boolean 
必需
group_draft
boolean 
必需
metadata
object 
必需
archived
boolean 
必需
invoicer
object 
必需
name
object 
必需
address
object 
必需
phones
array [object {3}] 
必需
website
string 
必需
tax_id
string 
必需
additional_notes
string 
必需
logo_url
string 
必需
primary_recipients
array [object {2}] 
必需
billing_info
object 
可选
shipping_info
object 
可选
items
array [object {8}] 
必需
id
string 
必需
name
string 
必需
description
string 
可选
quantity
string 
必需
unit_amount
object 
必需
tax
object 
必需
discount
object 
必需
unit_of_measure
string 
必需
configuration
object 
必需
tax_calculated_after_discount
boolean 
必需
tax_inclusive
boolean 
必需
allow_tip
boolean 
必需
partial_payment
object 
必需
template_id
string 
必需
amount
object 
必需
breakdown
object 
必需
currency_code
string 
必需
value
string 
必需
due_amount
object 
必需
currency_code
string 
必需
value
string 
必需
links
array [object {3}] 
必需
href
string 
必需
rel
string 
必需
method
string 
必需
示例
{
  "id": "INV2-JY7V-QMJH-T7TP-4FKF",
  "status": "DRAFT",
  "detail": {
    "reference": "<The reference data. Includes a post office (PO) number.>",
    "currency_code": "USD",
    "note": "<A note to the invoice recipient. Also appears on the invoice notification email.>",
    "terms_and_conditions": "<The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.>",
    "memo": "<A private bookkeeping note for merchant.>",
    "additional_data": "<Any additional information. Includes business hours.>",
    "category_code": "SHIPPABLE",
    "invoice_number": "1643944242",
    "invoice_date": "2022-02-04",
    "payment_term": {
      "term_type": "NET_10",
      "due_date": "2022-02-14"
    },
    "viewed_by_recipient": false,
    "group_draft": false,
    "metadata": {
      "create_time": "2022-02-04T03:10:42Z",
      "last_update_time": "2022-02-04T03:10:42Z",
      "created_by_flow": "REGULAR_SINGLE",
      "recipient_view_url": "https://www.sandbox.paypal.com/invoice/p/#JY7VQMJHT7TP4FKF",
      "invoicer_view_url": "https://www.sandbox.paypal.com/invoice/details/INV2-JY7V-QMJH-T7TP-4FKF",
      "caller_type": "API_V2_INVOICE"
    },
    "archived": false
  },
  "invoicer": {
    "name": {
      "given_name": "David",
      "surname": "Larusso",
      "full_name": "David Larusso"
    },
    "address": {
      "address_line_1": "1234 First Street",
      "address_line_2": "337673 Hillside Court",
      "admin_area_2": "Anytown",
      "admin_area_1": "CA",
      "postal_code": "98765",
      "country_code": "US"
    },
    "phones": [
      {
        "country_code": "001",
        "national_number": "4085551234",
        "phone_type": "MOBILE"
      }
    ],
    "website": "www.example.com",
    "tax_id": "XX-XXXXXXX",
    "additional_notes": "<Any additional information. Includes business hours.>",
    "logo_url": "https://example.com/logo.png"
  },
  "primary_recipients": [
    {
      "billing_info": {
        "name": {
          "given_name": "Stephanie",
          "surname": "Meyers",
          "full_name": "Stephanie Meyers"
        },
        "address": {
          "address_line_1": "1234 Main Street",
          "admin_area_2": "Anytown",
          "admin_area_1": "CA",
          "postal_code": "98765",
          "country_code": "US"
        },
        "email_address": "foobuyer@gmail.com"
      },
      "shipping_info": {
        "name": {
          "given_name": "Stephanie",
          "surname": "Meyers",
          "full_name": "Stephanie Meyers"
        },
        "address": {
          "address_line_1": "1234 Main Street",
          "admin_area_2": "Anytown",
          "admin_area_1": "CA",
          "postal_code": "98765",
          "country_code": "US"
        }
      }
    }
  ],
  "items": [
    {
      "id": "ITEM-7A26436807164804L",
      "name": "Yoga Mat",
      "description": "Elastic mat to practice yoga.",
      "quantity": "1",
      "unit_amount": {
        "currency_code": "USD",
        "value": "50.00"
      },
      "tax": {
        "id": "TAX-0N0416338A793061R",
        "name": "Sales Tax",
        "percent": "7.25",
        "amount": {
          "currency_code": "USD",
          "value": "3.27"
        }
      },
      "discount": {
        "percent": "5",
        "amount": {
          "currency_code": "USD",
          "value": "-2.50"
        }
      },
      "unit_of_measure": "QUANTITY"
    },
    {
      "id": "ITEM-8UG7841261075160N",
      "name": "Yoga t-shirt",
      "quantity": "1",
      "unit_amount": {
        "currency_code": "USD",
        "value": "10.00"
      },
      "tax": {
        "id": "TAX-0N0416338A793061R",
        "name": "Sales Tax",
        "percent": "7.25",
        "amount": {
          "currency_code": "USD",
          "value": "0.34"
        }
      },
      "discount": {
        "amount": {
          "currency_code": "USD",
          "value": "-5.00"
        }
      },
      "unit_of_measure": "QUANTITY"
    }
  ],
  "configuration": {
    "tax_calculated_after_discount": true,
    "tax_inclusive": false,
    "allow_tip": true,
    "partial_payment": {
      "allow_partial_payment": true,
      "minimum_amount_due": {
        "currency_code": "USD",
        "value": "20.00"
      }
    },
    "template_id": "TEMP-8LK05440PT816351U"
  },
  "amount": {
    "breakdown": {
      "item_total": {
        "currency_code": "USD",
        "value": "60.00"
      },
      "discount": {
        "invoice_discount": {
          "percent": "5",
          "amount": {
            "currency_code": "USD",
            "value": "-2.63"
          }
        },
        "item_discount": {
          "currency_code": "USD",
          "value": "-7.50"
        }
      },
      "tax_total": {
        "currency_code": "USD",
        "value": "4.34"
      },
      "shipping": {
        "amount": {
          "currency_code": "USD",
          "value": "10.00"
        },
        "tax": {
          "id": "TAX-3AW43712DC849124P",
          "name": "Sales Tax",
          "percent": "7.25",
          "amount": {
            "currency_code": "USD",
            "value": "0.73"
          }
        }
      },
      "custom": {
        "label": "Packing Charges",
        "amount": {
          "currency_code": "USD",
          "value": "10.00"
        }
      }
    },
    "currency_code": "USD",
    "value": "74.21"
  },
  "due_amount": {
    "currency_code": "USD",
    "value": "74.21"
  },
  "links": [
    {
      "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JY7V-QMJH-T7TP-4FKF",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JY7V-QMJH-T7TP-4FKF/send",
      "rel": "send",
      "method": "POST"
    },
    {
      "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JY7V-QMJH-T7TP-4FKF",
      "rel": "replace",
      "method": "PUT"
    },
    {
      "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JY7V-QMJH-T7TP-4FKF",
      "rel": "delete",
      "method": "DELETE"
    },
    {
      "href": "https://api.sandbox.paypal.com/v2/invoicing/invoices/INV2-JY7V-QMJH-T7TP-4FKF/payments",
      "rel": "record-payment",
      "method": "POST"
    }
  ]
}
🟢200200 - Cancelled Invoice
🟢200200 - Draft Invoice
🟢200200 - Marked As Paid Invoice
🟢200200 - Partially Paid Invoice
🟢200200 - Partially Refunded Invoice
🟢200200 - Refunded Invoice
🟢200200 - Scheduled Invoice
🟢200200 - Sent Invoice
🟠401401 Unauthorized - Invalid Token
🟠404404 Not Found - Invoice Not Found
修改于 2023-08-16 07:18:59
上一页
Create draft invoice
下一页
List invoices
Built with