Skip to main content
GET
/
v1
/
checkout
/
payment-resources
List payment resources
curl --request GET \
  --url https://api.paypal.com/v1/checkout/v1/checkout/payment-resources \
  --header 'Authorization: Bearer <token>'
{
  "resources": [
    {
      "integration_mode": "LINK",
      "type": "BUY_NOW",
      "id": "<string>",
      "payment_link": "<string>",
      "links": [
        {
          "href": "<string>",
          "rel": "<string>",
          "method": "GET"
        }
      ],
      "create_time": "<string>",
      "update_time": "<string>",
      "status": "ACTIVE",
      "reusable": "MULTIPLE",
      "return_url": "<string>",
      "line_items": [
        {
          "name": "<string>",
          "product_id": "<string>",
          "description": "<string>",
          "unit_amount": {
            "currency_code": "<string>",
            "value": "<string>"
          },
          "taxes": [
            {
              "type": "PERCENTAGE",
              "value": "<string>",
              "name": "<string>"
            }
          ],
          "shipping": [
            {
              "type": "FLAT",
              "value": "<string>"
            }
          ],
          "collect_shipping_address": true,
          "customer_notes": [
            {
              "required": true,
              "label": "<string>"
            }
          ],
          "variants": {
            "dimensions": [
              {
                "name": "<string>",
                "primary": true,
                "options": [
                  {
                    "label": "<string>",
                    "unit_amount": {
                      "currency_code": "<string>",
                      "value": "<string>"
                    }
                  }
                ]
              }
            ]
          },
          "adjustable_quantity": {
            "maximum": 50
          }
        }
      ]
    }
  ],
  "total_items": 32767,
  "total_pages": 32768,
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication.

Headers

​
Content-Type
string

The media type. Required for operations with a request body. The value is application/<format>, where format is json.

Required string length: 1 - 255
​
PayPal-Auth-Assertion
string

An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.

Query Parameters

​
page_size
integer
default:10

A non-negative, non-zero integer indicating the maximum number of results to return at one time. This parameter must only be provided on initial request and not combined with page_token.

Required range: 1 <= x <= 100
​
page_token
string

An opaque value representing the page to navigate to.

Required string length: 1 - 255
​
total_required
boolean
default:false

A boolean indicating total number of items and pages are expected to be returned in the response.

Response

A successful request returns the HTTP 200 OK status code with a JSON response body that shows payment resource details.

List of payment resources.

​
resources
Payment Resource Response · object[]

List of resources.

Required array length: 1 - 100 elements
​
total_items
integer

Total number of payment resources.

Required range: 0 <= x <= 65535
​
total_pages
integer

Total number of pages.

Required range: 1 <= x <= 65535
​
links
Link Description · object[]

An array of request-related HATEOAS links.

Required array length: 1 - 32 elements