API Reference
Start typing to search…

Card on File


Card on File is a convenient payment solution that allows you to securely store a shopper’s card details for future transactions. This document provides detailed information on what Card on File is, the benefits it offers, and how to integrate it into your system.

What is it

Card on File allows shoppers to securely store their card details on your website for future transactions. This functionality is especially valuable for streamlining repeat purchases and improving the overall shopping experience, as it removes the need for shoppers to re-enter their card information each time they check out. This feature supports major card brands, including Visa, Mastercard, VPay, and Maestro.

Why use it

  • Convenience for Shoppers: Shoppers can save their card details for future use, making repeat purchases faster and more convenient.
  • Boost Conversion Rates: Simplifying the payment process can lead to higher conversion rates as fewer steps reduce the likelihood of cart abandonment.
  • Enhance Shopper Loyalty: A seamless and efficient checkout experience encourages repeat business and builds long-term shopper loyalty.
  • Secure and Compliant: Card details are stored securely, ensuring compliance with industry standards and protecting shopper data.

Shopper flow

Initial payment

  1. Start card payment: After the shopper selects the checkout option on your webshop, they are redirected to the Rabo Smart Pay checkout page to complete their purchase using a card.

  2. Enter card details & save card: The shopper enters their card number, expiration date, and CVC, and checks the box to save the card details for future use.

  3. Complete transaction: The shopper confirms the payment and sees the success screen, after which they are returned to your webshop.

Subsequent payment

  1. Start checkout: If the shopper has previously saved their card details, the stored card will automatically appear during a subsequent purchase, streamlining the checkout process. However, they can always opt for a different payment method if they wish.

  2. Complete Card on File transaction: The shopper can directly choose to pay with the stored card and sees the success screen, after which they are returned to your webshop.

Configuration

You can activate Card on File directly through your self-service dashboard in just a few clicks:

  1. Path Self service → My business → Manage webshop → Webshop payment methods → Edit

  2. Enable Card on File by checking the box for the selected webshop.

Integration

API integration

If you use direct API integration, you’ll need to make adjustments in the order announcement. Additionally, a set of APIs is provided to manage the stored payment details

Order announcement

Card on File is available only through the new API domain: https://api.pay.rabobank.nl/

To enable Card on File, announce orders using the Create Order Announcement endpoint and include these parameters:

  • EnableCardOnFile: This boolean is set to ‘False’ by default. Set this to ‘True’ to enable storing and using stored cards. When set to ‘True’, both the shopperRef and the email address must also be provided.
  • shopperRef: Required for Card on File transactions. This should be the parameter that uniquely identifies the shopper within your own environment. When a card is stored, it is tied to the provided shopperRef. Stored cards can later be retrieved using the same shopperRef during subsequent payments.
  • Email address: Required for Card on File transactions.

Retrieve and remove stored cards

To manage stored cards for a shopper, use the following Card on File endpoints:

  • Retrieve stored cards Use the GET /v1/shopper-payment-details endpoint to fetch all stored cards associated with a specific shopper. This is useful for displaying saved cards or enabling a card management feature.
  • Remove a stored card Use the DELETE /v1/shopper-payment-details/ endpoint to delete a stored card, either at the shopper’s request or as part of a card management feature.

SDK integration

Card on File functionality is included in the Java SDKs; the .NET and PHP SDKs will be updated soon. If you use the SDK, please visit the SDK git.

Plugin integration

Card on File functionality is included in most plugins. Enable Card on File by using the latest version of the plugin. Go to the settings to turn the Card on File functionality on. If Card on File is not supported or you experience issues, reach out to https://payocity.nl/nl/contact.