List payment resources

Returns a paginated list of payment resources created by the authenticated merchant. Supports filtering by status and pagination parameters.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication.

In: header

Scope: https://uri.paypal.com/services/checkout/payment-resources

Query Parameters

page_size?integer

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.

Default10

Range1 <= value <= 100

page_token?string

An opaque value representing the page to navigate to.

Match[a-zA-Z0-9_-]

Length1 <= length <= 255

total_required?boolean

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

Defaultfalse

Header Parameters

Content-Type?string

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

Match^[A-Za-z0-9/+-]+$

Length1 <= length <= 255

PayPal-Auth-Assertion?string

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

Response Body

`application/json`

curl -X GET "https://api-m.sandbox.paypal.com/v1/checkout/payment-resources"

{
  "resources": [
    {
      "id": "string",
      "payment_link": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "create_time": "stringstringstringst",
      "update_time": "stringstringstringst",
      "status": "ACTIVE",
      "integration_mode": "LINK",
      "type": "BUY_NOW",
      "reusable": "MULTIPLE",
      "return_url": "http://example.com",
      "line_items": [
        {
          "name": "string",
          "product_id": "string",
          "description": "string",
          "unit_amount": {
            "currency_code": "str",
            "value": "string"
          },
          "taxes": [
            {
              "name": "string",
              "type": "PERCENTAGE",
              "value": "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": "str",
                      "value": "string"
                    }
                  }
                ]
              }
            ]
          },
          "adjustable_quantity": {
            "maximum": 1
          }
        }
      ]
    }
  ],
  "total_items": 0,
  "total_pages": 1,
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

Query Parameters

page_size?integer

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.

Default10

Range1 <= value <= 100

page_token?string

An opaque value representing the page to navigate to.

Match[a-zA-Z0-9_-]

Length1 <= length <= 255

total_required?boolean

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

Defaultfalse

Header Parameters

Content-Type?string

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

Match^[A-Za-z0-9/+-]+$

Length1 <= length <= 255

PayPal-Auth-Assertion?string

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

{ "resources": [ { "id": "string", "payment_link": "string", "links": [ { "href": "string", "rel": "string", "method": "GET" } ], "create_time": "stringstringstringst", "update_time": "stringstringstringst", "status": "ACTIVE", "integration_mode": "LINK", "type": "BUY_NOW", "reusable": "MULTIPLE", "return_url": "http://example.com", "line_items": [ { "name": "string", "product_id": "string", "description": "string", "unit_amount": { "currency_code": "str", "value": "string" }, "taxes": [ { "name": "string", "type": "PERCENTAGE", "value": "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": "str", "value": "string" } } ] } ] }, "adjustable_quantity": { "maximum": 1 } } ] } ], "total_items": 0, "total_pages": 1, "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }

{ "name": "string", "message": "string", "debug_id": "string", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "links": [ { "href": "string", "rel": "string", "method": "GET" } ], "description": "string" } ], "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }

List payment resources

200application/json

400application/json

403application/json

500application/json

defaultapplication/json

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

List payment resources

200application/json

400application/json

403application/json

500application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`