public class MandateImportService
extends java.lang.Object
Service class for working with mandate import resources.
Mandate Imports allow you to migrate existing mandates from other providers into the GoCardless platform.
The process is as follows:
When you add entries to your mandate import, they are not turned into actual mandates until the mandate import is submitted by you via the API, and then processed by a member of the GoCardless team. When that happens, a mandate will be created for each entry in the import.
We will issue a mandate_created webhook for each entry, which will be the same as the webhooks triggered when creating a mandate using the mandates API. Once these webhooks start arriving, any reconciliation can now be accomplished by checking the current status of the mandate import and linking up the mandates to your system.
Note that all Mandate Imports have an upper limit of 30,000 entries, so we recommend you split your import into several smaller imports if you're planning to exceed this threshold.
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 |
MandateImportService.MandateImportCancelRequest
Request class for
cancel(java.lang.String). |
static class |
MandateImportService.MandateImportCreateRequest
Request class for
create(). |
static class |
MandateImportService.MandateImportGetRequest
Request class for
get(java.lang.String). |
static class |
MandateImportService.MandateImportSubmitRequest
Request class for
submit(java.lang.String). |
| Constructor and Description |
|---|
MandateImportService(HttpClient httpClient)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
MandateImportService.MandateImportCancelRequest |
cancel(java.lang.String identity)
Cancels the mandate import, which aborts the import process and stops the mandates being set up in GoCardless.
|
MandateImportService.MandateImportCreateRequest |
create()
Mandate imports are first created, before mandates are added one-at-a-time, so this endpoint merely signals the start of the import process.
|
MandateImportService.MandateImportGetRequest |
get(java.lang.String identity)
Returns a single mandate import.
|
MandateImportService.MandateImportSubmitRequest |
submit(java.lang.String identity)
Submits the mandate import, which allows it to be processed by a member of the GoCardless team.
|
public MandateImportService(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.mandateImports().
public MandateImportService.MandateImportCreateRequest create()
Mandate imports are first created, before mandates are added one-at-a-time, so this endpoint merely signals the start of the import process. Once you’ve finished adding entries to an import, you should submit it.
public MandateImportService.MandateImportGetRequest get(java.lang.String identity)
Returns a single mandate import.
public MandateImportService.MandateImportSubmitRequest submit(java.lang.String identity)
Submits the mandate import, which allows it to be processed by a member of the GoCardless team. Once the import has been submitted, it can no longer have entries added to it.
In our sandbox environment, to aid development, we automatically process mandate imports approximately 10 seconds after they are submitted. This will allow you to test both the “submitted” response and wait for the webhook to confirm the processing has begun.
public MandateImportService.MandateImportCancelRequest cancel(java.lang.String identity)
Cancels the mandate import, which aborts the import process and stops the mandates being set up in GoCardless. Once the import has been cancelled, it can no longer have entries added to it. Mandate imports which have already been submitted or processed cannot be cancelled.