Last updated
Last updated
Tokenization allows you to store payment data for later use. This can be useful for recurring payment scenarios.
This guide will describe how you can store account details using COPYandPAY and how you can subsequently use the stored account details.
the payment data
the payment data
COPYandPAY provides two options for storing the payment data:
: When a shopper is checking out for the first time, he has to fill in his complete payment- and address data. Use this option to automatically store his data during the payment for reuse in later transactions.
: If your site provides shoppers with an administrative area where they can register their payment details independent of a checkout-process, this option is for you.
You have two options for achieving this:
During the checkout process you can store the data by adding an additional parameter to the normal prepare checkout request as described in :
With COPYandPAY it is also possible to create a just registration separate from any later payment.
A registration-only transaction with COPYandPAY is basically using the same workflow and parameters as a payment.
createRegistration=true
has to be sent.
paymentType
should not be sent.
Now COPYandPAY automatically adapts the workflow for handling a registration:
IMPORTANT: The baseUrl (that is prepended to the resourcePath) must end in a "/", e.g. "https://test.oppwa.com/".
Based on the stored account details, recurring payments become very simple to achieve.
For the initial payment request you should send the recurringType
with value INITIAL
.
For any subsequent payment you should send the recurringType
with value REPEATED
.
After the account holder has filled in their account information and are redirected back to your shopperResultUrl
, you can retrieve the response information as usual (). This time, however, the response will include a registrationId
(token) and useful card information that you can store.
When the payment form is displayed as described in , you can extend the form to display an option to your customer that allows him store his account data.
This can be achieved very easily by using the . You can see an example implementation of this in the "store payment details" use case that is part of the tutorial.
After the account holder has filled in his account information and was redirected to the shopperResultUrl
, you can retrieve the response information as usual (). This time, however, the response will include a registrationId
(token) and useful card information that you can store for future requests.
You only have to change two parameters in :
In COPYandPAY will render the payment form as usual, but send the form to https://{test.}oppwa.com/v1/checkouts/{checkoutId}/
registration
In you'll get back a resourcePath pointing to you to query for a registration's result: resourcePath=/v1/checkouts/{checkoutId}/
registration
All you need to do is to add the parameter recurringType
to your request to the /v1/checkouts endpoint (see ):