# Direct Debit Service

Direct Debit API by Monato

Version: 0.1.0

## Download OpenAPI description

[Direct Debit Service](https://docs.monato.com/_bundle/products/directdebit/openapi.yaml)

## customers

### Create Customer

 - [POST /customers](https://docs.monato.com/products/directdebit/openapi/customers/create_customer_customers_post.md): Create a new customer.

### List Customers

 - [GET /customers](https://docs.monato.com/products/directdebit/openapi/customers/list_customers_customers_get.md): Get all customers with pagination.

### Get Customer

 - [GET /customers/{customer_id}](https://docs.monato.com/products/directdebit/openapi/customers/get_customer_customers__customer_id__get.md): Get a customer by ID.

### Update Customer

 - [PUT /customers/{customer_id}](https://docs.monato.com/products/directdebit/openapi/customers/update_customer_customers__customer_id__put.md): Update an existing customer.

### Delete Customer

 - [DELETE /customers/{customer_id}](https://docs.monato.com/products/directdebit/openapi/customers/delete_customer_customers__customer_id__delete.md): Delete a customer by ID.

## instruments

### Create Instrument

 - [POST /instruments](https://docs.monato.com/products/directdebit/openapi/instruments/create_instrument_instruments_post.md): Create a new instrument.

### List Instruments

 - [GET /instruments](https://docs.monato.com/products/directdebit/openapi/instruments/list_instruments_instruments_get.md): List instruments with cursor-based pagination.

Pagination:
- cursor: Opaque cursor from previous response
- Use next_cursor from response for next page

### Get Instrument

 - [GET /instruments/{instrument_id}](https://docs.monato.com/products/directdebit/openapi/instruments/get_instrument_instruments__instrument_id__get.md): Get an instrument by ID.

### Update Instrument

 - [PUT /instruments/{instrument_id}](https://docs.monato.com/products/directdebit/openapi/instruments/update_instrument_instruments__instrument_id__put.md): Update an existing instrument.

### Delete Instrument

 - [DELETE /instruments/{instrument_id}](https://docs.monato.com/products/directdebit/openapi/instruments/delete_instrument_instruments__instrument_id__delete.md): Delete an instrument by ID.

## charges

### Create Charge

 - [POST /charges](https://docs.monato.com/products/directdebit/openapi/charges/create_charge_charges_post.md): Create a new charge.

### List Charges

 - [GET /charges](https://docs.monato.com/products/directdebit/openapi/charges/list_charges_charges_get.md): List charges with cursor-based pagination.

Filters:
- customer_id: Filter by customer UUID
- instrument_id: Filter by instrument UUID
- reference: Filter by exact reference match
- created_at_from: Filter charges created on or after this date
- created_at_to: Filter charges created on or before this date
- result_at_from: Filter charges with result on or after this date
- result_at_to: Filter charges with result on or before this date
- instrument_identifier: Filter by instrument identifier (inline or linked)

Pagination:
- cursor: Opaque cursor from previous response
- Use next_cursor from response for next page

### Get Charge

 - [GET /charges/{charge_id}](https://docs.monato.com/products/directdebit/openapi/charges/get_charge_charges__charge_id__get.md): Get a charge by ID.

### Update Charge

 - [PUT /charges/{charge_id}](https://docs.monato.com/products/directdebit/openapi/charges/update_charge_charges__charge_id__put.md): Update an existing charge.