PApaypal
Payment-Resources

Retrieve a payment resource

Retrieves details for a specific payment resource, including current status, integration configuration, and related HATEOAS links.

get/v1/checkout/payment-resources/{id}

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.

Path parameters

idstring required

ID of the setup token.

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.

idstring

Unique identifier for the payment resource (link or button).

payment_linkstring

The generated payment link URL for the transaction (present if integration_mode is link).

create_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

update_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

status'ACTIVE' | 'INACTIVE'

Status of the payment resource.

integration_mode'LINK' required

Determines how the payment resource is presented to customers. Currently, only LINK is supported, which generates a PayPal-hosted payment page with a shareable URL. This value is immutable after creation.

type'BUY_NOW' required

The type of payment resource. Once a payment resource is created, this field cannot be changed.

reusable'MULTIPLE'

Indicates if the payment resource can be used multiple times or only once.

return_urlstring uri

URL to which the customer is redirected after completing the transaction.

Changes

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