public static final class MandatePdfService.MandatePdfCreateRequest extends PostRequest<MandatePdf>
Request class for MandatePdfService.create().
Generates a PDF mandate and returns its temporary URL.
Customer and bank account details can be left blank (for a blank mandate), provided manually, or inferred from the ID of an existing mandate.
By default, we’ll generate PDF mandates in English.
To generate a PDF mandate in another language, set the Accept-Language header when creating the PDF mandate to the relevant ISO 639-1 language code supported for the scheme.
| Scheme | Supported languages |
|---|---|
:——————————————————————————————————————————————- | | Autogiro | English (en), Swedish (sv)
| | Bacs | English (en)
| | Becs | English (en)
| | Betalingsservice | Danish (da), English (en)
| | SEPA Core | Danish (da), Dutch (nl), English (en), French (fr), German (de), Italian (it), Portuguese (pt), Spanish (es), Swedish (sv) |
| Modifier and Type | Class and Description |
|---|---|
static class |
MandatePdfService.MandatePdfCreateRequest.Links |
| Modifier and Type | Method and Description |
|---|---|
MandatePdfService.MandatePdfCreateRequest |
withAccountHolderName(java.lang.String accountHolderName)
Name of the account holder, as known by the bank.
|
MandatePdfService.MandatePdfCreateRequest |
withAccountNumber(java.lang.String accountNumber)
Bank account number - see local details for more information.
|
MandatePdfService.MandatePdfCreateRequest |
withAddressLine1(java.lang.String addressLine1)
The first line of the customer’s address.
|
MandatePdfService.MandatePdfCreateRequest |
withAddressLine2(java.lang.String addressLine2)
The second line of the customer’s address.
|
MandatePdfService.MandatePdfCreateRequest |
withAddressLine3(java.lang.String addressLine3)
The third line of the customer’s address.
|
MandatePdfService.MandatePdfCreateRequest |
withBankCode(java.lang.String bankCode)
Bank code - see local details for more information.
|
MandatePdfService.MandatePdfCreateRequest |
withBic(java.lang.String bic)
SWIFT BIC.
|
MandatePdfService.MandatePdfCreateRequest |
withBranchCode(java.lang.String branchCode)
Branch code - see local details for more information.
|
MandatePdfService.MandatePdfCreateRequest |
withCity(java.lang.String city)
The city of the customer’s address.
|
MandatePdfService.MandatePdfCreateRequest |
withCountryCode(java.lang.String countryCode)
ISO 3166-1 alpha-2 code.
|
MandatePdfService.MandatePdfCreateRequest |
withDanishIdentityNumber(java.lang.String danishIdentityNumber)
For Danish customers only.
|
MandatePdfService.MandatePdfCreateRequest |
withHeader(java.lang.String headerName,
java.lang.String headerValue) |
MandatePdfService.MandatePdfCreateRequest |
withIban(java.lang.String iban)
International Bank Account Number.
|
MandatePdfService.MandatePdfCreateRequest |
withLinks(MandatePdfService.MandatePdfCreateRequest.Links links) |
MandatePdfService.MandatePdfCreateRequest |
withLinksMandate(java.lang.String mandate)
ID of an existing mandate to build the PDF from.
|
MandatePdfService.MandatePdfCreateRequest |
withMandateReference(java.lang.String mandateReference)
Unique 6 to 18 character reference.
|
MandatePdfService.MandatePdfCreateRequest |
withPostalCode(java.lang.String postalCode)
The customer’s postal code.
|
MandatePdfService.MandatePdfCreateRequest |
withRegion(java.lang.String region)
The customer’s address region, county or department.
|
MandatePdfService.MandatePdfCreateRequest |
withScheme(java.lang.String scheme)
Direct Debit scheme.
|
MandatePdfService.MandatePdfCreateRequest |
withSignatureDate(java.lang.String signatureDate)
If provided, a form will be generated with this date and no signature field.
|
MandatePdfService.MandatePdfCreateRequest |
withSwedishIdentityNumber(java.lang.String swedishIdentityNumber)
For Swedish customers only.
|
execute, executeWrappedpublic MandatePdfService.MandatePdfCreateRequest withAccountHolderName(java.lang.String accountHolderName)
Name of the account holder, as known by the bank. Usually this matches the name of the customer. This field cannot exceed 18 characters.
public MandatePdfService.MandatePdfCreateRequest withAccountNumber(java.lang.String accountNumber)
Bank account number - see local details for more information. Alternatively you can provide an iban.
public MandatePdfService.MandatePdfCreateRequest withAddressLine1(java.lang.String addressLine1)
The first line of the customer’s address.
public MandatePdfService.MandatePdfCreateRequest withAddressLine2(java.lang.String addressLine2)
The second line of the customer’s address.
public MandatePdfService.MandatePdfCreateRequest withAddressLine3(java.lang.String addressLine3)
The third line of the customer’s address.
public MandatePdfService.MandatePdfCreateRequest withBankCode(java.lang.String bankCode)
Bank code - see local details for more information. Alternatively you can provide an iban.
public MandatePdfService.MandatePdfCreateRequest withBic(java.lang.String bic)
SWIFT BIC. Will be derived automatically if a valid iban or local details are provided.
public MandatePdfService.MandatePdfCreateRequest withBranchCode(java.lang.String branchCode)
Branch code - see local details for more information. Alternatively you can provide an iban.
public MandatePdfService.MandatePdfCreateRequest withCity(java.lang.String city)
The city of the customer’s address.
public MandatePdfService.MandatePdfCreateRequest withCountryCode(java.lang.String countryCode)
ISO 3166-1 alpha-2 code. Required if providing local details.
public MandatePdfService.MandatePdfCreateRequest withDanishIdentityNumber(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). Can only be supplied for Betalingsservice mandates.
public MandatePdfService.MandatePdfCreateRequest withIban(java.lang.String iban)
International Bank Account Number. Alternatively you can provide local details. IBANs cannot be provided for Autogiro mandates.
public MandatePdfService.MandatePdfCreateRequest withLinks(MandatePdfService.MandatePdfCreateRequest.Links links)
public MandatePdfService.MandatePdfCreateRequest withLinksMandate(java.lang.String mandate)
ID of an existing mandate to build the PDF from. The customer’s bank details will be censored in the generated PDF. No other parameters may be provided alongside this.
public MandatePdfService.MandatePdfCreateRequest withMandateReference(java.lang.String mandateReference)
Unique 6 to 18 character reference. This may be left blank at the point of signing.
public MandatePdfService.MandatePdfCreateRequest withPostalCode(java.lang.String postalCode)
The customer’s postal code.
public MandatePdfService.MandatePdfCreateRequest withRegion(java.lang.String region)
The customer’s address region, county or department.
public MandatePdfService.MandatePdfCreateRequest withScheme(java.lang.String scheme)
Direct Debit scheme. Can be supplied or automatically detected from the bank account details provided. If you do not provide a scheme, you must provide either a mandate, an iban, or local details including a country_code.
public MandatePdfService.MandatePdfCreateRequest withSignatureDate(java.lang.String signatureDate)
If provided, a form will be generated with this date and no signature field.
public MandatePdfService.MandatePdfCreateRequest withSwedishIdentityNumber(java.lang.String swedishIdentityNumber)
For Swedish customers only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Can only be supplied for Autogiro mandates.
public MandatePdfService.MandatePdfCreateRequest withHeader(java.lang.String headerName, java.lang.String headerValue)