Ballerina PayPal Payments connector

Overview

PayPal is a global online payment platform enabling individuals and businesses to securely send and receive money, process transactions, and access merchant services across multiple currencies.

The ballerinax/paypal.payments package provides a Ballerina connector for interacting with the PayPal Payments API v2, allowing you to authorize payments, capture authorized payments, refund captured payments, void authorizations, and reauthorize expired authorizations in your Ballerina applications.

Setup guide

To use the PayPal Payments connector, you must have access to a PayPal Developer account.

Step 1: Create a business account

1. Open the PayPal Developer Dashboard.

2. Click on "Sandbox Accounts" under "Testing Tools".

   

3. Create a Business account

   Note: Some PayPal options and features may vary by region or country; check availability before creating an account.

   

Step 2: Create a REST API app

1. Navigate to the "Apps and Credentials" tab and create a new merchant app.

   Provide a name for the application and select the Business account you created earlier.

   

Step 3: Obtain Client ID and Client Secret

1. After creating your new app, you will see your Client ID and Client Secret. Make sure to copy and securely store these credentials.

   

Quickstart

To use the paypal.payments connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Import the paypal.payments module.

import ballerinax/paypal.payments as paypal;

Step 2: Instantiate a new connector

1. Create a Config.toml file and configure the obtained credentials in the above steps as follows:

clientId = "<test-client-id>"
clientSecret = "<test-client-secret>"

2. Create a paypal:ConnectionConfig with the obtained credentials and initialize the connector with it.

configurable string clientId = ?;
configurable string clientSecret= ?;

final paypal:Client paypal = check new ({
    auth: {
        clientId,
        clientSecret
    }
}, serviceUrl);

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

Capture an authorized payment

public function main() returns error? {
    paypal:CaptureRequest captureRequest = {
        amount: {
            currency_code: "USD",
            value: "100.00"
        },
        final_capture: true
    };
    
    paypal:Capture2 response = check paypal->/authorizations/[authorizationId]/capture.post(captureRequest);
}

Step 4: Run the Ballerina application

bal run

Examples

The PayPal Payments connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

1. Order creation: Process a complete product purchase from order creation through payment authorization, capture, and partial refunds.

2. Subscription management: Simulate a recurring billing flow with subscription-style orders, monthly payments, plan switching, and pro-rated refunds.

Build from the source

Setting up the prerequisites

1. Download and install Java SE Development Kit (JDK) version 21. You can download it from either of the following sources:

   • Oracle JDK
   • OpenJDK

   Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.

2. Download and install Ballerina Swan Lake.

3. Download and install Docker.

   Note: Ensure that the Docker daemon is running before executing any tests.

4. Export Github Personal access token with read package permissions as follows,

   export packageUser=<Username>
   export packagePAT=<Personal access token>

Build options

Execute the commands below to build from the source.

1. To build the package:

   ./gradlew clean build

2. To run the tests:

   ./gradlew clean test

3. To build the without the tests:

   ./gradlew clean build -x test

4. To run tests against different environments:

   ./gradlew clean test -Pgroups=<Comma separated groups/test cases>

5. To debug the package with a remote debugger:

   ./gradlew clean build -Pdebug=<port>

6. To debug with the Ballerina language:

   ./gradlew clean build -PbalJavaDebug=<port>

7. Publish the generated artifacts to the local Ballerina Central repository:

   ./gradlew clean build -PpublishToLocalCentral=true

8. Publish the generated artifacts to the Ballerina Central repository:

   ./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

• For more information go to the paypal.payments package.
• For example demonstrations of the usage, go to Ballerina By Examples.
• Chat live with us via our Discord server.
• Post all technical questions on Stack Overflow with the #ballerina tag.