The direct debit mandate object

A direct debit mandate authorises a creditor (a company, public administration, or association) to collect payments from a debtor's bank account (a company, public administration, association, or individual).

Attribute	Description
id string	The UUID of the direct debit mandate.
object string	The object, here `direct_debit_mandate`.
connected_account_id string	The connected account of the direct debit mandate.
direction string	The direction of the direct debit mandate. Either `outgoing` or `incoming`.
reference string	The reference of the direct debit mandate.
signature_date date	The signature date of the direct debit mandate.
type string	The type of the direct debit mandate. For SEPA, either `core` or `b2b`.
sequence string	The sequence of the direct debit mandate. Either `one_off` or `recurring`.
originating_account object	The account to be credited. This attribute must be filled by financial institution customers only. It must be left empty for corporate customers. The object includes the following attributes: account_number: for example, the IBAN. In case the `account_number` is an IBAN, Numeral verifies the validity of the IBAN, but does not verify that the IBAN exists or belongs to the account holder bank_code: for example, the BIC. Only upper case letters are allowed. holder_name: the legal entity or individual name creditor_identifier: the account creditor identifier holder_address: the account holder address, as an address object
receiving_account object	The account to be debited. This attribute must be left empty if `receiving_account_id` is filled. The object includes the following attributes: account_number: for example, the IBAN. In case the `account_number` is an IBAN, Numeral verifies the validity of the IBAN, but does not verify that the IBAN exists or belongs to the account holder bank_code: for example, the BIC. Only upper case letters are allowed holder_name: the legal entity or individual name holder_address: the account holder address, as an address object
receiving_account_id string	The ID of the counterparty_account to be debited. This attribute must be left empty if `receiving_account` is filled.
status string	The status of the direct debit mandate.
metadata object	Additional data in JSON `key:value` format. See Metadata.
created_at datetime	The UTC timestamp of the creation of this direct debit mandate.

Below is an example of a direct_debit_mandate :

{
    "id": "c3fd9ee4-2aab-11ed-a261-0242ac120002",
    "object": "direct_debit_mandate",
    "connected_account_id": "591d818a-27c5-11ee-be56-0242ac120002",
    "direction": "outgoing",
    "reference": "042a5034",
    "signature_date": "2022-09-03",
    "type": "core",
    "sequence": "recurring",
    "originating_account": {
        "account_number": "FR7601234567890627967100010",
        "bank_code": "SOGEFRPP",
        "holder_name": "SoftwareCo",
        "creditor_identifier": "",
        "holder_address": {
            "line_1": "1, rue de l'Abondance",
            "line_2": "",
            "postal_code": "69003",
            "region_state": "",
            "city": "Lyon",
            "country": "FR"
        }
    },
    "receiving_account": {
        "account_number": "FR7601234567891127967100082",
        "bank_code": "BNPAFRPPXXX",
        "holder_name": "PartnerCo",
        "holder_address": {
            "line_1": "1, rue de la Bourse",
            "line_2": "",
            "postal_code": "59000",
            "region_state": "",
            "city": "Lille",
            "country": "FR"
        }
    },
    "receiving_account_id": "b38f5318-a389-4278-9cbe-d16116750982",
    "status": "active",
    "metadata": {},
    "created_at": "2022-09-03T08:12:11.734182Z"
}