List direct debit mandates

get

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

List and filter direct debit mandate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

0 to 100

Defaults to 25

starting_after

uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order

string

enum

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

Allowed:

start_date

date

The creation date of the direct debit mandate.

end_date

date

The creation date of the direct debit mandate.

start_signature_date

date

The minimum signature date of the direct debit mandate.

end_signature_date

date

The maximum signature date of the direct debit mandate.

receiving_account_id

uuid

deprecated

The receiving_account_id of the direct debit mandate.

originating_account_id

uuid

deprecated

The originating_account_id of the direct debit mandate.

debtor_account_id

uuid

The debtor_account_id of the direct debit mandate.

creditor_account_id

uuid

The creditor_account_id of the direct debit mandate.

type

string

enum

The type of the direct debit mandate.

Allowed:

sequence

string

enum

deprecated

Deprecated, use frequency instead.

Allowed:

frequency

string

enum

The frequency of the direct debit mandate.

Allowed:

reference

string

The reference of the direct debit mandate.

custom_fields.key

string

The key of a custom field's value. You can pass multiple keys and multiple values, for instance custom_fields.k1=a&custom_fields.k1=b&custom_fields.k2=c.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400Validation Error.