1.0.0 • Published 5 months ago

@paypal/paypal-rest-api-specifications v1.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 months ago

PayPal REST API Specifications

This repository contains the specification files for PayPal REST APIs.

You can try our REST APIs in Postman without a PayPal Developer account. Learn more in our Postman guide.

Run in Postman

Steps to generate code from the specification

Note: Spec file used: openapi/checkout_orders_v2.json

Java

  1. npm run codegen-java -- openapi/checkout_orders_v2.json --artifact-id orders
  2. cd generated/java
  3. mvn clean install

The above will install the orders artifact to the local maven repository

Available scripts

 npm run
Scripts available in @paypal/paypal-rest-api-specifications@1.0.0 via `npm run-script`:
  preview
    redocly preview-docs
  bundle
    redocly bundle
  bundle-deref
    redocly bundle -d true
  lint-redocly
    redocly --format summary lint
  lint-spectral
    spectral --format pretty lint
  lint-openapi
    openapi-generator-cli validate -i
  codegen-java
    openapi-generator-cli generate -g java -o generated/java -i
  codegen-typescript-node
    openapi-generator-cli generate -g typescript-node -o generated/typescript-node -i

Available specifications

OpenAPI 3.0.3

The OpenAPI specification is a programming language agnostic standard that lets providers describe the interface of their HTTP APIs. This allows both humans and machines to discover the capabilities of an API without needing to first read documentation or understand the implementation.

API NameVersionLinks
Add Trackingv1OpenAPI, API Reference
Catalog Productsv1OpenAPI, API Reference
Disputesv1OpenAPI, API Reference
Invoicesv1OpenAPI, API Reference
Invoicesv2OpenAPI, API Reference
Ordersv1OpenAPI, API Reference
Ordersv2OpenAPI, API Reference
Partner Referralsv1OpenAPI, API Reference
Partner Referralsv2OpenAPI, API Reference
Payment Experiencev1OpenAPI, API Reference
Payment Method Tokensv3OpenAPI, API Reference
Paymentsv1OpenAPI, API Reference
Paymentsv2OpenAPI, API Reference
Payoutsv1OpenAPI, API Reference
Subscriptionsv1OpenAPI, API Reference
Transaction Searchv1OpenAPI, API Reference
Webhooks Managementv1OpenAPI, API Reference

Support

PayPal's Developer support