Getting Started with Paypal Merged API

Introduction

An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders., Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the Orders API. For more information, see the PayPal Checkout Overview., The Payment Method Tokens API saves payment methods so payers don't have to enter details for future transactions. Payers can check out faster or pay without being present after they agree to save a payment method.The API associates a payment method with a temporary setup token. Pass the setup token to the API to exchange the setup token for a permanent token.The permanent token represents a payment method that's saved to the vault. This token can be used repeatedly for checkout or recurring transactions such as subscriptions.

Find out more here: https://developer.paypal.com/docs/api/orders/v2/

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | oauth2Credentials | Oauth2Credentials | The credential object for oauth2 | | oauth2PaymentMethodTokensCredentials | Oauth2PaymentMethodTokensCredentials | The credential object for oauth2PaymentMethodTokens |

HttpClientOptions

| Parameter | Type | Description | | --- | --- | --- | | timeout | number | Timeout in milliseconds. | | httpAgent | any | Custom http agent to be used when performing http requests. | | httpsAgent | any | Custom https agent to be used when performing http requests. | | retryConfig | Partial<RetryConfiguration> | Configurations to retry requests. |

RetryConfiguration

| Parameter | Type | Description | | --- | --- | --- | | maxNumberOfRetries | number | Maximum number of retries. Default: 0 | | retryOnTimeout | boolean | Whether to retry on request timeout. Default: true | | retryInterval | number | Interval before next retry. Used in calculation of wait time for next request in case of failure. Default: 1 | | maximumRetryWaitTime | number | Overall wait time for the requests getting retried. Default: 0 | | backoffFactor | number | Used in calculation of wait time for next request in case of failure. Default: 2 | | httpStatusCodesToRetry | number[] | Http status codes to retry against. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] | | httpMethodsToRetry | HttpMethod[] | Http methods to retry against. Default: ['GET', 'PUT'] |

The API client can be initialized as follows:

const client = new Client({
  oauth2Credentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret',
    oAuthScopes: [
      OAuthScopeOauth2Enum.HttpsUriPaypalComServicesPaymentsPayment,
      OAuthScopeOauth2Enum.HttpsUriPaypalComServicesPaymentsPaymentReferenceTransaction
    ]
  },
  oauth2PaymentMethodTokensCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret',
    oAuthScopes: [
      OAuthScopeOauth2PaymentMethodTokensEnum.HttpsUriPaypalComServicesVaultPaymentTokensReadwrite,
      OAuthScopeOauth2PaymentMethodTokensEnum.HttpsUriPaypalComServicesVaultPaymentTokensRead
    ]
  },
  timeout: 0,
  environment: Environment.Production,
});

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

| Name | Description | | --- | --- | | production | Default PayPal Sandbox Environment | | environment2 | PayPal Live Environment |

Authorization

This API uses the following authentication schemes.

• Oauth2 (OAuth 2 Client Credentials Grant)
• Oauth2_PaymentMethodTokens (OAuth 2 Client Credentials Grant)

List of APIs

• O Auth Authorization
• Orders
• Authorizations
• Captures
• Refunds
• Payment-Tokens
• Setup-Tokens

Classes Documentation

• ApiResponse
• ApiError