PIPE allows you to securely collect and store (non-)card data from shoppers for future usage
e.g. recurring payments, one-click payments.
To better understand registration tokens in eCommerce, please read
Tokenization Guide.
To use network tokens issued by the card networks for your payments,
please refer to PIPE Network Tokens.
The merchant collects card data from the shopper via the tokenization widget and initiates the registration tokenization.
No payment request/flow is involved. A registration token is synchronously provisioned and returned to the merchant so it can be stored.
The registration token can then be used in subsequent payments.
Perform a server-to-server POST request to prepare the checkout with the required customer data, including createRegistration=true
but excluding paymentType. The response to a successful request is an id required in the second step to create the registration form.
Sample request:
2. Create the registration form
Create the registration form by adding the following lines of HTML/JavaScript to your page:
Perform a server-to-server POST request over the registration token retrieved in the previous step.
Alternatively, use one-click checkout to authorize the payment with a
selected stored registration token.
Sample request:
Tokenization during payment
The merchant collects card data from shopper via the payment widget and initiates the registration tokenization along an account verification
(zero amount auth) or initial purchase. A registration token is synchronously provisioned and returned to the merchant once the payment is complete.
The registration token can then be used in subsequent payments.
There are two ways to store the raw card details during a payment checkout:
Merchant-determined tokenization (see below).
Add createRegistration=true in the checkout request.
Shopper-determined
tokenization. Add a checkbox to the PIPE form to let the customer decide whether
or not to store the raw card details.
Find out if the payment and registration token were successful.
Transactions:
1. Prepare the checkout
Perform a server-to-server POST request to prepare the checkout with the required payment and customer data, including the order type,
amount and currency. The response to a successful request is an id required in the second step to create the payment form.
Sample request:
2. Create the payment form
Create the payment form by adding the following lines of HTML/JavaScript to your page:
Once the payment request is processed, the customer is redirected to your shopperResultUrl along with a GET parameter resourcePath.
resourcePath=/v1/checkouts/{checkoutId}/payment
Sample request:
One-click checkout
Speed up of the checkout process by re-using the raw card data a shopper entered previously. A shopper returns on the
merchant’s website (card is already tokenized). An unscheduled one-click purchase with one of the saved registration tokens is performed.
A cardholder initiated (CIT) payment is authorized with the real card data as saved for the registration token.
Perform a server-to-server POST request to prepare the checkout with the required payment data, including the registration token IDs.
The stored card on files should be sent in the registrations[n].id parameter, where n is a sequence number from zero, incrementing for
each of the customer's registration IDs. The response to a successful request is an id required in the second step to
create the one-click payment form.
Sample request:
2. Create the payment form
Create the payment form by adding the following lines of HTML/JavaScript to your page:
When PIPE builds up the payment form it automatically fetches the registrations data from the server and displays the pre-filled widgets to the shopper.
Sample form:
3. Get the payment status
Once the payment request is processed, the customer is redirected to your shopperResultUrl along with a GET parameter resourcePath.
