#PayPal APIs
Number of APIs: 106
Getting Started
Step 1: Fork the collection using Run in Qodex
[]
[
]
Step 2: Get your access token
An access token is automatically generated using a default
client_id
and
secret
. PayPal recommends using your own
client_id
and
secret
from the
Developer Dashboard
by entering the values under the
Variables
tab. A pre-request script will generate and manage the
access_token
automatically.
Note: Your developer account
client_id
andsecret
may have a different scope than the defaultclient_id
andsecret
.
Step 3: Make your first API call
PayPal recommends starting with the Orders API. These steps will use the Orders API to create an order and capture payment using sandbox accounts linked to your Developer Dashboard account.
To create an order:
- In your workspace, navigate to your fork of the PayPal collection.
- Select Orders > Create Order .
- Select the Send button to create the order. On a successful call, the API returns a 201 order created response code.
-
In the response, find the
payer-action
link if you created an order with
payment_source.paypal
or approve link if you created an order without payment source. - Open the approve or payer-action link in a browser.
- Log in with your Developer Dashboard Sandbox Personal Account credentials. You can find those credentials by logging into the Developer Dashboard and selecting Sandbox > Account .
- Select the Continue button. Payment has now been made.
To capture payment:
-
In the response of the order you created, find the
order_id
. -
In the
Variables
tab, enter the
order_id
number. - Select Orders > Capture payment for order .
- Select Send . On a successful call, the API returns a 201 order created response code.
Your order has been created and payment has been captured. You can verify the transaction in both the sandbox personal account and the sandbox business account.
-
Authorization - Generate access_token POST {{base_url}}/v1/oauth2/token
-
Subscriptions-Subscriptions - List transactions for subscription GET {{base_url}}/v1/billing/subscriptions/:subscription_id/transactions?start_time=2022-01-01T00:00:00.000Z&end_time=2030-01-01T00:00:00.000Z
-
Webhooks - Resend event notification POST {{base_url}}/v1/notifications/webhooks-events/:event_id/resend
-
Webhooks - Update webhook PATCH {{base_url}}/v1/notifications/webhooks/:webhook_id
-
Webhooks - Delete webhook DELETE {{base_url}}/v1/notifications/webhooks/:webhook_id
-
Shipment Tracking - Add tracking information for multiple PayPal transactions POST {{base_url}}/v1/shipping/trackers-batch
-
Shipment Tracking - Show tracking information GET {{base_url}}/v1/shipping/trackers/:tracking_id
-
Transaction Search - List transactions GET {{base_url}}/v1/reporting/transactions?fields=transaction_info,payer_info,shipping_info,auction_info,cart_info,incentive_info,store_info&start_date=2022-02-20T23:59:59.999Z&end_date=2022-03-20T00:00:00.000Z
-
Transaction Search - List all balances GET {{base_url}}/v1/reporting/balances?as_of_time=2022-03-20T00:00:00.000Z¤cy_code=ALL&include_crypto_currencies=true
-
Disputes - Show dispute details GET {{base_url}}/v1/customer/disputes/:dispute_id