paymentspring/paymentspring-php

PHP library for the PaymentSpring API

PaymentSpring PHP Library

Description

PaymentSpring is the easiest way to accept payments online, powered by an API designed for developers. This is the official PHP library for the PaymentSpring API., _(*1)

PaymentSpring API keys are required. Sign up for a free sandbox account to get your API keys., _(*2)

Usage examples can be found in the index.php file. You can add your own API keys in that file to test things out. To see all of the available endpoints and parameters, check out the API docs., _(*3)

Installation

The easiest way to user this library is with composer., _(*4)

Or, you can clone this repository. You must require the init.php file wherever you're going to use the this library. This is not required if you're using composer., _(*5)

Usage

Set Your API Keys

  // Replace these with your actual keys.
  \PaymentSpring\PaymentSpring::setApiKeys(YOUR_PUBLIC_KEY, YOUR_PRIVATE_KEY);

Customers

List Customers

This takes no arguments., _(*6)

    \PaymentSpring\Customer::listCustomers();

Get a Single Customer

Customer ID integer, _(*7)

    \PaymentSpring\Customer::getCustomer($customerID);

Create a Customer

Customer Parameters array, _(*8)

    \PaymentSpring\Customer::createCustomer($customerDetails);

Plans

List Plans

This takes no arguments., _(*9)

    \PaymentSpring\Plan::listPlans();

Subscribe Customer to Plan

Plan ID integer
Customer ID integer
Additional Parameters array optional, _(*10)

    \PaymentSpring\Plan::subscribeCustomer($planID, $customerID, $options);

Create and Subscribe Customer

For when you have a new customer and want to subscribe them to a plan at the same time., _(*11)

Customer Details array
Plan ID integer
Additional Parameters array optional, _(*12)

    \PaymentSpring\Plan::createAndSubscribeCustomer(
        $planID, 
        $customerID, 
        $options
    );

Charges

Charge Card

Charge Details/Parameters array
Amount in Cents integer (not required if included in parameters), _(*13)

    $amountInCents = 2500;
    $chargeDetails = array(
        "card_number" => "4111111111111111",
        "card_exp_month" => "01",
        "card_exp_year" => "19",
        "csc" => "123"
    );
    \PaymentSpring\Charge::chargeCard($chargeDetails, $amountInCents);

Charge Customer

Customer ID integer
Amount in Cents integer Other Parameters array (optional), _(*14)

    \PaymentSpring\Charge::chargeCustomer(
        $customerID, 
        $amountInCents, 
        $options
    );

Charge Token

Note: This library doesn't currently have a built in way of creating or fetching tokens. You could, however, use the makeRequest function, _(*15)

PaymentSpring Token string
Amount in Cents integer
Other Parameters array (optional), _(*16)

    \PaymentSpring\Charge::chargeToken($token, $amountInCents, $options);

Custom requests

For any requests that are not yet included in this library, you can make custom requests. To see all of the available endpoints and parameters, check out the API docs., _(*17)

This takes 2-3 arguments., _(*18)

Path to request string
Parameters array
Is POST? boolean, default false/GET, _(*19)

    \PaymentSpring\PaymentSpring::makeRequest(
        "/receipts/templates", 
        array(
              "receipt_text" => "Test template text [Amount]",            
              "name" => "Basic Template",      
            "subject" => "thanks for the payment"
       ), 
        true
    );