Paypal API
  1. Authorization
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
      • Create draft invoice
      • Show invoice details
      • List invoices
      • Generate QR code
      • Fully update invoice
      • Send invoice
      • Send invoice reminder
      • Cancel sent invoice
      • Delete invoice
      • Search for invoices
      • Record payment for invoice
      • Delete external payment
      • Record refund for invoice
      • Delete external refund
    • 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
      POST
    • Show payout batch details
      GET
    • Show payout item details
      GET
    • Cancel unclaimed payout item
      POST
  • 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. Authorization

Generate access_token

POST
/v1/oauth2/token
Shows user profile information. Filters the response by a schema. Supported schema value is paypalv1.1.

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Body 参数application/x-www-form-urlencoded
grant_type
string 
必需
The credential type to exchange for an access token.
示例值:
client_credentials
ignoreCache
string 
必需
A new token is issued ignoring the previously issued and still not expired token.
示例值:
true
return_authn_schemes
string 
必需
Lists user authentication options and returns a first-party access token to authenticate an end user. Valid for all grant types except the authzcode authorization code, which indicates that the user is already authenticated.
示例值:
true
return_client_metadata
string 
必需
Lists client metadata attributes. Valid for all grant types.
示例值:
true
return_unconsented_scopes
string 
必需
Lists unconsented scopes between the user and client. Valid for all grant types except client_credentials.
示例值:
true

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-m.sandbox.paypal.com/v1/oauth2/token' \
--header 'Authorization: Basic Og==' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'ignoreCache=true' \
--data-urlencode 'return_authn_schemes=true' \
--data-urlencode 'return_client_metadata=true' \
--data-urlencode 'return_unconsented_scopes=true'

返回响应

🟢200200 - Generate Token With Minimal Request
application/json
Body
scope
string 
必需
access_token
string 
必需
token_type
string 
必需
app_id
string 
必需
expires_in
integer 
必需
nonce
string 
必需
示例
{
  "scope": "https://uri.paypal.com/services/invoicing https://uri.paypal.com/services/vault/payment-tokens/read https://uri.paypal.com/services/disputes/read-buyer https://uri.paypal.com/services/payments/realtimepayment https://uri.paypal.com/services/disputes/update-seller https://uri.paypal.com/services/payments/payment/authcapture openid https://uri.paypal.com/services/disputes/read-seller Braintree:Vault https://uri.paypal.com/services/payments/refund https://api.paypal.com/v1/vault/credit-card https://api.paypal.com/v1/payments/.* https://uri.paypal.com/payments/payouts https://uri.paypal.com/services/vault/payment-tokens/readwrite https://api.paypal.com/v1/vault/credit-card/.* https://uri.paypal.com/services/subscriptions https://uri.paypal.com/services/applications/webhooks",
  "access_token": "A21AAL8A8rAjJjh1e8JcBuom2FEMJeCREs6Be0TY3T3aI610eKpQ93jV0lpJsvHj-YU7-lR2VaPZNLFOvUY6Wi4OCT7yv2BFA",
  "token_type": "Bearer",
  "app_id": "APP-80W284485P519543T",
  "expires_in": 32400,
  "nonce": "2022-01-26T01:01:51ZJFQBVUqWihFGkxmNANbC4ikQt5_CLogQGeDy3lTaiYs"
}
🟢200200 - Generate Token With Detailed Request
🟠400400 Bad Request - Unsupported "response_type"
🟠401401 Unauthorized - Missing/Bad Client Credentials
修改于 2023-08-16 07:18:59
下一页
Terminate access_token
Built with