v1
latestOpenAPI 3.1.02026-07-24180245513.9 KBDirect Debit Mandates
List direct debit mandates
List and filter direct debit mandate.
get/direct_debit_mandates
Query parameters
limitinteger
starting_afterstring uuid
The ID of the object from which your list request will start. It is not included in the result.
sort_order'asc' | 'desc'
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.
start_datestring date
The creation date of the direct debit mandate.
end_datestring date
The creation date of the direct debit mandate.
start_signature_datestring date
The minimum signature date of the direct debit mandate.
end_signature_datestring date
The maximum signature date of the direct debit mandate.
receiving_account_idstring uuid
The receiving_account_id of the direct debit mandate.
originating_account_idstring uuid
The originating_account_id of the direct debit mandate.
debtor_account_idstring uuid
The debtor_account_id of the direct debit mandate.
creditor_account_idstring uuid
The creditor_account_id of the direct debit mandate.
type'sepa_core' | 'sepa_b2b' | 'bacs_debit'
The type of the direct debit mandate.
sequence'one_off' | 'recurring'
Deprecated, use frequency instead.
frequency'one_off' | 'recurring'
The frequency of the direct debit mandate.
referencestring
The reference of the direct debit mandate.
Response
200
Example response
{
"records": [
{
"direction": "outgoing",
"type": "sepa_core",
"status": "active",
"connected_account_id": "ff1714ae-3ec8-450d-984c-c6ee44c82a88",
"creditor_account": {
"account_number": "FR7601234567890627967100010",
"bank_code": "SOGEFRPP",
"holder_name": "SoftwareCo",
"creditor_identifier": "FR12ZZZ123456",
"holder_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
}
},
"creditor_account_id": "2c524087-20ae-437e-948c-f673b0757821",
"creditor_account_type": "internal_account",
"debtor_account": {
"account_number": "FR7601234567891127967100082",
"bank_code": "BNPAFRPPXXX",
"holder_name": "PartnerCo",
"holder_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
}
},
"debtor_account_id": "b38f5318-a389-4278-9cbe-d16116750982",
"debtor_account_type": "external_account",
"originating_account": {
"account_number": "FR7601234567890627967100010",
"bank_code": "SOGEFRPP",
"holder_name": "SoftwareCo",
"creditor_identifier": "FR12ZZZ123456",
"holder_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
}
},
"originating_account_id": "2c524087-20ae-437e-948c-f673b0757821",
"receiving_account": {
"account_number": "FR7601234567891127967100082",
"bank_code": "BNPAFRPPXXX",
"holder_name": "PartnerCo",
"holder_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
}
},
"receiving_account_id": "b38f5318-a389-4278-9cbe-d16116750982",
"sequence": "recurring",
"frequency": "recurring",
"reference": "some reference",
"signature_date": "2023-05-31",
"last_debit_collection_date": "2024-03-15",
"expiry_date": "2027-03-15",
"metadata": {
"property_a": true,
"property_b": "some text"
},
"created_at": "2023-06-07T08:49:54.54422Z",
"bank_data": {
"message_id": "ABCDEF"
}
}
]
}