Migrate from deprecated Redirect Flows to Billing Requests (blocked on gocardless-pro SDK upgrade)

Open
#46 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
18/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Quiet
Tech stack
java
Domain
payments

Research direction

The work lives in src/main/java/org/killbill/billing/plugin/gocardless/GoCardlessPaymentPluginApi.java: buildFormDescriptor around L403 and addPaymentMethod around L332 both call redirectFlows(). Start by confirming which gocardless-pro release on Maven Central exposes BillingRequestService, because pom.xml pins 3.10.0 and nothing can be written until that upgrade lands. Done when a mandate is created and completed through Billing Requests, the optional scheme parameter is wired through /checkout, countryCode is prefilled in buildCustomer, and the README walkthrough no longer documents Redirect Flows.

Written by the indexing model from the issue text.

Description

Problem

The plugin sets up mandates using the Redirect Flows API:

  • created in buildFormDescriptor — L403
  • completed in addPaymentMethod — L332

GoCardless has deprecated Redirect Flows in favour of Billing Requests. Redirect Flows are closed to new integrators and are slated for eventual withdrawal for existing ones.

Why this matters

A new GoCardless customer cannot use this plugin at all. They have no access to the Redirect Flows API, so buildFormDescriptor fails on the first call. This is not a future risk — it is the current state for anyone signing up today.

Existing integrators are on borrowed time, with no published withdrawal date.

Blocked by the pinned SDK

pom.xml pins com.gocardless:gocardless-pro:3.10.0, which predates Billing Requests entirely. The services in that jar are:

BankDetailsLookup, Creditor, CreditorBankAccount, Customer, CustomerBankAccount,
CustomerNotification, Event, Mandate, MandateImport, MandateImportEntry, MandatePdf,
Payment, Payout, PayoutItem, RedirectFlow, Refund, Subscription

There is no BillingRequestService. The SDK upgrade is a prerequisite, not an afterthought.

Also missing: scheme selection

While in this code path — the redirect flow is created without a scheme:

buildGoCardlessClient(context).redirectFlows().create()
    .withDescription(redirectFlowDescription)
    .withSessionToken(sessionToken)
    .withSuccessRedirectUrl(successRedirectUrl)
    .withPrefilledCustomer(customer).execute();

RedirectFlowCreateRequest.withScheme(...) exists in the SDK (ach, autogiro, bacs, becs, becs_nz, betalingsservice, pad, sepa_core) and is never called, so the scheme cannot be constrained — GoCardless infers it from whatever bank details the customer types. Leaving it unset is a defensible default, but it should be an option rather than an omission. Relatedly, buildCustomer does not prefill countryCode, which is one of the signals that drives the hosted page.

Proposed work

  1. Upgrade gocardless-pro to a version exposing Billing Requests.
  2. Reimplement buildFormDescriptor to create a Billing Request + Billing Request Flow and return the authorisation_url.
  3. Reimplement addPaymentMethod to complete against the Billing Request and extract the resulting mandate.
  4. Expose an optional scheme parameter through /checkout and buildFormDescriptor, defaulting to unset.
  5. Prefill countryCode in buildCustomer.
  6. Update the README — the current walkthrough documents the Redirect Flow endpoints and uses a US routing number / checking account as its worked example.

Interacts with #45: Billing Requests are also the path to multiple mandates per customer.

Dominant language
Java
Stars
4
Forks
7
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from killbill/killbill-gocardless-plugin

All issues in killbill/killbill-gocardless-plugin

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.