PayGateway/List

List all of your previously connected real-time payment gateways associated with the brand. This service will also list all payment gateways supported by RecurringStack™ along with their required credentials (leave 'gateway_id' parameter empty).

Parameters

Parameter	Type	Required	Description
gateway_id	string	optional	Provide a 'gateway_id' to find information on a specific gateway.
gateway_provider	string	optional	Provide 'gateway_provider' to search for payment gatways from a specific gateway provider; for example "STRIPE".

GET https://api.recurringstack.com/{format}/PayGateway/List

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('gateway_id' => "",'gateway_provider' => "");
try { $response = $rstack->request('PayGateway/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <paygateway gateway_id="m3km4ubu52-9999-4b91-85a0-vervr433v434" default_cc_gateway="Y" default_ach_gateway="Y">
      <gateway_provider>STRIPE</gateway_provider>
      <name>Stripe Test</name>
      <credentials_1 name="API KEY">sk_test_zvIZANH5HVCUR2jKgK0q8XSA</credentials_1>
      <credentials_2 name=""/>
   </paygateway>
   <paygateway gateway_id="99347734br-5960-4b91-85a0-041587bcce11" default_cc_gateway="N" default_ach_gateway="N">
      <gateway_provider>AUTHORIZE.NET</gateway_provider>
      <name>HTG Authorize.net Gateway</name>
      <credentials_1 name="LOGIN ID">4df7XDX7Dy</credentials_1>
      <credentials_2 name="TRANSACTION KEY">79gZ432e4WTbHSnb</credentials_2>
   </paygateway>
   <paygateway default_cc_gateway="N" default_ach_gateway="N">
      <gateway_provider>HELCIM</gateway_provider>
      <credentials_1 name="ACCOUNT ID"/>
      <credentials_2 name="API TOKEN"/>
   </paygateway>
</recurringstack>

{
    "paygateway": [
        {
            "@attributes": {
                "gateway_id": "m3km4ubu52-9999-4b91-85a0-vervr433v434",
                "default_cc_gateway": "Y",
                "default_ach_gateway": "Y"
            },
            "gateway_provider": "STRIPE",
            "name": "Stripe Test",
            "credentials_1": "sk_test_zvIZANH5HVCUR2jKgK0q8XSA",
            "credentials_2": {
                "@attributes": {
                    "name": ""
                }
            }
        },
        {
            "@attributes": {
                "gateway_id": "99347734br-5960-4b91-85a0-041587bcce11",
                "default_cc_gateway": "N",
                "default_ach_gateway": "N"
            },
            "gateway_provider": "AUTHORIZE.NET",
            "name": "HTG Authorize.net Gateway",
            "credentials_1": "4df7XDX7Dy",
            "credentials_2": "79gZ432e4WTbHSnb"
        },
        {
            "@attributes": {
                "default_cc_gateway": "N",
                "default_ach_gateway": "N"
            },
            "gateway_provider": "HELCIM",
            "credentials_1": {
                "@attributes": {
                    "name": "ACCOUNT ID"
                }
            },
            "credentials_2": {
                "@attributes": {
                    "name": "API TOKEN"
                }
            }
        }
    ]
}

API Simulator

Initiate a live call to the PayGateway/List service using the API simulator.

gateway_id

gateway_provider

Your API credentials are missing, click "Set Credentials" to set them.

PayGateway/Create

Create or link a new payment gateway to process real-time payments.

Find supported gateways and whats expected for 'credentials_1" and 'credentials_2' by utilizing the 'PayGateway/List' service.

Parameters

Parameter	Type	Required	Description
name	string	required	A nickname or reference name of the gateway for your reference (not see by customers).
gateway_provider	string	required	The name of the gateway provider as listed on the 'PayGateway/List' service.
credentials_1	string	required	The credentials for the payment gateway 'credentials_1' location as described in the 'PayGateway/List' service.
credentials_2	string	optional	The credentials for the payment gateway 'credentials_2' location as described in the 'PayGateway/List' service.
default_cc	string	optional	Provide a 'Y' to make this gateway the default for credit card processing for the brand.
default_ba	string	optional	Provide a 'Y' to make this gateway the default for bank account or ACH processing for the brand.

POST https://api.recurringstack.com/{format}/PayGateway/Create

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('name' => "",'gateway_provider' => "",'credentials_1' => "",'credentials_2' => "",'default_cc' => "",'default_ba' => "");
try { $response = $rstack->request('PayGateway/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="479052">
   <paygateway gateway_id="cdcf04b8-8994-43b2-8c73-9b98f187d3f9" default_cc_gateway="N" default_ach_gateway="N" status="1"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479052"
    },
    "paygateway": {
        "@attributes": {
            "gateway_id": "cdcf04b8-8994-43b2-8c73-9b98f187d3f9",
            "default_cc_gateway": "N",
            "default_ach_gateway": "N",
            "status": "1"
        }
    }
}

API Simulator

Initiate a live call to the PayGateway/Create service using the API simulator.

name

gateway_provider

credentials_1

credentials_2

default_cc

default_ba

Your API credentials are missing, click "Set Credentials" to set them.

PayGateway/Update

Update a previously linked payment gateway and/or set it as the brands default credit card or ACH real-time processing gateway.

If the pay gateway you're updating is currently the brand 'default_cc' or 'default_ba' gateway you'll need to set a different gateway as the default to remove it. You can't "unset" a gateway as default, only replace it with a different pay gateway.

Parameters

Parameter	Type	Required	Description
gateway_id	string	required	The 'gateway_id' of the payment gateway you wish to update.
name	string	required	A nickname or reference name of the gateway for your reference (not see by customers).
credentials_1	string	required	The credentials for the payment gateway 'credentials_1' location as described in the 'PayGateway/List' service.
credentials_2	string	optional	The credentials for the payment gateway 'credentials_2' location as described in the 'PayGateway/List' service.
default_cc	string	optional	Provide a 'Y' to make this gateway the default for credit card processing for the brand.
default_ba	string	optional	Provide a 'Y' to make this gateway the default for bank accountor ACH processing for the brand.

PATCH https://api.recurringstack.com/{format}/PayGateway/Update

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('gateway_id' => "",'name' => "",'credentials_1' => "",'credentials_2' => "",'default_cc' => "",'default_ba' => "");
try { $response = $rstack->request('PayGateway/Update','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0"?>
<recurringstack transaction_id="479048">
  <paygateway gateway_id="a5ea99a5-6872-4e47-851f-b385dd4ef3c0" default_cc_gateway="N" default_ach_gateway="N" status="1"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479048"
    },
    "paygateway": {
        "@attributes": {
            "gateway_id": "a5ea99a5-6872-4e47-851f-b385dd4ef3c0",
            "default_cc_gateway": "N",
            "default_ach_gateway": "N",
            "status": "1"
        }
    }
}

API Simulator

Initiate a live call to the PayGateway/Update service using the API simulator.

gateway_id

name

credentials_1

credentials_2

default_cc

default_ba

Your API credentials are missing, click "Set Credentials" to set them.

PayGateway/Delete

Delete an existing payment gateway. If the pay gateway is currently the default for the brand, the brand will be left without a default gateway for payment processing.

Parameters

Parameter	Type	Required	Description
gateway_id	string	required	The 'gateway_id' of the payment gateway you wish to delete.

DELETE https://api.recurringstack.com/{format}/PayGateway/Delete

//key,user_key,brand_id,response_format (xml or json),return (clean = return object, leave blank to return raw)
$rstack = new recurringstack('','','','xml','clean'); 

$params = array('gateway_id' => "");
try { $response = $rstack->request('PayGateway/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="479050">
   <paygateway gateway_id="a5ea99a5-6872-4e47-851f-b385dd4ef3c0" status="3"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479050"
    },
    "paygateway": {
        "@attributes": {
            "gateway_id": "a5ea99a5-6872-4e47-851f-b385dd4ef3c0",
            "status": "3"
        }
    }
}

API Simulator

Initiate a live call to the PayGateway/Delete service using the API simulator.

gateway_id

Your API credentials are missing, click "Set Credentials" to set them.

Your content here

Lorem ipsum dolor sit amet consectetur adipisicing elit. Qui, natus temporibus voluptate corporis possimus ab aut cumque.

Homepage

Quick Tips

You may remove all ID or Class names which contain _dm-, they are only used for demonstration.

Boxed Layout

Fluid Layout	Remove the `.boxed-layout` and `.centered-layout` classes from the `body`.
Centered Layout	Add a class `.centered-layout` to the `body`.
Boxed Layout	Add a class `.boxed-layout` to the `body`.
Boxed Layout with background image	Add background image to the `body`. <body class="boxed-layout" style='background-image: url("path_to_img/image.jpg");'> .. .. </body> Or it could be in your own class. .bg-img { background-image: url("path_to_img/image.jpg"); } <body class="boxed-layout bg-img"> .. .. </body>

Color Schemes

Replace the current Bootstrap CSS and Nifty CSS path with the new path of the CSS color schemes you wish to use.

This is where you can change the color scheme of your app / website.

<head>
    ...
    <title>My Project</title>
    ...

    <!-- STYLESHEETS -->
    <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--- -->

    <!-- Bootstrap CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/bootstrap.min.css">

    <!-- Nifty CSS [ REQUIRED ] -->
    <link rel="stylesheet" href="documentation/assets/css/color-schemes/SELECTED-SCEHEMS/nifty.min.css">

</head>

Header

Sticky header	Add a class `.hd--sticky` to the `#root`.
Expanded header	Add a class `.hd--expanded` to the `#root`.
Expanded header with overlapping content.	Add a class `.overlapping` to the `#content > .content__header`.
Disable rounded header.	Add a class `.rounded-0` to the `#content > .content__header`.

Navigation

Max navigation by default	Add a class `.mn--max` to the `#root`.
Min navigation by default	Add a class `.mn--min` to the `#root`.
OffCanvas navigation with PUSH mode by default	Add a class `.mn--push` to the `#root`.
OffCanvas navigation with SLIDE mode by default	Add a class `.mn--slide` to the `#root`.
OffCanvas navigation with REVEAL mode by default	Add a class `.mn--slide` to the `#root`.
Sticky navigation	Add a class `.mn--sticky` to the `#root`.
Create a ToggleButton for navigation	Add a class `.nav-toggler` to the button. Example :

Sidebar

Disable sidebar backdrop	Add a class `.sb--bd-0` to the `#root`.
Static position	Add a class `.sb--static` to the `#root`.
Stuck sidebar as the default mode	Add a class `.sb--stuck` to the `#root`.
Unite sidebar as the default mode	Add a class `.sb--unite` to the `#root`.
Pinned sidebar as the default mode	Add a class `.sb--pinned` to the `#root`.
Toggle visibility	Toggle the class `.sb--show` in the `#root`.
Create a ToggleButton for Sidebar	Add a class `.sidebar-toggler` to the button. Example :

Animations

Add the following class to the body to change the animation transition.

Transition function name	Class name
In Quart	`.in-quart`
Out Quart	`.out-quart`
In Back	`.in-back`
Out Back	`.out-back`
In Out Back	`.in-out-back`
easeInOutBack	`.easeInOutBack`
steps	`.steps`
jumping	`.jumping`
rubber	`.rubber`