Package com.onlinepayments.domain

Class CreateMandateRequest

java.lang.Object
com.onlinepayments.domain.CreateMandateRequest
public class CreateMandateRequest extends Object

  • Constructor Details

    • CreateMandateRequest

      public CreateMandateRequest()

  • Method Details

    • getAlias

      public String getAlias()
      An alias for the mandate. This can be used to visually represent the mandate. Do not include any unmasked sensitive data in the alias. If this field is not provided the masked IBAN of the customer is used.

    • setAlias

      public void setAlias(String value)
      An alias for the mandate. This can be used to visually represent the mandate. Do not include any unmasked sensitive data in the alias. If this field is not provided the masked IBAN of the customer is used.

    • withAlias

      public CreateMandateRequest withAlias(String value)
      An alias for the mandate. This can be used to visually represent the mandate. Do not include any unmasked sensitive data in the alias. If this field is not provided the masked IBAN of the customer is used.

    • getCustomer

      public MandateCustomer getCustomer()
      Customer object containing customer specific inputs. Required for Create mandate and Create payment calls.

    • setCustomer

      public void setCustomer(MandateCustomer value)
      Customer object containing customer specific inputs. Required for Create mandate and Create payment calls.

    • withCustomer

      public CreateMandateRequest withCustomer(MandateCustomer value)
      Customer object containing customer specific inputs. Required for Create mandate and Create payment calls.

    • getCustomerReference

      public String getCustomerReference()
      The unique identifier of a customer

    • setCustomerReference

      public void setCustomerReference(String value)
      The unique identifier of a customer

    • withCustomerReference

      public CreateMandateRequest withCustomerReference(String value)
      The unique identifier of a customer

    • getLanguage

      public String getLanguage()
      The language code of the customer. ISO 639-1, possible values are:
      • de
      • en
      • es
      • fr
      • it
      • nl
      • si
      • sk
      • sv

    • setLanguage

      public void setLanguage(String value)
      The language code of the customer. ISO 639-1, possible values are:
      • de
      • en
      • es
      • fr
      • it
      • nl
      • si
      • sk
      • sv

    • withLanguage

      public CreateMandateRequest withLanguage(String value)
      The language code of the customer. ISO 639-1, possible values are:
      • de
      • en
      • es
      • fr
      • it
      • nl
      • si
      • sk
      • sv

    • getRecurrenceType

      public String getRecurrenceType()
      Specifies whether the mandate is for one-off or recurring payments. Possible values are:
      • UNIQUE
      • RECURRING

    • setRecurrenceType

      public void setRecurrenceType(String value)
      Specifies whether the mandate is for one-off or recurring payments. Possible values are:
      • UNIQUE
      • RECURRING

    • withRecurrenceType

      public CreateMandateRequest withRecurrenceType(String value)
      Specifies whether the mandate is for one-off or recurring payments. Possible values are:
      • UNIQUE
      • RECURRING

    • getReturnUrl

      public String getReturnUrl()
      Return URL to use if the mandate signing requires redirection. Required for S2S Create Payment if and only if the signatureType is "SMS".

    • setReturnUrl

      public void setReturnUrl(String value)
      Return URL to use if the mandate signing requires redirection. Required for S2S Create Payment if and only if the signatureType is "SMS".

    • withReturnUrl

      public CreateMandateRequest withReturnUrl(String value)
      Return URL to use if the mandate signing requires redirection. Required for S2S Create Payment if and only if the signatureType is "SMS".

    • getSignatureType

      public String getSignatureType()
      Specifies whether the mandate is tick box, unsigned or signed by SMS. Possible values are:
      • UNSIGNED
      • SMS
      • TICK_BOX - This option is only available for Equens Worldline

    • setSignatureType

      public void setSignatureType(String value)
      Specifies whether the mandate is tick box, unsigned or signed by SMS. Possible values are:
      • UNSIGNED
      • SMS
      • TICK_BOX - This option is only available for Equens Worldline

    • withSignatureType

      public CreateMandateRequest withSignatureType(String value)
      Specifies whether the mandate is tick box, unsigned or signed by SMS. Possible values are:
      • UNSIGNED
      • SMS
      • TICK_BOX - This option is only available for Equens Worldline

    • getUniqueMandateReference

      public String getUniqueMandateReference()
      The unique identifier of the mandate

    • setUniqueMandateReference

      public void setUniqueMandateReference(String value)
      The unique identifier of the mandate

    • withUniqueMandateReference

      public CreateMandateRequest withUniqueMandateReference(String value)
      The unique identifier of the mandate