Skip to content

dylan-marty-boldcommerce/external-payment-gateway-sample

Repository files navigation

external-payment-gateway-sample

Sample Third Party Payment Gateway

Description

The Checkout Example Third-Party Payment Gateway is intended to demonstrate the basic functionality of integrating a Payment Gateway with Bold Checkout. The example gateway is capable of the following:

  • Retaining payment methods for tokenization
  • Authorizing payment
  • Capturing funds
  • Voiding authorizations
  • Refunding captures

This repository is free to fork and use; to connect your payment gateway with Bold Checkout, you will need to TODO: Some good stuff here. Refer to the Getting Started Guide for more information.

Getting Started

  1. Clone this repository.

  2. Install npm dependencies.

    npm install
  3. Copy .envrc.example to .envrc.

    cp .envrc.example .envrc
  4. Set the following environment variables in .envrc.

    PORT={Your preferred port number}
    APP_URL={Your app's root URL}
  5. Export environment variables

    direnv allow
  6. Start your plugin server.

    npm run start
  7. Expose your server to the internet. In a development environment you can use services like ngrok or Cloudflare Tunnel to achieve this.

Customization

Feel free to modify this plugin to suit your use case. There are several things to keep in mind when doing so:

Or are there?

Documentation

For more information, refer to the following guides in the Bold Developer Documentation:

About

Sample Third Party Payment Gateway

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published