Constructor Detail

• MandateService

  public MandateService(HttpClient httpClient)

  Constructor. Users of this library should have no need to call this - an instance of this class can be obtained by calling GoCardlessClient.mandates().

Method Detail

• create

  public MandateService.MandateCreateRequest create()

  Creates a new mandate object.

• list

  public MandateService.MandateListRequest<ListResponse<Mandate>> list()

  Returns a cursor-paginated list of your mandates.

• all

  public MandateService.MandateListRequest<java.lang.Iterable<Mandate>> all()

• get

  public MandateService.MandateGetRequest get(java.lang.String identity)

  Retrieves the details of an existing mandate.

• update

  public MandateService.MandateUpdateRequest update(java.lang.String identity)

  Updates a mandate object. This accepts only the metadata parameter.

• cancel

  public MandateService.MandateCancelRequest cancel(java.lang.String identity)

  Immediately cancels a mandate and all associated cancellable payments. Any metadata supplied to this endpoint will be stored on the mandate cancellation event it causes.

  This will fail with a cancellation_failed error if the mandate is already cancelled.

• reinstate

  public MandateService.MandateReinstateRequest reinstate(java.lang.String identity)

  Reinstates a cancelled or expired mandate to the banks. You will receive a resubmission_requested webhook, but after that reinstating the mandate follows the same process as its initial creation, so you will receive a submitted webhook, followed by a reinstated or failed webhook up to two working days later. Any metadata supplied to this endpoint will be stored on the resubmission_requested event it causes.

  This will fail with a mandate_not_inactive error if the mandate is already being submitted, or is active.

  Mandates can be resubmitted up to 3 times.