Recurring Payments functions
Recurring payments are multiple payments applied on the same account. This can be multiple debits, for example a monthly subscription fee, but we also support Funds Transfer which is an outgoing transfer from your account to a consumer account.
To do a recurring payment you must always start with a VaultCheckout. After successfully vaulting the consumer's account you can then do additional debits or transfers on this account by specifying the same ConsumerID using in the VaultCheckout.
Note that you must be specifically approved for using recurring payment functions by ICEPAY before you can use these functions.
Field level documentation of our API is available at our Apiary site. Although this site is primarily focused on our REST API the field level descriptions apply to all our API's.
This operation is called when you need to vault consumer information like a credit card or bank account number in order to perform an automatic checkout or Funds Transfer in the future. This operation is only available for payment methods iDeal and CreditCard. That information is stored after the above mentioned payment has been successfully completed. This operation MUST be called if a recurring payment or Funds Transfer in the future is desired.
The operation is similar to a standard Checkout but with one additional (required) parameter: ConsumerID. After the vault is successful you can then do additional operations using this ConsumerID.
This operation is called when is needed to perform an automatic checkout using the consumerID that is stored by a VaultCheckout. It is available for payment methods CreditCard and DirectDebit only. It must always be preceded by a succesfull VaultCheckout for the given ConsumerID.
This operation is called to perform a Funds Transfer using the consumerID that is stored by a VaultCheckout. A Funds Transfer is a way of transferring funds (back) to a Consumer on their payment method. It differs from a refund in that the transfer is not limited to the amount of the original order. It is available for payment method CreditCard only. It must always be preceded by a succesfull VaultCheckout for the given ConsumerID.