Creates a payment resource for a single-item purchase

Creates a new PayPal payment resource for a single-item Buy Now checkout. Returns the full resource details including ID, payment link url, and status.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication.

In: header

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

Header Parameters

PayPal-Request-Id*string

The server stores keys for 6 hours.

Match^[0-9a-zA-Z_-]+$

Length1 <= length <= 108

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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api.paypal.com/v1/checkout/v1/checkout/payment-resources" \  -H "PayPal-Request-Id: string" \  -H "Content-Type: application/json" \  -d '{    "integration_mode": "LINK",    "type": "BUY_NOW"  }'

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

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

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

PayPal-Request-Id*string

The server stores keys for 6 hours.

Match^[0-9a-zA-Z_-]+$

Length1 <= length <= 108

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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

integration_mode*Integration Mode

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.

Match^[A-Z0-9_]+$

Length1 <= length <= 20

Value in"LINK"

type*Payment Resource Type

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

Match^[A-Z0-9_]+$

Length1 <= length <= 20

Value in"BUY_NOW"

reusable?Reusable

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

Default"MULTIPLE"

Match^[A-Z0-9_]+$

Length1 <= length <= 20

Value in"MULTIPLE"

return_url?string

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

Match^.*$

Formaturi

Length1 <= length <= 1024

line_items?array<>

List of individual item in payment resource.

Items1 <= items <= 20

curl -X POST "https://api.paypal.com/v1/checkout/v1/checkout/payment-resources" \ -H "PayPal-Request-Id: string" \ -H "Content-Type: application/json" \ -d '{ "integration_mode": "LINK", "type": "BUY_NOW" }'

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

Creates a payment resource for a single-item purchase

200application/json

201application/json

400application/json

403application/json

409application/json

422application/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

Creates a payment resource for a single-item purchase

200application/json

201application/json

400application/json

403application/json

409application/json

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

`application/json`

`application/json`

`application/json`

`application/json`