public static final class BankDetailsLookupService.BankDetailsLookupCreateRequest extends PostRequest<BankDetailsLookup>
Request class for BankDetailsLookupService.create()
.
Performs a bank details lookup. As part of the lookup, a modulus check and reachability check are performed.
If your request returns an error or the available_debit_schemes
attribute is an empty array, you will not be able to collect payments from the specified bank account. GoCardless may be able to collect payments from an account even if no bic
is returned.
Bank account details may be supplied using local details or an IBAN.
Note: Usage of this endpoint is monitored. If your organisation relies on GoCardless for modulus or reachability checking but not for payment collection, please get in touch.
Modifier and Type | Method and Description |
---|---|
BankDetailsLookupService.BankDetailsLookupCreateRequest |
withAccountNumber(java.lang.String accountNumber)
Bank account number - see local details for more information.
|
BankDetailsLookupService.BankDetailsLookupCreateRequest |
withBankCode(java.lang.String bankCode)
Bank code - see local details for more information.
|
BankDetailsLookupService.BankDetailsLookupCreateRequest |
withBranchCode(java.lang.String branchCode)
Branch code - see local details for more information.
|
BankDetailsLookupService.BankDetailsLookupCreateRequest |
withCountryCode(java.lang.String countryCode)
ISO 3166-1 alpha-2 code.
|
BankDetailsLookupService.BankDetailsLookupCreateRequest |
withHeader(java.lang.String headerName,
java.lang.String headerValue) |
BankDetailsLookupService.BankDetailsLookupCreateRequest |
withIban(java.lang.String iban)
International Bank Account Number.
|
execute, executeWrapped
public BankDetailsLookupService.BankDetailsLookupCreateRequest withAccountNumber(java.lang.String accountNumber)
Bank account number - see local details for more information. Alternatively you can provide an iban
.
public BankDetailsLookupService.BankDetailsLookupCreateRequest withBankCode(java.lang.String bankCode)
Bank code - see local details for more information. Alternatively you can provide an iban
.
public BankDetailsLookupService.BankDetailsLookupCreateRequest withBranchCode(java.lang.String branchCode)
Branch code - see local details for more information. Alternatively you can provide an iban
.
public BankDetailsLookupService.BankDetailsLookupCreateRequest withCountryCode(java.lang.String countryCode)
ISO 3166-1 alpha-2 code. Must be provided if specifying local details.
public BankDetailsLookupService.BankDetailsLookupCreateRequest withIban(java.lang.String iban)
International Bank Account Number. Alternatively you can provide local details.
public BankDetailsLookupService.BankDetailsLookupCreateRequest withHeader(java.lang.String headerName, java.lang.String headerValue)