---
title: "Retrieve a direct debit"
method: GET
path: "/payments/direct_debits/{direct_debit_id}"
tags: ["Direct Debits"]
---

# Retrieve a direct debit

`GET /payments/direct_debits/{direct_debit_id}`

Retrieve a direct debit

## Response `200`

Direct debit payment

- object
  - `id` string, uuid, required — Direct debit funding request unique identifier
  - `created_at` string, date-time, required — Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)
  - `user_id` string, uuid — User unique identifier.
  - `account_group_id` string, uuid, required — Account group unique identifier.
  - `mandate_id` string, uuid, required — Direct Debit Mandate unique identifier.
  - `cash_amount` string, required
  - `currency` 'EUR' | 'GBP', required — Alphabetic three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. * EUR - Euro * GBP - Pound Sterling
  - `remittance_information` string — Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting ([see more](/documentation/guides/payments/direct_debit/direct_debit_submitting)).
  - `status` 'NEW' | 'PROCESSING' | 'CONFIRMED' | 'CANCELLED' — Status of the direct debit * NEW - Direct debit is created but not started processing. * PROCESSING - Direct debit is in processing. * CONFIRMED - Direct debit was successfully processed. * CANCELLED - Direct debit was cancelled.
  - `cancellation_reason` 'CANCELLED_BY_BANK' | 'CANCELLED_BY_UPVEST' | 'CANCELLED_BY_CLIENT' | 'OTHER' — Reason the direct debit was cancelled. The field is present in case the direct debit has a status of CANCELLED. * CANCELLED_BY_BANK - The payment was not completed by your bank. Please check your account details or contact support. * CANCELLED_BY_UPVEST - The payment was cancelled. Contact support for details. * CANCELLED_BY_CLIENT - The payment was cancelled at your request. * OTHER - Reason not available (applies to historical data only).
  - `purpose_code` string — Purpose of the payment based on *ExternalPurpose1Code* from [ISO 20022](https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets).

## Other responses

- `401` — Unauthorized. The caller has not been authenticated.
- `403` — Forbidden. The caller has been authenticated but is not allowed to take the requested action.
- `404` — Not Found. The requested resource could not be found.
- `406` — Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
- `429` — Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
- `500` — Internal Server Error. The service encountered an unexpected error.
- `503` — Service Unavailable. The service handling for this request cannot be reached at this time.
- `504` — Gateway Timeout. The service gateway has reached its internal timeout.

---

[API](https://skmtc.net/upvest/apis/upvest-investment-api.md) · [All operations](https://skmtc.net/upvest/apis/upvest-investment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upvest/upvest-investment-api/revisions/2c6bc192bc09/schema)