Retrieve a payment resource

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

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication.

In: header

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

Path Parameters

id*string

The payment resource id for which to show details.

Match^[A-Z]{3}-[A-Z0-9]+$

Length1 <= length <= 127

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.paypal.com/v1/checkout/v1/checkout/payment-resources/string"

{
  "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
      }
    }
  ],
  "code_snippets": {
    "single": {
      "body": "string"
    },
    "stacked": [
      {
        "framework": "HTML",
        "head": "string",
        "body": "string",
        "button_placement": "string"
      }
    ]
  }
}

{
  "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"
    }
  ]
}

{
  "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"
    }
  ]
}

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.

{ "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 } } ], "code_snippets": { "single": { "body": "string" }, "stacked": [ { "framework": "HTML", "head": "string", "body": "string", "button_placement": "string" } ] } }

{ "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" } ] }

Retrieve a payment resource

200application/json

400application/json

403application/json

404application/json

500application/json

defaultapplication/json

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Retrieve a payment resource

200application/json

400application/json

403application/json

404application/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`

`application/json`

`application/json`