Constructor Detail

• PaymentService

  public PaymentService(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.payments().

Method Detail

• create

  public PaymentService.PaymentCreateRequest create()

  Creates a new payment object.

  This fails with a mandate_is_inactive error if the linked mandate is cancelled or has failed. Payments can be created against mandates with status of: pending_customer_approval, pending_submission, submitted, and active.

• list

  public PaymentService.PaymentListRequest<ListResponse<Payment>> list()

  Returns a cursor-paginated list of your payments.

• all

  public PaymentService.PaymentListRequest<java.lang.Iterable<Payment>> all()

• get

  public PaymentService.PaymentGetRequest get(java.lang.String identity)

  Retrieves the details of a single existing payment.

• update

  public PaymentService.PaymentUpdateRequest update(java.lang.String identity)

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

• cancel

  public PaymentService.PaymentCancelRequest cancel(java.lang.String identity)

  Cancels the payment if it has not already been submitted to the banks. Any metadata supplied to this endpoint will be stored on the payment cancellation event it causes.

  This will fail with a cancellation_failed error unless the payment’s status is pending_submission.

• retry

  public PaymentService.PaymentRetryRequest retry(java.lang.String identity)

  Retries a failed payment if the underlying mandate is active. You will receive a resubmission_requested webhook, but after that retrying the payment follows the same process as its initial creation, so you will receive a submitted webhook, followed by a confirmed or failed event. Any metadata supplied to this endpoint will be stored against the payment submission event it causes.

  This will return a retry_failed error if the payment has not failed.

  Payments can be retried up to 3 times.