Topup card
A topup card is a way for your customer to credit money on their account directly from a debit/credit card. There are different methods to do a topup.
Xpollens shop integration
Like in e-commerce experience, you need a shop and a payment form. Xpollens create a shop for you and use a Dalenys hosted-field payment form to make the customer enter its card datas.
Topup workflow
Hosted fields with Dalenys
In this picture, Xpollens is your shop.
Principle
- You display a payment page including a registration form, except that the bankcard input fields are replaced by hosted-fields containers. These containers could be any HTML tag: div, p, span… the hosted-fields JavaScript library injects Dalenys-hosted iframes in these containers, each containing the card data input fields.
- At the submit process, you should call the createToken method of the hosted-fields library which will trigger the tokenization of the cardholder data (card number, expiry date and cryptogram).
- If the tokenization is successful, you must add the received token to your form submission request (e.g. by adding a hidden input).
Creation of the form
You must own a TLS certificate to host a valid HTTPS payment page, otherwise the user’s browser will display security alerts and is likely to block it. The hosted-fields library must always be called online. Using a downloaded version hosted on your own server can cause serious malfunctions, especially in the case of an update of the API.
1- First, you must include the Dalenys hosted fields dedicated library, by adding code between the tags in your HTML:
2- Declare the UTF-8 encoding
3- Create a form with 4 containers identified by an id attribute.
4- Configure the hosted fields library
5- Load the hosted fields library
At this point, your web browser may display the bank card input fields into their containers.
6- Token generation Once the user submits the form, you should call the createToken method to trigger the tokenization process. In case of success you have to add the received token to the form submit request (by adding an hidden input for example) :
More information regarding this endpoint in the hosted fields by Dalenys.
Features with Xpollens shop
Create a topup with 3DSv2
Create a top up with 3DSV2
I want to use my own credit card to load my account. I enter all the details of my card (PAN, Date, CVV2 : i.e. 23char) like a classic e-commerce payment to make it. Since PSD2, except in exceptional cases, a strong customer authentication request (challenge) is systematically made (3DS). Without authorization request process can't be done. Each time I perform a TopUP in this way, the card bank is likely to ask me for a challenge.
Card registration during payment
To register the bank card during payment, you must, in the body of the request, in the "Card" parameter, specify the "AppCardId" parameter. It will be this "AppCardId" which will be called later for the top up oneclik. If there is no need to register the bank card during payment, then you should not specify "AppCardId". This parameter is optional.
Top up Oneclick with 3DSV2
To create a top up oneclick, you must, in the body of the request, add and fill in the "AppCardId" parameter instead of the "HFToken" parameter". This will allow you to directly call the previously registered bank card.
Endpoint
More information regarding this endpoint in the API reference.
Get all registered banks cards
The service is used to retrieve all existing bank cards already registered for a dedicated user. All information associated to the card will be displayed
Endpoint
More information regarding this endpoint in the API reference.
Get all top up
This endpoint is used by a dedicated user, to consult the list of top up operations, executed from his Xpollens account.
Endpoint
More information regarding this endpoint in the API reference.
Get top up by orderId
This endpoint is used by a dedicated user, to consult a specific top up operation, by the orderid.
Endpoint
More information regarding this endpoint in the API reference.
Refund a top up
A refund operation enables you to credit funds back to a end-user following a previous debit. A refund transaction is always linked to a successsful payment or capture transaction which it requires the original TOP UP.
This endpoint is used to refund a top up. It is possible to fully or partially refund an operation. You can refund several times a same debit transaction, but the sum of all the refund operations can’t be higher that the original debit amount.
By using this feature, the bank card holder will be refunded directly to his bank card, and the Xpollens account will be debited for the amount to be refunded. If there was a fee charged during the topup, then the fee will also be refunded to the bank card holder, and the Xpollens Partner's commission account will be debited with the amount of the commission to be refunded.
The amount of a refund transaction can be different from the original debit transaction but can not be higher. So the amount specified in the body of the request corresponds to the amount to be refund. The fee specified in the body of the request corresponds to the fee to be refund. Each amount must be less than or equal to the initial amount of the topup.
The orderid specified in the body of the request corresponds to a new orderid designating the refund operation.
Endpoint
More information regarding this endpoint in the API reference.