Skip to end of metadata
Go to start of metadata

The parameter group contains data of a recurring payment (Credentials on File).

  • Parameters
  • Server API Error Messages
  • Examples

Parameters

If a parameter in this list is marked as required, it means that this parameter is required in case you want to process a recurring payment. Otherwise, these parameters are not required for single payments. This use case will be set with the existing parameter "recurrence" and will be documented separately.


Parameter

RequiredComments
credentialsonfile_recurring_frequency+

Specifies the number of days between authorizations


Format

NUMERIC
credentialsonfile_recurring_start_date-

Determines the date of the first authorization according to the recurring mandate


Format

DATE(8), YYYYMMDD
credentialsonfile_recurring_expiry_date+

Date after which no further authorizations should be processed.


Format

DATE(8), YYYYMMDD
initial_payment

+

Indicates whether a card transaction with stored data is the first transaction in a series or a subsequent transaction


Format

LIST

Permitted Values

true
false

Server API Error Messages

No.

Signification

2550Parameter {credentialsonfile_recurring_frequency} incorrect or missing
2551Parameter {credentialsonfile_recurring_start_date} incorrect
2552Parameter {credentialsonfile_recurring_expiry_date} incorrect or missing
2553Parameter {initial_payment} incorrect or missing


Examples

Server API

credentialsonfile_recurring_frequency=30
credentialsonfile_recurring_start_date=20200101
credentialsonfile_recurring_expiry_date=20210101
initial_payment=false

  • No labels