API reference

Create direct debit mandate

post
https://sandbox.numeral.io/v1/direct_debit_mandates

Create a direct debit mandate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The direction of the direct debit mandate. An outgoing mandate aims to debit a third-party account, and an incoming mandate aims to debit an internal account. It must be outgoing for a corporate connected account.

Allowed:
string
enum
required

The type of the direct debit mandate.

Allowed:
uuid
required

The ID of the connected account.

creditor_account
object

The account to be credited. This attribute is required for financial institution connected accounts, and cannot be specified if creditor_account_id is filled or if connected account's type is corporate.

originating_account
object
deprecated

The account to be credited. This attribute is required for financial institution connected accounts, and cannot be specified if originating_account_id is filled or if connected account's type is corporate.

uuid

The ID of the internal account to be credited. It must be left empty if creditor_account parameter is filled. Only supported for outgoing mandates created by financial institution connected accounts.

uuid
deprecated

The ID of the internal account to be credited. It must be left empty if originating_account parameter is filled or if connected account's type is corporate.

debtor_account
object

The account to be debited. It must be left empty if debtor_account_id parameter is filled.

receiving_account
object
deprecated

The account to be debited. It must be left empty if receiving_account_id parameter is filled.

uuid

The ID of the account to be debited. For outgoing mandates, it can be an external account ID. For incoming mandates it can be an internal account ID, however it only applies to financial institutions. A debtor_account_id cannot be used if the debtor_account property is already filled.

uuid
deprecated

The ID of the external account to be debited. It must be left empty if receiving_account parameter is filled.

string
enum
deprecated

Deprecated, use frequency instead.

Allowed:
string
enum

The frequency of the direct debit mandate. Mandatory when type is sepa_core or sepa_b2b.

Allowed:
boolean

When generate_mandate_reference is true, Numeral automatically generates a unique mandate reference. Default value is false.

string

The reference of the direct debit mandate. It must be empty if generate_mandate_reference is true.

string

The signature date of the direct debit mandate.

metadata
object

Additional client data in JSON format. See Metadata.

custom_fields
object

Custom fields in JSON key:value format. See Custom fields.

Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago