Method Detail

• withDescription

  public RedirectFlowService.RedirectFlowCreateRequest withDescription(java.lang.String description)

  A description of the item the customer is paying for. This will be shown on the hosted payment pages.

• withLinks

  public RedirectFlowService.RedirectFlowCreateRequest withLinks(RedirectFlowService.RedirectFlowCreateRequest.Links links)

• withLinksCreditor

  public RedirectFlowService.RedirectFlowCreateRequest withLinksCreditor(java.lang.String creditor)

  The creditor for whom the mandate will be created. The name of the creditor will be displayed on the payment page. Required if your account manages multiple creditors.

• withPrefilledCustomer

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomer(RedirectFlowService.RedirectFlowCreateRequest.PrefilledCustomer prefilledCustomer)

  Information used to prefill the payment page so your customer doesn’t have to re-type details you already hold about them. It will be stored unvalidated and the customer will be able to review and amend it before completing the form.

• withPrefilledCustomerAddressLine1

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerAddressLine1(java.lang.String addressLine1)

  The first line of the customer’s address.

• withPrefilledCustomerAddressLine2

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerAddressLine2(java.lang.String addressLine2)

  The second line of the customer’s address.

• withPrefilledCustomerAddressLine3

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerAddressLine3(java.lang.String addressLine3)

  The third line of the customer’s address.

• withPrefilledCustomerCity

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerCity(java.lang.String city)

  The city of the customer’s address.

• withPrefilledCustomerCompanyName

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerCompanyName(java.lang.String companyName)

  Customer’s company name.

• withPrefilledCustomerCountryCode

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerCountryCode(java.lang.String countryCode)

  ISO 3166-1 alpha-2 code.

• withPrefilledCustomerDanishIdentityNumber

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerDanishIdentityNumber(java.lang.String danishIdentityNumber)

  For Danish customers only. The civic/company number (CPR or CVR) of the customer.

• withPrefilledCustomerEmail

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerEmail(java.lang.String email)

  Customer’s email address.

• withPrefilledCustomerFamilyName

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerFamilyName(java.lang.String familyName)

  Customer’s surname.

• withPrefilledCustomerGivenName

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerGivenName(java.lang.String givenName)

  Customer’s first name.

• withPrefilledCustomerLanguage

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerLanguage(java.lang.String language)

  ISO 639-1 code.

• withPrefilledCustomerPostalCode

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerPostalCode(java.lang.String postalCode)

  The customer’s postal code.

• withPrefilledCustomerRegion

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerRegion(java.lang.String region)

  The customer’s address region, county or department.

• withPrefilledCustomerSwedishIdentityNumber

  public RedirectFlowService.RedirectFlowCreateRequest withPrefilledCustomerSwedishIdentityNumber(java.lang.String swedishIdentityNumber)

  For Swedish customers only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer.

• withScheme

  public RedirectFlowService.RedirectFlowCreateRequest withScheme(RedirectFlowService.RedirectFlowCreateRequest.Scheme scheme)

  The Direct Debit scheme of the mandate. If specified, the payment pages will only allow the set-up of a mandate for the specified scheme. It is recommended that you leave this blank so the most appropriate scheme is picked based on the customer’s bank account.

• withSessionToken

  public RedirectFlowService.RedirectFlowCreateRequest withSessionToken(java.lang.String sessionToken)

  The customer’s session ID must be provided when the redirect flow is set up and again when it is completed. This allows integrators to ensure that the user who was originally sent to the GoCardless payment pages is the one who has completed them.

• withSuccessRedirectUrl

  public RedirectFlowService.RedirectFlowCreateRequest withSuccessRedirectUrl(java.lang.String successRedirectUrl)

  The URL to redirect to upon successful mandate setup. You must use a URL beginning https in the live environment.

• withIdempotencyKey

  public RedirectFlowService.RedirectFlowCreateRequest withIdempotencyKey(java.lang.String idempotencyKey)

• withHeader

  public RedirectFlowService.RedirectFlowCreateRequest withHeader(java.lang.String headerName,
                                                         java.lang.String headerValue)