com.gocardless.resources.MandateImportEntry 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;

/**
 * Represents a mandate import entry resource returned from the API.
 *
 * Mandate Import Entries are added to a [Mandate Import](#core-endpoints-mandate-imports). Each
 * entry corresponds to one mandate to be imported into GoCardless.
 * 
 * To import a mandate you will need:
 * 
 * Identifying information about the customer (name/company and address)
 * Bank account details, consisting of an account holder name and either an IBAN or
 * local bank details
 * Amendment details (SEPA only)
 * 
 * 
 * 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](#mandate-import-entries-list-all-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.
 * 
 */
public class MandateImportEntry {
    private MandateImportEntry() {
        // blank to prevent instantiation
    }

    private String createdAt;
    private Links links;
    private String recordIdentifier;

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

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

    /**
     * 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. Limited to 255 characters.
     * 
     */
    public String getRecordIdentifier() {
        return recordIdentifier;
    }

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

        private String customer;
        private String customerBankAccount;
        private String mandate;
        private String mandateImport;

        /**
         * The ID of the customer which was created when the mandate import was processed.
         */
        public String getCustomer() {
            return customer;
        }

        /**
         * The ID of the customer bank account which was created when the mandate import was
         * processed.
         */
        public String getCustomerBankAccount() {
            return customerBankAccount;
        }

        /**
         * The ID of the mandate which was created when the mandate import was processed.
         */
        public String getMandate() {
            return mandate;
        }

        /**
         * The ID of the mandate import. This is returned when you [create a Mandate
         * Import](#mandate-imports-create-a-new-mandate-import).
         * 
         */
        public String getMandateImport() {
            return mandateImport;
        }
    }
}