public class MandateImportEntryService
extends java.lang.Object
Service class for working with mandate import entry resources.
Mandate Import Entries are added to a Mandate Import. Each entry corresponds to one mandate to be imported into GoCardless.
To import a mandate you will need:
We suggest you provide a record_identifier (which is unique within the context of a single mandate import) to help you to identify mandates that have been created once the import has been processed by GoCardless. You can list the mandate import entries, match them up in your system using the record_identifier, and look at the links fields to find the mandate, customer and customer bank account that have been imported.
Restricted: This API is currently only available for approved integrators - please get in touch if you would like to use this API.
| Modifier and Type | Class and Description |
|---|---|
static class |
MandateImportEntryService.MandateImportEntryCreateRequest
Request class for
create(). |
static class |
MandateImportEntryService.MandateImportEntryListRequest<S>
Request class for
list(). |
| Constructor and Description |
|---|
MandateImportEntryService(HttpClient httpClient)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
MandateImportEntryService.MandateImportEntryListRequest<java.lang.Iterable<MandateImportEntry>> |
all() |
MandateImportEntryService.MandateImportEntryCreateRequest |
create()
For an existing mandate import, this endpoint can be used to add individual mandates to be imported into GoCardless.
|
MandateImportEntryService.MandateImportEntryListRequest<ListResponse<MandateImportEntry>> |
list()
For an existing mandate import, this endpoint lists all of the entries attached.
|
public MandateImportEntryService(HttpClient httpClient)
Constructor. Users of this library should have no need to call this - an instance of this class can be obtained by calling GoCardlessClient.mandateImportEntries().
public MandateImportEntryService.MandateImportEntryCreateRequest 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.
public MandateImportEntryService.MandateImportEntryListRequest<ListResponse<MandateImportEntry>> list()
For an existing mandate import, this endpoint lists all of the entries attached.
After a mandate import has been submitted, you can use this endpoint to associate records in your system (using the record_identifier that you provided when creating the mandate import).
public MandateImportEntryService.MandateImportEntryListRequest<java.lang.Iterable<MandateImportEntry>> all()