com.gocardless.resources.MandateImport Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gocardless-pro Show documentation
Client library for accessing the GoCardless Pro API
There is a newer version: 6.0.0
package com.gocardless.resources;

import com.google.gson.annotations.SerializedName;

/**
 * Represents a mandate import resource returned from the API.
 *
 * Mandate Imports allow you to migrate existing mandates from other providers into the GoCardless
 * platform.
 * 
 * The process is as follows:
 * 
 * 1. [Create a mandate import](#mandate-imports-create-a-new-mandate-import) 2. [Add
 * entries](#mandate-import-entries-add-a-mandate-import-entry) to the import 3.
 * [Submit](#mandate-imports-submit-a-mandate-import) the import 4. Wait until a member of the
 * GoCardless team approves the import, at which point the mandates will be created 5. [Link up the
 * mandates](#mandate-import-entries-list-all-mandate-import-entries) in your system
 * 
 * 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 ](#mandates-create-a-mandate) using the mandates API. Once
 * these webhooks start arriving, any reconciliation can now be accomplished by [checking the
 * current status](#mandate-imports-get-a-mandate-import) of the mandate import and [linking up the
 * mandates to your system](#mandate-import-entries-list-all-mandate-import-entries).
 * 
 * 
 * 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.
 * 
 */
public class MandateImport {
    private MandateImport() {
        // blank to prevent instantiation
    }

    private String createdAt;
    private String id;
    private Links links;
    private Scheme scheme;
    private Status status;

    /**
     * Fixed [timestamp](#api-usage-time-zones--dates), recording when this resource was created.
     */
    public String getCreatedAt() {
        return createdAt;
    }

    /**
     * Unique identifier, beginning with "IM".
     */
    public String getId() {
        return id;
    }

    /**
     * Related resources
     */
    public Links getLinks() {
        return links;
    }

    /**
     * The scheme of the mandates to be imported.

     * All mandates in a single mandate import must be for the same scheme.
     */
    public Scheme getScheme() {
        return scheme;
    }

    /**
     * The status of the mandate import.
     * 
     * `created`: A new mandate import.
     * `submitted`: After the integrator has finished adding mandates and
     * submitted the import.
     * `cancelled`: If the integrator
     * cancelled the mandate import.
     * `processing`: Once a mandate import has been approved by a GoCardless team member it will
     * be in this state while mandates are imported.
     * `processed`: When all mandates have been imported successfully.
     * 
     */
    public Status getStatus() {
        return status;
    }

    public enum Scheme {
        @SerializedName("ach")
        ACH, @SerializedName("autogiro")
        AUTOGIRO, @SerializedName("bacs")
        BACS, @SerializedName("becs")
        BECS, @SerializedName("becs_nz")
        BECS_NZ, @SerializedName("betalingsservice")
        BETALINGSSERVICE, @SerializedName("faster_payments")
        FASTER_PAYMENTS, @SerializedName("pad")
        PAD, @SerializedName("pay_to")
        PAY_TO, @SerializedName("sepa_core")
        SEPA_CORE, @SerializedName("unknown")
        UNKNOWN
    }

    public enum Status {
        @SerializedName("created")
        CREATED, @SerializedName("submitted")
        SUBMITTED, @SerializedName("cancelled")
        CANCELLED, @SerializedName("processing")
        PROCESSING, @SerializedName("processed")
        PROCESSED, @SerializedName("unknown")
        UNKNOWN
    }

    /**
     * Represents a link resource returned from the API.
     *
     * Related resources
     */
    public static class Links {
        private Links() {
            // blank to prevent instantiation
        }

        private String creditor;

        /**
         * ID of the associated creditor.
         */
        public String getCreditor() {
            return creditor;
        }
    }
}