public static final class MandateImportEntryService.MandateImportEntryCreateRequest extends PostRequest<MandateImportEntry>
Request class for MandateImportEntryService.create()
.
For an existing mandate import, this endpoint can be used to add individual mandates to be imported into GoCardless.
You can add no more than 30,000 rows to a single mandate import. If you attempt to go over this limit, the API will return a record_limit_exceeded
error.
Modifier and Type | Class and Description |
---|---|
static class |
MandateImportEntryService.MandateImportEntryCreateRequest.Amendment |
static class |
MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount |
static class |
MandateImportEntryService.MandateImportEntryCreateRequest.Customer |
static class |
MandateImportEntryService.MandateImportEntryCreateRequest.Links |
execute, executeWrapped
public MandateImportEntryService.MandateImportEntryCreateRequest withAmendment(MandateImportEntryService.MandateImportEntryCreateRequest.Amendment amendment)
public MandateImportEntryService.MandateImportEntryCreateRequest withAmendmentOriginalCreditorId(java.lang.String originalCreditorId)
The creditor identifier of the direct debit originator. Required if mandate import scheme is sepa
.
public MandateImportEntryService.MandateImportEntryCreateRequest withAmendmentOriginalCreditorName(java.lang.String originalCreditorName)
Data about the original mandate to be moved or modified.
public MandateImportEntryService.MandateImportEntryCreateRequest withAmendmentOriginalMandateReference(java.lang.String originalMandateReference)
The unique SEPA reference for the mandate being amended. Required if mandate import scheme is sepa
.
public MandateImportEntryService.MandateImportEntryCreateRequest withBankAccount(MandateImportEntryService.MandateImportEntryCreateRequest.BankAccount bankAccount)
public MandateImportEntryService.MandateImportEntryCreateRequest withBankAccountAccountHolderName(java.lang.String accountHolderName)
Name of the account holder, as known by the bank. Usually this matches the name of the linked customer. This field will be transliterated, upcased and truncated to 18 characters.
public MandateImportEntryService.MandateImportEntryCreateRequest withBankAccountAccountNumber(java.lang.String accountNumber)
Bank account number - see local details for more information. Alternatively you can provide an iban
.
public MandateImportEntryService.MandateImportEntryCreateRequest withBankAccountBankCode(java.lang.String bankCode)
Bank code - see local details for more information. Alternatively you can provide an iban
.
public MandateImportEntryService.MandateImportEntryCreateRequest withBankAccountBranchCode(java.lang.String branchCode)
Branch code - see local details for more information. Alternatively you can provide an iban
.
public MandateImportEntryService.MandateImportEntryCreateRequest withBankAccountCountryCode(java.lang.String countryCode)
ISO 3166-1 alpha-2 code. Defaults to the country code of the iban
if supplied, otherwise is required.
public MandateImportEntryService.MandateImportEntryCreateRequest withBankAccountIban(java.lang.String iban)
International Bank Account Number. Alternatively you can provide local details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you must supply local details.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomer(MandateImportEntryService.MandateImportEntryCreateRequest.Customer customer)
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerAddressLine1(java.lang.String addressLine1)
The first line of the customer’s address. Required if mandate import scheme is bacs
.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerAddressLine2(java.lang.String addressLine2)
The second line of the customer’s address.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerAddressLine3(java.lang.String addressLine3)
The third line of the customer’s address.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerCity(java.lang.String city)
The city of the customer’s address.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerCompanyName(java.lang.String companyName)
Customer’s company name. Required unless a given_name
and family_name
are provided.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerCountryCode(java.lang.String countryCode)
ISO 3166-1 alpha-2 code.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerDanishIdentityNumber(java.lang.String danishIdentityNumber)
For Danish customers only. The civic/company number (CPR or CVR) of the customer. Must be supplied if the customer’s bank account is denominated in Danish krone (DKK).
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerEmail(java.lang.String email)
Customer’s email address. Required in most cases, as this allows GoCardless to send notifications to this customer.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerFamilyName(java.lang.String familyName)
Customer’s surname. Required unless a company_name
is provided.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerGivenName(java.lang.String givenName)
Customer’s first name. Required unless a company_name
is provided.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerLanguage(java.lang.String language)
ISO 639-1 code. Used as the language for notification emails sent by GoCardless if your organisation does not send its own (see compliance requirements). Currently only “en”, “fr”, “de”, “pt”, “es”, “it”, “nl”, “da”, “nb”, “sl”, “sv” are supported. If this is not provided, the language will be chosen based on the country_code
(if supplied) or default to “en”.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerPostalCode(java.lang.String postalCode)
The customer’s postal code. Required if mandate import scheme is bacs
.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerRegion(java.lang.String region)
The customer’s address region, county or department.
public MandateImportEntryService.MandateImportEntryCreateRequest withCustomerSwedishIdentityNumber(java.lang.String swedishIdentityNumber)
For Swedish customers only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer’s bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
public MandateImportEntryService.MandateImportEntryCreateRequest withLinks(MandateImportEntryService.MandateImportEntryCreateRequest.Links links)
public MandateImportEntryService.MandateImportEntryCreateRequest withLinksMandateImport(java.lang.String mandateImport)
Unique identifier, beginning with “IM”.
public MandateImportEntryService.MandateImportEntryCreateRequest withRecordIdentifier(java.lang.String recordIdentifier)
A unique identifier for this entry, which you can use (once the import has been processed by GoCardless) to identify the records that have been created.
public MandateImportEntryService.MandateImportEntryCreateRequest withHeader(java.lang.String headerName, java.lang.String headerValue)