Method Detail

• getCause

  public java.lang.String getCause()

  What triggered the event. Note: cause is our simplified and predictable key indicating what triggered the event.

• getDescription

  public java.lang.String getDescription()

  Human readable description of the cause. Note: Changes to event descriptions are not considered breaking.

• getOrigin

  public Event.Details.Origin getOrigin()

  Who initiated the event. One of:

  • bank: this event was triggered by a report from the banks
  • gocardless: this event was performed by GoCardless automatically
  • api: this event was triggered by an API endpoint
  • customer: this event was triggered by a Customer

• getReasonCode

  public java.lang.String getReasonCode()

  Set when a bank is the origin of the event. This is the reason code received in the report from the customer’s bank. See the GoCardless Direct Debit guide for information on the meanings of different reason codes. Note: reason_code is payment scheme-specific and can be inconsistent between banks.

• getScheme

  public Event.Details.Scheme getScheme()

  A Direct Debit scheme. Set when a bank is the origin of the event.