Method Detail

• getCreatedAt

  public java.lang.String getCreatedAt()

  Fixed timestamp, recording when this resource was created.

• getId

  public java.lang.String getId()

  Unique identifier, beginning with “MD”.

• getLinks

  public Mandate.Links getLinks()

• getMetadata

  public java.util.Map<java.lang.String,java.lang.String> getMetadata()

  Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.

• getNextPossibleChargeDate

  public java.lang.String getNextPossibleChargeDate()

  The earliest date a newly created payment for this mandate could be charged.

• getPaymentsRequireApproval

  public java.lang.Boolean getPaymentsRequireApproval()

  Boolean value showing whether payments and subscriptions under this mandate require approval via an automated email before being processed.

• getReference

  public java.lang.String getReference()

  Unique reference. Different schemes have different length and character set requirements. GoCardless will generate a unique reference satisfying the different scheme requirements if this field is left blank.

• getScheme

  public java.lang.String getScheme()

  Direct Debit scheme to which this mandate and associated payments are submitted. Can be supplied or automatically detected from the customer’s bank account. Currently “autogiro”, “bacs”, “becs”, “betalingsservice”, and “sepa_core” are supported.

• getStatus

  public Mandate.Status getStatus()

  One of:

  • pending_customer_approval: the mandate has not yet been signed by the second customer
  • pending_submission: the mandate has not yet been submitted to the customer’s bank
  • submitted: the mandate has been submitted to the customer’s bank but has not been processed yet
  • active: the mandate has been successfully set up by the customer’s bank
  • failed: the mandate could not be created
  • cancelled: the mandate has been cancelled
  • expired: the mandate has expired due to dormancy