Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Tokenization gives merchants the ability to securely save payment information. By tokenizing a customer's payment method, merchants can schedule future card-on-file charges and create recurring payment plans.

...

This page includes the following information about Payrix’s tokenization and recurring payments solutions:

Table of Contents

...

How to Tokenize a Customer’s Payment Method

There are two ways in which a cardholder’s payment data can be saved for CoF & recurring payment transactions:

Creating a Customer in the Payrix Portal/wiki/spaces/PAL/pages/764805252

Merchants have the ability to tokenize a cardholder’s payment method data directly in the Portal /wiki/spaces/PAL/pages/764805252 via the Customers section on the Dashboard menu. When creating a customer, the Merchant will be prompted to enter the cardholder’s personal information, including name, address, and email address.

...

Info

For our full step-by-step instructions for creating a Customer & attaching a tokenized payment method, please visit our Portal User Guide /wiki/spaces/PAL/pages/764805252.

Tokenizing a Payment Method Via the API

...

Location

Syntax

URL

Code Block
[POST]https://api.payrix.com/txns

HEADER

Code Block
Content-Type:application/json
APIKEY:{{private_api_key}}

BODY (for card payments)

Code Block
{
    "merchant": "t1_mer_59efbf4e69b27a4760b885d",
    "type": "1",
    "origin": "2",
    "token": {
        "payment": {
            "number": "4242424242424242",
            "cvv": "123",
            "expiration": "1020"
        },
        "customer": {
          "first": "John",
          "last": "Smith",
          "email":"john@example.com",
          "address1":"123 Main Street",
          "city":"New York",
          "state":"NY",
          "zip":"12345",
          }
    },
    "total": "10000"
}

BODY (for eCheck payments)

Code Block
{
	"merchant": "t1_mer_59efbf4e69b27a4760b885d",
	"type": "7",
	"origin": "2",
	"token": {
		"payment": {
			"method": "8",
			"number": "123456789",
			"routing": "123456789"
		},
		"customer": {
			"first": "First",
			"last": "Last",
			"email":"john@example.com",
			"address1":"123 Main Street",
			"city":"New York",
			"state":"NY",
			"zip":"12345",
		}
	},
	"total": "10000"
}

...

Recurring Payments

One of the key features of tokenizing a payment method is the ability for Merchants to use it to schedule recurring payments. This solution gives a Merchant the ability to charge their customer’s tokenized payment method in their desired amount and at their desired frequency. For example, Merchants can utilize recurring payments to charge their customers a monthly fee or for billing on a subscription-based business model.

Recurring payments can be set up directly in the Portal, by creating a recurring payment plan & subscribing your desired customer/s to that plan.

Setting Up Recurring Payments

Info

You can find step-by-step instructions for setting up recurring payment plans & subscriptions here /wiki/spaces/PAL/pages/765788206.

Setting up recurring payments within Payrix consists of three components:

Creating a Customer/wiki/spaces/PAL/pages/764805252

In order to set up recurring payments, you must first save the cardholder’s personal & payment information by creating a customer (with a token). You can read more about creating a customer here/wiki/spaces/PAL/pages/764805252.

Info

In the Portal, you have the ability to create recurring payments using a new payment method, and this will save the customer simultaneously as you subscribe them to a recurring payment plan.

Recurring Payment Plans

A plan dictates the amount and how often a recurring payment will be charged. Plans are not unique to a specific customer, rather multiple customers can be added to the same plan, and each will be charged the same amount at the intervals dictated in the plan.

Subscriptions

Once a plan dictating the recurring payment amount & frequency is created, customers can be added to the plan via subscriptions. Therefore, customers can be added or removed from a recurring payment plan without any changes being made to the actual plan. Simply adjust a customer’s subscription to make any changes.

To summarize, a plan determines the amount & frequency of a recurring payment, and customers can be added to a plan via a subscription.

...

How to Submit a Card-On-File (CoF) Payment Using a Token

Once a customer’s payment method has been tokenized it can also be used by Merchants to submit CoF transactions.

...

Location

Syntax

URL

Code Block
[POST]https://api.payrix.com/txns

HEADER

Code Block
Content-Type:application/json
APIKEY:{{private_api_key}}

BODY (for card payments)

Code Block
{
    "merchant": "t1_mer_59efbf4e69b27a4760b885d",
    "type": "1",
    "origin": "2",
    "token": "b73443457d0202be0489fed2b5687f81",
    "total": "10000"
}

BODY (for eCheck payments)

Code Block
{
	"merchant": "t1_mer_59efbf4e69b27a4760b885d",
	"type": "7",
	"origin": "2",
	"token": "944afd0919c5561724f511d4846e40b9",
	"total": "10000"
}

...

Related Articles

Child pages (Children Display)