Public
Documentation Settings
No Environment
Double Column
cURL - cURL
PayPal
Introduction
POST
Get Access Token
GET
Get Invoices
POST
Payment
GET
List Payments
POST
Execute a payment accepted by a customer

PayPal

POSTGet Access Token

https://api.sandbox.paypal.com/v1/oauth2/token

Returns a bearer token

AUTHORIZATIONBasic Auth
Username

<username>

Password

<password>

HEADERS
Content-Type

application/x-www-form-urlencoded

Bodyurlencoded
grant_type

client_credentials

Example Request
Get Access Token
curl
curl --location 'https://api.sandbox.paypal.com/v1/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETGet Invoices

https://api.sandbox.paypal.com/v1/invoicing/invoices

Returns invoices for a merchant

AUTHORIZATIONBearer Token
Token

<token>

Example Request
Get Invoices
curl
curl --location 'https://api.sandbox.paypal.com/v1/invoicing/invoices'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

POSTPayment

https://api.sandbox.paypal.com/v1/payments/payment

Creates a payment transactions/sale

HEADERS
Content-Type

application/json

Authorization
Bodyraw 
{
  "intent": "sale",
  "payer": {
    "payment_method": "paypal"
  },
  "transactions": [
    {
      "amount": {
        "total": "30.11",
        "currency": "USD",
        "details": {
          "subtotal": "30.00",
          "tax": "0.07",
          "shipping": "0.03",
          "handling_fee": "1.00",
          "shipping_discount": "-1.00",
          "insurance": "0.01"
        }
      },
      "description": "The payment transaction description.",
      "custom": "EBAY_EMS_90048630024435",
      "invoice_number": "48787589673",
      "payment_options": {
        "allowed_payment_method": "INSTANT_FUNDING_SOURCE"
      },
      "soft_descriptor": "ECHI5786786",
      "item_list": {
        "items": [
          {
            "name": "hat",
            "description": "Brown hat.",
            "quantity": "5",
            "price": "3",
            "tax": "0.01",
            "sku": "1",
            "currency": "USD"
          },
          {
            "name": "handbag",
            "description": "Black handbag.",
            "quantity": "1",
            "price": "15",
            "tax": "0.02",
            "sku": "product34",
            "currency": "USD"
          }
        ],
        "shipping_address": {
          "recipient_name": "Brian Robinson",
          "line1": "4th Floor",
          "line2": "Unit #34",
          "city": "San Jose",
          "country_code": "US",
          "postal_code": "95131",
          "phone": "011862212345678",
          "state": "CA"
        }
      }
    }
  ],
  "note_to_payer": "Contact us for any questions on your order.",
  "redirect_urls": {
    "return_url": "https://example.com/return",
    "cancel_url": "https://example.com/cancel"
  }
}
Example Request
Payment
curl
curl --location 'https://api.sandbox.paypal.com/v1/payments/payment' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data '{
  "intent": "sale",
  "payer": {
    "payment_method": "paypal"
  },
  "transactions": [
    {
      "amount": {
        "total": "30.11",
        "currency": "USD",
        "details": {
          "subtotal": "30.00",
          "tax": "0.07",
          "shipping": "0.03",
          "handling_fee": "1.00",
          "shipping_discount": "-1.00",
          "insurance": "0.01"
        }
      },
      "description": "The payment transaction description.",
      "custom": "EBAY_EMS_90048630024435",
      "invoice_number": "48787589673",
      "payment_options": {
        "allowed_payment_method": "INSTANT_FUNDING_SOURCE"
      },
      "soft_descriptor": "ECHI5786786",
      "item_list": {
        "items": [
          {
            "name": "hat",
            "description": "Brown hat.",
            "quantity": "5",
            "price": "3",
            "tax": "0.01",
            "sku": "1",
            "currency": "USD"
          },
          {
            "name": "handbag",
            "description": "Black handbag.",
            "quantity": "1",
            "price": "15",
            "tax": "0.02",
            "sku": "product34",
            "currency": "USD"
          }
        ],
        "shipping_address": {
          "recipient_name": "Brian Robinson",
          "line1": "4th Floor",
          "line2": "Unit #34",
          "city": "San Jose",
          "country_code": "US",
          "postal_code": "95131",
          "phone": "011862212345678",
          "state": "CA"
        }
      }
    }
  ],
  "note_to_payer": "Contact us for any questions on your order.",
  "redirect_urls": {
    "return_url": "https://example.com/return",
    "cancel_url": "https://example.com/cancel"
  }
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers