# Retrieve a direct debit mandates by customer

Endpoint: GET /customers/{id}/directdebitmandates
Version: 1.0.0
Security: Biller Access Token (Staging), Biller Access Token (Production)

## Path parameters:

  - `id` (string, required)

## Response 200 fields (application/json):

  - `mandates` (array)
    The list of all direct debit mandates for the specified filter.

  - `mandates.id` (string)
    The ID of the mandate

  - `mandates.creationTime` (string)
    The creation time of the mandate

  - `mandates.lastUpdateTime` (string)
    The last time when the mandate was updated

  - `mandates.distributionTime` (string)
    The time when the mandate was sent to the customer

  - `mandates.authorisationTime` (string)
    The time when the mandate was signed by the customer

  - `mandates.submissionTime` (string)
    The time when the mandate was submitted to the payment provider

  - `mandates.status` (string)
    The mandate status. 
Possible values (non-exclusive): CREATED, PENDING, ACTIVE, CANCELLED, MIGRATING

  - `mandates.failureReason` (string)
    The reason for failing to set up the mandate

  - `mandates.statusReasonCode` (string)
    The reason why the direct debit mandate is in a certain status.
* PENDING_DD_CAPABILITY - The direct debit mandate was signed, but not yet submitted to the payment provider as the biller onboarding is still in progress.
* PENDING_ACTIVATION - The direct debit mandate was signed, but not yet activated by the payment provider.
* MIGRATED - The direct debit mandate was migrated to a new payment provider.
* BANK_ACCOUNT_CHANGED - The direct debit mandate was created due to a bank account change (bank switching).
* INCORRECT_BANK_DETAILS - The direct debit mandate has incorrect bank account details.
* OTHER - Unknown reason. 
Possible values (non-exclusive): PENDING_DD_CAPABILITY, PENDING_ACTIVATION, MIGRATED, BANK_ACCOUNT_CHANGED, INCORRECT_BANK_DETAILS, OTHER

  - `mandates.statusReason` (string)
    Reason explaining the current status of the direct debit mandate, especially useful for failure cases.

  - `mandates.customer` (object)
    The customer details.

  - `mandates.customer.id` (string)
    The Adfin id of the customer.

  - `mandates.customer.externalId` (string)
    The id of the customer from the platform that is integrating with Adfin.

  - `mandates.customer.name` (string)
    The full name of the customer.

  - `mandates.customer.creationTime` (string)
    The time the customer was created.

  - `mandates.customer.lastUpdatedTime` (string)
    The last time when the customer was updated.

  - `mandates.customer.people` (array)
    The list of people assigned to the customer.

  - `mandates.customer.people.id` (string)
    The internal id of the person.

  - `mandates.customer.people.firstName` (string)
    The first name of the person.

  - `mandates.customer.people.lastName` (string)
    The last name of the person.

  - `mandates.customer.people.email` (string)
    The email of the person.

  - `mandates.customer.people.phoneNo` (string)
    The phone number of the person.

  - `mandates.customer.people.isPrimaryContact` (boolean)
    True if this person is a primary contact.

  - `mandates.customer.people.isIncludedInCommunications` (boolean)
    True if this person is included in the customers communications.

  - `mandates.customer.addresses` (array)
    The list of the addresses for the customer.

  - `mandates.customer.addresses.id` (string)
    The internal id of the address.

  - `mandates.customer.addresses.city` (string)
    The name of the city.

  - `mandates.customer.addresses.postalCode` (string)
    The postal code.

  - `mandates.customer.addresses.country` (string)
    The name of the biller country.

  - `mandates.customer.addresses.addressLine1` (string)
    The name of the street, and the house or building number.

  - `mandates.customer.directDebitMandate` (object)
    Direct Debit details.

  - `mandates.customer.directDebitMandate.id` (string)
    The id of the direct debit mandate.

  - `mandates.customer.directDebitMandate.status` (string)
    The status of the Direct Debit Mandate, if any present.
* CREATED: The Direct Debit Mandate was created with success.
* PENDING: The Direct Debit Mandate was signed and accepted by the customer and it is in the Payment Provider's accepted timeframe.
* ACTIVE: The Direct Debit Mandate was confirmed by the Payment Provider.
* CANCELLED: The Direct Debit Mandate was cancelled directly by the customer.
* MIGRATING: The Direct Debit Mandate is in process of migrating from one payment provider to another.. 
Possible values (non-exclusive): CREATED, PENDING, ACTIVE, CANCELLED, MIGRATING

  - `mandates.customer.directDebitMandate.creationTime` (string)
    The time when the mandate was created

  - `mandates.customer.directDebitMandate.lastUpdatedTime` (string)
    The last time when the mandate was updated

  - `mandates.customer.directDebitMandate.url` (string)
    The URL where the customer can sign the direct debit mandate.

  - `mandates.customer.timezone` (string)
    The timezone of the customer.

  - `mandates.customer.discount` (object)
    The customer discount details.

  - `mandates.customer.discount.percentage` (number)
    The discount as a percentage to be applied for the invoices.

  - `mandates.customer.discount.period` (integer)
    The period in hours until the discount expires.

  - `mandates.customer.externalData` (array)
    References about this customer from external platforms Adfin integrates with, such as ID, etc.

  - `mandates.customer.externalData.connectorType` (string, required)
    The customer connector type. 
Possible values (non-exclusive): XERO, QUICKBOOKS

  - `mandates.customer.externalData.id` (string, required)
    The ID of the Customer in the external platform.

  - `mandates.customer.externalData.name` (string)
    The name of the Customer in the external platform.

  - `mandates.customer.tags` (array)
    The tag ids associated with the customer.

  - `mandates.redirectUrl` (string)
    The (optional) redirect URL to redirect the user after they sign the mandate

  - `mandates.sender` (object)
    The sender details.

  - `mandates.sender.name` (string)
    The registration name of the sender.

  - `mandates.bankAccountNumber` (string)
    The mandate bank account number

  - `mandates.sortCode` (string)
    The mandate sort code

  - `mandates.bankAccountHolderName` (string)
    The mandate bank account holder name


## Response 404 fields