# API Endpoints

# Get mandate

**Description**: Retrieves the details of a specific mandate for a customer.\
**HTTP Method**: GET\
**Endpoint**: /platform/vendors/:vendorId/consumers/reference/:consumerReference/mandates\
**Parameters**:

* ConsumerReference (required): The Reference of the consumer

# Request mandate from customer

**Description**: Initiates the process of requesting a Direct Debit mandate from a customer.\
**HTTP Method**: POST\
**Endpoint**: /platform/vendors/vendorId/mandates\
**Parameters**:

* Vendor ID (required):  The unique identifier of the vendor
* Customer ID (required): The unique identifier of the customer.
* Additional parameters for customer information, such as name, email, and address.

# Resend mandate request

**Description**: Resends the mandate request to a customer who has not yet responded or approved the mandate.\
**HTTP Method**: POST\
**Endpoint**: /platform/vendors/\{\{vendor\_id}}/mandates/\{\{mandate\_id}}/send\
**Parameters**:

* Vendor ID (required):  The unique identifier of the vendor
* Mandate ID (required): The unique identifier of the mandate.

# Collect with Direct Debit

> 📘 Note
>
> Within the Direct Debit context, "Collect", "Collection" or "Collecting" refer to a Direct Debit payment (authorization).

**Description**: Creates a collection for a Direct Debit payment.\
**HTTP Method**: POST\
**Endpoint**: /pay-ins/checkout\
**Parameters**:

* Payment method (required)
* Amount (required)
* Due date (required)
* Reference (required)

# Cancel collection

**Description**: Cancels a specific collection made through the Direct Debit service.\
**HTTP Method**: DELETE\
**Endpoint**: platform/pay-ins/:authorizationId/void\
**Parameters**:

* Collection ID (required): The unique identifier of the collection.

# Get all mandates

**Description**: Retrieves a list of all mandates associated with the Direct Debit service.\
**HTTP Method**: GET\
**Endpoint**: TBD

# Get all collections

**Description**: Retrieves a list of all collections made through the Direct Debit service.\
**HTTP Method**: GET\
**Endpoint**: TBD

# Get collection

**Description**: Retrieves the details of a specific collection.\
**HTTP Method**: GET\
**Endpoint**: TBD\
**Parameters**:

* Collection ID (required): The unique identifier of the collection.

# Cancel mandate

**Description**: Cancels a Direct Debit mandate for a customer.\
**HTTP Method**: DELETE\
**Endpoint**: /platform/vendors/:vendorId/mandates/:mandateId/cancel\
**Parameters**:

* Mandate ID (required): The unique identifier of the mandate.

***

*ADD PAYLOADS + INPUT + RESPONSE EXAMPLES*