Payment/List

List payments connected to a customer account, invoice, or subscription.

Parameters

Parameter	Type	Required	Description
payment_id	string	optional	The 'payment_id' of a specific payment.
invoice_id	string	optional	Provide a 'invoice_id' to list all payments connected to a specific invoice.
customer_account_id	string	optional	Provive a 'customer_account_id" to list all payments connected to a specific customer account.
pay_method_id	string	optional	Provide a 'pay_method_id' to list all payments connected to a specific pay method.
subscription_id	string	optional	Provide a 'subscription_id' to show invoice payments linked to a specific subscription.
payment_transaction_id	string	optional	Provide a 'payment_transaction_id' to find a specific payment using the payment gateway transaction ID.

GET https://api.recurringstack.com/{format}/Payment/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('payment_id' => "",'invoice_id' => "",'customer_account_id' => "",'pay_method_id' => "",'subscription_id' => "",'payment_transaction_id' => "");
try { $response = $rstack->request('Payment/List','GET',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

<?xml version="1.0" encoding="UTF-8"?>
<recurringstack>
   <payment payment_id="ccf70bb5-1393-4274-8743-d6c39df2963f" creation_date="2022-06-16 01:32:06" reversal_date="0000-00-00 00:00:00" override_billing="N">
      <invoice_id>154aa6d0-efa8-4098-b402-fdc211848da7</invoice_id>
      <customer_account_id>a9316b3b-97e1-4ba1-be03-9362037f5e4d</customer_account_id>
      <paymethod pay_method_id="0c0eb9fe-5073-47ed-9488-9935d78b35df" type="CC">
         <card_type>Visa</card_type>
         <account_number>42XX-XXXX-XXXX-4242</account_number>
         <expiration_month>02</expiration_month>
         <expiration_year>25</expiration_year>
      </paymethod>
      <amount>1.00</amount>
      <gateway gateway_id="m3km4ubu52-9999-4b91-85a0-vervr433v434">
         <name>Stripe Test 2</name>
         <gateway_transaction_id>ch_3LBCFQ2R6ox4wZvV0BN3MijX</gateway_transaction_id>
         <type>Real-Time</type>
      </gateway>
   </payment>
   <payment payment_id="15894371-b0d6-4e99-bde4-3b966c55b033" creation_date="2022-06-15 12:19:23" reversal_date="0000-00-00 00:00:00" override_billing="Y">
      <invoice_id>94f559f0-565f-47f5-aa38-60bf72b92bae</invoice_id>
      <customer_account_id>a9316b3b-97e1-4ba1-be03-9362037f5e4d</customer_account_id>
      <pay_method_id>NA</pay_method_id>
      <amount>0.00</amount>
      <gateway gateway_id="NA">
         <name>PayPal</name>
         <gateway_transaction_id>Ha33yvef34f3445bbtt41</gateway_transaction_id>
         <type>Third Party</type>
      </gateway>
   </payment>
</recurringstack>

{
    "payment": [
        {
            "@attributes": {
                "payment_id": "ccf70bb5-1393-4274-8743-d6c39df2963f",
                "creation_date": "2022-06-16 01:32:06",
                "reversal_date": "0000-00-00 00:00:00",
                "override_billing": "N"
            },
            "invoice_id": "154aa6d0-efa8-4098-b402-fdc211848da7",
            "customer_account_id": "a9316b3b-97e1-4ba1-be03-9362037f5e4d",
            "paymethod": {
                "@attributes": {
                    "pay_method_id": "0c0eb9fe-5073-47ed-9488-9935d78b35df",
                    "type": "CC"
                },
                "card_type": "Visa",
                "account_number": "42XX-XXXX-XXXX-4242",
                "expiration_month": "02",
                "expiration_year": "25"
            },
            "amount": "1.00",
            "gateway": {
                "@attributes": {
                    "gateway_id": "m3km4ubu52-9999-4b91-85a0-vervr433v434"
                },
                "name": "Stripe Test 2",
                "gateway_transaction_id": "ch_3LBCFQ2R6ox4wZvV0BN3MijX",
                "type": "Real-Time"
            }
        },
        {
            "@attributes": {
                "payment_id": "15894371-b0d6-4e99-bde4-3b966c55b033",
                "creation_date": "2022-06-15 12:19:23",
                "reversal_date": "0000-00-00 00:00:00",
                "override_billing": "Y"
            },
            "invoice_id": "94f559f0-565f-47f5-aa38-60bf72b92bae",
            "customer_account_id": "a9316b3b-97e1-4ba1-be03-9362037f5e4d",
            "pay_method_id": "NA",
            "amount": "0.00",
            "gateway": {
                "@attributes": {
                    "gateway_id": "NA"
                },
                "name": "PayPal",
                "gateway_transaction_id": "Ha33yvef34f3445bbtt41",
                "type": "Third Party"
            }
        }
    ]
}

API Simulator

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

payment_id

invoice_id

customer_account_id

pay_method_id

subscription_id

payment_transaction_id

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

Payment/Create

Post a payment to an existing invoice using a pay method on the customers account or using 'Cash' or other form of third party pay method.

Failed payments are recorded along with the reason for failure only when utilizing real-time billing (when 'override_billing' is set to 'N').

The 'status' returned by this service is NOT the status of the payment itself but the status of the invoice. Any response that's not an error is a successful payment, whether it be partial or full.

Invoice Status Ledger:
0 - Unpaid
1 - Paid
2 - Partially Paid
3 - Deleted

Parameters

Parameter	Type	Required	Description
invoice_id	string	optional	The 'invoice_id' of the invoice you wish to make a payment on. Required if 'apply_to_prepaid_balance' is 'N'
customer_account_id	string	required	The customer account linked to the invoice you wish to make a payment on.
pay_method_id	string	optional	The 'pay_method_id' of the payment method the customer will use to make a payment on the invoice.
apply_to_prepaid_balance	string	required	Provide a value of 'Y' if you want to apply the payment to the customers prepaid balance instead of an invoice.
override_billing	string	required	Provide a 'Y' to skip real-time billing of the 'pay_method_id' and simply post the payment 'amount'.
payment_gateway	string	optional	Provide a payment gateway name (ie. PayPal) if using a third party payment gatway; 'override_billing' must be 'Y'.
payment_transaction_id	string	optional	You can provide a payment transaction id if a thrid party payment service (ie. PayPal) was used to bill the customer; 'override_billing' must be 'Y'.
amount	string	required	Provide the amount of the payment in full dollar amount (eg. 10.50).

POST https://api.recurringstack.com/{format}/Payment/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('invoice_id' => "",'customer_account_id' => "",'pay_method_id' => "",'apply_to_prepaid_balance' => "",'override_billing' => "",'payment_gateway' => "",'payment_transaction_id' => "",'amount' => "");
try { $response = $rstack->request('Payment/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="478986">
   <payment invoice_id="154aa6d0-efa8-4098-b402-fdc211848da7" payment_id="ccf70bb5-1393-4274-8743-d6c39df2963f" status="2">
      <amount>1.00</amount>
      <remaining_balance>273.00</remaining_balance>
   </payment>
</recurringstack>

{
    "@attributes": {
        "transaction_id": "478986"
    },
    "payment": {
        "@attributes": {
            "invoice_id": "154aa6d0-efa8-4098-b402-fdc211848da7",
            "payment_id": "ccf70bb5-1393-4274-8743-d6c39df2963f",
            "status": "2"
        },
        "amount": "1.00",
        "remaining_balance": "273.00"
    }
}

API Simulator

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

invoice_id

customer_account_id

pay_method_id

apply_to_prepaid_balance

override_billing

payment_gateway

payment_transaction_id

amount

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

Payment/Delete

Delete an existing payment. If the payment was processed with a real time gateway, RecurringStack™ will attempt to refund the payment using the same gatway.

Parameters

Parameter	Type	Required	Description
payment_id	string	required	The ID of the payment you wish to reverse.
customer_account_id	string	required	The 'customer_account_id' of the customer who made the payment.
invoice_id	string	required	The 'invoice_id' the payment was intially applied to.

DELETE https://api.recurringstack.com/{format}/Payment/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('payment_id' => "",'customer_account_id' => "",'invoice_id' => "");
try { $response = $rstack->request('Payment/Delete','DELETE',$params); } catch(Exception $e) { $error =  $e->getMessage(); echo "Error: $error"; }
print_r($response);

Response

API Simulator

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

payment_id

customer_account_id

invoice_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`