PApaypal
Payment-Resources

List payment resources

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

get/v1/checkout/payment-resources

Request

  • Base URL
    https://api-m.paypal.com
  • Auth
    • OAuth 2
      Client credentials
      Token URL/v1/oauth2/token
      Scopeshttps://uri.paypal.com/services/checkout/payment-resources
    • or OAuth 2
      Client credentials
      Token URL/v1/oauth2/token
      Scopeshttps://uri.paypal.com/services/checkout/payment-resources/readwrite
    • or OAuth 2
      Client credentials
      Token URL/v1/oauth2/token
      Scopeshttps://uri.paypal.com/services/checkout/payment-resources/read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

page_sizeinteger

The number of webhook event notifications to return in the response.

page_tokenstring

An opaque value representing the page to navigate to.

total_requiredboolean

Indicates whether the to show <code>total_pages</code> and <code>total_items</code> in the response.

Headers

Content-Typestring

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

PayPal-Auth-Assertionstring

Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.

Response

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

total_itemsinteger

Total number of payment resources.

total_pagesinteger

Total number of pages.

Changes

No recorded changes to this operation across all 1 revision of this API.