paypal/paypal-server-sdk

PayPal's SDK for interacting with the REST APIs

0.5.1 2024-09-10 14:38 UTC

This package is not auto-updated.

Last update: 2024-09-10 15:45:58 UTC


README

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.

The Payment Method Tokens API is available in the US only.

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

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "paypal/paypal-server-sdk:0.5.1"

Or add it to the composer.json file manually as given below:

"require": {
    "paypal/paypal-server-sdk": "0.5.1"
}

You can also view the package at: https://packagist.org/packages/paypal/paypal-server-sdk#0.5.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

$client = PaypalServerSDKClientBuilder::init()
    ->clientCredentialsAuthCredentials(
        ClientCredentialsAuthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->environment(Environment::SANDBOX)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

API calls return an ApiResponse object that includes the following fields:

Environments

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

Fields

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation