PayMethod/List

Get a list or search for a specific payment method on a customer account. Max results 300.

Payment methods which are set as default on the associated account will have the 'default_pm" attribute set to 'Y'. This attribute is only returned in responses from this service and is not included in responses from other 'PayMethod' services.

Parameters
Parameter Type Required Description
pay_method_id string optional Supply a 'pay_method_id' to retrieve a specific payment method.
customer_account_id string optional The 'customer_account_id' of the account you want to get pay methods for.
GET https://api.recurringstack.com/{format}/PayMethod/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('pay_method_id' => "",'customer_account_id' => "");
try { $response = $rstack->request('PayMethod/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <paymethod pay_method_id="18fea653-a7d4-4ef4-baa7-b50d99458f43" type="CC" customer_account_id="3ade05fc-f502-4c94-8662-7f88677ed377" default_pm="Y" brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-02-23 21:28:50" status="1">
      <card_type>Master Card</card_type>
      <account_number>51XX-XXXX-XXXX-4931</account_number>
      <expiration_month>05</expiration_month>
      <expiration_year>23</expiration_year>
      <card_security_code>***</card_security_code>
      <verification>
         <verified>N</verified>
      </verification>
      <custom_field_1>Anything you want here up to 500 characters.</custom_field_1>
      <custom_field_2>Anything you want here up to 500 characters.</custom_field_2>
      <status>1</status>
   </paymethod>
   <paymethod pay_method_id="aed20a23-e6a2-4992-be5c-430519f8013d" type="CC" customer_account_id="3ade05fc-f502-4c94-8662-7f88677ed377" default_pm="N" brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-02-23 20:50:21" status="1">
      <card_type>Visa</card_type>
      <account_number>44XX-XXXX-XXXX-6429</account_number>
      <expiration_month>02</expiration_month>
      <expiration_year>24</expiration_year>
      <card_security_code>***</card_security_code>
      <verification>
         <verified>N</verified>
      </verification>
      <custom_field_1>PCI compliant card storage.</custom_field_1>
      <custom_field_2>Anything we want here.</custom_field_2>
      <status>1</status>
   </paymethod>
</recurringstack>

{
    "paymethod": [
        {
            "@attributes": {
                "pay_method_id": "18fea653-a7d4-4ef4-baa7-b50d99458f43",
                "type": "CC",
                "customer_account_id": "3ade05fc-f502-4c94-8662-7f88677ed377",
                "default_pm": "Y",
                "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
                "creation_date": "2022-02-23 21:28:50",
                "status": "1"
            },
            "card_type": "Master Card",
            "account_number": "51XX-XXXX-XXXX-4931",
            "expiration_month": "05",
            "expiration_year": "23",
            "card_security_code": "***",
            "verification": {
                "verified": "N"
            },
            "custom_field_1": "Anything you want here up to 500 characters.",
            "custom_field_2": "Anything you want here up to 500 characters.",
            "status": "1"
        },
        {
            "@attributes": {
                "pay_method_id": "aed20a23-e6a2-4992-be5c-430519f8013d",
                "type": "CC",
                "customer_account_id": "3ade05fc-f502-4c94-8662-7f88677ed377",
                "default_pm": "N",
                "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
                "creation_date": "2022-02-23 20:50:21",
                "status": "1"
            },
            "card_type": "Visa",
            "account_number": "44XX-XXXX-XXXX-6429",
            "expiration_month": "02",
            "expiration_year": "24",
            "card_security_code": "***",
            "verification": {
                "verified": "N"
            },
            "custom_field_1": "PCI compliant card storage.",
            "custom_field_2": "Anything we want here.",
            "status": "1"
        }
    ]
}

API Simulator

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

PayMethod/Create

Add a new payment method (credit card or bank account) to a customer account. The payment information is attached to the customer account within the brand as opposed to any individual subscription itself.

If the 'require_verification' paramater is set to 'Y' a micro debit will be sent to the card or bank account, after which the customer will need to verify the debit amount with the 'PayMethod/Verify' endpoint before it can be used for payments. To skip this verification process provide a 'N' for the 'require_verification' parameter and the pay method will be marked as verified by default.
Your payment gateway may require address verification when charging a credit or debit card. In these situations the address on the account ('customer_account_id') is utilized. The address may be updated using the 'Account/Update' service.

Parameters
Parameter Type Required Description
customer_account_id string required The 'customer_account_id' you want to connect this payment method to.
type string required The type of payment method. Valid options are CC for credit card and BA for bank account.
account_number string required The bank account number or credit/debit card number.
routing_number string optional The bank account routing number when 'type' is BA.
account_type string optional For bank accounts only. 'Personal Checking' 'Personal Savings' 'Business Checking' and 'Business Savings' are options.
expiration_month string optional When 'type' is CC provide the card expiration month with leading zero. For example: 02.
expiration_year string optional When 'type' is CC provide the card two digit expiration year.
card_security_code string optional When type is CC provide the three or four digit card security code; also known as the CVV.
plaid_account_id string optional For instant bank account verification using Plaid. The 'account_id' as provided by Plaid.
plaid_access_token string optional For instant bank account verification using Plaid. The 'access_token' as provided by Plaid.
plaid_item_id string optional For instant bank account verification using Plaid. The 'item_id' as provided by Plaid for bank accounts only.
require_verification string required Provide a 'Y' for yes or an 'N' for no. See notes above.
custom_field_1 string optional A custom field for your records.
custom_field_2 string optional A custom field for your records.
POST https://api.recurringstack.com/{format}/PayMethod/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('customer_account_id' => "",'type' => "",'account_number' => "",'routing_number' => "",'account_type' => "",'expiration_month' => "",'expiration_year' => "",'card_security_code' => "",'plaid_account_id' => "",'plaid_access_token' => "",'plaid_item_id' => "",'require_verification' => "",'custom_field_1' => "",'custom_field_2' => "");
try { $response = $rstack->request('PayMethod/Create','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <paymethod pay_method_id="774a0d7a-d638-44e0-b88f-5f79f435e533" type="CC" customer_account_id="3ade05fc-f502-4c94-8662-7f88677ed377" brand_id="2f9f862f-3e25-44f0-a701-8e16b59ee969" creation_date="2022-02-23 21:37:43" status="1">
      <card_type>Master Card</card_type>
      <account_number>51XX-XXXX-XXXX-4931</account_number>
      <expiration_month>05</expiration_month>
      <expiration_year>26</expiration_year>
      <card_security_code>458</card_security_code>
      <verification>
         <verified>Y</verified>
      </verification>
      <custom_field_1>Anything you want here up to 500 characters.</custom_field_1>
      <custom_field_2>Anything you want here up to 500 characters.</custom_field_2>
      <status>1</status>
   </paymethod>
</recurringstack>

{
    "paymethod": {
        "@attributes": {
            "pay_method_id": "774a0d7a-d638-44e0-b88f-5f79f435e533",
            "type": "CC",
            "customer_account_id": "3ade05fc-f502-4c94-8662-7f88677ed377",
            "brand_id": "2f9f862f-3e25-44f0-a701-8e16b59ee969",
            "creation_date": "2022-02-23 21:37:43",
            "status": "1"
        },
        "card_type": "Master Card",
        "account_number": "51XX-XXXX-XXXX-4931",
        "expiration_month": "05",
        "expiration_year": "26",
        "card_security_code": "458",
        "verification": {
            "verified": "Y"
        },
        "custom_field_1": "Anything you want here up to 500 characters.",
        "custom_field_2": "Anything you want here up to 500 characters.",
        "status": "1"
    }
}

API Simulator

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

PayMethod/Verify

Utilize this endpoint to verify a payment method.

Using Stripe for bank account/ACH billing? Make sure your Stripe account is setup for Plaid, learn more.
The user has ten attempts to verify the micro charge amount after which verification will be unavailable. If this happens you will need to delete the card and add it again.

Parameters
Parameter Type Required Description
pay_method_id string required The 'pay_method_id' you want to verify.
micro_charge_amount string optional If verifying a credit card (CC) you should specify the micro charge amount.
force_verification string optional Provide a 'Y' if you wish to disregard the 'micro_charge_amount' and simply force verification of the pay method.
POST https://api.recurringstack.com/{format}/PayMethod/Verify 
//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('pay_method_id' => "",'micro_charge_amount' => "",'force_verification' => "");
try { $response = $rstack->request('PayMethod/Verify','POST',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <paymethod pay_method_id="0e8e5c9f-7761-492b-b392-a6314418e009" creation_date="2022-02-25 14:35:27" status="1">
      <verified>Y</verified>
   </paymethod>
</recurringstack>

{
    "paymethod": {
        "@attributes": {
            "pay_method_id": "0e8e5c9f-7761-492b-b392-a6314418e009",
            "creation_date": "2022-02-25 14:35:27",
            "status": "1"
        },
        "verified": "Y"
    }
}

API Simulator

Initiate a live call to the PayMethod/Verify service using the API simulator.

PayMethod/History

List the payment history for a specific payment method or account.

Parameters
Parameter Type Required Description
pay_method_id string optional Supply a 'pay_method_id' to retrieve a specific pay methods payment history.
customer_account_id string optional Supply a 'customer_account_id' to view all payments on a customer account using any pay method.
GET https://api.recurringstack.com/{format}/PayMethod/History 
//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('pay_method_id' => "",'customer_account_id' => "");
try { $response = $rstack->request('PayMethod/History','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response

API Simulator

Initiate a live call to the PayMethod/History service using the API simulator.

PayMethod/Delete

Delete a pay method from an account. The pay method will be unassociated with any existing associated subscriptions.

This operation is not reversable as it is with other services.

Parameters
Parameter Type Required Description
pay_method_id string required The 'pay_method_id' you want to delete.
DELETE https://api.recurringstack.com/{format}/PayMethod/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('pay_method_id' => "");
try { $response = $rstack->request('PayMethod/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <paymethod pay_method_id="774a0d7a-d638-44e0-b88f-5f79f435e533" creation_date="2022-02-23 21:37:43" deletion_date="2022-02-24 13:12:43" status="3"/>
</recurringstack>

{
    "paymethod": {
        "@attributes": {
            "pay_method_id": "774a0d7a-d638-44e0-b88f-5f79f435e533",
            "creation_date": "2022-02-23 21:37:43",
            "deletion_date": "2022-02-24 13:12:43",
            "status": "3"
        }
    }
}

API Simulator

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

PayMethod/SetDefault

Set or unset a payment method as default on a customer account. If the payment method is already the defualt for the account, calling this service will remove it. Likewise, if the payment method is currently not the default payment method this service will set it as default.

Default payment methods are utilized for automated recurring subscription billing / invoice payment when 'auto_renew' is set to Y on the subscription.

There can only be one default payment method per customer account.

Parameters
Parameter Type Required Description
pay_method_id string required The 'pay_method_id' you want to set or unset as the customer account's default payment method.
customer_account_id string required The 'customer_account_id' the payment method is connected to. This will also be the account the pay method is set as default for.
type string required The type of payment method (should match the 'pay_method_id'). Valid options are CC for credit card and BA for bank account.
PATCH https://api.recurringstack.com/{format}/PayMethod/SetDefault 
//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('pay_method_id' => "",'customer_account_id' => "",'type' => "");
try { $response = $rstack->request('PayMethod/SetDefault','PATCH',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);
Response 
<?xml version="1.0" encoding="UTF-8"?>
<recurringstack transaction_id="479488">
   <paymethod pay_method_id="f93693a5-33e8-47e3-b37c-09072deec342" default_pm="Y"/>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "479488"
    },
    "paymethod": {
        "@attributes": {
            "pay_method_id": "f93693a5-33e8-47e3-b37c-09072deec342",
            "default_pm": "Y"
        }
    }
}

API Simulator

Initiate a live call to the PayMethod/SetDefault service using the API simulator.
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.

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
Tips on this page :
RecurringStack Documentation
RecurringStack Docs
RecurringStack Simulator API Credentials
A valid API key associated with your RecurringStack™ account.
The user key associated with your RecurringStack™ login.
The 'brand_id' associated with one of your brands.
NOTE: Your credentials will not be validated.

Sign In

Background Images

Add an image to replace the solid background color
Blurred
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Polygon & Geometric
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Abstract
Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image Background Image
Layouts
Layouts
Transitions
Header
Additional Offcanvas New in BS v.5.0

Select the offcanvas placement.

Sidebars
Navigation
Right sidebar
Color Schemes
Light Completely bright color themes.
Dark Completely dark color themes.
Expanded Header
Fair Header
Full Header
Primary Nav
Brand
Tall Header New in v3.0
Scrollbars

Hides native scrollbars and creates custom styleable overlay scrollbars.

Offcanvas Header
Content Here

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Sapiente eos nihil earum aliquam quod in dolor, aspernatur obcaecati et at. Dicta, ipsum aut, fugit nam dolore porro non est totam sapiente animi recusandae obcaecati dolorum, rem ullam cumque. Illum quidem reiciendis autem neque excepturi odit est accusantium, facilis provident molestias, dicta obcaecati itaque ducimus fuga iure in distinctio voluptate nesciunt dignissimos rem error a. Expedita officiis nam dolore dolores ea. Soluta repellendus delectus culpa quo. Ea tenetur impedit error quod exercitationem ut ad provident quisquam omnis! Nostrum quasi ex delectus vero, facilis aut recusandae deleniti beatae. Qui velit commodi inventore.